~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2012 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
 
 
19
17
import bz2
20
 
import zlib
21
18
 
22
19
from bzrlib import (
23
20
    bencode,
24
21
    branch,
25
 
    bzrdir as _mod_bzrdir,
26
 
    config as _mod_config,
 
22
    bzrdir,
 
23
    config,
27
24
    controldir,
28
25
    debug,
29
26
    errors,
30
 
    gpg,
31
27
    graph,
32
 
    inventory_delta,
33
28
    lock,
34
29
    lockdir,
35
 
    osutils,
36
 
    registry,
 
30
    repository,
37
31
    repository as _mod_repository,
 
32
    revision,
38
33
    revision as _mod_revision,
39
34
    static_tuple,
40
35
    symbol_versioning,
41
 
    testament as _mod_testament,
42
 
    urlutils,
43
 
    vf_repository,
44
 
    vf_search,
45
 
    )
 
36
)
46
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
38
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
47
39
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
48
40
from bzrlib.errors import (
49
41
    NoSuchRevision,
50
42
    SmartProtocolError,
51
43
    )
52
 
from bzrlib.i18n import gettext
53
 
from bzrlib.inventory import Inventory
54
44
from bzrlib.lockable_files import LockableFiles
55
45
from bzrlib.smart import client, vfs, repository as smart_repo
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 FulltextContentFactory
63
 
 
64
 
 
65
 
_DEFAULT_SEARCH_DEPTH = 100
 
46
from bzrlib.revision import ensure_null, NULL_REVISION
 
47
from bzrlib.repository import RepositoryWriteLockResult
 
48
from bzrlib.trace import mutter, note, warning
66
49
 
67
50
 
68
51
class _RpcHelper(object):
105
88
    return format
106
89
 
107
90
 
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
 
    colocated_branches = False
117
 
 
118
 
    def __init__(self):
119
 
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
120
 
        # XXX: It's a bit ugly that the network name is here, because we'd
121
 
        # like to believe that format objects are stateless or at least
122
 
        # immutable,  However, we do at least avoid mutating the name after
123
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
124
 
        self._network_name = None
125
 
 
126
 
    def __repr__(self):
127
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
128
 
            self._network_name)
129
 
 
130
 
    def get_format_description(self):
131
 
        if self._network_name:
132
 
            try:
133
 
                real_format = controldir.network_format_registry.get(
134
 
                        self._network_name)
135
 
            except KeyError:
136
 
                pass
137
 
            else:
138
 
                return 'Remote: ' + real_format.get_format_description()
139
 
        return 'bzr remote bzrdir'
140
 
 
141
 
    def get_format_string(self):
142
 
        raise NotImplementedError(self.get_format_string)
143
 
 
144
 
    def network_name(self):
145
 
        if self._network_name:
146
 
            return self._network_name
147
 
        else:
148
 
            raise AssertionError("No network name set.")
149
 
 
150
 
    def initialize_on_transport(self, transport):
151
 
        try:
152
 
            # hand off the request to the smart server
153
 
            client_medium = transport.get_smart_medium()
154
 
        except errors.NoSmartMedium:
155
 
            # TODO: lookup the local format from a server hint.
156
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
157
 
            return local_dir_format.initialize_on_transport(transport)
158
 
        client = _SmartClient(client_medium)
159
 
        path = client.remote_path_from_transport(transport)
160
 
        try:
161
 
            response = client.call('BzrDirFormat.initialize', path)
162
 
        except errors.ErrorFromSmartServer, err:
163
 
            _translate_error(err, path=path)
164
 
        if response[0] != 'ok':
165
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
166
 
        format = RemoteBzrDirFormat()
167
 
        self._supply_sub_formats_to(format)
168
 
        return RemoteBzrDir(transport, format)
169
 
 
170
 
    def parse_NoneTrueFalse(self, arg):
171
 
        if not arg:
172
 
            return None
173
 
        if arg == 'False':
174
 
            return False
175
 
        if arg == 'True':
176
 
            return True
177
 
        raise AssertionError("invalid arg %r" % arg)
178
 
 
179
 
    def _serialize_NoneTrueFalse(self, arg):
180
 
        if arg is False:
181
 
            return 'False'
182
 
        if arg:
183
 
            return 'True'
184
 
        return ''
185
 
 
186
 
    def _serialize_NoneString(self, arg):
187
 
        return arg or ''
188
 
 
189
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
190
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
191
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
192
 
        shared_repo=False):
193
 
        try:
194
 
            # hand off the request to the smart server
195
 
            client_medium = transport.get_smart_medium()
196
 
        except errors.NoSmartMedium:
197
 
            do_vfs = True
198
 
        else:
199
 
            # Decline to open it if the server doesn't support our required
200
 
            # version (3) so that the VFS-based transport will do it.
201
 
            if client_medium.should_probe():
202
 
                try:
203
 
                    server_version = client_medium.protocol_version()
204
 
                    if server_version != '2':
205
 
                        do_vfs = True
206
 
                    else:
207
 
                        do_vfs = False
208
 
                except errors.SmartProtocolError:
209
 
                    # Apparently there's no usable smart server there, even though
210
 
                    # the medium supports the smart protocol.
211
 
                    do_vfs = True
212
 
            else:
213
 
                do_vfs = False
214
 
        if not do_vfs:
215
 
            client = _SmartClient(client_medium)
216
 
            path = client.remote_path_from_transport(transport)
217
 
            if client_medium._is_remote_before((1, 16)):
218
 
                do_vfs = True
219
 
        if do_vfs:
220
 
            # TODO: lookup the local format from a server hint.
221
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
222
 
            self._supply_sub_formats_to(local_dir_format)
223
 
            return local_dir_format.initialize_on_transport_ex(transport,
224
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
225
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
226
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
227
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
228
 
                vfs_only=True)
229
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
230
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
231
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
232
 
 
233
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
234
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
235
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
236
 
        args = []
237
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
238
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
239
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
240
 
        args.append(self._serialize_NoneString(stacked_on))
241
 
        # stack_on_pwd is often/usually our transport
242
 
        if stack_on_pwd:
243
 
            try:
244
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
245
 
                if not stack_on_pwd:
246
 
                    stack_on_pwd = '.'
247
 
            except errors.PathNotChild:
248
 
                pass
249
 
        args.append(self._serialize_NoneString(stack_on_pwd))
250
 
        args.append(self._serialize_NoneString(repo_format_name))
251
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
252
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
253
 
        request_network_name = self._network_name or \
254
 
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
255
 
        try:
256
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
257
 
                request_network_name, path, *args)
258
 
        except errors.UnknownSmartMethod:
259
 
            client._medium._remember_remote_is_before((1,16))
260
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
261
 
            self._supply_sub_formats_to(local_dir_format)
262
 
            return local_dir_format.initialize_on_transport_ex(transport,
263
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
264
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
265
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
266
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
267
 
                vfs_only=True)
268
 
        except errors.ErrorFromSmartServer, err:
269
 
            _translate_error(err, path=path)
270
 
        repo_path = response[0]
271
 
        bzrdir_name = response[6]
272
 
        require_stacking = response[7]
273
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
274
 
        format = RemoteBzrDirFormat()
275
 
        format._network_name = bzrdir_name
276
 
        self._supply_sub_formats_to(format)
277
 
        bzrdir = RemoteBzrDir(transport, format, _client=client)
278
 
        if repo_path:
279
 
            repo_format = response_tuple_to_repo_format(response[1:])
280
 
            if repo_path == '.':
281
 
                repo_path = ''
282
 
            if repo_path:
283
 
                repo_bzrdir_format = RemoteBzrDirFormat()
284
 
                repo_bzrdir_format._network_name = response[5]
285
 
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
286
 
                    repo_bzrdir_format)
287
 
            else:
288
 
                repo_bzr = bzrdir
289
 
            final_stack = response[8] or None
290
 
            final_stack_pwd = response[9] or None
291
 
            if final_stack_pwd:
292
 
                final_stack_pwd = urlutils.join(
293
 
                    transport.base, final_stack_pwd)
294
 
            remote_repo = RemoteRepository(repo_bzr, repo_format)
295
 
            if len(response) > 10:
296
 
                # Updated server verb that locks remotely.
297
 
                repo_lock_token = response[10] or None
298
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
299
 
                if repo_lock_token:
300
 
                    remote_repo.dont_leave_lock_in_place()
301
 
            else:
302
 
                remote_repo.lock_write()
303
 
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
304
 
                final_stack_pwd, require_stacking)
305
 
            policy.acquire_repository()
306
 
        else:
307
 
            remote_repo = None
308
 
            policy = None
309
 
        bzrdir._format.set_branch_format(self.get_branch_format())
310
 
        if require_stacking:
311
 
            # The repo has already been created, but we need to make sure that
312
 
            # we'll make a stackable branch.
313
 
            bzrdir._format.require_stacking(_skip_repo=True)
314
 
        return remote_repo, bzrdir, require_stacking, policy
315
 
 
316
 
    def _open(self, transport):
317
 
        return RemoteBzrDir(transport, self)
318
 
 
319
 
    def __eq__(self, other):
320
 
        if not isinstance(other, RemoteBzrDirFormat):
321
 
            return False
322
 
        return self.get_format_description() == other.get_format_description()
323
 
 
324
 
    def __return_repository_format(self):
325
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
326
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
327
 
        # that it should use that for init() etc.
328
 
        result = RemoteRepositoryFormat()
329
 
        custom_format = getattr(self, '_repository_format', None)
330
 
        if custom_format:
331
 
            if isinstance(custom_format, RemoteRepositoryFormat):
332
 
                return custom_format
333
 
            else:
334
 
                # We will use the custom format to create repositories over the
335
 
                # wire; expose its details like rich_root_data for code to
336
 
                # query
337
 
                result._custom_format = custom_format
338
 
        return result
339
 
 
340
 
    def get_branch_format(self):
341
 
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
342
 
        if not isinstance(result, RemoteBranchFormat):
343
 
            new_result = RemoteBranchFormat()
344
 
            new_result._custom_format = result
345
 
            # cache the result
346
 
            self.set_branch_format(new_result)
347
 
            result = new_result
348
 
        return result
349
 
 
350
 
    repository_format = property(__return_repository_format,
351
 
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
352
 
 
353
 
 
354
 
class RemoteControlStore(_mod_config.IniFileStore):
355
 
    """Control store which attempts to use HPSS calls to retrieve control store.
356
 
 
357
 
    Note that this is specific to bzr-based formats.
358
 
    """
359
 
 
360
 
    def __init__(self, bzrdir):
361
 
        super(RemoteControlStore, self).__init__()
362
 
        self.bzrdir = bzrdir
363
 
        self._real_store = None
364
 
 
365
 
    def lock_write(self, token=None):
366
 
        self._ensure_real()
367
 
        return self._real_store.lock_write(token)
368
 
 
369
 
    def unlock(self):
370
 
        self._ensure_real()
371
 
        return self._real_store.unlock()
372
 
 
373
 
    @needs_write_lock
374
 
    def save(self):
375
 
        # We need to be able to override the undecorated implementation
376
 
        self.save_without_locking()
377
 
 
378
 
    def save_without_locking(self):
379
 
        super(RemoteControlStore, self).save()
380
 
 
381
 
    def _ensure_real(self):
382
 
        self.bzrdir._ensure_real()
383
 
        if self._real_store is None:
384
 
            self._real_store = _mod_config.ControlStore(self.bzrdir)
385
 
 
386
 
    def external_url(self):
387
 
        return urlutils.join(self.branch.user_url, 'control.conf')
388
 
 
389
 
    def _load_content(self):
390
 
        medium = self.bzrdir._client._medium
391
 
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
392
 
        try:
393
 
            response, handler = self.bzrdir._call_expecting_body(
394
 
                'BzrDir.get_config_file', path)
395
 
        except errors.UnknownSmartMethod:
396
 
            self._ensure_real()
397
 
            return self._real_store._load_content()
398
 
        if len(response) and response[0] != 'ok':
399
 
            raise errors.UnexpectedSmartServerResponse(response)
400
 
        return handler.read_body_bytes()
401
 
 
402
 
    def _save_content(self, content):
403
 
        # FIXME JRV 2011-11-22: Ideally this should use a
404
 
        # HPSS call too, but at the moment it is not possible
405
 
        # to write lock control directories.
406
 
        self._ensure_real()
407
 
        return self._real_store._save_content(content)
408
 
 
409
 
 
410
 
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
 
91
# Note: RemoteBzrDirFormat is in bzrdir.py
 
92
 
 
93
class RemoteBzrDir(BzrDir, _RpcHelper):
411
94
    """Control directory on a remote server, accessed via bzr:// or similar."""
412
95
 
413
96
    def __init__(self, transport, format, _client=None, _force_probe=False):
416
99
        :param _client: Private parameter for testing. Disables probing and the
417
100
            use of a real bzrdir.
418
101
        """
419
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
102
        BzrDir.__init__(self, transport, format)
420
103
        # this object holds a delegated bzrdir that uses file-level operations
421
104
        # to talk to the other side
422
105
        self._real_bzrdir = None
482
165
                import traceback
483
166
                warning('VFS BzrDir access triggered\n%s',
484
167
                    ''.join(traceback.format_stack()))
485
 
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
486
 
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
 
168
            self._real_bzrdir = BzrDir.open_from_transport(
 
169
                self.root_transport, _server_formats=False)
487
170
            self._format._network_name = \
488
171
                self._real_bzrdir._format.network_name()
489
172
 
494
177
        # Prevent aliasing problems in the next_open_branch_result cache.
495
178
        # See create_branch for rationale.
496
179
        self._next_open_branch_result = None
497
 
        return _mod_bzrdir.BzrDir.break_lock(self)
498
 
 
499
 
    def _vfs_checkout_metadir(self):
500
 
        self._ensure_real()
501
 
        return self._real_bzrdir.checkout_metadir()
502
 
 
503
 
    def checkout_metadir(self):
504
 
        """Retrieve the controldir format to use for checkouts of this one.
505
 
        """
506
 
        medium = self._client._medium
507
 
        if medium._is_remote_before((2, 5)):
508
 
            return self._vfs_checkout_metadir()
509
 
        path = self._path_for_remote_call(self._client)
510
 
        try:
511
 
            response = self._client.call('BzrDir.checkout_metadir',
512
 
                path)
513
 
        except errors.UnknownSmartMethod:
514
 
            medium._remember_remote_is_before((2, 5))
515
 
            return self._vfs_checkout_metadir()
516
 
        if len(response) != 3:
517
 
            raise errors.UnexpectedSmartServerResponse(response)
518
 
        control_name, repo_name, branch_name = response
519
 
        try:
520
 
            format = controldir.network_format_registry.get(control_name)
521
 
        except KeyError:
522
 
            raise errors.UnknownFormatError(kind='control',
523
 
                format=control_name)
524
 
        if repo_name:
525
 
            try:
526
 
                repo_format = _mod_repository.network_format_registry.get(
527
 
                    repo_name)
528
 
            except KeyError:
529
 
                raise errors.UnknownFormatError(kind='repository',
530
 
                    format=repo_name)
531
 
            format.repository_format = repo_format
532
 
        if branch_name:
533
 
            try:
534
 
                format.set_branch_format(
535
 
                    branch.network_format_registry.get(branch_name))
536
 
            except KeyError:
537
 
                raise errors.UnknownFormatError(kind='branch',
538
 
                    format=branch_name)
539
 
        return format
 
180
        return BzrDir.break_lock(self)
540
181
 
541
182
    def _vfs_cloning_metadir(self, require_stacking=False):
542
183
        self._ensure_real()
573
214
        if len(branch_info) != 2:
574
215
            raise errors.UnexpectedSmartServerResponse(response)
575
216
        branch_ref, branch_name = branch_info
576
 
        try:
577
 
            format = controldir.network_format_registry.get(control_name)
578
 
        except KeyError:
579
 
            raise errors.UnknownFormatError(kind='control', format=control_name)
580
 
 
 
217
        format = bzrdir.network_format_registry.get(control_name)
581
218
        if repo_name:
582
 
            try:
583
 
                format.repository_format = _mod_repository.network_format_registry.get(
584
 
                    repo_name)
585
 
            except KeyError:
586
 
                raise errors.UnknownFormatError(kind='repository',
587
 
                    format=repo_name)
 
219
            format.repository_format = repository.network_format_registry.get(
 
220
                repo_name)
588
221
        if branch_ref == 'ref':
589
222
            # XXX: we need possible_transports here to avoid reopening the
590
223
            # connection to the referenced location
591
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
 
224
            ref_bzrdir = BzrDir.open(branch_name)
592
225
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
593
226
            format.set_branch_format(branch_format)
594
227
        elif branch_ref == 'branch':
595
228
            if branch_name:
596
 
                try:
597
 
                    branch_format = branch.network_format_registry.get(
598
 
                        branch_name)
599
 
                except KeyError:
600
 
                    raise errors.UnknownFormatError(kind='branch',
601
 
                        format=branch_name)
602
 
                format.set_branch_format(branch_format)
 
229
                format.set_branch_format(
 
230
                    branch.network_format_registry.get(branch_name))
603
231
        else:
604
232
            raise errors.UnexpectedSmartServerResponse(response)
605
233
        return format
615
243
 
616
244
    def destroy_repository(self):
617
245
        """See BzrDir.destroy_repository"""
618
 
        path = self._path_for_remote_call(self._client)
619
 
        try:
620
 
            response = self._call('BzrDir.destroy_repository', path)
621
 
        except errors.UnknownSmartMethod:
622
 
            self._ensure_real()
623
 
            self._real_bzrdir.destroy_repository()
624
 
            return
625
 
        if response[0] != 'ok':
626
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
246
        self._ensure_real()
 
247
        self._real_bzrdir.destroy_repository()
627
248
 
628
 
    def create_branch(self, name=None, repository=None,
629
 
                      append_revisions_only=None):
630
 
        if name is None:
631
 
            name = self._get_selected_branch()
632
 
        if name != "":
633
 
            raise errors.NoColocatedBranchSupport(self)
 
249
    def create_branch(self, name=None):
634
250
        # as per meta1 formats - just delegate to the format object which may
635
251
        # be parameterised.
636
252
        real_branch = self._format.get_branch_format().initialize(self,
637
 
            name=name, repository=repository,
638
 
            append_revisions_only=append_revisions_only)
 
253
            name=name)
639
254
        if not isinstance(real_branch, RemoteBranch):
640
 
            if not isinstance(repository, RemoteRepository):
641
 
                raise AssertionError(
642
 
                    'need a RemoteRepository to use with RemoteBranch, got %r'
643
 
                    % (repository,))
644
 
            result = RemoteBranch(self, repository, real_branch, name=name)
 
255
            result = RemoteBranch(self, self.find_repository(), real_branch,
 
256
                                  name=name)
645
257
        else:
646
258
            result = real_branch
647
259
        # BzrDir.clone_on_transport() uses the result of create_branch but does
655
267
 
656
268
    def destroy_branch(self, name=None):
657
269
        """See BzrDir.destroy_branch"""
658
 
        if name is None:
659
 
            name = self._get_selected_branch()
660
 
        if name != "":
661
 
            raise errors.NoColocatedBranchSupport(self)
662
 
        path = self._path_for_remote_call(self._client)
663
 
        try:
664
 
            if name != "":
665
 
                args = (name, )
666
 
            else:
667
 
                args = ()
668
 
            response = self._call('BzrDir.destroy_branch', path, *args)
669
 
        except errors.UnknownSmartMethod:
670
 
            self._ensure_real()
671
 
            self._real_bzrdir.destroy_branch(name=name)
672
 
            self._next_open_branch_result = None
673
 
            return
 
270
        self._ensure_real()
 
271
        self._real_bzrdir.destroy_branch(name=name)
674
272
        self._next_open_branch_result = None
675
 
        if response[0] != 'ok':
676
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
677
273
 
678
 
    def create_workingtree(self, revision_id=None, from_branch=None,
679
 
        accelerator_tree=None, hardlink=False):
 
274
    def create_workingtree(self, revision_id=None, from_branch=None):
680
275
        raise errors.NotLocalUrl(self.transport.base)
681
276
 
682
277
    def find_branch_format(self, name=None):
687
282
        b = self.open_branch(name=name)
688
283
        return b._format
689
284
 
690
 
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
691
 
        path = self._path_for_remote_call(self._client)
692
 
        try:
693
 
            response, handler = self._call_expecting_body(
694
 
                'BzrDir.get_branches', path)
695
 
        except errors.UnknownSmartMethod:
696
 
            self._ensure_real()
697
 
            return self._real_bzrdir.get_branches()
698
 
        if response[0] != "success":
699
 
            raise errors.UnexpectedSmartServerResponse(response)
700
 
        body = bencode.bdecode(handler.read_body_bytes())
701
 
        ret = {}
702
 
        for (name, value) in body.iteritems():
703
 
            ret[name] = self._open_branch(name, value[0], value[1],
704
 
                possible_transports=possible_transports,
705
 
                ignore_fallbacks=ignore_fallbacks)
706
 
        return ret
707
 
 
708
 
    def set_branch_reference(self, target_branch, name=None):
709
 
        """See BzrDir.set_branch_reference()."""
710
 
        if name is None:
711
 
            name = self._get_selected_branch()
712
 
        if name != "":
713
 
            raise errors.NoColocatedBranchSupport(self)
714
 
        self._ensure_real()
715
 
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
716
 
 
717
285
    def get_branch_reference(self, name=None):
718
286
        """See BzrDir.get_branch_reference()."""
719
 
        if name is None:
720
 
            name = self._get_selected_branch()
721
 
        if name != "":
 
287
        if name is not None:
 
288
            # XXX JRV20100304: Support opening colocated branches
722
289
            raise errors.NoColocatedBranchSupport(self)
723
290
        response = self._get_branch_reference()
724
291
        if response[0] == 'ref':
760
327
        """See BzrDir._get_tree_branch()."""
761
328
        return None, self.open_branch(name=name)
762
329
 
763
 
    def _open_branch(self, name, kind, location_or_format,
764
 
                     ignore_fallbacks=False, possible_transports=None):
765
 
        if kind == 'ref':
 
330
    def open_branch(self, name=None, unsupported=False,
 
331
                    ignore_fallbacks=False):
 
332
        if unsupported:
 
333
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
334
        if self._next_open_branch_result is not None:
 
335
            # See create_branch for details.
 
336
            result = self._next_open_branch_result
 
337
            self._next_open_branch_result = None
 
338
            return result
 
339
        response = self._get_branch_reference()
 
340
        if response[0] == 'ref':
766
341
            # a branch reference, use the existing BranchReference logic.
767
342
            format = BranchReferenceFormat()
768
343
            return format.open(self, name=name, _found=True,
769
 
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
770
 
                possible_transports=possible_transports)
771
 
        branch_format_name = location_or_format
 
344
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
345
        branch_format_name = response[1]
772
346
        if not branch_format_name:
773
347
            branch_format_name = None
774
348
        format = RemoteBranchFormat(network_name=branch_format_name)
775
349
        return RemoteBranch(self, self.find_repository(), format=format,
776
 
            setup_stacking=not ignore_fallbacks, name=name,
777
 
            possible_transports=possible_transports)
778
 
 
779
 
    def open_branch(self, name=None, unsupported=False,
780
 
                    ignore_fallbacks=False, possible_transports=None):
781
 
        if name is None:
782
 
            name = self._get_selected_branch()
783
 
        if name != "":
784
 
            raise errors.NoColocatedBranchSupport(self)
785
 
        if unsupported:
786
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
787
 
        if self._next_open_branch_result is not None:
788
 
            # See create_branch for details.
789
 
            result = self._next_open_branch_result
790
 
            self._next_open_branch_result = None
791
 
            return result
792
 
        response = self._get_branch_reference()
793
 
        return self._open_branch(name, response[0], response[1],
794
 
            possible_transports=possible_transports,
795
 
            ignore_fallbacks=ignore_fallbacks)
 
350
            setup_stacking=not ignore_fallbacks, name=name)
796
351
 
797
352
    def _open_repo_v1(self, path):
798
353
        verb = 'BzrDir.find_repository'
861
416
 
862
417
    def has_workingtree(self):
863
418
        if self._has_working_tree is None:
864
 
            path = self._path_for_remote_call(self._client)
865
 
            try:
866
 
                response = self._call('BzrDir.has_workingtree', path)
867
 
            except errors.UnknownSmartMethod:
868
 
                self._ensure_real()
869
 
                self._has_working_tree = self._real_bzrdir.has_workingtree()
870
 
            else:
871
 
                if response[0] not in ('yes', 'no'):
872
 
                    raise SmartProtocolError('unexpected response code %s' % (response,))
873
 
                self._has_working_tree = (response[0] == 'yes')
 
419
            self._ensure_real()
 
420
            self._has_working_tree = self._real_bzrdir.has_workingtree()
874
421
        return self._has_working_tree
875
422
 
876
423
    def open_workingtree(self, recommend_upgrade=True):
881
428
 
882
429
    def _path_for_remote_call(self, client):
883
430
        """Return the path to be used for this bzrdir in a remote call."""
884
 
        return urlutils.split_segment_parameters_raw(
885
 
            client.remote_path_from_transport(self.root_transport))[0]
 
431
        return client.remote_path_from_transport(self.root_transport)
886
432
 
887
433
    def get_branch_transport(self, branch_format, name=None):
888
434
        self._ensure_real()
900
446
        """Upgrading of remote bzrdirs is not supported yet."""
901
447
        return False
902
448
 
903
 
    def needs_format_conversion(self, format):
 
449
    def needs_format_conversion(self, format=None):
904
450
        """Upgrading of remote bzrdirs is not supported yet."""
 
451
        if format is None:
 
452
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
453
                % 'needs_format_conversion(format=None)')
905
454
        return False
906
455
 
 
456
    def clone(self, url, revision_id=None, force_new_repo=False,
 
457
              preserve_stacking=False):
 
458
        self._ensure_real()
 
459
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
460
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
461
 
907
462
    def _get_config(self):
908
463
        return RemoteBzrDirConfig(self)
909
464
 
910
 
    def _get_config_store(self):
911
 
        return RemoteControlStore(self)
912
 
 
913
 
 
914
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
465
 
 
466
class RemoteRepositoryFormat(repository.RepositoryFormat):
915
467
    """Format for repositories accessed over a _SmartClient.
916
468
 
917
469
    Instances of this repository are represented by RemoteRepository
932
484
    """
933
485
 
934
486
    _matchingbzrdir = RemoteBzrDirFormat()
935
 
    supports_full_versioned_files = True
936
 
    supports_leaving_lock = True
937
487
 
938
488
    def __init__(self):
939
 
        _mod_repository.RepositoryFormat.__init__(self)
 
489
        repository.RepositoryFormat.__init__(self)
940
490
        self._custom_format = None
941
491
        self._network_name = None
942
492
        self._creating_bzrdir = None
943
 
        self._revision_graph_can_have_wrong_parents = None
944
493
        self._supports_chks = None
945
494
        self._supports_external_lookups = None
946
495
        self._supports_tree_reference = None
947
 
        self._supports_funky_characters = None
948
 
        self._supports_nesting_repositories = None
949
496
        self._rich_root_data = None
950
497
 
951
498
    def __repr__(self):
980
527
        return self._supports_external_lookups
981
528
 
982
529
    @property
983
 
    def supports_funky_characters(self):
984
 
        if self._supports_funky_characters is None:
985
 
            self._ensure_real()
986
 
            self._supports_funky_characters = \
987
 
                self._custom_format.supports_funky_characters
988
 
        return self._supports_funky_characters
989
 
 
990
 
    @property
991
 
    def supports_nesting_repositories(self):
992
 
        if self._supports_nesting_repositories is None:
993
 
            self._ensure_real()
994
 
            self._supports_nesting_repositories = \
995
 
                self._custom_format.supports_nesting_repositories
996
 
        return self._supports_nesting_repositories
997
 
 
998
 
    @property
999
530
    def supports_tree_reference(self):
1000
531
        if self._supports_tree_reference is None:
1001
532
            self._ensure_real()
1003
534
                self._custom_format.supports_tree_reference
1004
535
        return self._supports_tree_reference
1005
536
 
1006
 
    @property
1007
 
    def revision_graph_can_have_wrong_parents(self):
1008
 
        if self._revision_graph_can_have_wrong_parents is None:
1009
 
            self._ensure_real()
1010
 
            self._revision_graph_can_have_wrong_parents = \
1011
 
                self._custom_format.revision_graph_can_have_wrong_parents
1012
 
        return self._revision_graph_can_have_wrong_parents
1013
 
 
1014
537
    def _vfs_initialize(self, a_bzrdir, shared):
1015
538
        """Helper for common code in initialize."""
1016
539
        if self._custom_format:
1051
574
            network_name = self._network_name
1052
575
        else:
1053
576
            # Select the current bzrlib default and ask for that.
1054
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
577
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
1055
578
            reference_format = reference_bzrdir_format.repository_format
1056
579
            network_name = reference_format.network_name()
1057
580
        # 2) try direct creation via RPC
1083
606
 
1084
607
    def _ensure_real(self):
1085
608
        if self._custom_format is None:
1086
 
            try:
1087
 
                self._custom_format = _mod_repository.network_format_registry.get(
1088
 
                    self._network_name)
1089
 
            except KeyError:
1090
 
                raise errors.UnknownFormatError(kind='repository',
1091
 
                    format=self._network_name)
 
609
            self._custom_format = repository.network_format_registry.get(
 
610
                self._network_name)
1092
611
 
1093
612
    @property
1094
613
    def _fetch_order(self):
1129
648
        return self._custom_format._serializer
1130
649
 
1131
650
 
1132
 
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
1133
 
        lock._RelockDebugMixin):
 
651
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
 
652
    controldir.ControlComponent):
1134
653
    """Repository accessed over rpc.
1135
654
 
1136
655
    For the moment most operations are performed using local transport-backed
1160
679
        self._format = format
1161
680
        self._lock_mode = None
1162
681
        self._lock_token = None
1163
 
        self._write_group_tokens = None
1164
682
        self._lock_count = 0
1165
683
        self._leave_lock = False
1166
684
        # Cache of revision parents; misses are cached during read locks, and
1190
708
        # transport, but I'm not sure it's worth making this method
1191
709
        # optional -- mbp 2010-04-21
1192
710
        return self.bzrdir.get_repository_transport(None)
1193
 
 
 
711
        
1194
712
    def __str__(self):
1195
713
        return "%s(%s)" % (self.__class__.__name__, self.base)
1196
714
 
1206
724
 
1207
725
        :param suppress_errors: see Repository.abort_write_group.
1208
726
        """
1209
 
        if self._real_repository:
1210
 
            self._ensure_real()
1211
 
            return self._real_repository.abort_write_group(
1212
 
                suppress_errors=suppress_errors)
1213
 
        if not self.is_in_write_group():
1214
 
            if suppress_errors:
1215
 
                mutter('(suppressed) not in write group')
1216
 
                return
1217
 
            raise errors.BzrError("not in write group")
1218
 
        path = self.bzrdir._path_for_remote_call(self._client)
1219
 
        try:
1220
 
            response = self._call('Repository.abort_write_group', path,
1221
 
                self._lock_token, self._write_group_tokens)
1222
 
        except Exception, exc:
1223
 
            self._write_group = None
1224
 
            if not suppress_errors:
1225
 
                raise
1226
 
            mutter('abort_write_group failed')
1227
 
            log_exception_quietly()
1228
 
            note(gettext('bzr: ERROR (ignored): %s'), exc)
1229
 
        else:
1230
 
            if response != ('ok', ):
1231
 
                raise errors.UnexpectedSmartServerResponse(response)
1232
 
            self._write_group_tokens = None
 
727
        self._ensure_real()
 
728
        return self._real_repository.abort_write_group(
 
729
            suppress_errors=suppress_errors)
1233
730
 
1234
731
    @property
1235
732
    def chk_bytes(self):
1249
746
        for older plugins that don't use e.g. the CommitBuilder
1250
747
        facility.
1251
748
        """
1252
 
        if self._real_repository:
1253
 
            self._ensure_real()
1254
 
            return self._real_repository.commit_write_group()
1255
 
        if not self.is_in_write_group():
1256
 
            raise errors.BzrError("not in write group")
1257
 
        path = self.bzrdir._path_for_remote_call(self._client)
1258
 
        response = self._call('Repository.commit_write_group', path,
1259
 
            self._lock_token, self._write_group_tokens)
1260
 
        if response != ('ok', ):
1261
 
            raise errors.UnexpectedSmartServerResponse(response)
1262
 
        self._write_group_tokens = None
1263
 
        # Refresh data after writing to the repository.
1264
 
        self.refresh_data()
 
749
        self._ensure_real()
 
750
        return self._real_repository.commit_write_group()
1265
751
 
1266
752
    def resume_write_group(self, tokens):
1267
 
        if self._real_repository:
1268
 
            return self._real_repository.resume_write_group(tokens)
1269
 
        path = self.bzrdir._path_for_remote_call(self._client)
1270
 
        try:
1271
 
            response = self._call('Repository.check_write_group', path,
1272
 
               self._lock_token, tokens)
1273
 
        except errors.UnknownSmartMethod:
1274
 
            self._ensure_real()
1275
 
            return self._real_repository.resume_write_group(tokens)
1276
 
        if response != ('ok', ):
1277
 
            raise errors.UnexpectedSmartServerResponse(response)
1278
 
        self._write_group_tokens = tokens
 
753
        self._ensure_real()
 
754
        return self._real_repository.resume_write_group(tokens)
1279
755
 
1280
756
    def suspend_write_group(self):
1281
 
        if self._real_repository:
1282
 
            return self._real_repository.suspend_write_group()
1283
 
        ret = self._write_group_tokens or []
1284
 
        self._write_group_tokens = None
1285
 
        return ret
 
757
        self._ensure_real()
 
758
        return self._real_repository.suspend_write_group()
1286
759
 
1287
760
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1288
761
        self._ensure_real()
1349
822
    def find_text_key_references(self):
1350
823
        """Find the text key references within the repository.
1351
824
 
 
825
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
826
        revision_ids. Each altered file-ids has the exact revision_ids that
 
827
        altered it listed explicitly.
1352
828
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1353
829
            to whether they were referred to by the inventory of the
1354
830
            revision_id that they contain. The inventory texts from all present
1372
848
        """Private method for using with old (< 1.2) servers to fallback."""
1373
849
        if revision_id is None:
1374
850
            revision_id = ''
1375
 
        elif _mod_revision.is_null(revision_id):
 
851
        elif revision.is_null(revision_id):
1376
852
            return {}
1377
853
 
1378
854
        path = self.bzrdir._path_for_remote_call(self._client)
1402
878
        return RemoteStreamSource(self, to_format)
1403
879
 
1404
880
    @needs_read_lock
1405
 
    def get_file_graph(self):
1406
 
        return graph.Graph(self.texts)
1407
 
 
1408
 
    @needs_read_lock
1409
881
    def has_revision(self, revision_id):
1410
882
        """True if this repository has a copy of the revision."""
1411
883
        # Copy of bzrlib.repository.Repository.has_revision
1463
935
        """See Repository.gather_stats()."""
1464
936
        path = self.bzrdir._path_for_remote_call(self._client)
1465
937
        # revid can be None to indicate no revisions, not just NULL_REVISION
1466
 
        if revid is None or _mod_revision.is_null(revid):
 
938
        if revid is None or revision.is_null(revid):
1467
939
            fmt_revid = ''
1468
940
        else:
1469
941
            fmt_revid = revid
1498
970
 
1499
971
    def get_physical_lock_status(self):
1500
972
        """See Repository.get_physical_lock_status()."""
1501
 
        path = self.bzrdir._path_for_remote_call(self._client)
1502
 
        try:
1503
 
            response = self._call('Repository.get_physical_lock_status', path)
1504
 
        except errors.UnknownSmartMethod:
1505
 
            self._ensure_real()
1506
 
            return self._real_repository.get_physical_lock_status()
1507
 
        if response[0] not in ('yes', 'no'):
1508
 
            raise errors.UnexpectedSmartServerResponse(response)
1509
 
        return (response[0] == 'yes')
 
973
        # should be an API call to the server.
 
974
        self._ensure_real()
 
975
        return self._real_repository.get_physical_lock_status()
1510
976
 
1511
977
    def is_in_write_group(self):
1512
978
        """Return True if there is an open write group.
1513
979
 
1514
980
        write groups are only applicable locally for the smart server..
1515
981
        """
1516
 
        if self._write_group_tokens is not None:
1517
 
            return True
1518
982
        if self._real_repository:
1519
983
            return self._real_repository.is_in_write_group()
1520
984
 
1655
1119
            self._real_repository.lock_write(self._lock_token)
1656
1120
        elif self._lock_mode == 'r':
1657
1121
            self._real_repository.lock_read()
1658
 
        if self._write_group_tokens is not None:
1659
 
            # if we are already in a write group, resume it
1660
 
            self._real_repository.resume_write_group(self._write_group_tokens)
1661
 
            self._write_group_tokens = None
1662
1122
 
1663
1123
    def start_write_group(self):
1664
1124
        """Start a write group on the decorated repository.
1668
1128
        for older plugins that don't use e.g. the CommitBuilder
1669
1129
        facility.
1670
1130
        """
1671
 
        if self._real_repository:
1672
 
            self._ensure_real()
1673
 
            return self._real_repository.start_write_group()
1674
 
        if not self.is_write_locked():
1675
 
            raise errors.NotWriteLocked(self)
1676
 
        if self._write_group_tokens is not None:
1677
 
            raise errors.BzrError('already in a write group')
1678
 
        path = self.bzrdir._path_for_remote_call(self._client)
1679
 
        try:
1680
 
            response = self._call('Repository.start_write_group', path,
1681
 
                self._lock_token)
1682
 
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
1683
 
            self._ensure_real()
1684
 
            return self._real_repository.start_write_group()
1685
 
        if response[0] != 'ok':
1686
 
            raise errors.UnexpectedSmartServerResponse(response)
1687
 
        self._write_group_tokens = response[1]
 
1131
        self._ensure_real()
 
1132
        return self._real_repository.start_write_group()
1688
1133
 
1689
1134
    def _unlock(self, token):
1690
1135
        path = self.bzrdir._path_for_remote_call(self._client)
1717
1162
            # This is just to let the _real_repository stay up to date.
1718
1163
            if self._real_repository is not None:
1719
1164
                self._real_repository.unlock()
1720
 
            elif self._write_group_tokens is not None:
1721
 
                self.abort_write_group()
1722
1165
        finally:
1723
1166
            # The rpc-level lock should be released even if there was a
1724
1167
            # problem releasing the vfs-based lock.
1736
1179
 
1737
1180
    def break_lock(self):
1738
1181
        # should hand off to the network
1739
 
        path = self.bzrdir._path_for_remote_call(self._client)
1740
 
        try:
1741
 
            response = self._call("Repository.break_lock", path)
1742
 
        except errors.UnknownSmartMethod:
1743
 
            self._ensure_real()
1744
 
            return self._real_repository.break_lock()
1745
 
        if response != ('ok',):
1746
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1182
        self._ensure_real()
 
1183
        return self._real_repository.break_lock()
1747
1184
 
1748
1185
    def _get_tarball(self, compression):
1749
1186
        """Return a TemporaryFile containing a repository tarball.
1767
1204
            return t
1768
1205
        raise errors.UnexpectedSmartServerResponse(response)
1769
1206
 
1770
 
    @needs_read_lock
1771
1207
    def sprout(self, to_bzrdir, revision_id=None):
1772
 
        """Create a descendent repository for new development.
1773
 
 
1774
 
        Unlike clone, this does not copy the settings of the repository.
1775
 
        """
1776
 
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1208
        # TODO: Option to control what format is created?
 
1209
        self._ensure_real()
 
1210
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
1211
                                                             shared=False)
1777
1212
        dest_repo.fetch(self, revision_id=revision_id)
1778
1213
        return dest_repo
1779
1214
 
1780
 
    def _create_sprouting_repo(self, a_bzrdir, shared):
1781
 
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1782
 
            # use target default format.
1783
 
            dest_repo = a_bzrdir.create_repository()
1784
 
        else:
1785
 
            # Most control formats need the repository to be specifically
1786
 
            # created, but on some old all-in-one formats it's not needed
1787
 
            try:
1788
 
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1789
 
            except errors.UninitializableFormat:
1790
 
                dest_repo = a_bzrdir.open_repository()
1791
 
        return dest_repo
1792
 
 
1793
1215
    ### These methods are just thin shims to the VFS object for now.
1794
1216
 
1795
 
    @needs_read_lock
1796
1217
    def revision_tree(self, revision_id):
1797
 
        revision_id = _mod_revision.ensure_null(revision_id)
1798
 
        if revision_id == _mod_revision.NULL_REVISION:
1799
 
            return InventoryRevisionTree(self,
1800
 
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
1801
 
        else:
1802
 
            return list(self.revision_trees([revision_id]))[0]
 
1218
        self._ensure_real()
 
1219
        return self._real_repository.revision_tree(revision_id)
1803
1220
 
1804
1221
    def get_serializer_format(self):
1805
 
        path = self.bzrdir._path_for_remote_call(self._client)
1806
 
        try:
1807
 
            response = self._call('VersionedFileRepository.get_serializer_format',
1808
 
                path)
1809
 
        except errors.UnknownSmartMethod:
1810
 
            self._ensure_real()
1811
 
            return self._real_repository.get_serializer_format()
1812
 
        if response[0] != 'ok':
1813
 
            raise errors.UnexpectedSmartServerResponse(response)
1814
 
        return response[1]
 
1222
        self._ensure_real()
 
1223
        return self._real_repository.get_serializer_format()
1815
1224
 
1816
1225
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1817
1226
                           timezone=None, committer=None, revprops=None,
1818
 
                           revision_id=None, lossy=False):
1819
 
        """Obtain a CommitBuilder for this repository.
1820
 
 
1821
 
        :param branch: Branch to commit to.
1822
 
        :param parents: Revision ids of the parents of the new revision.
1823
 
        :param config: Configuration to use.
1824
 
        :param timestamp: Optional timestamp recorded for commit.
1825
 
        :param timezone: Optional timezone for timestamp.
1826
 
        :param committer: Optional committer to set for commit.
1827
 
        :param revprops: Optional dictionary of revision properties.
1828
 
        :param revision_id: Optional revision id.
1829
 
        :param lossy: Whether to discard data that can not be natively
1830
 
            represented, when pushing to a foreign VCS
1831
 
        """
1832
 
        if self._fallback_repositories and not self._format.supports_chks:
1833
 
            raise errors.BzrError("Cannot commit directly to a stacked branch"
1834
 
                " in pre-2a formats. See "
1835
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1836
 
        if self._format.rich_root_data:
1837
 
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
1838
 
        else:
1839
 
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
1840
 
        result = commit_builder_kls(self, parents, config,
1841
 
            timestamp, timezone, committer, revprops, revision_id,
1842
 
            lossy)
1843
 
        self.start_write_group()
1844
 
        return result
 
1227
                           revision_id=None):
 
1228
        # FIXME: It ought to be possible to call this without immediately
 
1229
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
1230
        self._ensure_real()
 
1231
        real_repo = self._real_repository
 
1232
        builder = real_repo.get_commit_builder(branch, parents,
 
1233
                config, timestamp=timestamp, timezone=timezone,
 
1234
                committer=committer, revprops=revprops, revision_id=revision_id)
 
1235
        return builder
1845
1236
 
1846
1237
    def add_fallback_repository(self, repository):
1847
1238
        """Add a repository to use for looking up data not held locally.
1854
1245
        # We need to accumulate additional repositories here, to pass them in
1855
1246
        # on various RPC's.
1856
1247
        #
1857
 
        # Make the check before we lock: this raises an exception.
1858
 
        self._check_fallback_repository(repository)
1859
1248
        if self.is_locked():
1860
1249
            # We will call fallback.unlock() when we transition to the unlocked
1861
1250
            # state, so always add a lock here. If a caller passes us a locked
1862
1251
            # repository, they are responsible for unlocking it later.
1863
1252
            repository.lock_read()
 
1253
        self._check_fallback_repository(repository)
1864
1254
        self._fallback_repositories.append(repository)
1865
1255
        # If self._real_repository was parameterised already (e.g. because a
1866
1256
        # _real_branch had its get_stacked_on_url method called), then the
1892
1282
            delta, new_revision_id, parents, basis_inv=basis_inv,
1893
1283
            propagate_caches=propagate_caches)
1894
1284
 
1895
 
    def add_revision(self, revision_id, rev, inv=None):
1896
 
        _mod_revision.check_not_reserved_id(revision_id)
1897
 
        key = (revision_id,)
1898
 
        # check inventory present
1899
 
        if not self.inventories.get_parent_map([key]):
1900
 
            if inv is None:
1901
 
                raise errors.WeaveRevisionNotPresent(revision_id,
1902
 
                                                     self.inventories)
1903
 
            else:
1904
 
                # yes, this is not suitable for adding with ghosts.
1905
 
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1906
 
                                                        rev.parent_ids)
1907
 
        else:
1908
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1909
 
        self._add_revision(rev)
1910
 
 
1911
 
    def _add_revision(self, rev):
1912
 
        if self._real_repository is not None:
1913
 
            return self._real_repository._add_revision(rev)
1914
 
        text = self._serializer.write_revision_to_string(rev)
1915
 
        key = (rev.revision_id,)
1916
 
        parents = tuple((parent,) for parent in rev.parent_ids)
1917
 
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
1918
 
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
1919
 
            self._format, self._write_group_tokens)
 
1285
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
1286
        self._ensure_real()
 
1287
        return self._real_repository.add_revision(
 
1288
            rev_id, rev, inv=inv, config=config)
1920
1289
 
1921
1290
    @needs_read_lock
1922
1291
    def get_inventory(self, revision_id):
1923
 
        return list(self.iter_inventories([revision_id]))[0]
1924
 
 
1925
 
    def _iter_inventories_rpc(self, revision_ids, ordering):
1926
 
        if ordering is None:
1927
 
            ordering = 'unordered'
1928
 
        path = self.bzrdir._path_for_remote_call(self._client)
1929
 
        body = "\n".join(revision_ids)
1930
 
        response_tuple, response_handler = (
1931
 
            self._call_with_body_bytes_expecting_body(
1932
 
                "VersionedFileRepository.get_inventories",
1933
 
                (path, ordering), body))
1934
 
        if response_tuple[0] != "ok":
1935
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1936
 
        deserializer = inventory_delta.InventoryDeltaDeserializer()
1937
 
        byte_stream = response_handler.read_streamed_body()
1938
 
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
1939
 
        if decoded is None:
1940
 
            # no results whatsoever
1941
 
            return
1942
 
        src_format, stream = decoded
1943
 
        if src_format.network_name() != self._format.network_name():
1944
 
            raise AssertionError(
1945
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
1946
 
                src_format.network_name(), self._format.network_name()))
1947
 
        # ignore the src format, it's not really relevant
1948
 
        prev_inv = Inventory(root_id=None,
1949
 
            revision_id=_mod_revision.NULL_REVISION)
1950
 
        # there should be just one substream, with inventory deltas
1951
 
        substream_kind, substream = stream.next()
1952
 
        if substream_kind != "inventory-deltas":
1953
 
            raise AssertionError(
1954
 
                 "Unexpected stream %r received" % substream_kind)
1955
 
        for record in substream:
1956
 
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
1957
 
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
1958
 
            if parent_id != prev_inv.revision_id:
1959
 
                raise AssertionError("invalid base %r != %r" % (parent_id,
1960
 
                    prev_inv.revision_id))
1961
 
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
1962
 
            yield inv, inv.revision_id
1963
 
            prev_inv = inv
1964
 
 
1965
 
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1966
1292
        self._ensure_real()
1967
 
        return self._real_repository._iter_inventories(revision_ids, ordering)
 
1293
        return self._real_repository.get_inventory(revision_id)
1968
1294
 
1969
1295
    def iter_inventories(self, revision_ids, ordering=None):
1970
 
        """Get many inventories by revision_ids.
1971
 
 
1972
 
        This will buffer some or all of the texts used in constructing the
1973
 
        inventories in memory, but will only parse a single inventory at a
1974
 
        time.
1975
 
 
1976
 
        :param revision_ids: The expected revision ids of the inventories.
1977
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
1978
 
            specified, the order of revision_ids will be preserved (by
1979
 
            buffering if necessary).
1980
 
        :return: An iterator of inventories.
1981
 
        """
1982
 
        if ((None in revision_ids)
1983
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
1984
 
            raise ValueError('cannot get null revision inventory')
1985
 
        for inv, revid in self._iter_inventories(revision_ids, ordering):
1986
 
            if inv is None:
1987
 
                raise errors.NoSuchRevision(self, revid)
1988
 
            yield inv
1989
 
 
1990
 
    def _iter_inventories(self, revision_ids, ordering=None):
1991
 
        if len(revision_ids) == 0:
1992
 
            return
1993
 
        missing = set(revision_ids)
1994
 
        if ordering is None:
1995
 
            order_as_requested = True
1996
 
            invs = {}
1997
 
            order = list(revision_ids)
1998
 
            order.reverse()
1999
 
            next_revid = order.pop()
2000
 
        else:
2001
 
            order_as_requested = False
2002
 
            if ordering != 'unordered' and self._fallback_repositories:
2003
 
                raise ValueError('unsupported ordering %r' % ordering)
2004
 
        iter_inv_fns = [self._iter_inventories_rpc] + [
2005
 
            fallback._iter_inventories for fallback in
2006
 
            self._fallback_repositories]
2007
 
        try:
2008
 
            for iter_inv in iter_inv_fns:
2009
 
                request = [revid for revid in revision_ids if revid in missing]
2010
 
                for inv, revid in iter_inv(request, ordering):
2011
 
                    if inv is None:
2012
 
                        continue
2013
 
                    missing.remove(inv.revision_id)
2014
 
                    if ordering != 'unordered':
2015
 
                        invs[revid] = inv
2016
 
                    else:
2017
 
                        yield inv, revid
2018
 
                if order_as_requested:
2019
 
                    # Yield as many results as we can while preserving order.
2020
 
                    while next_revid in invs:
2021
 
                        inv = invs.pop(next_revid)
2022
 
                        yield inv, inv.revision_id
2023
 
                        try:
2024
 
                            next_revid = order.pop()
2025
 
                        except IndexError:
2026
 
                            # We still want to fully consume the stream, just
2027
 
                            # in case it is not actually finished at this point
2028
 
                            next_revid = None
2029
 
                            break
2030
 
        except errors.UnknownSmartMethod:
2031
 
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
2032
 
                yield inv, revid
2033
 
            return
2034
 
        # Report missing
2035
 
        if order_as_requested:
2036
 
            if next_revid is not None:
2037
 
                yield None, next_revid
2038
 
            while order:
2039
 
                revid = order.pop()
2040
 
                yield invs.get(revid), revid
2041
 
        else:
2042
 
            while missing:
2043
 
                yield None, missing.pop()
 
1296
        self._ensure_real()
 
1297
        return self._real_repository.iter_inventories(revision_ids, ordering)
2044
1298
 
2045
1299
    @needs_read_lock
2046
1300
    def get_revision(self, revision_id):
2047
 
        return self.get_revisions([revision_id])[0]
 
1301
        self._ensure_real()
 
1302
        return self._real_repository.get_revision(revision_id)
2048
1303
 
2049
1304
    def get_transaction(self):
2050
1305
        self._ensure_real()
2052
1307
 
2053
1308
    @needs_read_lock
2054
1309
    def clone(self, a_bzrdir, revision_id=None):
2055
 
        dest_repo = self._create_sprouting_repo(
2056
 
            a_bzrdir, shared=self.is_shared())
2057
 
        self.copy_content_into(dest_repo, revision_id)
2058
 
        return dest_repo
 
1310
        self._ensure_real()
 
1311
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2059
1312
 
2060
1313
    def make_working_trees(self):
2061
1314
        """See Repository.make_working_trees"""
2062
 
        path = self.bzrdir._path_for_remote_call(self._client)
2063
 
        try:
2064
 
            response = self._call('Repository.make_working_trees', path)
2065
 
        except errors.UnknownSmartMethod:
2066
 
            self._ensure_real()
2067
 
            return self._real_repository.make_working_trees()
2068
 
        if response[0] not in ('yes', 'no'):
2069
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2070
 
        return response[0] == 'yes'
 
1315
        self._ensure_real()
 
1316
        return self._real_repository.make_working_trees()
2071
1317
 
2072
1318
    def refresh_data(self):
2073
1319
        """Re-read any data needed to synchronise with disk.
2082
1328
        """
2083
1329
        if self._real_repository is not None:
2084
1330
            self._real_repository.refresh_data()
2085
 
        # Refresh the parents cache for this object
2086
 
        self._unstacked_provider.disable_cache()
2087
 
        self._unstacked_provider.enable_cache()
2088
1331
 
2089
1332
    def revision_ids_to_search_result(self, result_set):
2090
1333
        """Convert a set of revision ids to a graph SearchResult."""
2095
1338
        included_keys = result_set.intersection(result_parents)
2096
1339
        start_keys = result_set.difference(included_keys)
2097
1340
        exclude_keys = result_parents.difference(result_set)
2098
 
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
1341
        result = graph.SearchResult(start_keys, exclude_keys,
2099
1342
            len(result_set), result_set)
2100
1343
        return result
2101
1344
 
2102
1345
    @needs_read_lock
2103
 
    def search_missing_revision_ids(self, other,
2104
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
2105
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
2106
 
            limit=None):
 
1346
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
2107
1347
        """Return the revision ids that other has that this does not.
2108
1348
 
2109
1349
        These are returned in topological order.
2110
1350
 
2111
1351
        revision_id: only return revision ids included by revision_id.
2112
1352
        """
2113
 
        if symbol_versioning.deprecated_passed(revision_id):
2114
 
            symbol_versioning.warn(
2115
 
                'search_missing_revision_ids(revision_id=...) was '
2116
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
2117
 
                DeprecationWarning, stacklevel=2)
2118
 
            if revision_ids is not None:
2119
 
                raise AssertionError(
2120
 
                    'revision_ids is mutually exclusive with revision_id')
2121
 
            if revision_id is not None:
2122
 
                revision_ids = [revision_id]
2123
 
        inter_repo = _mod_repository.InterRepository.get(other, self)
2124
 
        return inter_repo.search_missing_revision_ids(
2125
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
2126
 
            if_present_ids=if_present_ids, limit=limit)
 
1353
        return repository.InterRepository.get(
 
1354
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
2127
1355
 
2128
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1356
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
2129
1357
            fetch_spec=None):
2130
1358
        # No base implementation to use as RemoteRepository is not a subclass
2131
1359
        # of Repository; so this is a copy of Repository.fetch().
2142
1370
            # check that last_revision is in 'from' and then return a
2143
1371
            # no-operation.
2144
1372
            if (revision_id is not None and
2145
 
                not _mod_revision.is_null(revision_id)):
 
1373
                not revision.is_null(revision_id)):
2146
1374
                self.get_revision(revision_id)
2147
1375
            return 0, []
2148
1376
        # if there is no specific appropriate InterRepository, this will get
2149
1377
        # the InterRepository base class, which raises an
2150
1378
        # IncompatibleRepositories when asked to fetch.
2151
 
        inter = _mod_repository.InterRepository.get(source, self)
2152
 
        if (fetch_spec is not None and
2153
 
            not getattr(inter, "supports_fetch_spec", False)):
2154
 
            raise errors.UnsupportedOperation(
2155
 
                "fetch_spec not supported for %r" % inter)
2156
 
        return inter.fetch(revision_id=revision_id,
 
1379
        inter = repository.InterRepository.get(source, self)
 
1380
        return inter.fetch(revision_id=revision_id, pb=pb,
2157
1381
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
2158
1382
 
2159
1383
    def create_bundle(self, target, base, fileobj, format=None):
2160
1384
        self._ensure_real()
2161
1385
        self._real_repository.create_bundle(target, base, fileobj, format)
2162
1386
 
 
1387
    @needs_read_lock
 
1388
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1389
        self._ensure_real()
 
1390
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
1391
 
2163
1392
    def fileids_altered_by_revision_ids(self, revision_ids):
2164
1393
        self._ensure_real()
2165
1394
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
2169
1398
        return self._real_repository._get_versioned_file_checker(
2170
1399
            revisions, revision_versions_cache)
2171
1400
 
2172
 
    def _iter_files_bytes_rpc(self, desired_files, absent):
2173
 
        path = self.bzrdir._path_for_remote_call(self._client)
2174
 
        lines = []
2175
 
        identifiers = []
2176
 
        for (file_id, revid, identifier) in desired_files:
2177
 
            lines.append("%s\0%s" % (
2178
 
                osutils.safe_file_id(file_id),
2179
 
                osutils.safe_revision_id(revid)))
2180
 
            identifiers.append(identifier)
2181
 
        (response_tuple, response_handler) = (
2182
 
            self._call_with_body_bytes_expecting_body(
2183
 
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
2184
 
        if response_tuple != ('ok', ):
2185
 
            response_handler.cancel_read_body()
2186
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2187
 
        byte_stream = response_handler.read_streamed_body()
2188
 
        def decompress_stream(start, byte_stream, unused):
2189
 
            decompressor = zlib.decompressobj()
2190
 
            yield decompressor.decompress(start)
2191
 
            while decompressor.unused_data == "":
2192
 
                try:
2193
 
                    data = byte_stream.next()
2194
 
                except StopIteration:
2195
 
                    break
2196
 
                yield decompressor.decompress(data)
2197
 
            yield decompressor.flush()
2198
 
            unused.append(decompressor.unused_data)
2199
 
        unused = ""
2200
 
        while True:
2201
 
            while not "\n" in unused:
2202
 
                unused += byte_stream.next()
2203
 
            header, rest = unused.split("\n", 1)
2204
 
            args = header.split("\0")
2205
 
            if args[0] == "absent":
2206
 
                absent[identifiers[int(args[3])]] = (args[1], args[2])
2207
 
                unused = rest
2208
 
                continue
2209
 
            elif args[0] == "ok":
2210
 
                idx = int(args[1])
2211
 
            else:
2212
 
                raise errors.UnexpectedSmartServerResponse(args)
2213
 
            unused_chunks = []
2214
 
            yield (identifiers[idx],
2215
 
                decompress_stream(rest, byte_stream, unused_chunks))
2216
 
            unused = "".join(unused_chunks)
2217
 
 
2218
1401
    def iter_files_bytes(self, desired_files):
2219
1402
        """See Repository.iter_file_bytes.
2220
1403
        """
2221
 
        try:
2222
 
            absent = {}
2223
 
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
2224
 
                    desired_files, absent):
2225
 
                yield identifier, bytes_iterator
2226
 
            for fallback in self._fallback_repositories:
2227
 
                if not absent:
2228
 
                    break
2229
 
                desired_files = [(key[0], key[1], identifier) for
2230
 
                    (identifier, key) in absent.iteritems()]
2231
 
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
2232
 
                    del absent[identifier]
2233
 
                    yield identifier, bytes_iterator
2234
 
            if absent:
2235
 
                # There may be more missing items, but raise an exception
2236
 
                # for just one.
2237
 
                missing_identifier = absent.keys()[0]
2238
 
                missing_key = absent[missing_identifier]
2239
 
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
2240
 
                    file_id=missing_key[0])
2241
 
        except errors.UnknownSmartMethod:
2242
 
            self._ensure_real()
2243
 
            for (identifier, bytes_iterator) in (
2244
 
                self._real_repository.iter_files_bytes(desired_files)):
2245
 
                yield identifier, bytes_iterator
2246
 
 
2247
 
    def get_cached_parent_map(self, revision_ids):
2248
 
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
2249
 
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
 
1404
        self._ensure_real()
 
1405
        return self._real_repository.iter_files_bytes(desired_files)
2250
1406
 
2251
1407
    def get_parent_map(self, revision_ids):
2252
1408
        """See bzrlib.Graph.get_parent_map()."""
2311
1467
        if parents_map is None:
2312
1468
            # Repository is not locked, so there's no cache.
2313
1469
            parents_map = {}
2314
 
        if _DEFAULT_SEARCH_DEPTH <= 0:
2315
 
            (start_set, stop_keys,
2316
 
             key_count) = vf_search.search_result_from_parent_map(
2317
 
                parents_map, self._unstacked_provider.missing_keys)
2318
 
        else:
2319
 
            (start_set, stop_keys,
2320
 
             key_count) = vf_search.limited_search_result_from_parent_map(
2321
 
                parents_map, self._unstacked_provider.missing_keys,
2322
 
                keys, depth=_DEFAULT_SEARCH_DEPTH)
 
1470
        # start_set is all the keys in the cache
 
1471
        start_set = set(parents_map)
 
1472
        # result set is all the references to keys in the cache
 
1473
        result_parents = set()
 
1474
        for parents in parents_map.itervalues():
 
1475
            result_parents.update(parents)
 
1476
        stop_keys = result_parents.difference(start_set)
 
1477
        # We don't need to send ghosts back to the server as a position to
 
1478
        # stop either.
 
1479
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
 
1480
        key_count = len(parents_map)
 
1481
        if (NULL_REVISION in result_parents
 
1482
            and NULL_REVISION in self._unstacked_provider.missing_keys):
 
1483
            # If we pruned NULL_REVISION from the stop_keys because it's also
 
1484
            # in our cache of "missing" keys we need to increment our key count
 
1485
            # by 1, because the reconsitituted SearchResult on the server will
 
1486
            # still consider NULL_REVISION to be an included key.
 
1487
            key_count += 1
 
1488
        included_keys = start_set.intersection(result_parents)
 
1489
        start_set.difference_update(included_keys)
2323
1490
        recipe = ('manual', start_set, stop_keys, key_count)
2324
1491
        body = self._serialise_search_recipe(recipe)
2325
1492
        path = self.bzrdir._path_for_remote_call(self._client)
2374
1541
 
2375
1542
    @needs_read_lock
2376
1543
    def get_signature_text(self, revision_id):
2377
 
        path = self.bzrdir._path_for_remote_call(self._client)
2378
 
        try:
2379
 
            response_tuple, response_handler = self._call_expecting_body(
2380
 
                'Repository.get_revision_signature_text', path, revision_id)
2381
 
        except errors.UnknownSmartMethod:
2382
 
            self._ensure_real()
2383
 
            return self._real_repository.get_signature_text(revision_id)
2384
 
        except errors.NoSuchRevision, err:
2385
 
            for fallback in self._fallback_repositories:
2386
 
                try:
2387
 
                    return fallback.get_signature_text(revision_id)
2388
 
                except errors.NoSuchRevision:
2389
 
                    pass
2390
 
            raise err
2391
 
        else:
2392
 
            if response_tuple[0] != 'ok':
2393
 
                raise errors.UnexpectedSmartServerResponse(response_tuple)
2394
 
            return response_handler.read_body_bytes()
 
1544
        self._ensure_real()
 
1545
        return self._real_repository.get_signature_text(revision_id)
2395
1546
 
2396
1547
    @needs_read_lock
2397
1548
    def _get_inventory_xml(self, revision_id):
2398
 
        # This call is used by older working tree formats,
2399
 
        # which stored a serialized basis inventory.
2400
1549
        self._ensure_real()
2401
1550
        return self._real_repository._get_inventory_xml(revision_id)
2402
1551
 
2403
 
    @needs_write_lock
2404
1552
    def reconcile(self, other=None, thorough=False):
2405
 
        from bzrlib.reconcile import RepoReconciler
2406
 
        path = self.bzrdir._path_for_remote_call(self._client)
2407
 
        try:
2408
 
            response, handler = self._call_expecting_body(
2409
 
                'Repository.reconcile', path, self._lock_token)
2410
 
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
2411
 
            self._ensure_real()
2412
 
            return self._real_repository.reconcile(other=other, thorough=thorough)
2413
 
        if response != ('ok', ):
2414
 
            raise errors.UnexpectedSmartServerResponse(response)
2415
 
        body = handler.read_body_bytes()
2416
 
        result = RepoReconciler(self)
2417
 
        for line in body.split('\n'):
2418
 
            if not line:
2419
 
                continue
2420
 
            key, val_text = line.split(':')
2421
 
            if key == "garbage_inventories":
2422
 
                result.garbage_inventories = int(val_text)
2423
 
            elif key == "inconsistent_parents":
2424
 
                result.inconsistent_parents = int(val_text)
2425
 
            else:
2426
 
                mutter("unknown reconcile key %r" % key)
2427
 
        return result
 
1553
        self._ensure_real()
 
1554
        return self._real_repository.reconcile(other=other, thorough=thorough)
2428
1555
 
2429
1556
    def all_revision_ids(self):
2430
 
        path = self.bzrdir._path_for_remote_call(self._client)
2431
 
        try:
2432
 
            response_tuple, response_handler = self._call_expecting_body(
2433
 
                "Repository.all_revision_ids", path)
2434
 
        except errors.UnknownSmartMethod:
2435
 
            self._ensure_real()
2436
 
            return self._real_repository.all_revision_ids()
2437
 
        if response_tuple != ("ok", ):
2438
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2439
 
        revids = set(response_handler.read_body_bytes().splitlines())
2440
 
        for fallback in self._fallback_repositories:
2441
 
            revids.update(set(fallback.all_revision_ids()))
2442
 
        return list(revids)
2443
 
 
2444
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2445
 
        """Return Tree for a revision on this branch with only some files.
2446
 
 
2447
 
        :param revision_ids: a sequence of revision-ids;
2448
 
          a revision-id may not be None or 'null:'
2449
 
        :param file_ids: if not None, the result is filtered
2450
 
          so that only those file-ids, their parents and their
2451
 
          children are included.
2452
 
        """
2453
 
        inventories = self.iter_inventories(revision_ids)
2454
 
        for inv in inventories:
2455
 
            # Should we introduce a FilteredRevisionTree class rather
2456
 
            # than pre-filter the inventory here?
2457
 
            filtered_inv = inv.filter(file_ids)
2458
 
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
1557
        self._ensure_real()
 
1558
        return self._real_repository.all_revision_ids()
2459
1559
 
2460
1560
    @needs_read_lock
2461
1561
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
2462
 
        medium = self._client._medium
2463
 
        if medium._is_remote_before((1, 2)):
2464
 
            self._ensure_real()
2465
 
            for delta in self._real_repository.get_deltas_for_revisions(
2466
 
                    revisions, specific_fileids):
2467
 
                yield delta
2468
 
            return
2469
 
        # Get the revision-ids of interest
2470
 
        required_trees = set()
2471
 
        for revision in revisions:
2472
 
            required_trees.add(revision.revision_id)
2473
 
            required_trees.update(revision.parent_ids[:1])
2474
 
 
2475
 
        # Get the matching filtered trees. Note that it's more
2476
 
        # efficient to pass filtered trees to changes_from() rather
2477
 
        # than doing the filtering afterwards. changes_from() could
2478
 
        # arguably do the filtering itself but it's path-based, not
2479
 
        # file-id based, so filtering before or afterwards is
2480
 
        # currently easier.
2481
 
        if specific_fileids is None:
2482
 
            trees = dict((t.get_revision_id(), t) for
2483
 
                t in self.revision_trees(required_trees))
2484
 
        else:
2485
 
            trees = dict((t.get_revision_id(), t) for
2486
 
                t in self._filtered_revision_trees(required_trees,
2487
 
                specific_fileids))
2488
 
 
2489
 
        # Calculate the deltas
2490
 
        for revision in revisions:
2491
 
            if not revision.parent_ids:
2492
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
2493
 
            else:
2494
 
                old_tree = trees[revision.parent_ids[0]]
2495
 
            yield trees[revision.revision_id].changes_from(old_tree)
 
1562
        self._ensure_real()
 
1563
        return self._real_repository.get_deltas_for_revisions(revisions,
 
1564
            specific_fileids=specific_fileids)
2496
1565
 
2497
1566
    @needs_read_lock
2498
1567
    def get_revision_delta(self, revision_id, specific_fileids=None):
2499
 
        r = self.get_revision(revision_id)
2500
 
        return list(self.get_deltas_for_revisions([r],
2501
 
            specific_fileids=specific_fileids))[0]
 
1568
        self._ensure_real()
 
1569
        return self._real_repository.get_revision_delta(revision_id,
 
1570
            specific_fileids=specific_fileids)
2502
1571
 
2503
1572
    @needs_read_lock
2504
1573
    def revision_trees(self, revision_ids):
2505
 
        inventories = self.iter_inventories(revision_ids)
2506
 
        for inv in inventories:
2507
 
            yield InventoryRevisionTree(self, inv, inv.revision_id)
 
1574
        self._ensure_real()
 
1575
        return self._real_repository.revision_trees(revision_ids)
2508
1576
 
2509
1577
    @needs_read_lock
2510
1578
    def get_revision_reconcile(self, revision_id):
2518
1586
            callback_refs=callback_refs, check_repo=check_repo)
2519
1587
 
2520
1588
    def copy_content_into(self, destination, revision_id=None):
2521
 
        """Make a complete copy of the content in self into destination.
2522
 
 
2523
 
        This is a destructive operation! Do not use it on existing
2524
 
        repositories.
2525
 
        """
2526
 
        interrepo = _mod_repository.InterRepository.get(self, destination)
2527
 
        return interrepo.copy_content(revision_id)
 
1589
        self._ensure_real()
 
1590
        return self._real_repository.copy_content_into(
 
1591
            destination, revision_id=revision_id)
2528
1592
 
2529
1593
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
2530
1594
        # get a tarball of the remote repository, and copy from that into the
2531
1595
        # destination
 
1596
        from bzrlib import osutils
2532
1597
        import tarfile
2533
1598
        # TODO: Maybe a progress bar while streaming the tarball?
2534
 
        note(gettext("Copying repository content as tarball..."))
 
1599
        note("Copying repository content as tarball...")
2535
1600
        tar_file = self._get_tarball('bz2')
2536
1601
        if tar_file is None:
2537
1602
            return None
2542
1607
            tmpdir = osutils.mkdtemp()
2543
1608
            try:
2544
1609
                _extract_tar(tar, tmpdir)
2545
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1610
                tmp_bzrdir = BzrDir.open(tmpdir)
2546
1611
                tmp_repo = tmp_bzrdir.open_repository()
2547
1612
                tmp_repo.copy_content_into(destination, revision_id)
2548
1613
            finally:
2566
1631
    @needs_write_lock
2567
1632
    def pack(self, hint=None, clean_obsolete_packs=False):
2568
1633
        """Compress the data within the repository.
 
1634
 
 
1635
        This is not currently implemented within the smart server.
2569
1636
        """
2570
 
        if hint is None:
2571
 
            body = ""
2572
 
        else:
2573
 
            body = "".join([l+"\n" for l in hint])
2574
 
        path = self.bzrdir._path_for_remote_call(self._client)
2575
 
        try:
2576
 
            response, handler = self._call_with_body_bytes_expecting_body(
2577
 
                'Repository.pack', (path, self._lock_token,
2578
 
                    str(clean_obsolete_packs)), body)
2579
 
        except errors.UnknownSmartMethod:
2580
 
            self._ensure_real()
2581
 
            return self._real_repository.pack(hint=hint,
2582
 
                clean_obsolete_packs=clean_obsolete_packs)
2583
 
        handler.cancel_read_body()
2584
 
        if response != ('ok', ):
2585
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1637
        self._ensure_real()
 
1638
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2586
1639
 
2587
1640
    @property
2588
1641
    def revisions(self):
2589
1642
        """Decorate the real repository for now.
2590
1643
 
 
1644
        In the short term this should become a real object to intercept graph
 
1645
        lookups.
 
1646
 
2591
1647
        In the long term a full blown network facility is needed.
2592
1648
        """
2593
1649
        self._ensure_real()
2621
1677
 
2622
1678
    @needs_write_lock
2623
1679
    def sign_revision(self, revision_id, gpg_strategy):
2624
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2625
 
        plaintext = testament.as_short_text()
2626
 
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1680
        self._ensure_real()
 
1681
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
2627
1682
 
2628
1683
    @property
2629
1684
    def texts(self):
2635
1690
        self._ensure_real()
2636
1691
        return self._real_repository.texts
2637
1692
 
2638
 
    def _iter_revisions_rpc(self, revision_ids):
2639
 
        body = "\n".join(revision_ids)
2640
 
        path = self.bzrdir._path_for_remote_call(self._client)
2641
 
        response_tuple, response_handler = (
2642
 
            self._call_with_body_bytes_expecting_body(
2643
 
            "Repository.iter_revisions", (path, ), body))
2644
 
        if response_tuple[0] != "ok":
2645
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2646
 
        serializer_format = response_tuple[1]
2647
 
        serializer = serializer_format_registry.get(serializer_format)
2648
 
        byte_stream = response_handler.read_streamed_body()
2649
 
        decompressor = zlib.decompressobj()
2650
 
        chunks = []
2651
 
        for bytes in byte_stream:
2652
 
            chunks.append(decompressor.decompress(bytes))
2653
 
            if decompressor.unused_data != "":
2654
 
                chunks.append(decompressor.flush())
2655
 
                yield serializer.read_revision_from_string("".join(chunks))
2656
 
                unused = decompressor.unused_data
2657
 
                decompressor = zlib.decompressobj()
2658
 
                chunks = [decompressor.decompress(unused)]
2659
 
        chunks.append(decompressor.flush())
2660
 
        text = "".join(chunks)
2661
 
        if text != "":
2662
 
            yield serializer.read_revision_from_string("".join(chunks))
2663
 
 
2664
1693
    @needs_read_lock
2665
1694
    def get_revisions(self, revision_ids):
2666
 
        if revision_ids is None:
2667
 
            revision_ids = self.all_revision_ids()
2668
 
        else:
2669
 
            for rev_id in revision_ids:
2670
 
                if not rev_id or not isinstance(rev_id, basestring):
2671
 
                    raise errors.InvalidRevisionId(
2672
 
                        revision_id=rev_id, branch=self)
2673
 
        try:
2674
 
            missing = set(revision_ids)
2675
 
            revs = {}
2676
 
            for rev in self._iter_revisions_rpc(revision_ids):
2677
 
                missing.remove(rev.revision_id)
2678
 
                revs[rev.revision_id] = rev
2679
 
        except errors.UnknownSmartMethod:
2680
 
            self._ensure_real()
2681
 
            return self._real_repository.get_revisions(revision_ids)
2682
 
        for fallback in self._fallback_repositories:
2683
 
            if not missing:
2684
 
                break
2685
 
            for revid in list(missing):
2686
 
                # XXX JRV 2011-11-20: It would be nice if there was a
2687
 
                # public method on Repository that could be used to query
2688
 
                # for revision objects *without* failing completely if one
2689
 
                # was missing. There is VersionedFileRepository._iter_revisions,
2690
 
                # but unfortunately that's private and not provided by
2691
 
                # all repository implementations.
2692
 
                try:
2693
 
                    revs[revid] = fallback.get_revision(revid)
2694
 
                except errors.NoSuchRevision:
2695
 
                    pass
2696
 
                else:
2697
 
                    missing.remove(revid)
2698
 
        if missing:
2699
 
            raise errors.NoSuchRevision(self, list(missing)[0])
2700
 
        return [revs[revid] for revid in revision_ids]
 
1695
        self._ensure_real()
 
1696
        return self._real_repository.get_revisions(revision_ids)
2701
1697
 
2702
1698
    def supports_rich_root(self):
2703
1699
        return self._format.rich_root_data
2704
1700
 
 
1701
    def iter_reverse_revision_history(self, revision_id):
 
1702
        self._ensure_real()
 
1703
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
1704
 
2705
1705
    @property
2706
1706
    def _serializer(self):
2707
1707
        return self._format._serializer
2708
1708
 
2709
 
    @needs_write_lock
2710
1709
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2711
 
        signature = gpg_strategy.sign(plaintext)
2712
 
        self.add_signature_text(revision_id, signature)
 
1710
        self._ensure_real()
 
1711
        return self._real_repository.store_revision_signature(
 
1712
            gpg_strategy, plaintext, revision_id)
2713
1713
 
2714
1714
    def add_signature_text(self, revision_id, signature):
2715
 
        if self._real_repository:
2716
 
            # If there is a real repository the write group will
2717
 
            # be in the real repository as well, so use that:
2718
 
            self._ensure_real()
2719
 
            return self._real_repository.add_signature_text(
2720
 
                revision_id, signature)
2721
 
        path = self.bzrdir._path_for_remote_call(self._client)
2722
 
        response, handler = self._call_with_body_bytes_expecting_body(
2723
 
            'Repository.add_signature_text', (path, self._lock_token,
2724
 
                revision_id) + tuple(self._write_group_tokens), signature)
2725
 
        handler.cancel_read_body()
2726
 
        self.refresh_data()
2727
 
        if response[0] != 'ok':
2728
 
            raise errors.UnexpectedSmartServerResponse(response)
2729
 
        self._write_group_tokens = response[1:]
 
1715
        self._ensure_real()
 
1716
        return self._real_repository.add_signature_text(revision_id, signature)
2730
1717
 
2731
1718
    def has_signature_for_revision_id(self, revision_id):
2732
 
        path = self.bzrdir._path_for_remote_call(self._client)
2733
 
        try:
2734
 
            response = self._call('Repository.has_signature_for_revision_id',
2735
 
                path, revision_id)
2736
 
        except errors.UnknownSmartMethod:
2737
 
            self._ensure_real()
2738
 
            return self._real_repository.has_signature_for_revision_id(
2739
 
                revision_id)
2740
 
        if response[0] not in ('yes', 'no'):
2741
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2742
 
        if response[0] == 'yes':
2743
 
            return True
2744
 
        for fallback in self._fallback_repositories:
2745
 
            if fallback.has_signature_for_revision_id(revision_id):
2746
 
                return True
2747
 
        return False
2748
 
 
2749
 
    @needs_read_lock
2750
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
2751
 
        if not self.has_signature_for_revision_id(revision_id):
2752
 
            return gpg.SIGNATURE_NOT_SIGNED, None
2753
 
        signature = self.get_signature_text(revision_id)
2754
 
 
2755
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2756
 
        plaintext = testament.as_short_text()
2757
 
 
2758
 
        return gpg_strategy.verify(signature, plaintext)
 
1719
        self._ensure_real()
 
1720
        return self._real_repository.has_signature_for_revision_id(revision_id)
2759
1721
 
2760
1722
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2761
1723
        self._ensure_real()
2762
1724
        return self._real_repository.item_keys_introduced_by(revision_ids,
2763
1725
            _files_pb=_files_pb)
2764
1726
 
 
1727
    def revision_graph_can_have_wrong_parents(self):
 
1728
        # The answer depends on the remote repo format.
 
1729
        self._ensure_real()
 
1730
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1731
 
2765
1732
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2766
1733
        self._ensure_real()
2767
1734
        return self._real_repository._find_inconsistent_revision_parents(
2775
1742
        providers = [self._unstacked_provider]
2776
1743
        if other is not None:
2777
1744
            providers.insert(0, other)
2778
 
        return graph.StackedParentsProvider(_LazyListJoin(
2779
 
            providers, self._fallback_repositories))
 
1745
        providers.extend(r._make_parents_provider() for r in
 
1746
                         self._fallback_repositories)
 
1747
        return graph.StackedParentsProvider(providers)
2780
1748
 
2781
1749
    def _serialise_search_recipe(self, recipe):
2782
1750
        """Serialise a graph search recipe.
2790
1758
        return '\n'.join((start_keys, stop_keys, count))
2791
1759
 
2792
1760
    def _serialise_search_result(self, search_result):
2793
 
        parts = search_result.get_network_struct()
 
1761
        if isinstance(search_result, graph.PendingAncestryResult):
 
1762
            parts = ['ancestry-of']
 
1763
            parts.extend(search_result.heads)
 
1764
        else:
 
1765
            recipe = search_result.get_recipe()
 
1766
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
2794
1767
        return '\n'.join(parts)
2795
1768
 
2796
1769
    def autopack(self):
2806
1779
            raise errors.UnexpectedSmartServerResponse(response)
2807
1780
 
2808
1781
 
2809
 
class RemoteStreamSink(vf_repository.StreamSink):
 
1782
class RemoteStreamSink(repository.StreamSink):
2810
1783
 
2811
1784
    def _insert_real(self, stream, src_format, resume_tokens):
2812
1785
        self.target_repo._ensure_real()
2913
1886
        self._last_substream and self._last_stream so that the stream can be
2914
1887
        resumed by _resume_stream_with_vfs.
2915
1888
        """
2916
 
 
 
1889
                    
2917
1890
        stream_iter = iter(stream)
2918
1891
        for substream_kind, substream in stream_iter:
2919
1892
            if substream_kind == 'inventory-deltas':
2922
1895
                return
2923
1896
            else:
2924
1897
                yield substream_kind, substream
2925
 
 
2926
 
 
2927
 
class RemoteStreamSource(vf_repository.StreamSource):
 
1898
            
 
1899
 
 
1900
class RemoteStreamSource(repository.StreamSource):
2928
1901
    """Stream data from a remote server."""
2929
1902
 
2930
1903
    def get_stream(self, search):
2951
1924
 
2952
1925
    def _real_stream(self, repo, search):
2953
1926
        """Get a stream for search from repo.
2954
 
 
2955
 
        This never called RemoteStreamSource.get_stream, and is a helper
2956
 
        for RemoteStreamSource._get_stream to allow getting a stream
 
1927
        
 
1928
        This never called RemoteStreamSource.get_stream, and is a heler
 
1929
        for RemoteStreamSource._get_stream to allow getting a stream 
2957
1930
        reliably whether fallback back because of old servers or trying
2958
1931
        to stream from a non-RemoteRepository (which the stacked support
2959
1932
        code will do).
2990
1963
        candidate_verbs = [
2991
1964
            ('Repository.get_stream_1.19', (1, 19)),
2992
1965
            ('Repository.get_stream', (1, 13))]
2993
 
 
2994
1966
        found_verb = False
2995
1967
        for verb, version in candidate_verbs:
2996
1968
            if medium._is_remote_before(version):
3000
1972
                    verb, args, search_bytes)
3001
1973
            except errors.UnknownSmartMethod:
3002
1974
                medium._remember_remote_is_before(version)
3003
 
            except errors.UnknownErrorFromSmartServer, e:
3004
 
                if isinstance(search, vf_search.EverythingResult):
3005
 
                    error_verb = e.error_from_smart_server.error_verb
3006
 
                    if error_verb == 'BadSearch':
3007
 
                        # Pre-2.4 servers don't support this sort of search.
3008
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
3009
 
                        # good idea in general?  It might provide a little bit
3010
 
                        # of protection against client-side bugs.
3011
 
                        medium._remember_remote_is_before((2, 4))
3012
 
                        break
3013
 
                raise
3014
1975
            else:
3015
1976
                response_tuple, response_handler = response
3016
1977
                found_verb = True
3099
2060
 
3100
2061
    def _ensure_real(self):
3101
2062
        if self._custom_format is None:
3102
 
            try:
3103
 
                self._custom_format = branch.network_format_registry.get(
3104
 
                    self._network_name)
3105
 
            except KeyError:
3106
 
                raise errors.UnknownFormatError(kind='branch',
3107
 
                    format=self._network_name)
 
2063
            self._custom_format = branch.network_format_registry.get(
 
2064
                self._network_name)
3108
2065
 
3109
2066
    def get_format_description(self):
3110
2067
        self._ensure_real()
3117
2074
        return a_bzrdir.open_branch(name=name, 
3118
2075
            ignore_fallbacks=ignore_fallbacks)
3119
2076
 
3120
 
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only,
3121
 
                        repository=None):
 
2077
    def _vfs_initialize(self, a_bzrdir, name):
3122
2078
        # Initialisation when using a local bzrdir object, or a non-vfs init
3123
2079
        # method is not available on the server.
3124
2080
        # self._custom_format is always set - the start of initialize ensures
3126
2082
        if isinstance(a_bzrdir, RemoteBzrDir):
3127
2083
            a_bzrdir._ensure_real()
3128
2084
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
3129
 
                name=name, append_revisions_only=append_revisions_only,
3130
 
                repository=repository)
 
2085
                name)
3131
2086
        else:
3132
2087
            # We assume the bzrdir is parameterised; it may not be.
3133
 
            result = self._custom_format.initialize(a_bzrdir, name=name,
3134
 
                append_revisions_only=append_revisions_only,
3135
 
                repository=repository)
 
2088
            result = self._custom_format.initialize(a_bzrdir, name)
3136
2089
        if (isinstance(a_bzrdir, RemoteBzrDir) and
3137
2090
            not isinstance(result, RemoteBranch)):
3138
2091
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
3139
2092
                                  name=name)
3140
2093
        return result
3141
2094
 
3142
 
    def initialize(self, a_bzrdir, name=None, repository=None,
3143
 
                   append_revisions_only=None):
3144
 
        if name is None:
3145
 
            name = a_bzrdir._get_selected_branch()
 
2095
    def initialize(self, a_bzrdir, name=None):
3146
2096
        # 1) get the network name to use.
3147
2097
        if self._custom_format:
3148
2098
            network_name = self._custom_format.network_name()
3149
2099
        else:
3150
2100
            # Select the current bzrlib default and ask for that.
3151
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
2101
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
3152
2102
            reference_format = reference_bzrdir_format.get_branch_format()
3153
2103
            self._custom_format = reference_format
3154
2104
            network_name = reference_format.network_name()
3155
2105
        # Being asked to create on a non RemoteBzrDir:
3156
2106
        if not isinstance(a_bzrdir, RemoteBzrDir):
3157
 
            return self._vfs_initialize(a_bzrdir, name=name,
3158
 
                append_revisions_only=append_revisions_only,
3159
 
                repository=repository)
 
2107
            return self._vfs_initialize(a_bzrdir, name=name)
3160
2108
        medium = a_bzrdir._client._medium
3161
2109
        if medium._is_remote_before((1, 13)):
3162
 
            return self._vfs_initialize(a_bzrdir, name=name,
3163
 
                append_revisions_only=append_revisions_only,
3164
 
                repository=repository)
 
2110
            return self._vfs_initialize(a_bzrdir, name=name)
3165
2111
        # Creating on a remote bzr dir.
3166
2112
        # 2) try direct creation via RPC
3167
2113
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
3168
 
        if name != "":
 
2114
        if name is not None:
3169
2115
            # XXX JRV20100304: Support creating colocated branches
3170
2116
            raise errors.NoColocatedBranchSupport(self)
3171
2117
        verb = 'BzrDir.create_branch'
3174
2120
        except errors.UnknownSmartMethod:
3175
2121
            # Fallback - use vfs methods
3176
2122
            medium._remember_remote_is_before((1, 13))
3177
 
            return self._vfs_initialize(a_bzrdir, name=name,
3178
 
                    append_revisions_only=append_revisions_only,
3179
 
                    repository=repository)
 
2123
            return self._vfs_initialize(a_bzrdir, name=name)
3180
2124
        if response[0] != 'ok':
3181
2125
            raise errors.UnexpectedSmartServerResponse(response)
3182
2126
        # Turn the response into a RemoteRepository object.
3183
2127
        format = RemoteBranchFormat(network_name=response[1])
3184
2128
        repo_format = response_tuple_to_repo_format(response[3:])
3185
 
        repo_path = response[2]
3186
 
        if repository is not None:
3187
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
3188
 
            url_diff = urlutils.relative_url(repository.user_url,
3189
 
                    remote_repo_url)
3190
 
            if url_diff != '.':
3191
 
                raise AssertionError(
3192
 
                    'repository.user_url %r does not match URL from server '
3193
 
                    'response (%r + %r)'
3194
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
3195
 
            remote_repo = repository
 
2129
        if response[2] == '':
 
2130
            repo_bzrdir = a_bzrdir
3196
2131
        else:
3197
 
            if repo_path == '':
3198
 
                repo_bzrdir = a_bzrdir
3199
 
            else:
3200
 
                repo_bzrdir = RemoteBzrDir(
3201
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
3202
 
                    a_bzrdir._client)
3203
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2132
            repo_bzrdir = RemoteBzrDir(
 
2133
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
2134
                a_bzrdir._client)
 
2135
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
3204
2136
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
3205
2137
            format=format, setup_stacking=False, name=name)
3206
 
        if append_revisions_only:
3207
 
            remote_branch.set_append_revisions_only(append_revisions_only)
3208
2138
        # XXX: We know this is a new branch, so it must have revno 0, revid
3209
2139
        # NULL_REVISION. Creating the branch locked would make this be unable
3210
2140
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
3229
2159
        self._ensure_real()
3230
2160
        return self._custom_format.supports_set_append_revisions_only()
3231
2161
 
3232
 
    def _use_default_local_heads_to_fetch(self):
3233
 
        # If the branch format is a metadir format *and* its heads_to_fetch
3234
 
        # implementation is not overridden vs the base class, we can use the
3235
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
3236
 
        # usually cheaper in terms of net round trips, as the last-revision and
3237
 
        # tags info fetched is cached and would be fetched anyway.
3238
 
        self._ensure_real()
3239
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
3240
 
            branch_class = self._custom_format._branch_class()
3241
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
3242
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
3243
 
                return True
3244
 
        return False
3245
 
 
3246
 
 
3247
 
class RemoteBranchStore(_mod_config.IniFileStore):
3248
 
    """Branch store which attempts to use HPSS calls to retrieve branch store.
3249
 
 
3250
 
    Note that this is specific to bzr-based formats.
3251
 
    """
3252
 
 
3253
 
    def __init__(self, branch):
3254
 
        super(RemoteBranchStore, self).__init__()
3255
 
        self.branch = branch
3256
 
        self.id = "branch"
3257
 
        self._real_store = None
3258
 
 
3259
 
    def external_url(self):
3260
 
        return urlutils.join(self.branch.user_url, 'branch.conf')
3261
 
 
3262
 
    def _load_content(self):
3263
 
        path = self.branch._remote_path()
3264
 
        try:
3265
 
            response, handler = self.branch._call_expecting_body(
3266
 
                'Branch.get_config_file', path)
3267
 
        except errors.UnknownSmartMethod:
3268
 
            self._ensure_real()
3269
 
            return self._real_store._load_content()
3270
 
        if len(response) and response[0] != 'ok':
3271
 
            raise errors.UnexpectedSmartServerResponse(response)
3272
 
        return handler.read_body_bytes()
3273
 
 
3274
 
    def _save_content(self, content):
3275
 
        path = self.branch._remote_path()
3276
 
        try:
3277
 
            response, handler = self.branch._call_with_body_bytes_expecting_body(
3278
 
                'Branch.put_config_file', (path,
3279
 
                    self.branch._lock_token, self.branch._repo_lock_token),
3280
 
                content)
3281
 
        except errors.UnknownSmartMethod:
3282
 
            self._ensure_real()
3283
 
            return self._real_store._save_content(content)
3284
 
        handler.cancel_read_body()
3285
 
        if response != ('ok', ):
3286
 
            raise errors.UnexpectedSmartServerResponse(response)
3287
 
 
3288
 
    def _ensure_real(self):
3289
 
        self.branch._ensure_real()
3290
 
        if self._real_store is None:
3291
 
            self._real_store = _mod_config.BranchStore(self.branch)
3292
 
 
3293
2162
 
3294
2163
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
3295
2164
    """Branch stored on a server accessed by HPSS RPC.
3298
2167
    """
3299
2168
 
3300
2169
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
3301
 
        _client=None, format=None, setup_stacking=True, name=None,
3302
 
        possible_transports=None):
 
2170
        _client=None, format=None, setup_stacking=True, name=None):
3303
2171
        """Create a RemoteBranch instance.
3304
2172
 
3305
2173
        :param real_branch: An optional local implementation of the branch
3317
2185
        # will try to assign to self.tags, which is a property in this subclass.
3318
2186
        # And the parent's __init__ doesn't do much anyway.
3319
2187
        self.bzrdir = remote_bzrdir
3320
 
        self.name = name
3321
2188
        if _client is not None:
3322
2189
            self._client = _client
3323
2190
        else:
3346
2213
        self._repo_lock_token = None
3347
2214
        self._lock_count = 0
3348
2215
        self._leave_lock = False
3349
 
        self.conf_store = None
3350
2216
        # Setup a format: note that we cannot call _ensure_real until all the
3351
2217
        # attributes above are set: This code cannot be moved higher up in this
3352
2218
        # function.
3372
2238
            hook(self)
3373
2239
        self._is_stacked = False
3374
2240
        if setup_stacking:
3375
 
            self._setup_stacking(possible_transports)
 
2241
            self._setup_stacking()
3376
2242
 
3377
 
    def _setup_stacking(self, possible_transports):
 
2243
    def _setup_stacking(self):
3378
2244
        # configure stacking into the remote repository, by reading it from
3379
2245
        # the vfs branch.
3380
2246
        try:
3383
2249
            errors.UnstackableRepositoryFormat), e:
3384
2250
            return
3385
2251
        self._is_stacked = True
3386
 
        if possible_transports is None:
3387
 
            possible_transports = []
3388
 
        else:
3389
 
            possible_transports = list(possible_transports)
3390
 
        possible_transports.append(self.bzrdir.root_transport)
3391
 
        self._activate_fallback_location(fallback_url,
3392
 
            possible_transports=possible_transports)
 
2252
        self._activate_fallback_location(fallback_url)
3393
2253
 
3394
2254
    def _get_config(self):
3395
2255
        return RemoteBranchConfig(self)
3396
2256
 
3397
 
    def _get_config_store(self):
3398
 
        if self.conf_store is None:
3399
 
            self.conf_store =  RemoteBranchStore(self)
3400
 
        return self.conf_store
3401
 
 
3402
 
    def store_uncommitted(self, creator):
3403
 
        self._ensure_real()
3404
 
        return self._real_branch.store_uncommitted(creator)
3405
 
 
3406
 
    def get_unshelver(self, tree):
3407
 
        self._ensure_real()
3408
 
        return self._real_branch.get_unshelver(tree)
3409
 
 
3410
2257
    def _get_real_transport(self):
3411
2258
        # if we try vfs access, return the real branch's vfs transport
3412
2259
        self._ensure_real()
3431
2278
            self.bzrdir._ensure_real()
3432
2279
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
3433
2280
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
3434
 
            # The remote branch and the real branch shares the same store. If
3435
 
            # we don't, there will always be cases where one of the stores
3436
 
            # doesn't see an update made on the other.
3437
 
            self._real_branch.conf_store = self.conf_store
3438
2281
            if self.repository._real_repository is None:
3439
2282
                # Give the remote repository the matching real repo.
3440
2283
                real_repo = self._real_branch.repository
3479
2322
                self.bzrdir, self._client)
3480
2323
        return self._control_files
3481
2324
 
 
2325
    def _get_checkout_format(self):
 
2326
        self._ensure_real()
 
2327
        return self._real_branch._get_checkout_format()
 
2328
 
3482
2329
    def get_physical_lock_status(self):
3483
2330
        """See Branch.get_physical_lock_status()."""
3484
 
        try:
3485
 
            response = self._client.call('Branch.get_physical_lock_status',
3486
 
                self._remote_path())
3487
 
        except errors.UnknownSmartMethod:
3488
 
            self._ensure_real()
3489
 
            return self._real_branch.get_physical_lock_status()
3490
 
        if response[0] not in ('yes', 'no'):
3491
 
            raise errors.UnexpectedSmartServerResponse(response)
3492
 
        return (response[0] == 'yes')
 
2331
        # should be an API call to the server, as branches must be lockable.
 
2332
        self._ensure_real()
 
2333
        return self._real_branch.get_physical_lock_status()
3493
2334
 
3494
2335
    def get_stacked_on_url(self):
3495
2336
        """Get the URL this branch is stacked against.
3518
2359
 
3519
2360
    def set_stacked_on_url(self, url):
3520
2361
        branch.Branch.set_stacked_on_url(self, url)
3521
 
        # We need the stacked_on_url to be visible both locally (to not query
3522
 
        # it repeatedly) and remotely (so smart verbs can get it server side)
3523
 
        # Without the following line,
3524
 
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
3525
 
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
3526
 
        # fails for remote branches -- vila 2012-01-04
3527
 
        self.conf_store.save_changes()
3528
2362
        if not url:
3529
2363
            self._is_stacked = False
3530
2364
        else:
3531
2365
            self._is_stacked = True
3532
 
 
 
2366
        
3533
2367
    def _vfs_get_tags_bytes(self):
3534
2368
        self._ensure_real()
3535
2369
        return self._real_branch._get_tags_bytes()
3536
2370
 
3537
 
    @needs_read_lock
3538
2371
    def _get_tags_bytes(self):
3539
 
        if self._tags_bytes is None:
3540
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
3541
 
        return self._tags_bytes
3542
 
 
3543
 
    def _get_tags_bytes_via_hpss(self):
3544
2372
        medium = self._client._medium
3545
2373
        if medium._is_remote_before((1, 13)):
3546
2374
            return self._vfs_get_tags_bytes()
3556
2384
        return self._real_branch._set_tags_bytes(bytes)
3557
2385
 
3558
2386
    def _set_tags_bytes(self, bytes):
3559
 
        if self.is_locked():
3560
 
            self._tags_bytes = bytes
3561
2387
        medium = self._client._medium
3562
2388
        if medium._is_remote_before((1, 18)):
3563
2389
            self._vfs_set_tags_bytes(bytes)
3658
2484
        try:
3659
2485
            self._lock_count -= 1
3660
2486
            if not self._lock_count:
3661
 
                if self.conf_store is not None:
3662
 
                    self.conf_store.save_changes()
3663
2487
                self._clear_cached_state()
3664
2488
                mode = self._lock_mode
3665
2489
                self._lock_mode = None
3688
2512
            self.repository.unlock()
3689
2513
 
3690
2514
    def break_lock(self):
3691
 
        try:
3692
 
            response = self._call(
3693
 
                'Branch.break_lock', self._remote_path())
3694
 
        except errors.UnknownSmartMethod:
3695
 
            self._ensure_real()
3696
 
            return self._real_branch.break_lock()
3697
 
        if response != ('ok',):
3698
 
            raise errors.UnexpectedSmartServerResponse(response)
 
2515
        self._ensure_real()
 
2516
        return self._real_branch.break_lock()
3699
2517
 
3700
2518
    def leave_lock_in_place(self):
3701
2519
        if not self._lock_token:
3725
2543
            missing_parent = parent_map[missing_parent]
3726
2544
        raise errors.RevisionNotPresent(missing_parent, self.repository)
3727
2545
 
3728
 
    def _read_last_revision_info(self):
 
2546
    def _last_revision_info(self):
3729
2547
        response = self._call('Branch.last_revision_info', self._remote_path())
3730
2548
        if response[0] != 'ok':
3731
2549
            raise SmartProtocolError('unexpected response code %s' % (response,))
3794
2612
            raise errors.UnexpectedSmartServerResponse(response)
3795
2613
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3796
2614
 
 
2615
    @needs_write_lock
 
2616
    def set_revision_history(self, rev_history):
 
2617
        # Send just the tip revision of the history; the server will generate
 
2618
        # the full history from that.  If the revision doesn't exist in this
 
2619
        # branch, NoSuchRevision will be raised.
 
2620
        if rev_history == []:
 
2621
            rev_id = 'null:'
 
2622
        else:
 
2623
            rev_id = rev_history[-1]
 
2624
        self._set_last_revision(rev_id)
 
2625
        for hook in branch.Branch.hooks['set_rh']:
 
2626
            hook(self, rev_history)
 
2627
        self._cache_revision_history(rev_history)
 
2628
 
3797
2629
    def _get_parent_location(self):
3798
2630
        medium = self._client._medium
3799
2631
        if medium._is_remote_before((1, 13)):
3845
2677
            _override_hook_target=self, **kwargs)
3846
2678
 
3847
2679
    @needs_read_lock
3848
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
2680
    def push(self, target, overwrite=False, stop_revision=None):
3849
2681
        self._ensure_real()
3850
2682
        return self._real_branch.push(
3851
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
2683
            target, overwrite=overwrite, stop_revision=stop_revision,
3852
2684
            _override_hook_source_branch=self)
3853
2685
 
3854
 
    def peek_lock_mode(self):
3855
 
        return self._lock_mode
3856
 
 
3857
2686
    def is_locked(self):
3858
2687
        return self._lock_count >= 1
3859
2688
 
3860
2689
    @needs_read_lock
3861
 
    def revision_id_to_dotted_revno(self, revision_id):
3862
 
        """Given a revision id, return its dotted revno.
3863
 
 
3864
 
        :return: a tuple like (1,) or (400,1,3).
3865
 
        """
3866
 
        try:
3867
 
            response = self._call('Branch.revision_id_to_revno',
3868
 
                self._remote_path(), revision_id)
3869
 
        except errors.UnknownSmartMethod:
3870
 
            self._ensure_real()
3871
 
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
3872
 
        if response[0] == 'ok':
3873
 
            return tuple([int(x) for x in response[1:]])
3874
 
        else:
3875
 
            raise errors.UnexpectedSmartServerResponse(response)
3876
 
 
3877
 
    @needs_read_lock
3878
2690
    def revision_id_to_revno(self, revision_id):
3879
 
        """Given a revision id on the branch mainline, return its revno.
3880
 
 
3881
 
        :return: an integer
3882
 
        """
3883
 
        try:
3884
 
            response = self._call('Branch.revision_id_to_revno',
3885
 
                self._remote_path(), revision_id)
3886
 
        except errors.UnknownSmartMethod:
3887
 
            self._ensure_real()
3888
 
            return self._real_branch.revision_id_to_revno(revision_id)
3889
 
        if response[0] == 'ok':
3890
 
            if len(response) == 2:
3891
 
                return int(response[1])
3892
 
            raise NoSuchRevision(self, revision_id)
3893
 
        else:
3894
 
            raise errors.UnexpectedSmartServerResponse(response)
 
2691
        self._ensure_real()
 
2692
        return self._real_branch.revision_id_to_revno(revision_id)
3895
2693
 
3896
2694
    @needs_write_lock
3897
2695
    def set_last_revision_info(self, revno, revision_id):
3898
2696
        # XXX: These should be returned by the set_last_revision_info verb
3899
2697
        old_revno, old_revid = self.last_revision_info()
3900
2698
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3901
 
        if not revision_id or not isinstance(revision_id, basestring):
3902
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2699
        revision_id = ensure_null(revision_id)
3903
2700
        try:
3904
2701
            response = self._call('Branch.set_last_revision_info',
3905
2702
                self._remote_path(), self._lock_token, self._repo_lock_token,
3934
2731
            except errors.UnknownSmartMethod:
3935
2732
                medium._remember_remote_is_before((1, 6))
3936
2733
        self._clear_cached_state_of_remote_branch_only()
3937
 
        graph = self.repository.get_graph()
3938
 
        (last_revno, last_revid) = self.last_revision_info()
3939
 
        known_revision_ids = [
3940
 
            (last_revid, last_revno),
3941
 
            (_mod_revision.NULL_REVISION, 0),
3942
 
            ]
3943
 
        if last_rev is not None:
3944
 
            if not graph.is_ancestor(last_rev, revision_id):
3945
 
                # our previous tip is not merged into stop_revision
3946
 
                raise errors.DivergedBranches(self, other_branch)
3947
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
3948
 
        self.set_last_revision_info(revno, revision_id)
 
2734
        self.set_revision_history(self._lefthand_history(revision_id,
 
2735
            last_rev=last_rev,other_branch=other_branch))
3949
2736
 
3950
2737
    def set_push_location(self, location):
3951
 
        self._set_config_location('push_location', location)
3952
 
 
3953
 
    def heads_to_fetch(self):
3954
 
        if self._format._use_default_local_heads_to_fetch():
3955
 
            # We recognise this format, and its heads-to-fetch implementation
3956
 
            # is the default one (tip + tags).  In this case it's cheaper to
3957
 
            # just use the default implementation rather than a special RPC as
3958
 
            # the tip and tags data is cached.
3959
 
            return branch.Branch.heads_to_fetch(self)
3960
 
        medium = self._client._medium
3961
 
        if medium._is_remote_before((2, 4)):
3962
 
            return self._vfs_heads_to_fetch()
3963
 
        try:
3964
 
            return self._rpc_heads_to_fetch()
3965
 
        except errors.UnknownSmartMethod:
3966
 
            medium._remember_remote_is_before((2, 4))
3967
 
            return self._vfs_heads_to_fetch()
3968
 
 
3969
 
    def _rpc_heads_to_fetch(self):
3970
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3971
 
        if len(response) != 2:
3972
 
            raise errors.UnexpectedSmartServerResponse(response)
3973
 
        must_fetch, if_present_fetch = response
3974
 
        return set(must_fetch), set(if_present_fetch)
3975
 
 
3976
 
    def _vfs_heads_to_fetch(self):
3977
2738
        self._ensure_real()
3978
 
        return self._real_branch.heads_to_fetch()
 
2739
        return self._real_branch.set_push_location(location)
3979
2740
 
3980
2741
 
3981
2742
class RemoteConfig(object):
3996
2757
        """
3997
2758
        try:
3998
2759
            configobj = self._get_configobj()
3999
 
            section_obj = None
4000
2760
            if section is None:
4001
2761
                section_obj = configobj
4002
2762
            else:
4003
2763
                try:
4004
2764
                    section_obj = configobj[section]
4005
2765
                except KeyError:
4006
 
                    pass
4007
 
            if section_obj is None:
4008
 
                value = default
4009
 
            else:
4010
 
                value = section_obj.get(name, default)
 
2766
                    return default
 
2767
            return section_obj.get(name, default)
4011
2768
        except errors.UnknownSmartMethod:
4012
 
            value = self._vfs_get_option(name, section, default)
4013
 
        for hook in _mod_config.OldConfigHooks['get']:
4014
 
            hook(self, name, value)
4015
 
        return value
 
2769
            return self._vfs_get_option(name, section, default)
4016
2770
 
4017
2771
    def _response_to_configobj(self, response):
4018
2772
        if len(response[0]) and response[0][0] != 'ok':
4019
2773
            raise errors.UnexpectedSmartServerResponse(response)
4020
2774
        lines = response[1].read_body_bytes().splitlines()
4021
 
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
4022
 
        for hook in _mod_config.OldConfigHooks['load']:
4023
 
            hook(self)
4024
 
        return conf
 
2775
        return config.ConfigObj(lines, encoding='utf-8')
4025
2776
 
4026
2777
 
4027
2778
class RemoteBranchConfig(RemoteConfig):
4135
2886
        return self._bzrdir._real_bzrdir
4136
2887
 
4137
2888
 
 
2889
 
4138
2890
def _extract_tar(tar, to_dir):
4139
2891
    """Extract all the contents of a tarfile object.
4140
2892
 
4144
2896
        tar.extract(tarinfo, to_dir)
4145
2897
 
4146
2898
 
4147
 
error_translators = registry.Registry()
4148
 
no_context_error_translators = registry.Registry()
4149
 
 
4150
 
 
4151
2899
def _translate_error(err, **context):
4152
2900
    """Translate an ErrorFromSmartServer into a more useful error.
4153
2901
 
4182
2930
                    'Missing key %r in context %r', key_err.args[0], context)
4183
2931
                raise err
4184
2932
 
4185
 
    try:
4186
 
        translator = error_translators.get(err.error_verb)
4187
 
    except KeyError:
4188
 
        pass
4189
 
    else:
4190
 
        raise translator(err, find, get_path)
4191
 
    try:
4192
 
        translator = no_context_error_translators.get(err.error_verb)
4193
 
    except KeyError:
4194
 
        raise errors.UnknownErrorFromSmartServer(err)
4195
 
    else:
4196
 
        raise translator(err)
4197
 
 
4198
 
 
4199
 
error_translators.register('NoSuchRevision',
4200
 
    lambda err, find, get_path: NoSuchRevision(
4201
 
        find('branch'), err.error_args[0]))
4202
 
error_translators.register('nosuchrevision',
4203
 
    lambda err, find, get_path: NoSuchRevision(
4204
 
        find('repository'), err.error_args[0]))
4205
 
 
4206
 
def _translate_nobranch_error(err, find, get_path):
4207
 
    if len(err.error_args) >= 1:
4208
 
        extra = err.error_args[0]
4209
 
    else:
4210
 
        extra = None
4211
 
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
4212
 
        detail=extra)
4213
 
 
4214
 
error_translators.register('nobranch', _translate_nobranch_error)
4215
 
error_translators.register('norepository',
4216
 
    lambda err, find, get_path: errors.NoRepositoryPresent(
4217
 
        find('bzrdir')))
4218
 
error_translators.register('UnlockableTransport',
4219
 
    lambda err, find, get_path: errors.UnlockableTransport(
4220
 
        find('bzrdir').root_transport))
4221
 
error_translators.register('TokenMismatch',
4222
 
    lambda err, find, get_path: errors.TokenMismatch(
4223
 
        find('token'), '(remote token)'))
4224
 
error_translators.register('Diverged',
4225
 
    lambda err, find, get_path: errors.DivergedBranches(
4226
 
        find('branch'), find('other_branch')))
4227
 
error_translators.register('NotStacked',
4228
 
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
4229
 
 
4230
 
def _translate_PermissionDenied(err, find, get_path):
4231
 
    path = get_path()
4232
 
    if len(err.error_args) >= 2:
4233
 
        extra = err.error_args[1]
4234
 
    else:
4235
 
        extra = None
4236
 
    return errors.PermissionDenied(path, extra=extra)
4237
 
 
4238
 
error_translators.register('PermissionDenied', _translate_PermissionDenied)
4239
 
error_translators.register('ReadError',
4240
 
    lambda err, find, get_path: errors.ReadError(get_path()))
4241
 
error_translators.register('NoSuchFile',
4242
 
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
4243
 
error_translators.register('TokenLockingNotSupported',
4244
 
    lambda err, find, get_path: errors.TokenLockingNotSupported(
4245
 
        find('repository')))
4246
 
error_translators.register('UnsuspendableWriteGroup',
4247
 
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
4248
 
        repository=find('repository')))
4249
 
error_translators.register('UnresumableWriteGroup',
4250
 
    lambda err, find, get_path: errors.UnresumableWriteGroup(
4251
 
        repository=find('repository'), write_groups=err.error_args[0],
4252
 
        reason=err.error_args[1]))
4253
 
no_context_error_translators.register('IncompatibleRepositories',
4254
 
    lambda err: errors.IncompatibleRepositories(
4255
 
        err.error_args[0], err.error_args[1], err.error_args[2]))
4256
 
no_context_error_translators.register('LockContention',
4257
 
    lambda err: errors.LockContention('(remote lock)'))
4258
 
no_context_error_translators.register('LockFailed',
4259
 
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
4260
 
no_context_error_translators.register('TipChangeRejected',
4261
 
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
4262
 
no_context_error_translators.register('UnstackableBranchFormat',
4263
 
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
4264
 
no_context_error_translators.register('UnstackableRepositoryFormat',
4265
 
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
4266
 
no_context_error_translators.register('FileExists',
4267
 
    lambda err: errors.FileExists(err.error_args[0]))
4268
 
no_context_error_translators.register('DirectoryNotEmpty',
4269
 
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
4270
 
 
4271
 
def _translate_short_readv_error(err):
4272
 
    args = err.error_args
4273
 
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
4274
 
        int(args[3]))
4275
 
 
4276
 
no_context_error_translators.register('ShortReadvError',
4277
 
    _translate_short_readv_error)
4278
 
 
4279
 
def _translate_unicode_error(err):
 
2933
    if err.error_verb == 'IncompatibleRepositories':
 
2934
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2935
            err.error_args[1], err.error_args[2])
 
2936
    elif err.error_verb == 'NoSuchRevision':
 
2937
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
2938
    elif err.error_verb == 'nosuchrevision':
 
2939
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
2940
    elif err.error_verb == 'nobranch':
 
2941
        if len(err.error_args) >= 1:
 
2942
            extra = err.error_args[0]
 
2943
        else:
 
2944
            extra = None
 
2945
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
2946
            detail=extra)
 
2947
    elif err.error_verb == 'norepository':
 
2948
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2949
    elif err.error_verb == 'LockContention':
 
2950
        raise errors.LockContention('(remote lock)')
 
2951
    elif err.error_verb == 'UnlockableTransport':
 
2952
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2953
    elif err.error_verb == 'LockFailed':
 
2954
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
2955
    elif err.error_verb == 'TokenMismatch':
 
2956
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
2957
    elif err.error_verb == 'Diverged':
 
2958
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2959
    elif err.error_verb == 'TipChangeRejected':
 
2960
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2961
    elif err.error_verb == 'UnstackableBranchFormat':
 
2962
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2963
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2964
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
2965
    elif err.error_verb == 'NotStacked':
 
2966
        raise errors.NotStacked(branch=find('branch'))
 
2967
    elif err.error_verb == 'PermissionDenied':
 
2968
        path = get_path()
 
2969
        if len(err.error_args) >= 2:
 
2970
            extra = err.error_args[1]
 
2971
        else:
 
2972
            extra = None
 
2973
        raise errors.PermissionDenied(path, extra=extra)
 
2974
    elif err.error_verb == 'ReadError':
 
2975
        path = get_path()
 
2976
        raise errors.ReadError(path)
 
2977
    elif err.error_verb == 'NoSuchFile':
 
2978
        path = get_path()
 
2979
        raise errors.NoSuchFile(path)
 
2980
    elif err.error_verb == 'FileExists':
 
2981
        raise errors.FileExists(err.error_args[0])
 
2982
    elif err.error_verb == 'DirectoryNotEmpty':
 
2983
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
2984
    elif err.error_verb == 'ShortReadvError':
 
2985
        args = err.error_args
 
2986
        raise errors.ShortReadvError(
 
2987
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
2988
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
4280
2989
        encoding = str(err.error_args[0]) # encoding must always be a string
4281
2990
        val = err.error_args[1]
4282
2991
        start = int(err.error_args[2])
4290
2999
            raise UnicodeDecodeError(encoding, val, start, end, reason)
4291
3000
        elif err.error_verb == 'UnicodeEncodeError':
4292
3001
            raise UnicodeEncodeError(encoding, val, start, end, reason)
4293
 
 
4294
 
no_context_error_translators.register('UnicodeEncodeError',
4295
 
    _translate_unicode_error)
4296
 
no_context_error_translators.register('UnicodeDecodeError',
4297
 
    _translate_unicode_error)
4298
 
no_context_error_translators.register('ReadOnlyError',
4299
 
    lambda err: errors.TransportNotPossible('readonly transport'))
4300
 
no_context_error_translators.register('MemoryError',
4301
 
    lambda err: errors.BzrError("remote server out of memory\n"
4302
 
        "Retry non-remotely, or contact the server admin for details."))
4303
 
no_context_error_translators.register('RevisionNotPresent',
4304
 
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
4305
 
 
4306
 
no_context_error_translators.register('BzrCheckError',
4307
 
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
4308
 
 
 
3002
    elif err.error_verb == 'ReadOnlyError':
 
3003
        raise errors.TransportNotPossible('readonly transport')
 
3004
    raise errors.UnknownErrorFromSmartServer(err)