~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
MergeĀ 1.11rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2012 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
18
19
 
19
20
import bz2
20
 
import zlib
21
21
 
22
22
from bzrlib import (
23
 
    bencode,
24
23
    branch,
25
 
    bzrdir as _mod_bzrdir,
26
 
    config as _mod_config,
27
 
    controldir,
28
24
    debug,
29
25
    errors,
30
 
    gpg,
31
26
    graph,
32
 
    inventory_delta,
33
 
    lock,
34
27
    lockdir,
35
 
    osutils,
36
 
    registry,
37
 
    repository as _mod_repository,
38
 
    revision as _mod_revision,
39
 
    static_tuple,
 
28
    repository,
 
29
    revision,
40
30
    symbol_versioning,
41
 
    testament as _mod_testament,
42
31
    urlutils,
43
 
    vf_repository,
44
 
    vf_search,
45
 
    )
46
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
47
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
32
)
 
33
from bzrlib.branch import BranchReferenceFormat
 
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
48
36
from bzrlib.errors import (
49
37
    NoSuchRevision,
50
38
    SmartProtocolError,
51
39
    )
52
 
from bzrlib.i18n import gettext
53
 
from bzrlib.inventory import Inventory
54
40
from bzrlib.lockable_files import LockableFiles
55
 
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
 
41
from bzrlib.smart import client, vfs
 
42
from bzrlib.revision import ensure_null, NULL_REVISION
 
43
from bzrlib.trace import mutter, note, warning
66
44
 
67
45
 
68
46
class _RpcHelper(object):
73
51
            return self._client.call(method, *args)
74
52
        except errors.ErrorFromSmartServer, err:
75
53
            self._translate_error(err, **err_context)
76
 
 
 
54
        
77
55
    def _call_expecting_body(self, method, *args, **err_context):
78
56
        try:
79
57
            return self._client.call_expecting_body(method, *args)
80
58
        except errors.ErrorFromSmartServer, err:
81
59
            self._translate_error(err, **err_context)
82
 
 
83
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
84
 
        try:
85
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
86
 
        except errors.ErrorFromSmartServer, err:
87
 
            self._translate_error(err, **err_context)
88
 
 
 
60
        
89
61
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
90
62
                                             **err_context):
91
63
        try:
93
65
                method, args, body_bytes)
94
66
        except errors.ErrorFromSmartServer, err:
95
67
            self._translate_error(err, **err_context)
96
 
 
97
 
 
98
 
def response_tuple_to_repo_format(response):
99
 
    """Convert a response tuple describing a repository format to a format."""
100
 
    format = RemoteRepositoryFormat()
101
 
    format._rich_root_data = (response[0] == 'yes')
102
 
    format._supports_tree_reference = (response[1] == 'yes')
103
 
    format._supports_external_lookups = (response[2] == 'yes')
104
 
    format._network_name = response[3]
105
 
    return format
106
 
 
107
 
 
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):
 
68
        
 
69
# Note: RemoteBzrDirFormat is in bzrdir.py
 
70
 
 
71
class RemoteBzrDir(BzrDir, _RpcHelper):
411
72
    """Control directory on a remote server, accessed via bzr:// or similar."""
412
73
 
413
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
74
    def __init__(self, transport, _client=None):
414
75
        """Construct a RemoteBzrDir.
415
76
 
416
77
        :param _client: Private parameter for testing. Disables probing and the
417
78
            use of a real bzrdir.
418
79
        """
419
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
80
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
420
81
        # this object holds a delegated bzrdir that uses file-level operations
421
82
        # to talk to the other side
422
83
        self._real_bzrdir = None
423
 
        self._has_working_tree = None
424
 
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
425
 
        # create_branch for details.
426
 
        self._next_open_branch_result = None
427
84
 
428
85
        if _client is None:
429
86
            medium = transport.get_smart_medium()
430
87
            self._client = client._SmartClient(medium)
431
88
        else:
432
89
            self._client = _client
433
 
            if not _force_probe:
434
 
                return
435
 
 
436
 
        self._probe_bzrdir()
437
 
 
438
 
    def __repr__(self):
439
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
440
 
 
441
 
    def _probe_bzrdir(self):
442
 
        medium = self._client._medium
 
90
            return
 
91
 
443
92
        path = self._path_for_remote_call(self._client)
444
 
        if medium._is_remote_before((2, 1)):
445
 
            self._rpc_open(path)
446
 
            return
447
 
        try:
448
 
            self._rpc_open_2_1(path)
449
 
            return
450
 
        except errors.UnknownSmartMethod:
451
 
            medium._remember_remote_is_before((2, 1))
452
 
            self._rpc_open(path)
453
 
 
454
 
    def _rpc_open_2_1(self, path):
455
 
        response = self._call('BzrDir.open_2.1', path)
456
 
        if response == ('no',):
457
 
            raise errors.NotBranchError(path=self.root_transport.base)
458
 
        elif response[0] == 'yes':
459
 
            if response[1] == 'yes':
460
 
                self._has_working_tree = True
461
 
            elif response[1] == 'no':
462
 
                self._has_working_tree = False
463
 
            else:
464
 
                raise errors.UnexpectedSmartServerResponse(response)
465
 
        else:
466
 
            raise errors.UnexpectedSmartServerResponse(response)
467
 
 
468
 
    def _rpc_open(self, path):
469
93
        response = self._call('BzrDir.open', path)
470
94
        if response not in [('yes',), ('no',)]:
471
95
            raise errors.UnexpectedSmartServerResponse(response)
472
96
        if response == ('no',):
473
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
97
            raise errors.NotBranchError(path=transport.base)
474
98
 
475
99
    def _ensure_real(self):
476
100
        """Ensure that there is a _real_bzrdir set.
478
102
        Used before calls to self._real_bzrdir.
479
103
        """
480
104
        if not self._real_bzrdir:
481
 
            if 'hpssvfs' in debug.debug_flags:
482
 
                import traceback
483
 
                warning('VFS BzrDir access triggered\n%s',
484
 
                    ''.join(traceback.format_stack()))
485
 
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
486
 
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
487
 
            self._format._network_name = \
488
 
                self._real_bzrdir._format.network_name()
 
105
            self._real_bzrdir = BzrDir.open_from_transport(
 
106
                self.root_transport, _server_formats=False)
489
107
 
490
108
    def _translate_error(self, err, **context):
491
109
        _translate_error(err, bzrdir=self, **context)
492
110
 
493
 
    def break_lock(self):
494
 
        # Prevent aliasing problems in the next_open_branch_result cache.
495
 
        # See create_branch for rationale.
496
 
        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
540
 
 
541
 
    def _vfs_cloning_metadir(self, require_stacking=False):
542
 
        self._ensure_real()
543
 
        return self._real_bzrdir.cloning_metadir(
544
 
            require_stacking=require_stacking)
545
 
 
546
 
    def cloning_metadir(self, require_stacking=False):
547
 
        medium = self._client._medium
548
 
        if medium._is_remote_before((1, 13)):
549
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
550
 
        verb = 'BzrDir.cloning_metadir'
551
 
        if require_stacking:
552
 
            stacking = 'True'
553
 
        else:
554
 
            stacking = 'False'
555
 
        path = self._path_for_remote_call(self._client)
556
 
        try:
557
 
            response = self._call(verb, path, stacking)
558
 
        except errors.UnknownSmartMethod:
559
 
            medium._remember_remote_is_before((1, 13))
560
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
561
 
        except errors.UnknownErrorFromSmartServer, err:
562
 
            if err.error_tuple != ('BranchReference',):
563
 
                raise
564
 
            # We need to resolve the branch reference to determine the
565
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
566
 
            # referenced branch (and bzrdir, etc) but only when the caller
567
 
            # didn't already resolve the branch reference.
568
 
            referenced_branch = self.open_branch()
569
 
            return referenced_branch.bzrdir.cloning_metadir()
570
 
        if len(response) != 3:
571
 
            raise errors.UnexpectedSmartServerResponse(response)
572
 
        control_name, repo_name, branch_info = response
573
 
        if len(branch_info) != 2:
574
 
            raise errors.UnexpectedSmartServerResponse(response)
575
 
        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
 
 
581
 
        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)
588
 
        if branch_ref == 'ref':
589
 
            # XXX: we need possible_transports here to avoid reopening the
590
 
            # connection to the referenced location
591
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
592
 
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
593
 
            format.set_branch_format(branch_format)
594
 
        elif branch_ref == 'branch':
595
 
            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)
603
 
        else:
604
 
            raise errors.UnexpectedSmartServerResponse(response)
605
 
        return format
 
111
    def cloning_metadir(self, stacked=False):
 
112
        self._ensure_real()
 
113
        return self._real_bzrdir.cloning_metadir(stacked)
606
114
 
607
115
    def create_repository(self, shared=False):
608
 
        # as per meta1 formats - just delegate to the format object which may
609
 
        # be parameterised.
610
 
        result = self._format.repository_format.initialize(self, shared)
611
 
        if not isinstance(result, RemoteRepository):
612
 
            return self.open_repository()
613
 
        else:
614
 
            return result
 
116
        self._ensure_real()
 
117
        self._real_bzrdir.create_repository(shared=shared)
 
118
        return self.open_repository()
615
119
 
616
120
    def destroy_repository(self):
617
121
        """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,))
627
 
 
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)
634
 
        # as per meta1 formats - just delegate to the format object which may
635
 
        # be parameterised.
636
 
        real_branch = self._format.get_branch_format().initialize(self,
637
 
            name=name, repository=repository,
638
 
            append_revisions_only=append_revisions_only)
639
 
        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)
645
 
        else:
646
 
            result = real_branch
647
 
        # BzrDir.clone_on_transport() uses the result of create_branch but does
648
 
        # not return it to its callers; we save approximately 8% of our round
649
 
        # trips by handing the branch we created back to the first caller to
650
 
        # open_branch rather than probing anew. Long term we need a API in
651
 
        # bzrdir that doesn't discard result objects (like result_branch).
652
 
        # RBC 20090225
653
 
        self._next_open_branch_result = result
654
 
        return result
655
 
 
656
 
    def destroy_branch(self, name=None):
 
122
        self._ensure_real()
 
123
        self._real_bzrdir.destroy_repository()
 
124
 
 
125
    def create_branch(self):
 
126
        self._ensure_real()
 
127
        real_branch = self._real_bzrdir.create_branch()
 
128
        return RemoteBranch(self, self.find_repository(), real_branch)
 
129
 
 
130
    def destroy_branch(self):
657
131
        """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
674
 
        self._next_open_branch_result = None
675
 
        if response[0] != 'ok':
676
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
132
        self._ensure_real()
 
133
        self._real_bzrdir.destroy_branch()
677
134
 
678
 
    def create_workingtree(self, revision_id=None, from_branch=None,
679
 
        accelerator_tree=None, hardlink=False):
 
135
    def create_workingtree(self, revision_id=None, from_branch=None):
680
136
        raise errors.NotLocalUrl(self.transport.base)
681
137
 
682
 
    def find_branch_format(self, name=None):
 
138
    def find_branch_format(self):
683
139
        """Find the branch 'format' for this bzrdir.
684
140
 
685
141
        This might be a synthetic object for e.g. RemoteBranch and SVN.
686
142
        """
687
 
        b = self.open_branch(name=name)
 
143
        b = self.open_branch()
688
144
        return b._format
689
145
 
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
 
    def get_branch_reference(self, name=None):
 
146
    def get_branch_reference(self):
718
147
        """See BzrDir.get_branch_reference()."""
719
 
        if name is None:
720
 
            name = self._get_selected_branch()
721
 
        if name != "":
722
 
            raise errors.NoColocatedBranchSupport(self)
723
 
        response = self._get_branch_reference()
724
 
        if response[0] == 'ref':
725
 
            return response[1]
 
148
        path = self._path_for_remote_call(self._client)
 
149
        response = self._call('BzrDir.open_branch', path)
 
150
        if response[0] == 'ok':
 
151
            if response[1] == '':
 
152
                # branch at this location.
 
153
                return None
 
154
            else:
 
155
                # a branch reference, use the existing BranchReference logic.
 
156
                return response[1]
726
157
        else:
727
 
            return None
728
 
 
729
 
    def _get_branch_reference(self):
730
 
        path = self._path_for_remote_call(self._client)
731
 
        medium = self._client._medium
732
 
        candidate_calls = [
733
 
            ('BzrDir.open_branchV3', (2, 1)),
734
 
            ('BzrDir.open_branchV2', (1, 13)),
735
 
            ('BzrDir.open_branch', None),
736
 
            ]
737
 
        for verb, required_version in candidate_calls:
738
 
            if required_version and medium._is_remote_before(required_version):
739
 
                continue
740
 
            try:
741
 
                response = self._call(verb, path)
742
 
            except errors.UnknownSmartMethod:
743
 
                if required_version is None:
744
 
                    raise
745
 
                medium._remember_remote_is_before(required_version)
746
 
            else:
747
 
                break
748
 
        if verb == 'BzrDir.open_branch':
749
 
            if response[0] != 'ok':
750
 
                raise errors.UnexpectedSmartServerResponse(response)
751
 
            if response[1] != '':
752
 
                return ('ref', response[1])
753
 
            else:
754
 
                return ('branch', '')
755
 
        if response[0] not in ('ref', 'branch'):
756
158
            raise errors.UnexpectedSmartServerResponse(response)
757
 
        return response
758
159
 
759
 
    def _get_tree_branch(self, name=None):
 
160
    def _get_tree_branch(self):
760
161
        """See BzrDir._get_tree_branch()."""
761
 
        return None, self.open_branch(name=name)
 
162
        return None, self.open_branch()
762
163
 
763
 
    def _open_branch(self, name, kind, location_or_format,
764
 
                     ignore_fallbacks=False, possible_transports=None):
765
 
        if kind == 'ref':
 
164
    def open_branch(self, _unsupported=False):
 
165
        if _unsupported:
 
166
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
167
        reference_url = self.get_branch_reference()
 
168
        if reference_url is None:
 
169
            # branch at this location.
 
170
            return RemoteBranch(self, self.find_repository())
 
171
        else:
766
172
            # a branch reference, use the existing BranchReference logic.
767
173
            format = BranchReferenceFormat()
768
 
            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
772
 
        if not branch_format_name:
773
 
            branch_format_name = None
774
 
        format = RemoteBranchFormat(network_name=branch_format_name)
775
 
        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)
796
 
 
797
 
    def _open_repo_v1(self, path):
798
 
        verb = 'BzrDir.find_repository'
799
 
        response = self._call(verb, path)
800
 
        if response[0] != 'ok':
801
 
            raise errors.UnexpectedSmartServerResponse(response)
802
 
        # servers that only support the v1 method don't support external
803
 
        # references either.
804
 
        self._ensure_real()
805
 
        repo = self._real_bzrdir.open_repository()
806
 
        response = response + ('no', repo._format.network_name())
807
 
        return response, repo
808
 
 
809
 
    def _open_repo_v2(self, path):
 
174
            return format.open(self, _found=True, location=reference_url)
 
175
                
 
176
    def open_repository(self):
 
177
        path = self._path_for_remote_call(self._client)
810
178
        verb = 'BzrDir.find_repositoryV2'
811
 
        response = self._call(verb, path)
812
 
        if response[0] != 'ok':
813
 
            raise errors.UnexpectedSmartServerResponse(response)
814
 
        self._ensure_real()
815
 
        repo = self._real_bzrdir.open_repository()
816
 
        response = response + (repo._format.network_name(),)
817
 
        return response, repo
818
 
 
819
 
    def _open_repo_v3(self, path):
820
 
        verb = 'BzrDir.find_repositoryV3'
821
 
        medium = self._client._medium
822
 
        if medium._is_remote_before((1, 13)):
823
 
            raise errors.UnknownSmartMethod(verb)
824
179
        try:
825
180
            response = self._call(verb, path)
826
181
        except errors.UnknownSmartMethod:
827
 
            medium._remember_remote_is_before((1, 13))
828
 
            raise
829
 
        if response[0] != 'ok':
830
 
            raise errors.UnexpectedSmartServerResponse(response)
831
 
        return response, None
832
 
 
833
 
    def open_repository(self):
834
 
        path = self._path_for_remote_call(self._client)
835
 
        response = None
836
 
        for probe in [self._open_repo_v3, self._open_repo_v2,
837
 
            self._open_repo_v1]:
838
 
            try:
839
 
                response, real_repo = probe(path)
840
 
                break
841
 
            except errors.UnknownSmartMethod:
842
 
                pass
843
 
        if response is None:
844
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
845
 
        if response[0] != 'ok':
846
 
            raise errors.UnexpectedSmartServerResponse(response)
847
 
        if len(response) != 6:
 
182
            verb = 'BzrDir.find_repository'
 
183
            response = self._call(verb, path)
 
184
        if response[0] != 'ok':
 
185
            raise errors.UnexpectedSmartServerResponse(response)
 
186
        if verb == 'BzrDir.find_repository':
 
187
            # servers that don't support the V2 method don't support external
 
188
            # references either.
 
189
            response = response + ('no', )
 
190
        if not (len(response) == 5):
848
191
            raise SmartProtocolError('incorrect response length %s' % (response,))
849
192
        if response[1] == '':
850
 
            # repo is at this dir.
851
 
            format = response_tuple_to_repo_format(response[2:])
 
193
            format = RemoteRepositoryFormat()
 
194
            format.rich_root_data = (response[2] == 'yes')
 
195
            format.supports_tree_reference = (response[3] == 'yes')
 
196
            # No wire format to check this yet.
 
197
            format.supports_external_lookups = (response[4] == 'yes')
852
198
            # Used to support creating a real format instance when needed.
853
199
            format._creating_bzrdir = self
854
 
            remote_repo = RemoteRepository(self, format)
855
 
            format._creating_repo = remote_repo
856
 
            if real_repo is not None:
857
 
                remote_repo._set_real_repository(real_repo)
858
 
            return remote_repo
 
200
            return RemoteRepository(self, format)
859
201
        else:
860
202
            raise errors.NoRepositoryPresent(self)
861
203
 
862
 
    def has_workingtree(self):
863
 
        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')
874
 
        return self._has_working_tree
875
 
 
876
204
    def open_workingtree(self, recommend_upgrade=True):
877
 
        if self.has_workingtree():
 
205
        self._ensure_real()
 
206
        if self._real_bzrdir.has_workingtree():
878
207
            raise errors.NotLocalUrl(self.root_transport)
879
208
        else:
880
209
            raise errors.NoWorkingTree(self.root_transport.base)
881
210
 
882
211
    def _path_for_remote_call(self, client):
883
212
        """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]
 
213
        return client.remote_path_from_transport(self.root_transport)
886
214
 
887
 
    def get_branch_transport(self, branch_format, name=None):
 
215
    def get_branch_transport(self, branch_format):
888
216
        self._ensure_real()
889
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
217
        return self._real_bzrdir.get_branch_transport(branch_format)
890
218
 
891
219
    def get_repository_transport(self, repository_format):
892
220
        self._ensure_real()
900
228
        """Upgrading of remote bzrdirs is not supported yet."""
901
229
        return False
902
230
 
903
 
    def needs_format_conversion(self, format):
 
231
    def needs_format_conversion(self, format=None):
904
232
        """Upgrading of remote bzrdirs is not supported yet."""
905
233
        return False
906
234
 
907
 
    def _get_config(self):
908
 
        return RemoteBzrDirConfig(self)
909
 
 
910
 
    def _get_config_store(self):
911
 
        return RemoteControlStore(self)
912
 
 
913
 
 
914
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
235
    def clone(self, url, revision_id=None, force_new_repo=False,
 
236
              preserve_stacking=False):
 
237
        self._ensure_real()
 
238
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
239
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
240
 
 
241
    def get_config(self):
 
242
        self._ensure_real()
 
243
        return self._real_bzrdir.get_config()
 
244
 
 
245
 
 
246
class RemoteRepositoryFormat(repository.RepositoryFormat):
915
247
    """Format for repositories accessed over a _SmartClient.
916
248
 
917
249
    Instances of this repository are represented by RemoteRepository
922
254
    the attributes rich_root_data and supports_tree_reference are set
923
255
    on a per instance basis, and are not set (and should not be) at
924
256
    the class level.
925
 
 
926
 
    :ivar _custom_format: If set, a specific concrete repository format that
927
 
        will be used when initializing a repository with this
928
 
        RemoteRepositoryFormat.
929
 
    :ivar _creating_repo: If set, the repository object that this
930
 
        RemoteRepositoryFormat was created for: it can be called into
931
 
        to obtain data like the network name.
932
257
    """
933
258
 
934
259
    _matchingbzrdir = RemoteBzrDirFormat()
935
 
    supports_full_versioned_files = True
936
 
    supports_leaving_lock = True
937
 
 
938
 
    def __init__(self):
939
 
        _mod_repository.RepositoryFormat.__init__(self)
940
 
        self._custom_format = None
941
 
        self._network_name = None
942
 
        self._creating_bzrdir = None
943
 
        self._revision_graph_can_have_wrong_parents = None
944
 
        self._supports_chks = None
945
 
        self._supports_external_lookups = None
946
 
        self._supports_tree_reference = None
947
 
        self._supports_funky_characters = None
948
 
        self._supports_nesting_repositories = None
949
 
        self._rich_root_data = None
950
 
 
951
 
    def __repr__(self):
952
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
953
 
            self._network_name)
954
 
 
955
 
    @property
956
 
    def fast_deltas(self):
957
 
        self._ensure_real()
958
 
        return self._custom_format.fast_deltas
959
 
 
960
 
    @property
961
 
    def rich_root_data(self):
962
 
        if self._rich_root_data is None:
963
 
            self._ensure_real()
964
 
            self._rich_root_data = self._custom_format.rich_root_data
965
 
        return self._rich_root_data
966
 
 
967
 
    @property
968
 
    def supports_chks(self):
969
 
        if self._supports_chks is None:
970
 
            self._ensure_real()
971
 
            self._supports_chks = self._custom_format.supports_chks
972
 
        return self._supports_chks
973
 
 
974
 
    @property
975
 
    def supports_external_lookups(self):
976
 
        if self._supports_external_lookups is None:
977
 
            self._ensure_real()
978
 
            self._supports_external_lookups = \
979
 
                self._custom_format.supports_external_lookups
980
 
        return self._supports_external_lookups
981
 
 
982
 
    @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
 
    def supports_tree_reference(self):
1000
 
        if self._supports_tree_reference is None:
1001
 
            self._ensure_real()
1002
 
            self._supports_tree_reference = \
1003
 
                self._custom_format.supports_tree_reference
1004
 
        return self._supports_tree_reference
1005
 
 
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
 
    def _vfs_initialize(self, a_bzrdir, shared):
1015
 
        """Helper for common code in initialize."""
1016
 
        if self._custom_format:
1017
 
            # Custom format requested
1018
 
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
1019
 
        elif self._creating_bzrdir is not None:
1020
 
            # Use the format that the repository we were created to back
1021
 
            # has.
 
260
 
 
261
    def initialize(self, a_bzrdir, shared=False):
 
262
        if not isinstance(a_bzrdir, RemoteBzrDir):
1022
263
            prior_repo = self._creating_bzrdir.open_repository()
1023
264
            prior_repo._ensure_real()
1024
 
            result = prior_repo._real_repository._format.initialize(
 
265
            return prior_repo._real_repository._format.initialize(
1025
266
                a_bzrdir, shared=shared)
1026
 
        else:
1027
 
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
1028
 
            # support remote initialization.
1029
 
            # We delegate to a real object at this point (as RemoteBzrDir
1030
 
            # delegate to the repository format which would lead to infinite
1031
 
            # recursion if we just called a_bzrdir.create_repository.
1032
 
            a_bzrdir._ensure_real()
1033
 
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
1034
 
        if not isinstance(result, RemoteRepository):
1035
 
            return self.open(a_bzrdir)
1036
 
        else:
1037
 
            return result
1038
 
 
1039
 
    def initialize(self, a_bzrdir, shared=False):
1040
 
        # Being asked to create on a non RemoteBzrDir:
1041
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
1042
 
            return self._vfs_initialize(a_bzrdir, shared)
1043
 
        medium = a_bzrdir._client._medium
1044
 
        if medium._is_remote_before((1, 13)):
1045
 
            return self._vfs_initialize(a_bzrdir, shared)
1046
 
        # Creating on a remote bzr dir.
1047
 
        # 1) get the network name to use.
1048
 
        if self._custom_format:
1049
 
            network_name = self._custom_format.network_name()
1050
 
        elif self._network_name:
1051
 
            network_name = self._network_name
1052
 
        else:
1053
 
            # Select the current bzrlib default and ask for that.
1054
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
1055
 
            reference_format = reference_bzrdir_format.repository_format
1056
 
            network_name = reference_format.network_name()
1057
 
        # 2) try direct creation via RPC
1058
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1059
 
        verb = 'BzrDir.create_repository'
1060
 
        if shared:
1061
 
            shared_str = 'True'
1062
 
        else:
1063
 
            shared_str = 'False'
1064
 
        try:
1065
 
            response = a_bzrdir._call(verb, path, network_name, shared_str)
1066
 
        except errors.UnknownSmartMethod:
1067
 
            # Fallback - use vfs methods
1068
 
            medium._remember_remote_is_before((1, 13))
1069
 
            return self._vfs_initialize(a_bzrdir, shared)
1070
 
        else:
1071
 
            # Turn the response into a RemoteRepository object.
1072
 
            format = response_tuple_to_repo_format(response[1:])
1073
 
            # Used to support creating a real format instance when needed.
1074
 
            format._creating_bzrdir = a_bzrdir
1075
 
            remote_repo = RemoteRepository(a_bzrdir, format)
1076
 
            format._creating_repo = remote_repo
1077
 
            return remote_repo
1078
 
 
 
267
        return a_bzrdir.create_repository(shared=shared)
 
268
    
1079
269
    def open(self, a_bzrdir):
1080
270
        if not isinstance(a_bzrdir, RemoteBzrDir):
1081
271
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
1082
272
        return a_bzrdir.open_repository()
1083
273
 
1084
 
    def _ensure_real(self):
1085
 
        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)
1092
 
 
1093
 
    @property
1094
 
    def _fetch_order(self):
1095
 
        self._ensure_real()
1096
 
        return self._custom_format._fetch_order
1097
 
 
1098
 
    @property
1099
 
    def _fetch_uses_deltas(self):
1100
 
        self._ensure_real()
1101
 
        return self._custom_format._fetch_uses_deltas
1102
 
 
1103
 
    @property
1104
 
    def _fetch_reconcile(self):
1105
 
        self._ensure_real()
1106
 
        return self._custom_format._fetch_reconcile
1107
 
 
1108
274
    def get_format_description(self):
1109
 
        self._ensure_real()
1110
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
275
        return 'bzr remote repository'
1111
276
 
1112
277
    def __eq__(self, other):
1113
 
        return self.__class__ is other.__class__
1114
 
 
1115
 
    def network_name(self):
1116
 
        if self._network_name:
1117
 
            return self._network_name
1118
 
        self._creating_repo._ensure_real()
1119
 
        return self._creating_repo._real_repository._format.network_name()
1120
 
 
1121
 
    @property
1122
 
    def pack_compresses(self):
1123
 
        self._ensure_real()
1124
 
        return self._custom_format.pack_compresses
1125
 
 
1126
 
    @property
1127
 
    def _serializer(self):
1128
 
        self._ensure_real()
1129
 
        return self._custom_format._serializer
1130
 
 
1131
 
 
1132
 
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
1133
 
        lock._RelockDebugMixin):
 
278
        return self.__class__ == other.__class__
 
279
 
 
280
    def check_conversion_target(self, target_format):
 
281
        if self.rich_root_data and not target_format.rich_root_data:
 
282
            raise errors.BadConversionTarget(
 
283
                'Does not support rich root data.', target_format)
 
284
        if (self.supports_tree_reference and
 
285
            not getattr(target_format, 'supports_tree_reference', False)):
 
286
            raise errors.BadConversionTarget(
 
287
                'Does not support nested trees', target_format)
 
288
 
 
289
 
 
290
class RemoteRepository(_RpcHelper):
1134
291
    """Repository accessed over rpc.
1135
292
 
1136
293
    For the moment most operations are performed using local transport-backed
1139
296
 
1140
297
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
1141
298
        """Create a RemoteRepository instance.
1142
 
 
 
299
        
1143
300
        :param remote_bzrdir: The bzrdir hosting this repository.
1144
301
        :param format: The RemoteFormat object to use.
1145
302
        :param real_repository: If not None, a local implementation of the
1160
317
        self._format = format
1161
318
        self._lock_mode = None
1162
319
        self._lock_token = None
1163
 
        self._write_group_tokens = None
1164
320
        self._lock_count = 0
1165
321
        self._leave_lock = False
1166
 
        # Cache of revision parents; misses are cached during read locks, and
1167
 
        # write locks when no _real_repository has been set.
1168
322
        self._unstacked_provider = graph.CachingParentsProvider(
1169
323
            get_parent_map=self._get_parent_map_rpc)
1170
324
        self._unstacked_provider.disable_cache()
1180
334
        # Additional places to query for data.
1181
335
        self._fallback_repositories = []
1182
336
 
1183
 
    @property
1184
 
    def user_transport(self):
1185
 
        return self.bzrdir.user_transport
1186
 
 
1187
 
    @property
1188
 
    def control_transport(self):
1189
 
        # XXX: Normally you shouldn't directly get at the remote repository
1190
 
        # transport, but I'm not sure it's worth making this method
1191
 
        # optional -- mbp 2010-04-21
1192
 
        return self.bzrdir.get_repository_transport(None)
1193
 
 
1194
337
    def __str__(self):
1195
338
        return "%s(%s)" % (self.__class__.__name__, self.base)
1196
339
 
1198
341
 
1199
342
    def abort_write_group(self, suppress_errors=False):
1200
343
        """Complete a write group on the decorated repository.
1201
 
 
1202
 
        Smart methods perform operations in a single step so this API
 
344
        
 
345
        Smart methods peform operations in a single step so this api
1203
346
        is not really applicable except as a compatibility thunk
1204
347
        for older plugins that don't use e.g. the CommitBuilder
1205
348
        facility.
1206
349
 
1207
350
        :param suppress_errors: see Repository.abort_write_group.
1208
351
        """
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
1233
 
 
1234
 
    @property
1235
 
    def chk_bytes(self):
1236
 
        """Decorate the real repository for now.
1237
 
 
1238
 
        In the long term a full blown network facility is needed to avoid
1239
 
        creating a real repository object locally.
1240
 
        """
1241
352
        self._ensure_real()
1242
 
        return self._real_repository.chk_bytes
 
353
        return self._real_repository.abort_write_group(
 
354
            suppress_errors=suppress_errors)
1243
355
 
1244
356
    def commit_write_group(self):
1245
357
        """Complete a write group on the decorated repository.
1246
 
 
1247
 
        Smart methods perform operations in a single step so this API
 
358
        
 
359
        Smart methods peform operations in a single step so this api
1248
360
        is not really applicable except as a compatibility thunk
1249
361
        for older plugins that don't use e.g. the CommitBuilder
1250
362
        facility.
1251
363
        """
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()
1265
 
 
1266
 
    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
1279
 
 
1280
 
    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
1286
 
 
1287
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1288
 
        self._ensure_real()
1289
 
        return self._real_repository.get_missing_parent_inventories(
1290
 
            check_for_missing_texts=check_for_missing_texts)
1291
 
 
1292
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
1293
 
        self._ensure_real()
1294
 
        return self._real_repository.get_rev_id_for_revno(
1295
 
            revno, known_pair)
1296
 
 
1297
 
    def get_rev_id_for_revno(self, revno, known_pair):
1298
 
        """See Repository.get_rev_id_for_revno."""
1299
 
        path = self.bzrdir._path_for_remote_call(self._client)
1300
 
        try:
1301
 
            if self._client._medium._is_remote_before((1, 17)):
1302
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
1303
 
            response = self._call(
1304
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
1305
 
        except errors.UnknownSmartMethod:
1306
 
            self._client._medium._remember_remote_is_before((1, 17))
1307
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
1308
 
        if response[0] == 'ok':
1309
 
            return True, response[1]
1310
 
        elif response[0] == 'history-incomplete':
1311
 
            known_pair = response[1:3]
1312
 
            for fallback in self._fallback_repositories:
1313
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
1314
 
                if found:
1315
 
                    return True, result
1316
 
                else:
1317
 
                    known_pair = result
1318
 
            # Not found in any fallbacks
1319
 
            return False, known_pair
1320
 
        else:
1321
 
            raise errors.UnexpectedSmartServerResponse(response)
 
364
        self._ensure_real()
 
365
        return self._real_repository.commit_write_group()
1322
366
 
1323
367
    def _ensure_real(self):
1324
368
        """Ensure that there is a _real_repository set.
1325
369
 
1326
370
        Used before calls to self._real_repository.
1327
 
 
1328
 
        Note that _ensure_real causes many roundtrips to the server which are
1329
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
1330
 
        perform complex operations (such as accessing parent data, streaming
1331
 
        revisions etc). Adding calls to _ensure_real should only be done when
1332
 
        bringing up new functionality, adding fallbacks for smart methods that
1333
 
        require a fallback path, and never to replace an existing smart method
1334
 
        invocation. If in doubt chat to the bzr network team.
1335
371
        """
1336
372
        if self._real_repository is None:
1337
 
            if 'hpssvfs' in debug.debug_flags:
1338
 
                import traceback
1339
 
                warning('VFS Repository access triggered\n%s',
1340
 
                    ''.join(traceback.format_stack()))
1341
 
            self._unstacked_provider.missing_keys.clear()
1342
373
            self.bzrdir._ensure_real()
1343
374
            self._set_real_repository(
1344
375
                self.bzrdir._real_bzrdir.open_repository())
1349
380
    def find_text_key_references(self):
1350
381
        """Find the text key references within the repository.
1351
382
 
 
383
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
384
        revision_ids. Each altered file-ids has the exact revision_ids that
 
385
        altered it listed explicitly.
1352
386
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1353
387
            to whether they were referred to by the inventory of the
1354
388
            revision_id that they contain. The inventory texts from all present
1368
402
        self._ensure_real()
1369
403
        return self._real_repository._generate_text_key_index()
1370
404
 
 
405
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
406
    def get_revision_graph(self, revision_id=None):
 
407
        """See Repository.get_revision_graph()."""
 
408
        return self._get_revision_graph(revision_id)
 
409
 
1371
410
    def _get_revision_graph(self, revision_id):
1372
411
        """Private method for using with old (< 1.2) servers to fallback."""
1373
412
        if revision_id is None:
1374
413
            revision_id = ''
1375
 
        elif _mod_revision.is_null(revision_id):
 
414
        elif revision.is_null(revision_id):
1376
415
            return {}
1377
416
 
1378
417
        path = self.bzrdir._path_for_remote_call(self._client)
1390
429
        for line in lines:
1391
430
            d = tuple(line.split())
1392
431
            revision_graph[d[0]] = d[1:]
1393
 
 
 
432
            
1394
433
        return revision_graph
1395
434
 
1396
 
    def _get_sink(self):
1397
 
        """See Repository._get_sink()."""
1398
 
        return RemoteStreamSink(self)
1399
 
 
1400
 
    def _get_source(self, to_format):
1401
 
        """Return a source for streaming from this repository."""
1402
 
        return RemoteStreamSource(self, to_format)
1403
 
 
1404
 
    @needs_read_lock
1405
 
    def get_file_graph(self):
1406
 
        return graph.Graph(self.texts)
1407
 
 
1408
 
    @needs_read_lock
1409
435
    def has_revision(self, revision_id):
1410
 
        """True if this repository has a copy of the revision."""
1411
 
        # Copy of bzrlib.repository.Repository.has_revision
1412
 
        return revision_id in self.has_revisions((revision_id,))
 
436
        """See Repository.has_revision()."""
 
437
        if revision_id == NULL_REVISION:
 
438
            # The null revision is always present.
 
439
            return True
 
440
        path = self.bzrdir._path_for_remote_call(self._client)
 
441
        response = self._call('Repository.has_revision', path, revision_id)
 
442
        if response[0] not in ('yes', 'no'):
 
443
            raise errors.UnexpectedSmartServerResponse(response)
 
444
        if response[0] == 'yes':
 
445
            return True
 
446
        for fallback_repo in self._fallback_repositories:
 
447
            if fallback_repo.has_revision(revision_id):
 
448
                return True
 
449
        return False
1413
450
 
1414
 
    @needs_read_lock
1415
451
    def has_revisions(self, revision_ids):
1416
 
        """Probe to find out the presence of multiple revisions.
1417
 
 
1418
 
        :param revision_ids: An iterable of revision_ids.
1419
 
        :return: A set of the revision_ids that were present.
1420
 
        """
1421
 
        # Copy of bzrlib.repository.Repository.has_revisions
1422
 
        parent_map = self.get_parent_map(revision_ids)
1423
 
        result = set(parent_map)
1424
 
        if _mod_revision.NULL_REVISION in revision_ids:
1425
 
            result.add(_mod_revision.NULL_REVISION)
 
452
        """See Repository.has_revisions()."""
 
453
        # FIXME: This does many roundtrips, particularly when there are
 
454
        # fallback repositories.  -- mbp 20080905
 
455
        result = set()
 
456
        for revision_id in revision_ids:
 
457
            if self.has_revision(revision_id):
 
458
                result.add(revision_id)
1426
459
        return result
1427
460
 
1428
 
    def _has_same_fallbacks(self, other_repo):
1429
 
        """Returns true if the repositories have the same fallbacks."""
1430
 
        # XXX: copied from Repository; it should be unified into a base class
1431
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
1432
 
        my_fb = self._fallback_repositories
1433
 
        other_fb = other_repo._fallback_repositories
1434
 
        if len(my_fb) != len(other_fb):
1435
 
            return False
1436
 
        for f, g in zip(my_fb, other_fb):
1437
 
            if not f.has_same_location(g):
1438
 
                return False
1439
 
        return True
1440
 
 
1441
461
    def has_same_location(self, other):
1442
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
1443
 
        # one; unfortunately the tests rely on slightly different behaviour at
1444
 
        # present -- mbp 20090710
1445
 
        return (self.__class__ is other.__class__ and
 
462
        return (self.__class__ == other.__class__ and
1446
463
                self.bzrdir.transport.base == other.bzrdir.transport.base)
1447
464
 
1448
465
    def get_graph(self, other_repository=None):
1450
467
        parents_provider = self._make_parents_provider(other_repository)
1451
468
        return graph.Graph(parents_provider)
1452
469
 
1453
 
    @needs_read_lock
1454
 
    def get_known_graph_ancestry(self, revision_ids):
1455
 
        """Return the known graph for a set of revision ids and their ancestors.
1456
 
        """
1457
 
        st = static_tuple.StaticTuple
1458
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
1459
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1460
 
        return graph.GraphThunkIdsToKeys(known_graph)
1461
 
 
1462
470
    def gather_stats(self, revid=None, committers=None):
1463
471
        """See Repository.gather_stats()."""
1464
472
        path = self.bzrdir._path_for_remote_call(self._client)
1465
473
        # revid can be None to indicate no revisions, not just NULL_REVISION
1466
 
        if revid is None or _mod_revision.is_null(revid):
 
474
        if revid is None or revision.is_null(revid):
1467
475
            fmt_revid = ''
1468
476
        else:
1469
477
            fmt_revid = revid
1498
506
 
1499
507
    def get_physical_lock_status(self):
1500
508
        """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')
 
509
        # should be an API call to the server.
 
510
        self._ensure_real()
 
511
        return self._real_repository.get_physical_lock_status()
1510
512
 
1511
513
    def is_in_write_group(self):
1512
514
        """Return True if there is an open write group.
1513
515
 
1514
516
        write groups are only applicable locally for the smart server..
1515
517
        """
1516
 
        if self._write_group_tokens is not None:
1517
 
            return True
1518
518
        if self._real_repository:
1519
519
            return self._real_repository.is_in_write_group()
1520
520
 
1532
532
    def is_write_locked(self):
1533
533
        return self._lock_mode == 'w'
1534
534
 
1535
 
    def _warn_if_deprecated(self, branch=None):
1536
 
        # If we have a real repository, the check will be done there, if we
1537
 
        # don't the check will be done remotely.
1538
 
        pass
1539
 
 
1540
535
    def lock_read(self):
1541
 
        """Lock the repository for read operations.
1542
 
 
1543
 
        :return: A bzrlib.lock.LogicalLockResult.
1544
 
        """
1545
536
        # wrong eventually - want a local lock cache context
1546
537
        if not self._lock_mode:
1547
 
            self._note_lock('r')
1548
538
            self._lock_mode = 'r'
1549
539
            self._lock_count = 1
1550
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
540
            self._unstacked_provider.enable_cache(cache_misses=False)
1551
541
            if self._real_repository is not None:
1552
542
                self._real_repository.lock_read()
1553
 
            for repo in self._fallback_repositories:
1554
 
                repo.lock_read()
1555
543
        else:
1556
544
            self._lock_count += 1
1557
 
        return lock.LogicalLockResult(self.unlock)
1558
545
 
1559
546
    def _remote_lock_write(self, token):
1560
547
        path = self.bzrdir._path_for_remote_call(self._client)
1571
558
 
1572
559
    def lock_write(self, token=None, _skip_rpc=False):
1573
560
        if not self._lock_mode:
1574
 
            self._note_lock('w')
1575
561
            if _skip_rpc:
1576
562
                if self._lock_token is not None:
1577
563
                    if token != self._lock_token:
1591
577
                self._leave_lock = False
1592
578
            self._lock_mode = 'w'
1593
579
            self._lock_count = 1
1594
 
            cache_misses = self._real_repository is None
1595
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1596
 
            for repo in self._fallback_repositories:
1597
 
                # Writes don't affect fallback repos
1598
 
                repo.lock_read()
 
580
            self._unstacked_provider.enable_cache(cache_misses=False)
1599
581
        elif self._lock_mode == 'r':
1600
582
            raise errors.ReadOnlyError(self)
1601
583
        else:
1602
584
            self._lock_count += 1
1603
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
585
        return self._lock_token or None
1604
586
 
1605
587
    def leave_lock_in_place(self):
1606
588
        if not self._lock_token:
1619
601
            implemented operations.
1620
602
        """
1621
603
        if self._real_repository is not None:
1622
 
            # Replacing an already set real repository.
1623
 
            # We cannot do this [currently] if the repository is locked -
1624
 
            # synchronised state might be lost.
1625
 
            if self.is_locked():
1626
 
                raise AssertionError('_real_repository is already set')
 
604
            raise AssertionError('_real_repository is already set')
1627
605
        if isinstance(repository, RemoteRepository):
1628
606
            raise AssertionError()
1629
607
        self._real_repository = repository
1630
 
        # three code paths happen here:
1631
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1632
 
        # up stacking. In this case self._fallback_repositories is [], and the
1633
 
        # real repo is already setup. Preserve the real repo and
1634
 
        # RemoteRepository.add_fallback_repository will avoid adding
1635
 
        # duplicates.
1636
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1637
 
        # ensure_real is triggered from a branch, the real repository to
1638
 
        # set already has a matching list with separate instances, but
1639
 
        # as they are also RemoteRepositories we don't worry about making the
1640
 
        # lists be identical.
1641
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1642
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1643
 
        # and need to populate it.
1644
 
        if (self._fallback_repositories and
1645
 
            len(self._real_repository._fallback_repositories) !=
1646
 
            len(self._fallback_repositories)):
1647
 
            if len(self._real_repository._fallback_repositories):
1648
 
                raise AssertionError(
1649
 
                    "cannot cleanly remove existing _fallback_repositories")
1650
608
        for fb in self._fallback_repositories:
1651
609
            self._real_repository.add_fallback_repository(fb)
1652
610
        if self._lock_mode == 'w':
1655
613
            self._real_repository.lock_write(self._lock_token)
1656
614
        elif self._lock_mode == 'r':
1657
615
            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
616
 
1663
617
    def start_write_group(self):
1664
618
        """Start a write group on the decorated repository.
1665
 
 
1666
 
        Smart methods perform operations in a single step so this API
 
619
        
 
620
        Smart methods peform operations in a single step so this api
1667
621
        is not really applicable except as a compatibility thunk
1668
622
        for older plugins that don't use e.g. the CommitBuilder
1669
623
        facility.
1670
624
        """
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]
 
625
        self._ensure_real()
 
626
        return self._real_repository.start_write_group()
1688
627
 
1689
628
    def _unlock(self, token):
1690
629
        path = self.bzrdir._path_for_remote_call(self._client)
1699
638
        else:
1700
639
            raise errors.UnexpectedSmartServerResponse(response)
1701
640
 
1702
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1703
641
    def unlock(self):
1704
 
        if not self._lock_count:
1705
 
            return lock.cant_unlock_not_held(self)
1706
642
        self._lock_count -= 1
1707
643
        if self._lock_count > 0:
1708
644
            return
1717
653
            # This is just to let the _real_repository stay up to date.
1718
654
            if self._real_repository is not None:
1719
655
                self._real_repository.unlock()
1720
 
            elif self._write_group_tokens is not None:
1721
 
                self.abort_write_group()
1722
656
        finally:
1723
657
            # The rpc-level lock should be released even if there was a
1724
658
            # problem releasing the vfs-based lock.
1725
659
            if old_mode == 'w':
1726
660
                # Only write-locked repositories need to make a remote method
1727
 
                # call to perform the unlock.
 
661
                # call to perfom the unlock.
1728
662
                old_token = self._lock_token
1729
663
                self._lock_token = None
1730
664
                if not self._leave_lock:
1731
665
                    self._unlock(old_token)
1732
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1733
 
        # self._leave_lock
1734
 
        for repo in self._fallback_repositories:
1735
 
            repo.unlock()
1736
666
 
1737
667
    def break_lock(self):
1738
668
        # 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)
 
669
        self._ensure_real()
 
670
        return self._real_repository.break_lock()
1747
671
 
1748
672
    def _get_tarball(self, compression):
1749
673
        """Return a TemporaryFile containing a repository tarball.
1750
 
 
 
674
        
1751
675
        Returns None if the server does not support sending tarballs.
1752
676
        """
1753
677
        import tempfile
1767
691
            return t
1768
692
        raise errors.UnexpectedSmartServerResponse(response)
1769
693
 
1770
 
    @needs_read_lock
1771
694
    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)
 
695
        # TODO: Option to control what format is created?
 
696
        self._ensure_real()
 
697
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
698
                                                             shared=False)
1777
699
        dest_repo.fetch(self, revision_id=revision_id)
1778
700
        return dest_repo
1779
701
 
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
702
    ### These methods are just thin shims to the VFS object for now.
1794
703
 
1795
 
    @needs_read_lock
1796
704
    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]
 
705
        self._ensure_real()
 
706
        return self._real_repository.revision_tree(revision_id)
1803
707
 
1804
708
    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]
 
709
        self._ensure_real()
 
710
        return self._real_repository.get_serializer_format()
1815
711
 
1816
712
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1817
713
                           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
 
714
                           revision_id=None):
 
715
        # FIXME: It ought to be possible to call this without immediately
 
716
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
717
        self._ensure_real()
 
718
        real_repo = self._real_repository
 
719
        builder = real_repo.get_commit_builder(branch, parents,
 
720
                config, timestamp=timestamp, timezone=timezone,
 
721
                committer=committer, revprops=revprops, revision_id=revision_id)
 
722
        return builder
1845
723
 
1846
724
    def add_fallback_repository(self, repository):
1847
725
        """Add a repository to use for looking up data not held locally.
1848
 
 
 
726
        
1849
727
        :param repository: A repository.
1850
728
        """
1851
 
        if not self._format.supports_external_lookups:
1852
 
            raise errors.UnstackableRepositoryFormat(
1853
 
                self._format.network_name(), self.base)
 
729
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
730
        # unconditionally - however, a _real_repository will usually exist,
 
731
        # and may raise an error if it's not accommodated by the underlying
 
732
        # format.  Eventually we should check when opening the repository
 
733
        # whether it's willing to allow them or not.
 
734
        #
1854
735
        # We need to accumulate additional repositories here, to pass them in
1855
736
        # on various RPC's.
1856
 
        #
1857
 
        # Make the check before we lock: this raises an exception.
1858
 
        self._check_fallback_repository(repository)
1859
 
        if self.is_locked():
1860
 
            # We will call fallback.unlock() when we transition to the unlocked
1861
 
            # state, so always add a lock here. If a caller passes us a locked
1862
 
            # repository, they are responsible for unlocking it later.
1863
 
            repository.lock_read()
1864
737
        self._fallback_repositories.append(repository)
1865
 
        # If self._real_repository was parameterised already (e.g. because a
1866
 
        # _real_branch had its get_stacked_on_url method called), then the
1867
 
        # repository to be added may already be in the _real_repositories list.
1868
 
        if self._real_repository is not None:
1869
 
            fallback_locations = [repo.user_url for repo in
1870
 
                self._real_repository._fallback_repositories]
1871
 
            if repository.user_url not in fallback_locations:
1872
 
                self._real_repository.add_fallback_repository(repository)
1873
 
 
1874
 
    def _check_fallback_repository(self, repository):
1875
 
        """Check that this repository can fallback to repository safely.
1876
 
 
1877
 
        Raise an error if not.
1878
 
 
1879
 
        :param repository: A repository to fallback to.
1880
 
        """
1881
 
        return _mod_repository.InterRepository._assert_same_model(
1882
 
            self, repository)
 
738
        # They are also seen by the fallback repository.  If it doesn't exist
 
739
        # yet they'll be added then.  This implicitly copies them.
 
740
        self._ensure_real()
1883
741
 
1884
742
    def add_inventory(self, revid, inv, parents):
1885
743
        self._ensure_real()
1886
744
        return self._real_repository.add_inventory(revid, inv, parents)
1887
745
 
1888
746
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1889
 
            parents, basis_inv=None, propagate_caches=False):
 
747
                               parents):
1890
748
        self._ensure_real()
1891
749
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1892
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1893
 
            propagate_caches=propagate_caches)
1894
 
 
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)
 
750
            delta, new_revision_id, parents)
 
751
 
 
752
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
753
        self._ensure_real()
 
754
        return self._real_repository.add_revision(
 
755
            rev_id, rev, inv=inv, config=config)
1920
756
 
1921
757
    @needs_read_lock
1922
758
    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
 
        self._ensure_real()
1967
 
        return self._real_repository._iter_inventories(revision_ids, ordering)
1968
 
 
1969
 
    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()
 
759
        self._ensure_real()
 
760
        return self._real_repository.get_inventory(revision_id)
 
761
 
 
762
    def iter_inventories(self, revision_ids):
 
763
        self._ensure_real()
 
764
        return self._real_repository.iter_inventories(revision_ids)
2044
765
 
2045
766
    @needs_read_lock
2046
767
    def get_revision(self, revision_id):
2047
 
        return self.get_revisions([revision_id])[0]
 
768
        self._ensure_real()
 
769
        return self._real_repository.get_revision(revision_id)
2048
770
 
2049
771
    def get_transaction(self):
2050
772
        self._ensure_real()
2052
774
 
2053
775
    @needs_read_lock
2054
776
    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
 
777
        self._ensure_real()
 
778
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2059
779
 
2060
780
    def make_working_trees(self):
2061
781
        """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'
2071
 
 
2072
 
    def refresh_data(self):
2073
 
        """Re-read any data needed to synchronise with disk.
2074
 
 
2075
 
        This method is intended to be called after another repository instance
2076
 
        (such as one used by a smart server) has inserted data into the
2077
 
        repository. On all repositories this will work outside of write groups.
2078
 
        Some repository formats (pack and newer for bzrlib native formats)
2079
 
        support refresh_data inside write groups. If called inside a write
2080
 
        group on a repository that does not support refreshing in a write group
2081
 
        IsInWriteGroupError will be raised.
2082
 
        """
2083
 
        if self._real_repository is not None:
2084
 
            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()
 
782
        self._ensure_real()
 
783
        return self._real_repository.make_working_trees()
2088
784
 
2089
785
    def revision_ids_to_search_result(self, result_set):
2090
786
        """Convert a set of revision ids to a graph SearchResult."""
2095
791
        included_keys = result_set.intersection(result_parents)
2096
792
        start_keys = result_set.difference(included_keys)
2097
793
        exclude_keys = result_parents.difference(result_set)
2098
 
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
794
        result = graph.SearchResult(start_keys, exclude_keys,
2099
795
            len(result_set), result_set)
2100
796
        return result
2101
797
 
2102
798
    @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):
 
799
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
2107
800
        """Return the revision ids that other has that this does not.
2108
 
 
 
801
        
2109
802
        These are returned in topological order.
2110
803
 
2111
804
        revision_id: only return revision ids included by revision_id.
2112
805
        """
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)
 
806
        return repository.InterRepository.get(
 
807
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
2127
808
 
2128
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
2129
 
            fetch_spec=None):
2130
 
        # No base implementation to use as RemoteRepository is not a subclass
2131
 
        # of Repository; so this is a copy of Repository.fetch().
2132
 
        if fetch_spec is not None and revision_id is not None:
2133
 
            raise AssertionError(
2134
 
                "fetch_spec and revision_id are mutually exclusive.")
2135
 
        if self.is_in_write_group():
2136
 
            raise errors.InternalBzrError(
2137
 
                "May not fetch while in a write group.")
2138
 
        # fast path same-url fetch operations
2139
 
        if (self.has_same_location(source)
2140
 
            and fetch_spec is None
2141
 
            and self._has_same_fallbacks(source)):
 
809
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
810
        # Not delegated to _real_repository so that InterRepository.get has a
 
811
        # chance to find an InterRepository specialised for RemoteRepository.
 
812
        if self.has_same_location(source):
2142
813
            # check that last_revision is in 'from' and then return a
2143
814
            # no-operation.
2144
815
            if (revision_id is not None and
2145
 
                not _mod_revision.is_null(revision_id)):
 
816
                not revision.is_null(revision_id)):
2146
817
                self.get_revision(revision_id)
2147
818
            return 0, []
2148
 
        # if there is no specific appropriate InterRepository, this will get
2149
 
        # the InterRepository base class, which raises an
2150
 
        # 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,
2157
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
819
        inter = repository.InterRepository.get(source, self)
 
820
        try:
 
821
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
822
        except NotImplementedError:
 
823
            raise errors.IncompatibleRepositories(source, self)
2158
824
 
2159
825
    def create_bundle(self, target, base, fileobj, format=None):
2160
826
        self._ensure_real()
2161
827
        self._real_repository.create_bundle(target, base, fileobj, format)
2162
828
 
 
829
    @needs_read_lock
 
830
    def get_ancestry(self, revision_id, topo_sorted=True):
 
831
        self._ensure_real()
 
832
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
833
 
2163
834
    def fileids_altered_by_revision_ids(self, revision_ids):
2164
835
        self._ensure_real()
2165
836
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
2168
839
        self._ensure_real()
2169
840
        return self._real_repository._get_versioned_file_checker(
2170
841
            revisions, revision_versions_cache)
2171
 
 
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
 
 
 
842
        
2218
843
    def iter_files_bytes(self, desired_files):
2219
844
        """See Repository.iter_file_bytes.
2220
845
        """
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)
 
846
        self._ensure_real()
 
847
        return self._real_repository.iter_files_bytes(desired_files)
 
848
 
 
849
    @property
 
850
    def _fetch_order(self):
 
851
        """Decorate the real repository for now.
 
852
 
 
853
        In the long term getting this back from the remote repository as part
 
854
        of open would be more efficient.
 
855
        """
 
856
        self._ensure_real()
 
857
        return self._real_repository._fetch_order
 
858
 
 
859
    @property
 
860
    def _fetch_uses_deltas(self):
 
861
        """Decorate the real repository for now.
 
862
 
 
863
        In the long term getting this back from the remote repository as part
 
864
        of open would be more efficient.
 
865
        """
 
866
        self._ensure_real()
 
867
        return self._real_repository._fetch_uses_deltas
 
868
 
 
869
    @property
 
870
    def _fetch_reconcile(self):
 
871
        """Decorate the real repository for now.
 
872
 
 
873
        In the long term getting this back from the remote repository as part
 
874
        of open would be more efficient.
 
875
        """
 
876
        self._ensure_real()
 
877
        return self._real_repository._fetch_reconcile
2250
878
 
2251
879
    def get_parent_map(self, revision_ids):
2252
880
        """See bzrlib.Graph.get_parent_map()."""
2259
887
            # We already found out that the server can't understand
2260
888
            # Repository.get_parent_map requests, so just fetch the whole
2261
889
            # graph.
2262
 
            #
2263
 
            # Note that this reads the whole graph, when only some keys are
2264
 
            # wanted.  On this old server there's no way (?) to get them all
2265
 
            # in one go, and the user probably will have seen a warning about
2266
 
            # the server being old anyhow.
2267
 
            rg = self._get_revision_graph(None)
2268
 
            # There is an API discrepancy between get_parent_map and
 
890
            # XXX: Note that this will issue a deprecation warning. This is ok
 
891
            # :- its because we're working with a deprecated server anyway, and
 
892
            # the user will almost certainly have seen a warning about the
 
893
            # server version already.
 
894
            rg = self.get_revision_graph()
 
895
            # There is an api discrepency between get_parent_map and
2269
896
            # get_revision_graph. Specifically, a "key:()" pair in
2270
897
            # get_revision_graph just means a node has no parents. For
2271
898
            # "get_parent_map" it means the node is a ghost. So fix up the
2301
928
        # TODO: Manage this incrementally to avoid covering the same path
2302
929
        # repeatedly. (The server will have to on each request, but the less
2303
930
        # work done the better).
2304
 
        #
2305
 
        # Negative caching notes:
2306
 
        # new server sends missing when a request including the revid
2307
 
        # 'include-missing:' is present in the request.
2308
 
        # missing keys are serialised as missing:X, and we then call
2309
 
        # provider.note_missing(X) for-all X
2310
931
        parents_map = self._unstacked_provider.get_cached_map()
2311
932
        if parents_map is None:
2312
933
            # Repository is not locked, so there's no cache.
2313
934
            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)
2323
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
935
        start_set = set(parents_map)
 
936
        result_parents = set()
 
937
        for parents in parents_map.itervalues():
 
938
            result_parents.update(parents)
 
939
        stop_keys = result_parents.difference(start_set)
 
940
        included_keys = start_set.intersection(result_parents)
 
941
        start_set.difference_update(included_keys)
 
942
        recipe = (start_set, stop_keys, len(parents_map))
2324
943
        body = self._serialise_search_recipe(recipe)
2325
944
        path = self.bzrdir._path_for_remote_call(self._client)
2326
945
        for key in keys:
2328
947
                raise ValueError(
2329
948
                    "key %r not a plain string" % (key,))
2330
949
        verb = 'Repository.get_parent_map'
2331
 
        args = (path, 'include-missing:') + tuple(keys)
 
950
        args = (path,) + tuple(keys)
2332
951
        try:
2333
952
            response = self._call_with_body_bytes_expecting_body(
2334
953
                verb, args, body)
2344
963
            # To avoid having to disconnect repeatedly, we keep track of the
2345
964
            # fact the server doesn't understand remote methods added in 1.2.
2346
965
            medium._remember_remote_is_before((1, 2))
2347
 
            # Recurse just once and we should use the fallback code.
2348
 
            return self._get_parent_map_rpc(keys)
 
966
            return self.get_revision_graph(None)
2349
967
        response_tuple, response_handler = response
2350
968
        if response_tuple[0] not in ['ok']:
2351
969
            response_handler.cancel_read_body()
2362
980
                if len(d) > 1:
2363
981
                    revision_graph[d[0]] = d[1:]
2364
982
                else:
2365
 
                    # No parents:
2366
 
                    if d[0].startswith('missing:'):
2367
 
                        revid = d[0][8:]
2368
 
                        self._unstacked_provider.note_missing_key(revid)
2369
 
                    else:
2370
 
                        # no parents - so give the Graph result
2371
 
                        # (NULL_REVISION,).
2372
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
983
                    # No parents - so give the Graph result (NULL_REVISION,).
 
984
                    revision_graph[d[0]] = (NULL_REVISION,)
2373
985
            return revision_graph
2374
986
 
2375
987
    @needs_read_lock
2376
988
    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()
2395
 
 
2396
 
    @needs_read_lock
2397
 
    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
 
        self._ensure_real()
2401
 
        return self._real_repository._get_inventory_xml(revision_id)
2402
 
 
2403
 
    @needs_write_lock
 
989
        self._ensure_real()
 
990
        return self._real_repository.get_signature_text(revision_id)
 
991
 
 
992
    @needs_read_lock
 
993
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
994
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
995
        self._ensure_real()
 
996
        return self._real_repository.get_revision_graph_with_ghosts(
 
997
            revision_ids=revision_ids)
 
998
 
 
999
    @needs_read_lock
 
1000
    def get_inventory_xml(self, revision_id):
 
1001
        self._ensure_real()
 
1002
        return self._real_repository.get_inventory_xml(revision_id)
 
1003
 
 
1004
    def deserialise_inventory(self, revision_id, xml):
 
1005
        self._ensure_real()
 
1006
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
1007
 
2404
1008
    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
2428
 
 
 
1009
        self._ensure_real()
 
1010
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
1011
        
2429
1012
    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)
2459
 
 
2460
 
    @needs_read_lock
2461
 
    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)
2496
 
 
2497
 
    @needs_read_lock
2498
 
    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]
 
1013
        self._ensure_real()
 
1014
        return self._real_repository.all_revision_ids()
 
1015
    
 
1016
    @needs_read_lock
 
1017
    def get_deltas_for_revisions(self, revisions):
 
1018
        self._ensure_real()
 
1019
        return self._real_repository.get_deltas_for_revisions(revisions)
 
1020
 
 
1021
    @needs_read_lock
 
1022
    def get_revision_delta(self, revision_id):
 
1023
        self._ensure_real()
 
1024
        return self._real_repository.get_revision_delta(revision_id)
2502
1025
 
2503
1026
    @needs_read_lock
2504
1027
    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)
 
1028
        self._ensure_real()
 
1029
        return self._real_repository.revision_trees(revision_ids)
2508
1030
 
2509
1031
    @needs_read_lock
2510
1032
    def get_revision_reconcile(self, revision_id):
2512
1034
        return self._real_repository.get_revision_reconcile(revision_id)
2513
1035
 
2514
1036
    @needs_read_lock
2515
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1037
    def check(self, revision_ids=None):
2516
1038
        self._ensure_real()
2517
 
        return self._real_repository.check(revision_ids=revision_ids,
2518
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1039
        return self._real_repository.check(revision_ids=revision_ids)
2519
1040
 
2520
1041
    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)
 
1042
        self._ensure_real()
 
1043
        return self._real_repository.copy_content_into(
 
1044
            destination, revision_id=revision_id)
2528
1045
 
2529
1046
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
2530
1047
        # get a tarball of the remote repository, and copy from that into the
2531
1048
        # destination
 
1049
        from bzrlib import osutils
2532
1050
        import tarfile
2533
1051
        # TODO: Maybe a progress bar while streaming the tarball?
2534
 
        note(gettext("Copying repository content as tarball..."))
 
1052
        note("Copying repository content as tarball...")
2535
1053
        tar_file = self._get_tarball('bz2')
2536
1054
        if tar_file is None:
2537
1055
            return None
2542
1060
            tmpdir = osutils.mkdtemp()
2543
1061
            try:
2544
1062
                _extract_tar(tar, tmpdir)
2545
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1063
                tmp_bzrdir = BzrDir.open(tmpdir)
2546
1064
                tmp_repo = tmp_bzrdir.open_repository()
2547
1065
                tmp_repo.copy_content_into(destination, revision_id)
2548
1066
            finally:
2564
1082
        return self._real_repository.inventories
2565
1083
 
2566
1084
    @needs_write_lock
2567
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1085
    def pack(self):
2568
1086
        """Compress the data within the repository.
 
1087
 
 
1088
        This is not currently implemented within the smart server.
2569
1089
        """
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)
 
1090
        self._ensure_real()
 
1091
        return self._real_repository.pack()
2586
1092
 
2587
1093
    @property
2588
1094
    def revisions(self):
2589
1095
        """Decorate the real repository for now.
2590
1096
 
 
1097
        In the short term this should become a real object to intercept graph
 
1098
        lookups.
 
1099
 
2591
1100
        In the long term a full blown network facility is needed.
2592
1101
        """
2593
1102
        self._ensure_real()
2594
1103
        return self._real_repository.revisions
2595
1104
 
2596
1105
    def set_make_working_trees(self, new_value):
2597
 
        if new_value:
2598
 
            new_value_str = "True"
2599
 
        else:
2600
 
            new_value_str = "False"
2601
 
        path = self.bzrdir._path_for_remote_call(self._client)
2602
 
        try:
2603
 
            response = self._call(
2604
 
                'Repository.set_make_working_trees', path, new_value_str)
2605
 
        except errors.UnknownSmartMethod:
2606
 
            self._ensure_real()
2607
 
            self._real_repository.set_make_working_trees(new_value)
2608
 
        else:
2609
 
            if response[0] != 'ok':
2610
 
                raise errors.UnexpectedSmartServerResponse(response)
 
1106
        self._ensure_real()
 
1107
        self._real_repository.set_make_working_trees(new_value)
2611
1108
 
2612
1109
    @property
2613
1110
    def signatures(self):
2621
1118
 
2622
1119
    @needs_write_lock
2623
1120
    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)
 
1121
        self._ensure_real()
 
1122
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
2627
1123
 
2628
1124
    @property
2629
1125
    def texts(self):
2635
1131
        self._ensure_real()
2636
1132
        return self._real_repository.texts
2637
1133
 
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
1134
    @needs_read_lock
2665
1135
    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]
 
1136
        self._ensure_real()
 
1137
        return self._real_repository.get_revisions(revision_ids)
2701
1138
 
2702
1139
    def supports_rich_root(self):
2703
 
        return self._format.rich_root_data
 
1140
        self._ensure_real()
 
1141
        return self._real_repository.supports_rich_root()
 
1142
 
 
1143
    def iter_reverse_revision_history(self, revision_id):
 
1144
        self._ensure_real()
 
1145
        return self._real_repository.iter_reverse_revision_history(revision_id)
2704
1146
 
2705
1147
    @property
2706
1148
    def _serializer(self):
2707
 
        return self._format._serializer
 
1149
        self._ensure_real()
 
1150
        return self._real_repository._serializer
2708
1151
 
2709
 
    @needs_write_lock
2710
1152
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2711
 
        signature = gpg_strategy.sign(plaintext)
2712
 
        self.add_signature_text(revision_id, signature)
 
1153
        self._ensure_real()
 
1154
        return self._real_repository.store_revision_signature(
 
1155
            gpg_strategy, plaintext, revision_id)
2713
1156
 
2714
1157
    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:]
 
1158
        self._ensure_real()
 
1159
        return self._real_repository.add_signature_text(revision_id, signature)
2730
1160
 
2731
1161
    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)
 
1162
        self._ensure_real()
 
1163
        return self._real_repository.has_signature_for_revision_id(revision_id)
2759
1164
 
2760
1165
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2761
1166
        self._ensure_real()
2762
1167
        return self._real_repository.item_keys_introduced_by(revision_ids,
2763
1168
            _files_pb=_files_pb)
2764
1169
 
2765
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2766
 
        self._ensure_real()
2767
 
        return self._real_repository._find_inconsistent_revision_parents(
2768
 
            revisions_iterator)
 
1170
    def revision_graph_can_have_wrong_parents(self):
 
1171
        # The answer depends on the remote repo format.
 
1172
        self._ensure_real()
 
1173
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1174
 
 
1175
    def _find_inconsistent_revision_parents(self):
 
1176
        self._ensure_real()
 
1177
        return self._real_repository._find_inconsistent_revision_parents()
2769
1178
 
2770
1179
    def _check_for_inconsistent_revision_parents(self):
2771
1180
        self._ensure_real()
2775
1184
        providers = [self._unstacked_provider]
2776
1185
        if other is not None:
2777
1186
            providers.insert(0, other)
2778
 
        return graph.StackedParentsProvider(_LazyListJoin(
2779
 
            providers, self._fallback_repositories))
 
1187
        providers.extend(r._make_parents_provider() for r in
 
1188
                         self._fallback_repositories)
 
1189
        return graph._StackedParentsProvider(providers)
2780
1190
 
2781
1191
    def _serialise_search_recipe(self, recipe):
2782
1192
        """Serialise a graph search recipe.
2784
1194
        :param recipe: A search recipe (start, stop, count).
2785
1195
        :return: Serialised bytes.
2786
1196
        """
2787
 
        start_keys = ' '.join(recipe[1])
2788
 
        stop_keys = ' '.join(recipe[2])
2789
 
        count = str(recipe[3])
 
1197
        start_keys = ' '.join(recipe[0])
 
1198
        stop_keys = ' '.join(recipe[1])
 
1199
        count = str(recipe[2])
2790
1200
        return '\n'.join((start_keys, stop_keys, count))
2791
1201
 
2792
 
    def _serialise_search_result(self, search_result):
2793
 
        parts = search_result.get_network_struct()
2794
 
        return '\n'.join(parts)
2795
 
 
2796
1202
    def autopack(self):
2797
1203
        path = self.bzrdir._path_for_remote_call(self._client)
2798
1204
        try:
2801
1207
            self._ensure_real()
2802
1208
            self._real_repository._pack_collection.autopack()
2803
1209
            return
2804
 
        self.refresh_data()
 
1210
        if self._real_repository is not None:
 
1211
            # Reset the real repository's cache of pack names.
 
1212
            # XXX: At some point we may be able to skip this and just rely on
 
1213
            # the automatic retry logic to do the right thing, but for now we
 
1214
            # err on the side of being correct rather than being optimal.
 
1215
            self._real_repository._pack_collection.reload_pack_names()
2805
1216
        if response[0] != 'ok':
2806
1217
            raise errors.UnexpectedSmartServerResponse(response)
2807
1218
 
2808
1219
 
2809
 
class RemoteStreamSink(vf_repository.StreamSink):
2810
 
 
2811
 
    def _insert_real(self, stream, src_format, resume_tokens):
2812
 
        self.target_repo._ensure_real()
2813
 
        sink = self.target_repo._real_repository._get_sink()
2814
 
        result = sink.insert_stream(stream, src_format, resume_tokens)
2815
 
        if not result:
2816
 
            self.target_repo.autopack()
2817
 
        return result
2818
 
 
2819
 
    def insert_stream(self, stream, src_format, resume_tokens):
2820
 
        target = self.target_repo
2821
 
        target._unstacked_provider.missing_keys.clear()
2822
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2823
 
        if target._lock_token:
2824
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2825
 
            lock_args = (target._lock_token or '',)
2826
 
        else:
2827
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
2828
 
            lock_args = ()
2829
 
        client = target._client
2830
 
        medium = client._medium
2831
 
        path = target.bzrdir._path_for_remote_call(client)
2832
 
        # Probe for the verb to use with an empty stream before sending the
2833
 
        # real stream to it.  We do this both to avoid the risk of sending a
2834
 
        # large request that is then rejected, and because we don't want to
2835
 
        # implement a way to buffer, rewind, or restart the stream.
2836
 
        found_verb = False
2837
 
        for verb, required_version in candidate_calls:
2838
 
            if medium._is_remote_before(required_version):
2839
 
                continue
2840
 
            if resume_tokens:
2841
 
                # We've already done the probing (and set _is_remote_before) on
2842
 
                # a previous insert.
2843
 
                found_verb = True
2844
 
                break
2845
 
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2846
 
            try:
2847
 
                response = client.call_with_body_stream(
2848
 
                    (verb, path, '') + lock_args, byte_stream)
2849
 
            except errors.UnknownSmartMethod:
2850
 
                medium._remember_remote_is_before(required_version)
2851
 
            else:
2852
 
                found_verb = True
2853
 
                break
2854
 
        if not found_verb:
2855
 
            # Have to use VFS.
2856
 
            return self._insert_real(stream, src_format, resume_tokens)
2857
 
        self._last_inv_record = None
2858
 
        self._last_substream = None
2859
 
        if required_version < (1, 19):
2860
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
2861
 
            # make sure we don't send any.  If the stream contains inventory
2862
 
            # deltas we'll interrupt the smart insert_stream request and
2863
 
            # fallback to VFS.
2864
 
            stream = self._stop_stream_if_inventory_delta(stream)
2865
 
        byte_stream = smart_repo._stream_to_byte_stream(
2866
 
            stream, src_format)
2867
 
        resume_tokens = ' '.join(resume_tokens)
2868
 
        response = client.call_with_body_stream(
2869
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
2870
 
        if response[0][0] not in ('ok', 'missing-basis'):
2871
 
            raise errors.UnexpectedSmartServerResponse(response)
2872
 
        if self._last_substream is not None:
2873
 
            # The stream included an inventory-delta record, but the remote
2874
 
            # side isn't new enough to support them.  So we need to send the
2875
 
            # rest of the stream via VFS.
2876
 
            self.target_repo.refresh_data()
2877
 
            return self._resume_stream_with_vfs(response, src_format)
2878
 
        if response[0][0] == 'missing-basis':
2879
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2880
 
            resume_tokens = tokens
2881
 
            return resume_tokens, set(missing_keys)
2882
 
        else:
2883
 
            self.target_repo.refresh_data()
2884
 
            return [], set()
2885
 
 
2886
 
    def _resume_stream_with_vfs(self, response, src_format):
2887
 
        """Resume sending a stream via VFS, first resending the record and
2888
 
        substream that couldn't be sent via an insert_stream verb.
2889
 
        """
2890
 
        if response[0][0] == 'missing-basis':
2891
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2892
 
            # Ignore missing_keys, we haven't finished inserting yet
2893
 
        else:
2894
 
            tokens = []
2895
 
        def resume_substream():
2896
 
            # Yield the substream that was interrupted.
2897
 
            for record in self._last_substream:
2898
 
                yield record
2899
 
            self._last_substream = None
2900
 
        def resume_stream():
2901
 
            # Finish sending the interrupted substream
2902
 
            yield ('inventory-deltas', resume_substream())
2903
 
            # Then simply continue sending the rest of the stream.
2904
 
            for substream_kind, substream in self._last_stream:
2905
 
                yield substream_kind, substream
2906
 
        return self._insert_real(resume_stream(), src_format, tokens)
2907
 
 
2908
 
    def _stop_stream_if_inventory_delta(self, stream):
2909
 
        """Normally this just lets the original stream pass-through unchanged.
2910
 
 
2911
 
        However if any 'inventory-deltas' substream occurs it will stop
2912
 
        streaming, and store the interrupted substream and stream in
2913
 
        self._last_substream and self._last_stream so that the stream can be
2914
 
        resumed by _resume_stream_with_vfs.
2915
 
        """
2916
 
 
2917
 
        stream_iter = iter(stream)
2918
 
        for substream_kind, substream in stream_iter:
2919
 
            if substream_kind == 'inventory-deltas':
2920
 
                self._last_substream = substream
2921
 
                self._last_stream = stream_iter
2922
 
                return
2923
 
            else:
2924
 
                yield substream_kind, substream
2925
 
 
2926
 
 
2927
 
class RemoteStreamSource(vf_repository.StreamSource):
2928
 
    """Stream data from a remote server."""
2929
 
 
2930
 
    def get_stream(self, search):
2931
 
        if (self.from_repository._fallback_repositories and
2932
 
            self.to_format._fetch_order == 'topological'):
2933
 
            return self._real_stream(self.from_repository, search)
2934
 
        sources = []
2935
 
        seen = set()
2936
 
        repos = [self.from_repository]
2937
 
        while repos:
2938
 
            repo = repos.pop(0)
2939
 
            if repo in seen:
2940
 
                continue
2941
 
            seen.add(repo)
2942
 
            repos.extend(repo._fallback_repositories)
2943
 
            sources.append(repo)
2944
 
        return self.missing_parents_chain(search, sources)
2945
 
 
2946
 
    def get_stream_for_missing_keys(self, missing_keys):
2947
 
        self.from_repository._ensure_real()
2948
 
        real_repo = self.from_repository._real_repository
2949
 
        real_source = real_repo._get_source(self.to_format)
2950
 
        return real_source.get_stream_for_missing_keys(missing_keys)
2951
 
 
2952
 
    def _real_stream(self, repo, search):
2953
 
        """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
2957
 
        reliably whether fallback back because of old servers or trying
2958
 
        to stream from a non-RemoteRepository (which the stacked support
2959
 
        code will do).
2960
 
        """
2961
 
        source = repo._get_source(self.to_format)
2962
 
        if isinstance(source, RemoteStreamSource):
2963
 
            repo._ensure_real()
2964
 
            source = repo._real_repository._get_source(self.to_format)
2965
 
        return source.get_stream(search)
2966
 
 
2967
 
    def _get_stream(self, repo, search):
2968
 
        """Core worker to get a stream from repo for search.
2969
 
 
2970
 
        This is used by both get_stream and the stacking support logic. It
2971
 
        deliberately gets a stream for repo which does not need to be
2972
 
        self.from_repository. In the event that repo is not Remote, or
2973
 
        cannot do a smart stream, a fallback is made to the generic
2974
 
        repository._get_stream() interface, via self._real_stream.
2975
 
 
2976
 
        In the event of stacking, streams from _get_stream will not
2977
 
        contain all the data for search - this is normal (see get_stream).
2978
 
 
2979
 
        :param repo: A repository.
2980
 
        :param search: A search.
2981
 
        """
2982
 
        # Fallbacks may be non-smart
2983
 
        if not isinstance(repo, RemoteRepository):
2984
 
            return self._real_stream(repo, search)
2985
 
        client = repo._client
2986
 
        medium = client._medium
2987
 
        path = repo.bzrdir._path_for_remote_call(client)
2988
 
        search_bytes = repo._serialise_search_result(search)
2989
 
        args = (path, self.to_format.network_name())
2990
 
        candidate_verbs = [
2991
 
            ('Repository.get_stream_1.19', (1, 19)),
2992
 
            ('Repository.get_stream', (1, 13))]
2993
 
 
2994
 
        found_verb = False
2995
 
        for verb, version in candidate_verbs:
2996
 
            if medium._is_remote_before(version):
2997
 
                continue
2998
 
            try:
2999
 
                response = repo._call_with_body_bytes_expecting_body(
3000
 
                    verb, args, search_bytes)
3001
 
            except errors.UnknownSmartMethod:
3002
 
                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
 
            else:
3015
 
                response_tuple, response_handler = response
3016
 
                found_verb = True
3017
 
                break
3018
 
        if not found_verb:
3019
 
            return self._real_stream(repo, search)
3020
 
        if response_tuple[0] != 'ok':
3021
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
3022
 
        byte_stream = response_handler.read_streamed_body()
3023
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
3024
 
            self._record_counter)
3025
 
        if src_format.network_name() != repo._format.network_name():
3026
 
            raise AssertionError(
3027
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
3028
 
                src_format.network_name(), repo._format.network_name()))
3029
 
        return stream
3030
 
 
3031
 
    def missing_parents_chain(self, search, sources):
3032
 
        """Chain multiple streams together to handle stacking.
3033
 
 
3034
 
        :param search: The overall search to satisfy with streams.
3035
 
        :param sources: A list of Repository objects to query.
3036
 
        """
3037
 
        self.from_serialiser = self.from_repository._format._serializer
3038
 
        self.seen_revs = set()
3039
 
        self.referenced_revs = set()
3040
 
        # If there are heads in the search, or the key count is > 0, we are not
3041
 
        # done.
3042
 
        while not search.is_empty() and len(sources) > 1:
3043
 
            source = sources.pop(0)
3044
 
            stream = self._get_stream(source, search)
3045
 
            for kind, substream in stream:
3046
 
                if kind != 'revisions':
3047
 
                    yield kind, substream
3048
 
                else:
3049
 
                    yield kind, self.missing_parents_rev_handler(substream)
3050
 
            search = search.refine(self.seen_revs, self.referenced_revs)
3051
 
            self.seen_revs = set()
3052
 
            self.referenced_revs = set()
3053
 
        if not search.is_empty():
3054
 
            for kind, stream in self._get_stream(sources[0], search):
3055
 
                yield kind, stream
3056
 
 
3057
 
    def missing_parents_rev_handler(self, substream):
3058
 
        for content in substream:
3059
 
            revision_bytes = content.get_bytes_as('fulltext')
3060
 
            revision = self.from_serialiser.read_revision_from_string(
3061
 
                revision_bytes)
3062
 
            self.seen_revs.add(content.key[-1])
3063
 
            self.referenced_revs.update(revision.parent_ids)
3064
 
            yield content
3065
 
 
3066
 
 
3067
1220
class RemoteBranchLockableFiles(LockableFiles):
3068
1221
    """A 'LockableFiles' implementation that talks to a smart server.
3069
 
 
 
1222
    
3070
1223
    This is not a public interface class.
3071
1224
    """
3072
1225
 
3086
1239
 
3087
1240
class RemoteBranchFormat(branch.BranchFormat):
3088
1241
 
3089
 
    def __init__(self, network_name=None):
 
1242
    def __init__(self):
3090
1243
        super(RemoteBranchFormat, self).__init__()
3091
1244
        self._matchingbzrdir = RemoteBzrDirFormat()
3092
1245
        self._matchingbzrdir.set_branch_format(self)
3093
 
        self._custom_format = None
3094
 
        self._network_name = network_name
3095
1246
 
3096
1247
    def __eq__(self, other):
3097
 
        return (isinstance(other, RemoteBranchFormat) and
 
1248
        return (isinstance(other, RemoteBranchFormat) and 
3098
1249
            self.__dict__ == other.__dict__)
3099
1250
 
3100
 
    def _ensure_real(self):
3101
 
        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)
3108
 
 
3109
1251
    def get_format_description(self):
3110
 
        self._ensure_real()
3111
 
        return 'Remote: ' + self._custom_format.get_format_description()
3112
 
 
3113
 
    def network_name(self):
3114
 
        return self._network_name
3115
 
 
3116
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
3117
 
        return a_bzrdir.open_branch(name=name, 
3118
 
            ignore_fallbacks=ignore_fallbacks)
3119
 
 
3120
 
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only,
3121
 
                        repository=None):
3122
 
        # Initialisation when using a local bzrdir object, or a non-vfs init
3123
 
        # method is not available on the server.
3124
 
        # self._custom_format is always set - the start of initialize ensures
3125
 
        # that.
3126
 
        if isinstance(a_bzrdir, RemoteBzrDir):
3127
 
            a_bzrdir._ensure_real()
3128
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
3129
 
                name=name, append_revisions_only=append_revisions_only,
3130
 
                repository=repository)
3131
 
        else:
3132
 
            # 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)
3136
 
        if (isinstance(a_bzrdir, RemoteBzrDir) and
3137
 
            not isinstance(result, RemoteBranch)):
3138
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
3139
 
                                  name=name)
3140
 
        return result
3141
 
 
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()
3146
 
        # 1) get the network name to use.
3147
 
        if self._custom_format:
3148
 
            network_name = self._custom_format.network_name()
3149
 
        else:
3150
 
            # Select the current bzrlib default and ask for that.
3151
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
3152
 
            reference_format = reference_bzrdir_format.get_branch_format()
3153
 
            self._custom_format = reference_format
3154
 
            network_name = reference_format.network_name()
3155
 
        # Being asked to create on a non RemoteBzrDir:
3156
 
        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)
3160
 
        medium = a_bzrdir._client._medium
3161
 
        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)
3165
 
        # Creating on a remote bzr dir.
3166
 
        # 2) try direct creation via RPC
3167
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
3168
 
        if name != "":
3169
 
            # XXX JRV20100304: Support creating colocated branches
3170
 
            raise errors.NoColocatedBranchSupport(self)
3171
 
        verb = 'BzrDir.create_branch'
3172
 
        try:
3173
 
            response = a_bzrdir._call(verb, path, network_name)
3174
 
        except errors.UnknownSmartMethod:
3175
 
            # Fallback - use vfs methods
3176
 
            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)
3180
 
        if response[0] != 'ok':
3181
 
            raise errors.UnexpectedSmartServerResponse(response)
3182
 
        # Turn the response into a RemoteRepository object.
3183
 
        format = RemoteBranchFormat(network_name=response[1])
3184
 
        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
3196
 
        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)
3204
 
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
3205
 
            format=format, setup_stacking=False, name=name)
3206
 
        if append_revisions_only:
3207
 
            remote_branch.set_append_revisions_only(append_revisions_only)
3208
 
        # XXX: We know this is a new branch, so it must have revno 0, revid
3209
 
        # NULL_REVISION. Creating the branch locked would make this be unable
3210
 
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
3211
 
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
3212
 
        return remote_branch
3213
 
 
3214
 
    def make_tags(self, branch):
3215
 
        self._ensure_real()
3216
 
        return self._custom_format.make_tags(branch)
 
1252
        return 'Remote BZR Branch'
 
1253
 
 
1254
    def get_format_string(self):
 
1255
        return 'Remote BZR Branch'
 
1256
 
 
1257
    def open(self, a_bzrdir):
 
1258
        return a_bzrdir.open_branch()
 
1259
 
 
1260
    def initialize(self, a_bzrdir):
 
1261
        return a_bzrdir.create_branch()
3217
1262
 
3218
1263
    def supports_tags(self):
3219
1264
        # Remote branches might support tags, but we won't know until we
3220
1265
        # access the real remote branch.
3221
 
        self._ensure_real()
3222
 
        return self._custom_format.supports_tags()
3223
 
 
3224
 
    def supports_stacking(self):
3225
 
        self._ensure_real()
3226
 
        return self._custom_format.supports_stacking()
3227
 
 
3228
 
    def supports_set_append_revisions_only(self):
3229
 
        self._ensure_real()
3230
 
        return self._custom_format.supports_set_append_revisions_only()
3231
 
 
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
 
 
3294
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1266
        return True
 
1267
 
 
1268
 
 
1269
class RemoteBranch(branch.Branch, _RpcHelper):
3295
1270
    """Branch stored on a server accessed by HPSS RPC.
3296
1271
 
3297
1272
    At the moment most operations are mapped down to simple file operations.
3298
1273
    """
3299
1274
 
3300
1275
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
3301
 
        _client=None, format=None, setup_stacking=True, name=None,
3302
 
        possible_transports=None):
 
1276
        _client=None):
3303
1277
        """Create a RemoteBranch instance.
3304
1278
 
3305
1279
        :param real_branch: An optional local implementation of the branch
3306
1280
            format, usually accessing the data via the VFS.
3307
1281
        :param _client: Private parameter for testing.
3308
 
        :param format: A RemoteBranchFormat object, None to create one
3309
 
            automatically. If supplied it should have a network_name already
3310
 
            supplied.
3311
 
        :param setup_stacking: If True make an RPC call to determine the
3312
 
            stacked (or not) status of the branch. If False assume the branch
3313
 
            is not stacked.
3314
 
        :param name: Colocated branch name
3315
1282
        """
3316
1283
        # We intentionally don't call the parent class's __init__, because it
3317
1284
        # will try to assign to self.tags, which is a property in this subclass.
3318
1285
        # And the parent's __init__ doesn't do much anyway.
 
1286
        self._revision_id_to_revno_cache = None
 
1287
        self._revision_history_cache = None
 
1288
        self._last_revision_info_cache = None
3319
1289
        self.bzrdir = remote_bzrdir
3320
 
        self.name = name
3321
1290
        if _client is not None:
3322
1291
            self._client = _client
3323
1292
        else:
3335
1304
            self._real_branch.repository = self.repository
3336
1305
        else:
3337
1306
            self._real_branch = None
3338
 
        # Fill out expected attributes of branch for bzrlib API users.
3339
 
        self._clear_cached_state()
3340
 
        # TODO: deprecate self.base in favor of user_url
3341
 
        self.base = self.bzrdir.user_url
3342
 
        self._name = name
 
1307
        # Fill out expected attributes of branch for bzrlib api users.
 
1308
        self._format = RemoteBranchFormat()
 
1309
        self.base = self.bzrdir.root_transport.base
3343
1310
        self._control_files = None
3344
1311
        self._lock_mode = None
3345
1312
        self._lock_token = None
3346
1313
        self._repo_lock_token = None
3347
1314
        self._lock_count = 0
3348
1315
        self._leave_lock = False
3349
 
        self.conf_store = None
3350
 
        # Setup a format: note that we cannot call _ensure_real until all the
3351
 
        # attributes above are set: This code cannot be moved higher up in this
3352
 
        # function.
3353
 
        if format is None:
3354
 
            self._format = RemoteBranchFormat()
3355
 
            if real_branch is not None:
3356
 
                self._format._network_name = \
3357
 
                    self._real_branch._format.network_name()
3358
 
        else:
3359
 
            self._format = format
3360
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
3361
 
        # branch.open_branch method.
3362
 
        self._real_ignore_fallbacks = not setup_stacking
3363
 
        if not self._format._network_name:
3364
 
            # Did not get from open_branchV2 - old server.
3365
 
            self._ensure_real()
3366
 
            self._format._network_name = \
3367
 
                self._real_branch._format.network_name()
3368
 
        self.tags = self._format.make_tags(self)
3369
1316
        # The base class init is not called, so we duplicate this:
3370
1317
        hooks = branch.Branch.hooks['open']
3371
1318
        for hook in hooks:
3372
1319
            hook(self)
3373
 
        self._is_stacked = False
3374
 
        if setup_stacking:
3375
 
            self._setup_stacking(possible_transports)
 
1320
        self._setup_stacking()
3376
1321
 
3377
 
    def _setup_stacking(self, possible_transports):
 
1322
    def _setup_stacking(self):
3378
1323
        # configure stacking into the remote repository, by reading it from
3379
1324
        # the vfs branch.
3380
1325
        try:
3382
1327
        except (errors.NotStacked, errors.UnstackableBranchFormat,
3383
1328
            errors.UnstackableRepositoryFormat), e:
3384
1329
            return
3385
 
        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)
3393
 
 
3394
 
    def _get_config(self):
3395
 
        return RemoteBranchConfig(self)
3396
 
 
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)
 
1330
        # it's relative to this branch...
 
1331
        fallback_url = urlutils.join(self.base, fallback_url)
 
1332
        transports = [self.bzrdir.root_transport]
 
1333
        if self._real_branch is not None:
 
1334
            transports.append(self._real_branch._transport)
 
1335
        stacked_on = branch.Branch.open(fallback_url,
 
1336
                                        possible_transports=transports)
 
1337
        self.repository.add_fallback_repository(stacked_on.repository)
3409
1338
 
3410
1339
    def _get_real_transport(self):
3411
1340
        # if we try vfs access, return the real branch's vfs transport
3429
1358
                raise AssertionError('smart server vfs must be enabled '
3430
1359
                    'to use vfs implementation')
3431
1360
            self.bzrdir._ensure_real()
3432
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
3433
 
                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
 
1361
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
3438
1362
            if self.repository._real_repository is None:
3439
1363
                # Give the remote repository the matching real repo.
3440
1364
                real_repo = self._real_branch.repository
3469
1393
        too, in fact doing so might harm performance.
3470
1394
        """
3471
1395
        super(RemoteBranch, self)._clear_cached_state()
3472
 
 
 
1396
        
3473
1397
    @property
3474
1398
    def control_files(self):
3475
1399
        # Defer actually creating RemoteBranchLockableFiles until its needed,
3479
1403
                self.bzrdir, self._client)
3480
1404
        return self._control_files
3481
1405
 
 
1406
    def _get_checkout_format(self):
 
1407
        self._ensure_real()
 
1408
        return self._real_branch._get_checkout_format()
 
1409
 
3482
1410
    def get_physical_lock_status(self):
3483
1411
        """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')
 
1412
        # should be an API call to the server, as branches must be lockable.
 
1413
        self._ensure_real()
 
1414
        return self._real_branch.get_physical_lock_status()
3493
1415
 
3494
1416
    def get_stacked_on_url(self):
3495
1417
        """Get the URL this branch is stacked against.
3516
1438
            raise errors.UnexpectedSmartServerResponse(response)
3517
1439
        return response[1]
3518
1440
 
3519
 
    def set_stacked_on_url(self, url):
3520
 
        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
 
        if not url:
3529
 
            self._is_stacked = False
3530
 
        else:
3531
 
            self._is_stacked = True
3532
 
 
3533
 
    def _vfs_get_tags_bytes(self):
3534
 
        self._ensure_real()
3535
 
        return self._real_branch._get_tags_bytes()
3536
 
 
3537
 
    @needs_read_lock
3538
 
    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
 
        medium = self._client._medium
3545
 
        if medium._is_remote_before((1, 13)):
3546
 
            return self._vfs_get_tags_bytes()
3547
 
        try:
3548
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
3549
 
        except errors.UnknownSmartMethod:
3550
 
            medium._remember_remote_is_before((1, 13))
3551
 
            return self._vfs_get_tags_bytes()
3552
 
        return response[0]
3553
 
 
3554
 
    def _vfs_set_tags_bytes(self, bytes):
3555
 
        self._ensure_real()
3556
 
        return self._real_branch._set_tags_bytes(bytes)
3557
 
 
3558
 
    def _set_tags_bytes(self, bytes):
3559
 
        if self.is_locked():
3560
 
            self._tags_bytes = bytes
3561
 
        medium = self._client._medium
3562
 
        if medium._is_remote_before((1, 18)):
3563
 
            self._vfs_set_tags_bytes(bytes)
3564
 
            return
3565
 
        try:
3566
 
            args = (
3567
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
3568
 
            response = self._call_with_body_bytes(
3569
 
                'Branch.set_tags_bytes', args, bytes)
3570
 
        except errors.UnknownSmartMethod:
3571
 
            medium._remember_remote_is_before((1, 18))
3572
 
            self._vfs_set_tags_bytes(bytes)
3573
 
 
3574
1441
    def lock_read(self):
3575
 
        """Lock the branch for read operations.
3576
 
 
3577
 
        :return: A bzrlib.lock.LogicalLockResult.
3578
 
        """
3579
1442
        self.repository.lock_read()
3580
1443
        if not self._lock_mode:
3581
 
            self._note_lock('r')
3582
1444
            self._lock_mode = 'r'
3583
1445
            self._lock_count = 1
3584
1446
            if self._real_branch is not None:
3585
1447
                self._real_branch.lock_read()
3586
1448
        else:
3587
1449
            self._lock_count += 1
3588
 
        return lock.LogicalLockResult(self.unlock)
3589
1450
 
3590
1451
    def _remote_lock_write(self, token):
3591
1452
        if token is None:
3592
1453
            branch_token = repo_token = ''
3593
1454
        else:
3594
1455
            branch_token = token
3595
 
            repo_token = self.repository.lock_write().repository_token
 
1456
            repo_token = self.repository.lock_write()
3596
1457
            self.repository.unlock()
3597
1458
        err_context = {'token': token}
3598
 
        try:
3599
 
            response = self._call(
3600
 
                'Branch.lock_write', self._remote_path(), branch_token,
3601
 
                repo_token or '', **err_context)
3602
 
        except errors.LockContention, e:
3603
 
            # The LockContention from the server doesn't have any
3604
 
            # information about the lock_url. We re-raise LockContention
3605
 
            # with valid lock_url.
3606
 
            raise errors.LockContention('(remote lock)',
3607
 
                self.repository.base.split('.bzr/')[0])
 
1459
        response = self._call(
 
1460
            'Branch.lock_write', self._remote_path(), branch_token,
 
1461
            repo_token or '', **err_context)
3608
1462
        if response[0] != 'ok':
3609
1463
            raise errors.UnexpectedSmartServerResponse(response)
3610
1464
        ok, branch_token, repo_token = response
3611
1465
        return branch_token, repo_token
3612
 
 
 
1466
            
3613
1467
    def lock_write(self, token=None):
3614
1468
        if not self._lock_mode:
3615
 
            self._note_lock('w')
3616
1469
            # Lock the branch and repo in one remote call.
3617
1470
            remote_tokens = self._remote_lock_write(token)
3618
1471
            self._lock_token, self._repo_lock_token = remote_tokens
3631
1484
            self._lock_mode = 'w'
3632
1485
            self._lock_count = 1
3633
1486
        elif self._lock_mode == 'r':
3634
 
            raise errors.ReadOnlyError(self)
 
1487
            raise errors.ReadOnlyTransaction
3635
1488
        else:
3636
1489
            if token is not None:
3637
1490
                # A token was given to lock_write, and we're relocking, so
3642
1495
            self._lock_count += 1
3643
1496
            # Re-lock the repository too.
3644
1497
            self.repository.lock_write(self._repo_lock_token)
3645
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
1498
        return self._lock_token or None
3646
1499
 
3647
1500
    def _unlock(self, branch_token, repo_token):
3648
1501
        err_context = {'token': str((branch_token, repo_token))}
3653
1506
            return
3654
1507
        raise errors.UnexpectedSmartServerResponse(response)
3655
1508
 
3656
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
3657
1509
    def unlock(self):
3658
1510
        try:
3659
1511
            self._lock_count -= 1
3660
1512
            if not self._lock_count:
3661
 
                if self.conf_store is not None:
3662
 
                    self.conf_store.save_changes()
3663
1513
                self._clear_cached_state()
3664
1514
                mode = self._lock_mode
3665
1515
                self._lock_mode = None
3674
1524
                    self._real_branch.unlock()
3675
1525
                if mode != 'w':
3676
1526
                    # Only write-locked branched need to make a remote method
3677
 
                    # call to perform the unlock.
 
1527
                    # call to perfom the unlock.
3678
1528
                    return
3679
1529
                if not self._lock_token:
3680
1530
                    raise AssertionError('Locked, but no token!')
3688
1538
            self.repository.unlock()
3689
1539
 
3690
1540
    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)
 
1541
        self._ensure_real()
 
1542
        return self._real_branch.break_lock()
3699
1543
 
3700
1544
    def leave_lock_in_place(self):
3701
1545
        if not self._lock_token:
3707
1551
            raise NotImplementedError(self.dont_leave_lock_in_place)
3708
1552
        self._leave_lock = False
3709
1553
 
3710
 
    @needs_read_lock
3711
 
    def get_rev_id(self, revno, history=None):
3712
 
        if revno == 0:
3713
 
            return _mod_revision.NULL_REVISION
3714
 
        last_revision_info = self.last_revision_info()
3715
 
        ok, result = self.repository.get_rev_id_for_revno(
3716
 
            revno, last_revision_info)
3717
 
        if ok:
3718
 
            return result
3719
 
        missing_parent = result[1]
3720
 
        # Either the revision named by the server is missing, or its parent
3721
 
        # is.  Call get_parent_map to determine which, so that we report a
3722
 
        # useful error.
3723
 
        parent_map = self.repository.get_parent_map([missing_parent])
3724
 
        if missing_parent in parent_map:
3725
 
            missing_parent = parent_map[missing_parent]
3726
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
3727
 
 
3728
 
    def _read_last_revision_info(self):
 
1554
    def _last_revision_info(self):
3729
1555
        response = self._call('Branch.last_revision_info', self._remote_path())
3730
1556
        if response[0] != 'ok':
3731
1557
            raise SmartProtocolError('unexpected response code %s' % (response,))
3735
1561
 
3736
1562
    def _gen_revision_history(self):
3737
1563
        """See Branch._gen_revision_history()."""
3738
 
        if self._is_stacked:
3739
 
            self._ensure_real()
3740
 
            return self._real_branch._gen_revision_history()
3741
1564
        response_tuple, response_handler = self._call_expecting_body(
3742
1565
            'Branch.revision_history', self._remote_path())
3743
1566
        if response_tuple[0] != 'ok':
3752
1575
 
3753
1576
    def _set_last_revision_descendant(self, revision_id, other_branch,
3754
1577
            allow_diverged=False, allow_overwrite_descendant=False):
3755
 
        # This performs additional work to meet the hook contract; while its
3756
 
        # undesirable, we have to synthesise the revno to call the hook, and
3757
 
        # not calling the hook is worse as it means changes can't be prevented.
3758
 
        # Having calculated this though, we can't just call into
3759
 
        # set_last_revision_info as a simple call, because there is a set_rh
3760
 
        # hook that some folk may still be using.
3761
 
        old_revno, old_revid = self.last_revision_info()
3762
 
        history = self._lefthand_history(revision_id)
3763
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
3764
1578
        err_context = {'other_branch': other_branch}
3765
1579
        response = self._call('Branch.set_last_revision_ex',
3766
1580
            self._remote_path(), self._lock_token, self._repo_lock_token,
3771
1585
            raise errors.UnexpectedSmartServerResponse(response)
3772
1586
        new_revno, new_revision_id = response[1:]
3773
1587
        self._last_revision_info_cache = new_revno, new_revision_id
3774
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3775
1588
        if self._real_branch is not None:
3776
1589
            cache = new_revno, new_revision_id
3777
1590
            self._real_branch._last_revision_info_cache = cache
3778
1591
 
3779
1592
    def _set_last_revision(self, revision_id):
3780
 
        old_revno, old_revid = self.last_revision_info()
3781
 
        # This performs additional work to meet the hook contract; while its
3782
 
        # undesirable, we have to synthesise the revno to call the hook, and
3783
 
        # not calling the hook is worse as it means changes can't be prevented.
3784
 
        # Having calculated this though, we can't just call into
3785
 
        # set_last_revision_info as a simple call, because there is a set_rh
3786
 
        # hook that some folk may still be using.
3787
 
        history = self._lefthand_history(revision_id)
3788
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
3789
1593
        self._clear_cached_state()
3790
1594
        response = self._call('Branch.set_last_revision',
3791
1595
            self._remote_path(), self._lock_token, self._repo_lock_token,
3792
1596
            revision_id)
3793
1597
        if response != ('ok',):
3794
1598
            raise errors.UnexpectedSmartServerResponse(response)
3795
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3796
 
 
3797
 
    def _get_parent_location(self):
3798
 
        medium = self._client._medium
3799
 
        if medium._is_remote_before((1, 13)):
3800
 
            return self._vfs_get_parent_location()
3801
 
        try:
3802
 
            response = self._call('Branch.get_parent', self._remote_path())
3803
 
        except errors.UnknownSmartMethod:
3804
 
            medium._remember_remote_is_before((1, 13))
3805
 
            return self._vfs_get_parent_location()
3806
 
        if len(response) != 1:
3807
 
            raise errors.UnexpectedSmartServerResponse(response)
3808
 
        parent_location = response[0]
3809
 
        if parent_location == '':
3810
 
            return None
3811
 
        return parent_location
3812
 
 
3813
 
    def _vfs_get_parent_location(self):
3814
 
        self._ensure_real()
3815
 
        return self._real_branch._get_parent_location()
3816
 
 
3817
 
    def _set_parent_location(self, url):
3818
 
        medium = self._client._medium
3819
 
        if medium._is_remote_before((1, 15)):
3820
 
            return self._vfs_set_parent_location(url)
3821
 
        try:
3822
 
            call_url = url or ''
3823
 
            if type(call_url) is not str:
3824
 
                raise AssertionError('url must be a str or None (%s)' % url)
3825
 
            response = self._call('Branch.set_parent_location',
3826
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
3827
 
                call_url)
3828
 
        except errors.UnknownSmartMethod:
3829
 
            medium._remember_remote_is_before((1, 15))
3830
 
            return self._vfs_set_parent_location(url)
3831
 
        if response != ():
3832
 
            raise errors.UnexpectedSmartServerResponse(response)
3833
 
 
3834
 
    def _vfs_set_parent_location(self, url):
3835
 
        self._ensure_real()
3836
 
        return self._real_branch._set_parent_location(url)
 
1599
 
 
1600
    @needs_write_lock
 
1601
    def set_revision_history(self, rev_history):
 
1602
        # Send just the tip revision of the history; the server will generate
 
1603
        # the full history from that.  If the revision doesn't exist in this
 
1604
        # branch, NoSuchRevision will be raised.
 
1605
        if rev_history == []:
 
1606
            rev_id = 'null:'
 
1607
        else:
 
1608
            rev_id = rev_history[-1]
 
1609
        self._set_last_revision(rev_id)
 
1610
        self._cache_revision_history(rev_history)
 
1611
 
 
1612
    def get_parent(self):
 
1613
        self._ensure_real()
 
1614
        return self._real_branch.get_parent()
 
1615
        
 
1616
    def set_parent(self, url):
 
1617
        self._ensure_real()
 
1618
        return self._real_branch.set_parent(url)
 
1619
        
 
1620
    def set_stacked_on_url(self, stacked_location):
 
1621
        """Set the URL this branch is stacked against.
 
1622
 
 
1623
        :raises UnstackableBranchFormat: If the branch does not support
 
1624
            stacking.
 
1625
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1626
            stacking.
 
1627
        """
 
1628
        self._ensure_real()
 
1629
        return self._real_branch.set_stacked_on_url(stacked_location)
 
1630
 
 
1631
    def sprout(self, to_bzrdir, revision_id=None):
 
1632
        branch_format = to_bzrdir._format._branch_format
 
1633
        if (branch_format is None or
 
1634
            isinstance(branch_format, RemoteBranchFormat)):
 
1635
            # The to_bzrdir specifies RemoteBranchFormat (or no format, which
 
1636
            # implies the same thing), but RemoteBranches can't be created at
 
1637
            # arbitrary URLs.  So create a branch in the same format as
 
1638
            # _real_branch instead.
 
1639
            # XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
 
1640
            # to_bzrdir.create_branch to create a RemoteBranch after all...
 
1641
            self._ensure_real()
 
1642
            result = self._real_branch._format.initialize(to_bzrdir)
 
1643
            self.copy_content_into(result, revision_id=revision_id)
 
1644
            result.set_parent(self.bzrdir.root_transport.base)
 
1645
        else:
 
1646
            result = branch.Branch.sprout(
 
1647
                self, to_bzrdir, revision_id=revision_id)
 
1648
        return result
3837
1649
 
3838
1650
    @needs_write_lock
3839
1651
    def pull(self, source, overwrite=False, stop_revision=None,
3845
1657
            _override_hook_target=self, **kwargs)
3846
1658
 
3847
1659
    @needs_read_lock
3848
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
1660
    def push(self, target, overwrite=False, stop_revision=None):
3849
1661
        self._ensure_real()
3850
1662
        return self._real_branch.push(
3851
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
1663
            target, overwrite=overwrite, stop_revision=stop_revision,
3852
1664
            _override_hook_source_branch=self)
3853
1665
 
3854
 
    def peek_lock_mode(self):
3855
 
        return self._lock_mode
3856
 
 
3857
1666
    def is_locked(self):
3858
1667
        return self._lock_count >= 1
3859
1668
 
3860
1669
    @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
1670
    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)
 
1671
        self._ensure_real()
 
1672
        return self._real_branch.revision_id_to_revno(revision_id)
3895
1673
 
3896
1674
    @needs_write_lock
3897
1675
    def set_last_revision_info(self, revno, revision_id):
3898
 
        # XXX: These should be returned by the set_last_revision_info verb
3899
 
        old_revno, old_revid = self.last_revision_info()
3900
 
        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)
 
1676
        revision_id = ensure_null(revision_id)
3903
1677
        try:
3904
1678
            response = self._call('Branch.set_last_revision_info',
3905
1679
                self._remote_path(), self._lock_token, self._repo_lock_token,
3913
1687
        if response == ('ok',):
3914
1688
            self._clear_cached_state()
3915
1689
            self._last_revision_info_cache = revno, revision_id
3916
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3917
1690
            # Update the _real_branch's cache too.
3918
1691
            if self._real_branch is not None:
3919
1692
                cache = self._last_revision_info_cache
3926
1699
                                  other_branch=None):
3927
1700
        medium = self._client._medium
3928
1701
        if not medium._is_remote_before((1, 6)):
3929
 
            # Use a smart method for 1.6 and above servers
3930
1702
            try:
3931
1703
                self._set_last_revision_descendant(revision_id, other_branch,
3932
1704
                    allow_diverged=True, allow_overwrite_descendant=True)
3934
1706
            except errors.UnknownSmartMethod:
3935
1707
                medium._remember_remote_is_before((1, 6))
3936
1708
        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)
 
1709
        self._ensure_real()
 
1710
        self._real_branch.generate_revision_history(
 
1711
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
1712
 
 
1713
    @property
 
1714
    def tags(self):
 
1715
        self._ensure_real()
 
1716
        return self._real_branch.tags
3949
1717
 
3950
1718
    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
1719
        self._ensure_real()
3978
 
        return self._real_branch.heads_to_fetch()
3979
 
 
3980
 
 
3981
 
class RemoteConfig(object):
3982
 
    """A Config that reads and writes from smart verbs.
3983
 
 
3984
 
    It is a low-level object that considers config data to be name/value pairs
3985
 
    that may be associated with a section. Assigning meaning to the these
3986
 
    values is done at higher levels like bzrlib.config.TreeConfig.
3987
 
    """
3988
 
 
3989
 
    def get_option(self, name, section=None, default=None):
3990
 
        """Return the value associated with a named option.
3991
 
 
3992
 
        :param name: The name of the value
3993
 
        :param section: The section the option is in (if any)
3994
 
        :param default: The value to return if the value is not set
3995
 
        :return: The value or default value
3996
 
        """
3997
 
        try:
3998
 
            configobj = self._get_configobj()
3999
 
            section_obj = None
4000
 
            if section is None:
4001
 
                section_obj = configobj
4002
 
            else:
4003
 
                try:
4004
 
                    section_obj = configobj[section]
4005
 
                except KeyError:
4006
 
                    pass
4007
 
            if section_obj is None:
4008
 
                value = default
4009
 
            else:
4010
 
                value = section_obj.get(name, default)
4011
 
        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
4016
 
 
4017
 
    def _response_to_configobj(self, response):
4018
 
        if len(response[0]) and response[0][0] != 'ok':
4019
 
            raise errors.UnexpectedSmartServerResponse(response)
4020
 
        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
4025
 
 
4026
 
 
4027
 
class RemoteBranchConfig(RemoteConfig):
4028
 
    """A RemoteConfig for Branches."""
4029
 
 
4030
 
    def __init__(self, branch):
4031
 
        self._branch = branch
4032
 
 
4033
 
    def _get_configobj(self):
4034
 
        path = self._branch._remote_path()
4035
 
        response = self._branch._client.call_expecting_body(
4036
 
            'Branch.get_config_file', path)
4037
 
        return self._response_to_configobj(response)
4038
 
 
4039
 
    def set_option(self, value, name, section=None):
4040
 
        """Set the value associated with a named option.
4041
 
 
4042
 
        :param value: The value to set
4043
 
        :param name: The name of the value to set
4044
 
        :param section: The section the option is in (if any)
4045
 
        """
4046
 
        medium = self._branch._client._medium
4047
 
        if medium._is_remote_before((1, 14)):
4048
 
            return self._vfs_set_option(value, name, section)
4049
 
        if isinstance(value, dict):
4050
 
            if medium._is_remote_before((2, 2)):
4051
 
                return self._vfs_set_option(value, name, section)
4052
 
            return self._set_config_option_dict(value, name, section)
4053
 
        else:
4054
 
            return self._set_config_option(value, name, section)
4055
 
 
4056
 
    def _set_config_option(self, value, name, section):
4057
 
        try:
4058
 
            path = self._branch._remote_path()
4059
 
            response = self._branch._client.call('Branch.set_config_option',
4060
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
4061
 
                value.encode('utf8'), name, section or '')
4062
 
        except errors.UnknownSmartMethod:
4063
 
            medium = self._branch._client._medium
4064
 
            medium._remember_remote_is_before((1, 14))
4065
 
            return self._vfs_set_option(value, name, section)
4066
 
        if response != ():
4067
 
            raise errors.UnexpectedSmartServerResponse(response)
4068
 
 
4069
 
    def _serialize_option_dict(self, option_dict):
4070
 
        utf8_dict = {}
4071
 
        for key, value in option_dict.items():
4072
 
            if isinstance(key, unicode):
4073
 
                key = key.encode('utf8')
4074
 
            if isinstance(value, unicode):
4075
 
                value = value.encode('utf8')
4076
 
            utf8_dict[key] = value
4077
 
        return bencode.bencode(utf8_dict)
4078
 
 
4079
 
    def _set_config_option_dict(self, value, name, section):
4080
 
        try:
4081
 
            path = self._branch._remote_path()
4082
 
            serialised_dict = self._serialize_option_dict(value)
4083
 
            response = self._branch._client.call(
4084
 
                'Branch.set_config_option_dict',
4085
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
4086
 
                serialised_dict, name, section or '')
4087
 
        except errors.UnknownSmartMethod:
4088
 
            medium = self._branch._client._medium
4089
 
            medium._remember_remote_is_before((2, 2))
4090
 
            return self._vfs_set_option(value, name, section)
4091
 
        if response != ():
4092
 
            raise errors.UnexpectedSmartServerResponse(response)
4093
 
 
4094
 
    def _real_object(self):
4095
 
        self._branch._ensure_real()
4096
 
        return self._branch._real_branch
4097
 
 
4098
 
    def _vfs_set_option(self, value, name, section=None):
4099
 
        return self._real_object()._get_config().set_option(
4100
 
            value, name, section)
4101
 
 
4102
 
 
4103
 
class RemoteBzrDirConfig(RemoteConfig):
4104
 
    """A RemoteConfig for BzrDirs."""
4105
 
 
4106
 
    def __init__(self, bzrdir):
4107
 
        self._bzrdir = bzrdir
4108
 
 
4109
 
    def _get_configobj(self):
4110
 
        medium = self._bzrdir._client._medium
4111
 
        verb = 'BzrDir.get_config_file'
4112
 
        if medium._is_remote_before((1, 15)):
4113
 
            raise errors.UnknownSmartMethod(verb)
4114
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
4115
 
        response = self._bzrdir._call_expecting_body(
4116
 
            verb, path)
4117
 
        return self._response_to_configobj(response)
4118
 
 
4119
 
    def _vfs_get_option(self, name, section, default):
4120
 
        return self._real_object()._get_config().get_option(
4121
 
            name, section, default)
4122
 
 
4123
 
    def set_option(self, value, name, section=None):
4124
 
        """Set the value associated with a named option.
4125
 
 
4126
 
        :param value: The value to set
4127
 
        :param name: The name of the value to set
4128
 
        :param section: The section the option is in (if any)
4129
 
        """
4130
 
        return self._real_object()._get_config().set_option(
4131
 
            value, name, section)
4132
 
 
4133
 
    def _real_object(self):
4134
 
        self._bzrdir._ensure_real()
4135
 
        return self._bzrdir._real_bzrdir
 
1720
        return self._real_branch.set_push_location(location)
 
1721
 
 
1722
    @needs_write_lock
 
1723
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
1724
                         graph=None):
 
1725
        """See Branch.update_revisions."""
 
1726
        other.lock_read()
 
1727
        try:
 
1728
            if stop_revision is None:
 
1729
                stop_revision = other.last_revision()
 
1730
                if revision.is_null(stop_revision):
 
1731
                    # if there are no commits, we're done.
 
1732
                    return
 
1733
            self.fetch(other, stop_revision)
 
1734
 
 
1735
            if overwrite:
 
1736
                # Just unconditionally set the new revision.  We don't care if
 
1737
                # the branches have diverged.
 
1738
                self._set_last_revision(stop_revision)
 
1739
            else:
 
1740
                medium = self._client._medium
 
1741
                if not medium._is_remote_before((1, 6)):
 
1742
                    try:
 
1743
                        self._set_last_revision_descendant(stop_revision, other)
 
1744
                        return
 
1745
                    except errors.UnknownSmartMethod:
 
1746
                        medium._remember_remote_is_before((1, 6))
 
1747
                # Fallback for pre-1.6 servers: check for divergence
 
1748
                # client-side, then do _set_last_revision.
 
1749
                last_rev = revision.ensure_null(self.last_revision())
 
1750
                if graph is None:
 
1751
                    graph = self.repository.get_graph()
 
1752
                if self._check_if_descendant_or_diverged(
 
1753
                        stop_revision, last_rev, graph, other):
 
1754
                    # stop_revision is a descendant of last_rev, but we aren't
 
1755
                    # overwriting, so we're done.
 
1756
                    return
 
1757
                self._set_last_revision(stop_revision)
 
1758
        finally:
 
1759
            other.unlock()
4136
1760
 
4137
1761
 
4138
1762
def _extract_tar(tar, to_dir):
4144
1768
        tar.extract(tarinfo, to_dir)
4145
1769
 
4146
1770
 
4147
 
error_translators = registry.Registry()
4148
 
no_context_error_translators = registry.Registry()
4149
 
 
4150
 
 
4151
1771
def _translate_error(err, **context):
4152
1772
    """Translate an ErrorFromSmartServer into a more useful error.
4153
1773
 
4182
1802
                    'Missing key %r in context %r', key_err.args[0], context)
4183
1803
                raise err
4184
1804
 
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):
 
1805
    if err.error_verb == 'NoSuchRevision':
 
1806
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
1807
    elif err.error_verb == 'nosuchrevision':
 
1808
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
1809
    elif err.error_tuple == ('nobranch',):
 
1810
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
1811
    elif err.error_verb == 'norepository':
 
1812
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
1813
    elif err.error_verb == 'LockContention':
 
1814
        raise errors.LockContention('(remote lock)')
 
1815
    elif err.error_verb == 'UnlockableTransport':
 
1816
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
1817
    elif err.error_verb == 'LockFailed':
 
1818
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
1819
    elif err.error_verb == 'TokenMismatch':
 
1820
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
1821
    elif err.error_verb == 'Diverged':
 
1822
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
1823
    elif err.error_verb == 'TipChangeRejected':
 
1824
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
1825
    elif err.error_verb == 'UnstackableBranchFormat':
 
1826
        raise errors.UnstackableBranchFormat(*err.error_args)
 
1827
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
1828
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
1829
    elif err.error_verb == 'NotStacked':
 
1830
        raise errors.NotStacked(branch=find('branch'))
 
1831
    elif err.error_verb == 'PermissionDenied':
 
1832
        path = get_path()
 
1833
        if len(err.error_args) >= 2:
 
1834
            extra = err.error_args[1]
 
1835
        else:
 
1836
            extra = None
 
1837
        raise errors.PermissionDenied(path, extra=extra)
 
1838
    elif err.error_verb == 'ReadError':
 
1839
        path = get_path()
 
1840
        raise errors.ReadError(path)
 
1841
    elif err.error_verb == 'NoSuchFile':
 
1842
        path = get_path()
 
1843
        raise errors.NoSuchFile(path)
 
1844
    elif err.error_verb == 'FileExists':
 
1845
        raise errors.FileExists(err.error_args[0])
 
1846
    elif err.error_verb == 'DirectoryNotEmpty':
 
1847
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
1848
    elif err.error_verb == 'ShortReadvError':
 
1849
        args = err.error_args
 
1850
        raise errors.ShortReadvError(
 
1851
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
1852
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
4280
1853
        encoding = str(err.error_args[0]) # encoding must always be a string
4281
1854
        val = err.error_args[1]
4282
1855
        start = int(err.error_args[2])
4290
1863
            raise UnicodeDecodeError(encoding, val, start, end, reason)
4291
1864
        elif err.error_verb == 'UnicodeEncodeError':
4292
1865
            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
 
 
 
1866
    elif err.error_verb == 'ReadOnlyError':
 
1867
        raise errors.TransportNotPossible('readonly transport')
 
1868
    raise errors.UnknownErrorFromSmartServer(err)