~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

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, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import bz2
20
 
import zlib
21
18
 
22
19
from bzrlib import (
23
20
    bencode,
24
21
    branch,
25
 
    bzrdir as _mod_bzrdir,
26
 
    config as _mod_config,
27
 
    controldir,
 
22
    bzrdir,
 
23
    config,
28
24
    debug,
29
25
    errors,
30
 
    gpg,
31
26
    graph,
32
 
    inventory_delta,
33
27
    lock,
34
28
    lockdir,
35
 
    osutils,
36
 
    registry,
37
 
    repository as _mod_repository,
 
29
    repository,
 
30
    revision,
38
31
    revision as _mod_revision,
39
 
    static_tuple,
40
32
    symbol_versioning,
41
 
    testament as _mod_testament,
42
 
    urlutils,
43
 
    vf_repository,
44
 
    vf_search,
45
 
    )
46
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
33
)
 
34
from bzrlib.branch import BranchReferenceFormat
 
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
47
36
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
48
37
from bzrlib.errors import (
49
38
    NoSuchRevision,
50
39
    SmartProtocolError,
51
40
    )
52
 
from bzrlib.i18n import gettext
53
 
from bzrlib.inventory import Inventory
54
41
from bzrlib.lockable_files import LockableFiles
55
42
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
 
43
from bzrlib.revision import ensure_null, NULL_REVISION
 
44
from bzrlib.trace import mutter, note, warning
66
45
 
67
46
 
68
47
class _RpcHelper(object):
105
84
    return format
106
85
 
107
86
 
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 self.bzrdir.user_url
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):
 
87
# Note: RemoteBzrDirFormat is in bzrdir.py
 
88
 
 
89
class RemoteBzrDir(BzrDir, _RpcHelper):
411
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
412
91
 
413
92
    def __init__(self, transport, format, _client=None, _force_probe=False):
416
95
        :param _client: Private parameter for testing. Disables probing and the
417
96
            use of a real bzrdir.
418
97
        """
419
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
98
        BzrDir.__init__(self, transport, format)
420
99
        # this object holds a delegated bzrdir that uses file-level operations
421
100
        # to talk to the other side
422
101
        self._real_bzrdir = None
435
114
 
436
115
        self._probe_bzrdir()
437
116
 
438
 
    def __repr__(self):
439
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
440
 
 
441
117
    def _probe_bzrdir(self):
442
118
        medium = self._client._medium
443
119
        path = self._path_for_remote_call(self._client)
478
154
        Used before calls to self._real_bzrdir.
479
155
        """
480
156
        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])
 
157
            self._real_bzrdir = BzrDir.open_from_transport(
 
158
                self.root_transport, _server_formats=False)
487
159
            self._format._network_name = \
488
160
                self._real_bzrdir._format.network_name()
489
161
 
494
166
        # Prevent aliasing problems in the next_open_branch_result cache.
495
167
        # See create_branch for rationale.
496
168
        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
 
169
        return BzrDir.break_lock(self)
540
170
 
541
171
    def _vfs_cloning_metadir(self, require_stacking=False):
542
172
        self._ensure_real()
573
203
        if len(branch_info) != 2:
574
204
            raise errors.UnexpectedSmartServerResponse(response)
575
205
        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
 
 
 
206
        format = bzrdir.network_format_registry.get(control_name)
581
207
        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)
 
208
            format.repository_format = repository.network_format_registry.get(
 
209
                repo_name)
588
210
        if branch_ref == 'ref':
589
211
            # XXX: we need possible_transports here to avoid reopening the
590
212
            # connection to the referenced location
591
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
 
213
            ref_bzrdir = BzrDir.open(branch_name)
592
214
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
593
215
            format.set_branch_format(branch_format)
594
216
        elif branch_ref == 'branch':
595
217
            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)
 
218
                format.set_branch_format(
 
219
                    branch.network_format_registry.get(branch_name))
603
220
        else:
604
221
            raise errors.UnexpectedSmartServerResponse(response)
605
222
        return format
615
232
 
616
233
    def destroy_repository(self):
617
234
        """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,))
 
235
        self._ensure_real()
 
236
        self._real_bzrdir.destroy_repository()
627
237
 
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)
 
238
    def create_branch(self):
634
239
        # as per meta1 formats - just delegate to the format object which may
635
240
        # be parameterised.
636
 
        real_branch = self._format.get_branch_format().initialize(self,
637
 
            name=name, repository=repository,
638
 
            append_revisions_only=append_revisions_only)
 
241
        real_branch = self._format.get_branch_format().initialize(self)
639
242
        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)
 
243
            result = RemoteBranch(self, self.find_repository(), real_branch)
645
244
        else:
646
245
            result = real_branch
647
246
        # BzrDir.clone_on_transport() uses the result of create_branch but does
653
252
        self._next_open_branch_result = result
654
253
        return result
655
254
 
656
 
    def destroy_branch(self, name=None):
 
255
    def destroy_branch(self):
657
256
        """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
 
257
        self._ensure_real()
 
258
        self._real_bzrdir.destroy_branch()
674
259
        self._next_open_branch_result = None
675
 
        if response[0] != 'ok':
676
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
677
260
 
678
 
    def create_workingtree(self, revision_id=None, from_branch=None,
679
 
        accelerator_tree=None, hardlink=False):
 
261
    def create_workingtree(self, revision_id=None, from_branch=None):
680
262
        raise errors.NotLocalUrl(self.transport.base)
681
263
 
682
 
    def find_branch_format(self, name=None):
 
264
    def find_branch_format(self):
683
265
        """Find the branch 'format' for this bzrdir.
684
266
 
685
267
        This might be a synthetic object for e.g. RemoteBranch and SVN.
686
268
        """
687
 
        b = self.open_branch(name=name)
 
269
        b = self.open_branch()
688
270
        return b._format
689
271
 
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):
 
272
    def get_branch_reference(self):
718
273
        """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
274
        response = self._get_branch_reference()
724
275
        if response[0] == 'ref':
725
276
            return response[1]
729
280
    def _get_branch_reference(self):
730
281
        path = self._path_for_remote_call(self._client)
731
282
        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
 
283
        if not medium._is_remote_before((1, 13)):
740
284
            try:
741
 
                response = self._call(verb, path)
 
285
                response = self._call('BzrDir.open_branchV2', path)
 
286
                if response[0] not in ('ref', 'branch'):
 
287
                    raise errors.UnexpectedSmartServerResponse(response)
 
288
                return response
742
289
            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'):
 
290
                medium._remember_remote_is_before((1, 13))
 
291
        response = self._call('BzrDir.open_branch', path)
 
292
        if response[0] != 'ok':
756
293
            raise errors.UnexpectedSmartServerResponse(response)
757
 
        return response
 
294
        if response[1] != '':
 
295
            return ('ref', response[1])
 
296
        else:
 
297
            return ('branch', '')
758
298
 
759
 
    def _get_tree_branch(self, name=None):
 
299
    def _get_tree_branch(self):
760
300
        """See BzrDir._get_tree_branch()."""
761
 
        return None, self.open_branch(name=name)
 
301
        return None, self.open_branch()
762
302
 
763
 
    def _open_branch(self, name, kind, location_or_format,
764
 
                     ignore_fallbacks=False, possible_transports=None):
765
 
        if kind == 'ref':
 
303
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
304
        if _unsupported:
 
305
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
306
        if self._next_open_branch_result is not None:
 
307
            # See create_branch for details.
 
308
            result = self._next_open_branch_result
 
309
            self._next_open_branch_result = None
 
310
            return result
 
311
        response = self._get_branch_reference()
 
312
        if response[0] == 'ref':
766
313
            # a branch reference, use the existing BranchReference logic.
767
314
            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
 
315
            return format.open(self, _found=True, location=response[1],
 
316
                ignore_fallbacks=ignore_fallbacks)
 
317
        branch_format_name = response[1]
772
318
        if not branch_format_name:
773
319
            branch_format_name = None
774
320
        format = RemoteBranchFormat(network_name=branch_format_name)
775
321
        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)
 
322
            setup_stacking=not ignore_fallbacks)
796
323
 
797
324
    def _open_repo_v1(self, path):
798
325
        verb = 'BzrDir.find_repository'
861
388
 
862
389
    def has_workingtree(self):
863
390
        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')
 
391
            self._ensure_real()
 
392
            self._has_working_tree = self._real_bzrdir.has_workingtree()
874
393
        return self._has_working_tree
875
394
 
876
395
    def open_workingtree(self, recommend_upgrade=True):
881
400
 
882
401
    def _path_for_remote_call(self, client):
883
402
        """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]
 
403
        return client.remote_path_from_transport(self.root_transport)
886
404
 
887
 
    def get_branch_transport(self, branch_format, name=None):
 
405
    def get_branch_transport(self, branch_format):
888
406
        self._ensure_real()
889
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
407
        return self._real_bzrdir.get_branch_transport(branch_format)
890
408
 
891
409
    def get_repository_transport(self, repository_format):
892
410
        self._ensure_real()
900
418
        """Upgrading of remote bzrdirs is not supported yet."""
901
419
        return False
902
420
 
903
 
    def needs_format_conversion(self, format):
 
421
    def needs_format_conversion(self, format=None):
904
422
        """Upgrading of remote bzrdirs is not supported yet."""
 
423
        if format is None:
 
424
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
425
                % 'needs_format_conversion(format=None)')
905
426
        return False
906
427
 
 
428
    def clone(self, url, revision_id=None, force_new_repo=False,
 
429
              preserve_stacking=False):
 
430
        self._ensure_real()
 
431
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
432
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
433
 
907
434
    def _get_config(self):
908
435
        return RemoteBzrDirConfig(self)
909
436
 
910
 
    def _get_config_store(self):
911
 
        return RemoteControlStore(self)
912
 
 
913
 
 
914
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
437
 
 
438
class RemoteRepositoryFormat(repository.RepositoryFormat):
915
439
    """Format for repositories accessed over a _SmartClient.
916
440
 
917
441
    Instances of this repository are represented by RemoteRepository
932
456
    """
933
457
 
934
458
    _matchingbzrdir = RemoteBzrDirFormat()
935
 
    supports_full_versioned_files = True
936
 
    supports_leaving_lock = True
937
459
 
938
460
    def __init__(self):
939
 
        _mod_repository.RepositoryFormat.__init__(self)
 
461
        repository.RepositoryFormat.__init__(self)
940
462
        self._custom_format = None
941
463
        self._network_name = None
942
464
        self._creating_bzrdir = None
943
 
        self._revision_graph_can_have_wrong_parents = None
944
465
        self._supports_chks = None
945
466
        self._supports_external_lookups = None
946
467
        self._supports_tree_reference = None
947
 
        self._supports_funky_characters = None
948
 
        self._supports_nesting_repositories = None
949
468
        self._rich_root_data = None
950
469
 
951
470
    def __repr__(self):
980
499
        return self._supports_external_lookups
981
500
 
982
501
    @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
502
    def supports_tree_reference(self):
1000
503
        if self._supports_tree_reference is None:
1001
504
            self._ensure_real()
1003
506
                self._custom_format.supports_tree_reference
1004
507
        return self._supports_tree_reference
1005
508
 
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
509
    def _vfs_initialize(self, a_bzrdir, shared):
1015
510
        """Helper for common code in initialize."""
1016
511
        if self._custom_format:
1051
546
            network_name = self._network_name
1052
547
        else:
1053
548
            # Select the current bzrlib default and ask for that.
1054
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
549
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
1055
550
            reference_format = reference_bzrdir_format.repository_format
1056
551
            network_name = reference_format.network_name()
1057
552
        # 2) try direct creation via RPC
1083
578
 
1084
579
    def _ensure_real(self):
1085
580
        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)
 
581
            self._custom_format = repository.network_format_registry.get(
 
582
                self._network_name)
1092
583
 
1093
584
    @property
1094
585
    def _fetch_order(self):
1106
597
        return self._custom_format._fetch_reconcile
1107
598
 
1108
599
    def get_format_description(self):
1109
 
        self._ensure_real()
1110
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
600
        return 'bzr remote repository'
1111
601
 
1112
602
    def __eq__(self, other):
1113
603
        return self.__class__ is other.__class__
1129
619
        return self._custom_format._serializer
1130
620
 
1131
621
 
1132
 
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
1133
 
        lock._RelockDebugMixin):
 
622
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin):
1134
623
    """Repository accessed over rpc.
1135
624
 
1136
625
    For the moment most operations are performed using local transport-backed
1160
649
        self._format = format
1161
650
        self._lock_mode = None
1162
651
        self._lock_token = None
1163
 
        self._write_group_tokens = None
1164
652
        self._lock_count = 0
1165
653
        self._leave_lock = False
1166
654
        # Cache of revision parents; misses are cached during read locks, and
1180
668
        # Additional places to query for data.
1181
669
        self._fallback_repositories = []
1182
670
 
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
671
    def __str__(self):
1195
672
        return "%s(%s)" % (self.__class__.__name__, self.base)
1196
673
 
1206
683
 
1207
684
        :param suppress_errors: see Repository.abort_write_group.
1208
685
        """
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
 
686
        self._ensure_real()
 
687
        return self._real_repository.abort_write_group(
 
688
            suppress_errors=suppress_errors)
1233
689
 
1234
690
    @property
1235
691
    def chk_bytes(self):
1249
705
        for older plugins that don't use e.g. the CommitBuilder
1250
706
        facility.
1251
707
        """
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()
 
708
        self._ensure_real()
 
709
        return self._real_repository.commit_write_group()
1265
710
 
1266
711
    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
 
712
        self._ensure_real()
 
713
        return self._real_repository.resume_write_group(tokens)
1279
714
 
1280
715
    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
 
716
        self._ensure_real()
 
717
        return self._real_repository.suspend_write_group()
1286
718
 
1287
719
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1288
720
        self._ensure_real()
1349
781
    def find_text_key_references(self):
1350
782
        """Find the text key references within the repository.
1351
783
 
 
784
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
785
        revision_ids. Each altered file-ids has the exact revision_ids that
 
786
        altered it listed explicitly.
1352
787
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1353
788
            to whether they were referred to by the inventory of the
1354
789
            revision_id that they contain. The inventory texts from all present
1372
807
        """Private method for using with old (< 1.2) servers to fallback."""
1373
808
        if revision_id is None:
1374
809
            revision_id = ''
1375
 
        elif _mod_revision.is_null(revision_id):
 
810
        elif revision.is_null(revision_id):
1376
811
            return {}
1377
812
 
1378
813
        path = self.bzrdir._path_for_remote_call(self._client)
1402
837
        return RemoteStreamSource(self, to_format)
1403
838
 
1404
839
    @needs_read_lock
1405
 
    def get_file_graph(self):
1406
 
        return graph.Graph(self.texts)
1407
 
 
1408
 
    @needs_read_lock
1409
840
    def has_revision(self, revision_id):
1410
841
        """True if this repository has a copy of the revision."""
1411
842
        # Copy of bzrlib.repository.Repository.has_revision
1428
859
    def _has_same_fallbacks(self, other_repo):
1429
860
        """Returns true if the repositories have the same fallbacks."""
1430
861
        # XXX: copied from Repository; it should be unified into a base class
1431
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
 
862
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
1432
863
        my_fb = self._fallback_repositories
1433
864
        other_fb = other_repo._fallback_repositories
1434
865
        if len(my_fb) != len(other_fb):
1450
881
        parents_provider = self._make_parents_provider(other_repository)
1451
882
        return graph.Graph(parents_provider)
1452
883
 
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
884
    def gather_stats(self, revid=None, committers=None):
1463
885
        """See Repository.gather_stats()."""
1464
886
        path = self.bzrdir._path_for_remote_call(self._client)
1465
887
        # revid can be None to indicate no revisions, not just NULL_REVISION
1466
 
        if revid is None or _mod_revision.is_null(revid):
 
888
        if revid is None or revision.is_null(revid):
1467
889
            fmt_revid = ''
1468
890
        else:
1469
891
            fmt_revid = revid
1498
920
 
1499
921
    def get_physical_lock_status(self):
1500
922
        """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')
 
923
        # should be an API call to the server.
 
924
        self._ensure_real()
 
925
        return self._real_repository.get_physical_lock_status()
1510
926
 
1511
927
    def is_in_write_group(self):
1512
928
        """Return True if there is an open write group.
1513
929
 
1514
930
        write groups are only applicable locally for the smart server..
1515
931
        """
1516
 
        if self._write_group_tokens is not None:
1517
 
            return True
1518
932
        if self._real_repository:
1519
933
            return self._real_repository.is_in_write_group()
1520
934
 
1532
946
    def is_write_locked(self):
1533
947
        return self._lock_mode == 'w'
1534
948
 
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
949
    def lock_read(self):
1541
 
        """Lock the repository for read operations.
1542
 
 
1543
 
        :return: A bzrlib.lock.LogicalLockResult.
1544
 
        """
1545
950
        # wrong eventually - want a local lock cache context
1546
951
        if not self._lock_mode:
1547
952
            self._note_lock('r')
1554
959
                repo.lock_read()
1555
960
        else:
1556
961
            self._lock_count += 1
1557
 
        return lock.LogicalLockResult(self.unlock)
1558
962
 
1559
963
    def _remote_lock_write(self, token):
1560
964
        path = self.bzrdir._path_for_remote_call(self._client)
1600
1004
            raise errors.ReadOnlyError(self)
1601
1005
        else:
1602
1006
            self._lock_count += 1
1603
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
1007
        return self._lock_token or None
1604
1008
 
1605
1009
    def leave_lock_in_place(self):
1606
1010
        if not self._lock_token:
1655
1059
            self._real_repository.lock_write(self._lock_token)
1656
1060
        elif self._lock_mode == 'r':
1657
1061
            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
1062
 
1663
1063
    def start_write_group(self):
1664
1064
        """Start a write group on the decorated repository.
1668
1068
        for older plugins that don't use e.g. the CommitBuilder
1669
1069
        facility.
1670
1070
        """
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]
 
1071
        self._ensure_real()
 
1072
        return self._real_repository.start_write_group()
1688
1073
 
1689
1074
    def _unlock(self, token):
1690
1075
        path = self.bzrdir._path_for_remote_call(self._client)
1717
1102
            # This is just to let the _real_repository stay up to date.
1718
1103
            if self._real_repository is not None:
1719
1104
                self._real_repository.unlock()
1720
 
            elif self._write_group_tokens is not None:
1721
 
                self.abort_write_group()
1722
1105
        finally:
1723
1106
            # The rpc-level lock should be released even if there was a
1724
1107
            # problem releasing the vfs-based lock.
1736
1119
 
1737
1120
    def break_lock(self):
1738
1121
        # 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)
 
1122
        self._ensure_real()
 
1123
        return self._real_repository.break_lock()
1747
1124
 
1748
1125
    def _get_tarball(self, compression):
1749
1126
        """Return a TemporaryFile containing a repository tarball.
1767
1144
            return t
1768
1145
        raise errors.UnexpectedSmartServerResponse(response)
1769
1146
 
1770
 
    @needs_read_lock
1771
1147
    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)
 
1148
        # TODO: Option to control what format is created?
 
1149
        self._ensure_real()
 
1150
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
1151
                                                             shared=False)
1777
1152
        dest_repo.fetch(self, revision_id=revision_id)
1778
1153
        return dest_repo
1779
1154
 
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
1155
    ### These methods are just thin shims to the VFS object for now.
1794
1156
 
1795
 
    @needs_read_lock
1796
1157
    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]
 
1158
        self._ensure_real()
 
1159
        return self._real_repository.revision_tree(revision_id)
1803
1160
 
1804
1161
    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]
 
1162
        self._ensure_real()
 
1163
        return self._real_repository.get_serializer_format()
1815
1164
 
1816
1165
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1817
1166
                           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
 
1167
                           revision_id=None):
 
1168
        # FIXME: It ought to be possible to call this without immediately
 
1169
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
1170
        self._ensure_real()
 
1171
        real_repo = self._real_repository
 
1172
        builder = real_repo.get_commit_builder(branch, parents,
 
1173
                config, timestamp=timestamp, timezone=timezone,
 
1174
                committer=committer, revprops=revprops, revision_id=revision_id)
 
1175
        return builder
1845
1176
 
1846
1177
    def add_fallback_repository(self, repository):
1847
1178
        """Add a repository to use for looking up data not held locally.
1854
1185
        # We need to accumulate additional repositories here, to pass them in
1855
1186
        # on various RPC's.
1856
1187
        #
1857
 
        # Make the check before we lock: this raises an exception.
1858
 
        self._check_fallback_repository(repository)
1859
1188
        if self.is_locked():
1860
1189
            # We will call fallback.unlock() when we transition to the unlocked
1861
1190
            # state, so always add a lock here. If a caller passes us a locked
1866
1195
        # _real_branch had its get_stacked_on_url method called), then the
1867
1196
        # repository to be added may already be in the _real_repositories list.
1868
1197
        if self._real_repository is not None:
1869
 
            fallback_locations = [repo.user_url for repo in
 
1198
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1870
1199
                self._real_repository._fallback_repositories]
1871
 
            if repository.user_url not in fallback_locations:
 
1200
            if repository.bzrdir.root_transport.base not in fallback_locations:
1872
1201
                self._real_repository.add_fallback_repository(repository)
1873
1202
 
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)
1883
 
 
1884
1203
    def add_inventory(self, revid, inv, parents):
1885
1204
        self._ensure_real()
1886
1205
        return self._real_repository.add_inventory(revid, inv, parents)
1887
1206
 
1888
1207
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1889
 
            parents, basis_inv=None, propagate_caches=False):
 
1208
                               parents):
1890
1209
        self._ensure_real()
1891
1210
        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)
 
1211
            delta, new_revision_id, parents)
 
1212
 
 
1213
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
1214
        self._ensure_real()
 
1215
        return self._real_repository.add_revision(
 
1216
            rev_id, rev, inv=inv, config=config)
1920
1217
 
1921
1218
    @needs_read_lock
1922
1219
    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
1220
        self._ensure_real()
1967
 
        return self._real_repository._iter_inventories(revision_ids, ordering)
 
1221
        return self._real_repository.get_inventory(revision_id)
1968
1222
 
1969
1223
    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()
 
1224
        self._ensure_real()
 
1225
        return self._real_repository.iter_inventories(revision_ids, ordering)
2044
1226
 
2045
1227
    @needs_read_lock
2046
1228
    def get_revision(self, revision_id):
2047
 
        return self.get_revisions([revision_id])[0]
 
1229
        self._ensure_real()
 
1230
        return self._real_repository.get_revision(revision_id)
2048
1231
 
2049
1232
    def get_transaction(self):
2050
1233
        self._ensure_real()
2052
1235
 
2053
1236
    @needs_read_lock
2054
1237
    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
 
1238
        self._ensure_real()
 
1239
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2059
1240
 
2060
1241
    def make_working_trees(self):
2061
1242
        """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'
 
1243
        self._ensure_real()
 
1244
        return self._real_repository.make_working_trees()
2071
1245
 
2072
1246
    def refresh_data(self):
2073
 
        """Re-read any data needed to synchronise with disk.
 
1247
        """Re-read any data needed to to synchronise with disk.
2074
1248
 
2075
1249
        This method is intended to be called after another repository instance
2076
1250
        (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.
 
1251
        repository. It may not be called during a write group, but may be
 
1252
        called at any other time.
2082
1253
        """
 
1254
        if self.is_in_write_group():
 
1255
            raise errors.InternalBzrError(
 
1256
                "May not refresh_data while in a write group.")
2083
1257
        if self._real_repository is not None:
2084
1258
            self._real_repository.refresh_data()
2085
 
        # Refresh the parents cache for this object
2086
 
        self._unstacked_provider.disable_cache()
2087
 
        self._unstacked_provider.enable_cache()
2088
1259
 
2089
1260
    def revision_ids_to_search_result(self, result_set):
2090
1261
        """Convert a set of revision ids to a graph SearchResult."""
2095
1266
        included_keys = result_set.intersection(result_parents)
2096
1267
        start_keys = result_set.difference(included_keys)
2097
1268
        exclude_keys = result_parents.difference(result_set)
2098
 
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
1269
        result = graph.SearchResult(start_keys, exclude_keys,
2099
1270
            len(result_set), result_set)
2100
1271
        return result
2101
1272
 
2102
1273
    @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):
 
1274
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
2107
1275
        """Return the revision ids that other has that this does not.
2108
1276
 
2109
1277
        These are returned in topological order.
2110
1278
 
2111
1279
        revision_id: only return revision ids included by revision_id.
2112
1280
        """
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)
 
1281
        return repository.InterRepository.get(
 
1282
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
2127
1283
 
2128
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1284
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
2129
1285
            fetch_spec=None):
2130
1286
        # No base implementation to use as RemoteRepository is not a subclass
2131
1287
        # of Repository; so this is a copy of Repository.fetch().
2142
1298
            # check that last_revision is in 'from' and then return a
2143
1299
            # no-operation.
2144
1300
            if (revision_id is not None and
2145
 
                not _mod_revision.is_null(revision_id)):
 
1301
                not revision.is_null(revision_id)):
2146
1302
                self.get_revision(revision_id)
2147
1303
            return 0, []
2148
1304
        # if there is no specific appropriate InterRepository, this will get
2149
1305
        # the InterRepository base class, which raises an
2150
1306
        # 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,
 
1307
        inter = repository.InterRepository.get(source, self)
 
1308
        return inter.fetch(revision_id=revision_id, pb=pb,
2157
1309
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
2158
1310
 
2159
1311
    def create_bundle(self, target, base, fileobj, format=None):
2161
1313
        self._real_repository.create_bundle(target, base, fileobj, format)
2162
1314
 
2163
1315
    @needs_read_lock
2164
 
    @symbol_versioning.deprecated_method(
2165
 
        symbol_versioning.deprecated_in((2, 4, 0)))
2166
1316
    def get_ancestry(self, revision_id, topo_sorted=True):
2167
1317
        self._ensure_real()
2168
1318
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
2176
1326
        return self._real_repository._get_versioned_file_checker(
2177
1327
            revisions, revision_versions_cache)
2178
1328
 
2179
 
    def _iter_files_bytes_rpc(self, desired_files, absent):
2180
 
        path = self.bzrdir._path_for_remote_call(self._client)
2181
 
        lines = []
2182
 
        identifiers = []
2183
 
        for (file_id, revid, identifier) in desired_files:
2184
 
            lines.append("%s\0%s" % (
2185
 
                osutils.safe_file_id(file_id),
2186
 
                osutils.safe_revision_id(revid)))
2187
 
            identifiers.append(identifier)
2188
 
        (response_tuple, response_handler) = (
2189
 
            self._call_with_body_bytes_expecting_body(
2190
 
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
2191
 
        if response_tuple != ('ok', ):
2192
 
            response_handler.cancel_read_body()
2193
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2194
 
        byte_stream = response_handler.read_streamed_body()
2195
 
        def decompress_stream(start, byte_stream, unused):
2196
 
            decompressor = zlib.decompressobj()
2197
 
            yield decompressor.decompress(start)
2198
 
            while decompressor.unused_data == "":
2199
 
                try:
2200
 
                    data = byte_stream.next()
2201
 
                except StopIteration:
2202
 
                    break
2203
 
                yield decompressor.decompress(data)
2204
 
            yield decompressor.flush()
2205
 
            unused.append(decompressor.unused_data)
2206
 
        unused = ""
2207
 
        while True:
2208
 
            while not "\n" in unused:
2209
 
                unused += byte_stream.next()
2210
 
            header, rest = unused.split("\n", 1)
2211
 
            args = header.split("\0")
2212
 
            if args[0] == "absent":
2213
 
                absent[identifiers[int(args[3])]] = (args[1], args[2])
2214
 
                unused = rest
2215
 
                continue
2216
 
            elif args[0] == "ok":
2217
 
                idx = int(args[1])
2218
 
            else:
2219
 
                raise errors.UnexpectedSmartServerResponse(args)
2220
 
            unused_chunks = []
2221
 
            yield (identifiers[idx],
2222
 
                decompress_stream(rest, byte_stream, unused_chunks))
2223
 
            unused = "".join(unused_chunks)
2224
 
 
2225
1329
    def iter_files_bytes(self, desired_files):
2226
1330
        """See Repository.iter_file_bytes.
2227
1331
        """
2228
 
        try:
2229
 
            absent = {}
2230
 
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
2231
 
                    desired_files, absent):
2232
 
                yield identifier, bytes_iterator
2233
 
            for fallback in self._fallback_repositories:
2234
 
                if not absent:
2235
 
                    break
2236
 
                desired_files = [(key[0], key[1], identifier) for
2237
 
                    (identifier, key) in absent.iteritems()]
2238
 
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
2239
 
                    del absent[identifier]
2240
 
                    yield identifier, bytes_iterator
2241
 
            if absent:
2242
 
                # There may be more missing items, but raise an exception
2243
 
                # for just one.
2244
 
                missing_identifier = absent.keys()[0]
2245
 
                missing_key = absent[missing_identifier]
2246
 
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
2247
 
                    file_id=missing_key[0])
2248
 
        except errors.UnknownSmartMethod:
2249
 
            self._ensure_real()
2250
 
            for (identifier, bytes_iterator) in (
2251
 
                self._real_repository.iter_files_bytes(desired_files)):
2252
 
                yield identifier, bytes_iterator
2253
 
 
2254
 
    def get_cached_parent_map(self, revision_ids):
2255
 
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
2256
 
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
 
1332
        self._ensure_real()
 
1333
        return self._real_repository.iter_files_bytes(desired_files)
2257
1334
 
2258
1335
    def get_parent_map(self, revision_ids):
2259
1336
        """See bzrlib.Graph.get_parent_map()."""
2318
1395
        if parents_map is None:
2319
1396
            # Repository is not locked, so there's no cache.
2320
1397
            parents_map = {}
2321
 
        if _DEFAULT_SEARCH_DEPTH <= 0:
2322
 
            (start_set, stop_keys,
2323
 
             key_count) = vf_search.search_result_from_parent_map(
2324
 
                parents_map, self._unstacked_provider.missing_keys)
2325
 
        else:
2326
 
            (start_set, stop_keys,
2327
 
             key_count) = vf_search.limited_search_result_from_parent_map(
2328
 
                parents_map, self._unstacked_provider.missing_keys,
2329
 
                keys, depth=_DEFAULT_SEARCH_DEPTH)
 
1398
        # start_set is all the keys in the cache
 
1399
        start_set = set(parents_map)
 
1400
        # result set is all the references to keys in the cache
 
1401
        result_parents = set()
 
1402
        for parents in parents_map.itervalues():
 
1403
            result_parents.update(parents)
 
1404
        stop_keys = result_parents.difference(start_set)
 
1405
        # We don't need to send ghosts back to the server as a position to
 
1406
        # stop either.
 
1407
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
 
1408
        key_count = len(parents_map)
 
1409
        if (NULL_REVISION in result_parents
 
1410
            and NULL_REVISION in self._unstacked_provider.missing_keys):
 
1411
            # If we pruned NULL_REVISION from the stop_keys because it's also
 
1412
            # in our cache of "missing" keys we need to increment our key count
 
1413
            # by 1, because the reconsitituted SearchResult on the server will
 
1414
            # still consider NULL_REVISION to be an included key.
 
1415
            key_count += 1
 
1416
        included_keys = start_set.intersection(result_parents)
 
1417
        start_set.difference_update(included_keys)
2330
1418
        recipe = ('manual', start_set, stop_keys, key_count)
2331
1419
        body = self._serialise_search_recipe(recipe)
2332
1420
        path = self.bzrdir._path_for_remote_call(self._client)
2381
1469
 
2382
1470
    @needs_read_lock
2383
1471
    def get_signature_text(self, revision_id):
2384
 
        path = self.bzrdir._path_for_remote_call(self._client)
2385
 
        try:
2386
 
            response_tuple, response_handler = self._call_expecting_body(
2387
 
                'Repository.get_revision_signature_text', path, revision_id)
2388
 
        except errors.UnknownSmartMethod:
2389
 
            self._ensure_real()
2390
 
            return self._real_repository.get_signature_text(revision_id)
2391
 
        except errors.NoSuchRevision, err:
2392
 
            for fallback in self._fallback_repositories:
2393
 
                try:
2394
 
                    return fallback.get_signature_text(revision_id)
2395
 
                except errors.NoSuchRevision:
2396
 
                    pass
2397
 
            raise err
2398
 
        else:
2399
 
            if response_tuple[0] != 'ok':
2400
 
                raise errors.UnexpectedSmartServerResponse(response_tuple)
2401
 
            return response_handler.read_body_bytes()
 
1472
        self._ensure_real()
 
1473
        return self._real_repository.get_signature_text(revision_id)
2402
1474
 
2403
1475
    @needs_read_lock
2404
 
    def _get_inventory_xml(self, revision_id):
2405
 
        # This call is used by older working tree formats,
2406
 
        # which stored a serialized basis inventory.
2407
 
        self._ensure_real()
2408
 
        return self._real_repository._get_inventory_xml(revision_id)
2409
 
 
2410
 
    @needs_write_lock
 
1476
    def get_inventory_xml(self, revision_id):
 
1477
        self._ensure_real()
 
1478
        return self._real_repository.get_inventory_xml(revision_id)
 
1479
 
 
1480
    def deserialise_inventory(self, revision_id, xml):
 
1481
        self._ensure_real()
 
1482
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
1483
 
2411
1484
    def reconcile(self, other=None, thorough=False):
2412
 
        from bzrlib.reconcile import RepoReconciler
2413
 
        path = self.bzrdir._path_for_remote_call(self._client)
2414
 
        try:
2415
 
            response, handler = self._call_expecting_body(
2416
 
                'Repository.reconcile', path, self._lock_token)
2417
 
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
2418
 
            self._ensure_real()
2419
 
            return self._real_repository.reconcile(other=other, thorough=thorough)
2420
 
        if response != ('ok', ):
2421
 
            raise errors.UnexpectedSmartServerResponse(response)
2422
 
        body = handler.read_body_bytes()
2423
 
        result = RepoReconciler(self)
2424
 
        for line in body.split('\n'):
2425
 
            if not line:
2426
 
                continue
2427
 
            key, val_text = line.split(':')
2428
 
            if key == "garbage_inventories":
2429
 
                result.garbage_inventories = int(val_text)
2430
 
            elif key == "inconsistent_parents":
2431
 
                result.inconsistent_parents = int(val_text)
2432
 
            else:
2433
 
                mutter("unknown reconcile key %r" % key)
2434
 
        return result
 
1485
        self._ensure_real()
 
1486
        return self._real_repository.reconcile(other=other, thorough=thorough)
2435
1487
 
2436
1488
    def all_revision_ids(self):
2437
 
        path = self.bzrdir._path_for_remote_call(self._client)
2438
 
        try:
2439
 
            response_tuple, response_handler = self._call_expecting_body(
2440
 
                "Repository.all_revision_ids", path)
2441
 
        except errors.UnknownSmartMethod:
2442
 
            self._ensure_real()
2443
 
            return self._real_repository.all_revision_ids()
2444
 
        if response_tuple != ("ok", ):
2445
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2446
 
        revids = set(response_handler.read_body_bytes().splitlines())
2447
 
        for fallback in self._fallback_repositories:
2448
 
            revids.update(set(fallback.all_revision_ids()))
2449
 
        return list(revids)
2450
 
 
2451
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2452
 
        """Return Tree for a revision on this branch with only some files.
2453
 
 
2454
 
        :param revision_ids: a sequence of revision-ids;
2455
 
          a revision-id may not be None or 'null:'
2456
 
        :param file_ids: if not None, the result is filtered
2457
 
          so that only those file-ids, their parents and their
2458
 
          children are included.
2459
 
        """
2460
 
        inventories = self.iter_inventories(revision_ids)
2461
 
        for inv in inventories:
2462
 
            # Should we introduce a FilteredRevisionTree class rather
2463
 
            # than pre-filter the inventory here?
2464
 
            filtered_inv = inv.filter(file_ids)
2465
 
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
1489
        self._ensure_real()
 
1490
        return self._real_repository.all_revision_ids()
2466
1491
 
2467
1492
    @needs_read_lock
2468
1493
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
2469
 
        medium = self._client._medium
2470
 
        if medium._is_remote_before((1, 2)):
2471
 
            self._ensure_real()
2472
 
            for delta in self._real_repository.get_deltas_for_revisions(
2473
 
                    revisions, specific_fileids):
2474
 
                yield delta
2475
 
            return
2476
 
        # Get the revision-ids of interest
2477
 
        required_trees = set()
2478
 
        for revision in revisions:
2479
 
            required_trees.add(revision.revision_id)
2480
 
            required_trees.update(revision.parent_ids[:1])
2481
 
 
2482
 
        # Get the matching filtered trees. Note that it's more
2483
 
        # efficient to pass filtered trees to changes_from() rather
2484
 
        # than doing the filtering afterwards. changes_from() could
2485
 
        # arguably do the filtering itself but it's path-based, not
2486
 
        # file-id based, so filtering before or afterwards is
2487
 
        # currently easier.
2488
 
        if specific_fileids is None:
2489
 
            trees = dict((t.get_revision_id(), t) for
2490
 
                t in self.revision_trees(required_trees))
2491
 
        else:
2492
 
            trees = dict((t.get_revision_id(), t) for
2493
 
                t in self._filtered_revision_trees(required_trees,
2494
 
                specific_fileids))
2495
 
 
2496
 
        # Calculate the deltas
2497
 
        for revision in revisions:
2498
 
            if not revision.parent_ids:
2499
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
2500
 
            else:
2501
 
                old_tree = trees[revision.parent_ids[0]]
2502
 
            yield trees[revision.revision_id].changes_from(old_tree)
 
1494
        self._ensure_real()
 
1495
        return self._real_repository.get_deltas_for_revisions(revisions,
 
1496
            specific_fileids=specific_fileids)
2503
1497
 
2504
1498
    @needs_read_lock
2505
1499
    def get_revision_delta(self, revision_id, specific_fileids=None):
2506
 
        r = self.get_revision(revision_id)
2507
 
        return list(self.get_deltas_for_revisions([r],
2508
 
            specific_fileids=specific_fileids))[0]
 
1500
        self._ensure_real()
 
1501
        return self._real_repository.get_revision_delta(revision_id,
 
1502
            specific_fileids=specific_fileids)
2509
1503
 
2510
1504
    @needs_read_lock
2511
1505
    def revision_trees(self, revision_ids):
2512
 
        inventories = self.iter_inventories(revision_ids)
2513
 
        for inv in inventories:
2514
 
            yield InventoryRevisionTree(self, inv, inv.revision_id)
 
1506
        self._ensure_real()
 
1507
        return self._real_repository.revision_trees(revision_ids)
2515
1508
 
2516
1509
    @needs_read_lock
2517
1510
    def get_revision_reconcile(self, revision_id):
2525
1518
            callback_refs=callback_refs, check_repo=check_repo)
2526
1519
 
2527
1520
    def copy_content_into(self, destination, revision_id=None):
2528
 
        """Make a complete copy of the content in self into destination.
2529
 
 
2530
 
        This is a destructive operation! Do not use it on existing
2531
 
        repositories.
2532
 
        """
2533
 
        interrepo = _mod_repository.InterRepository.get(self, destination)
2534
 
        return interrepo.copy_content(revision_id)
 
1521
        self._ensure_real()
 
1522
        return self._real_repository.copy_content_into(
 
1523
            destination, revision_id=revision_id)
2535
1524
 
2536
1525
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
2537
1526
        # get a tarball of the remote repository, and copy from that into the
2538
1527
        # destination
 
1528
        from bzrlib import osutils
2539
1529
        import tarfile
2540
1530
        # TODO: Maybe a progress bar while streaming the tarball?
2541
 
        note(gettext("Copying repository content as tarball..."))
 
1531
        note("Copying repository content as tarball...")
2542
1532
        tar_file = self._get_tarball('bz2')
2543
1533
        if tar_file is None:
2544
1534
            return None
2549
1539
            tmpdir = osutils.mkdtemp()
2550
1540
            try:
2551
1541
                _extract_tar(tar, tmpdir)
2552
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1542
                tmp_bzrdir = BzrDir.open(tmpdir)
2553
1543
                tmp_repo = tmp_bzrdir.open_repository()
2554
1544
                tmp_repo.copy_content_into(destination, revision_id)
2555
1545
            finally:
2571
1561
        return self._real_repository.inventories
2572
1562
 
2573
1563
    @needs_write_lock
2574
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1564
    def pack(self, hint=None):
2575
1565
        """Compress the data within the repository.
 
1566
 
 
1567
        This is not currently implemented within the smart server.
2576
1568
        """
2577
 
        if hint is None:
2578
 
            body = ""
2579
 
        else:
2580
 
            body = "".join([l+"\n" for l in hint])
2581
 
        path = self.bzrdir._path_for_remote_call(self._client)
2582
 
        try:
2583
 
            response, handler = self._call_with_body_bytes_expecting_body(
2584
 
                'Repository.pack', (path, self._lock_token,
2585
 
                    str(clean_obsolete_packs)), body)
2586
 
        except errors.UnknownSmartMethod:
2587
 
            self._ensure_real()
2588
 
            return self._real_repository.pack(hint=hint,
2589
 
                clean_obsolete_packs=clean_obsolete_packs)
2590
 
        handler.cancel_read_body()
2591
 
        if response != ('ok', ):
2592
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1569
        self._ensure_real()
 
1570
        return self._real_repository.pack(hint=hint)
2593
1571
 
2594
1572
    @property
2595
1573
    def revisions(self):
2596
1574
        """Decorate the real repository for now.
2597
1575
 
 
1576
        In the short term this should become a real object to intercept graph
 
1577
        lookups.
 
1578
 
2598
1579
        In the long term a full blown network facility is needed.
2599
1580
        """
2600
1581
        self._ensure_real()
2628
1609
 
2629
1610
    @needs_write_lock
2630
1611
    def sign_revision(self, revision_id, gpg_strategy):
2631
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2632
 
        plaintext = testament.as_short_text()
2633
 
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1612
        self._ensure_real()
 
1613
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
2634
1614
 
2635
1615
    @property
2636
1616
    def texts(self):
2642
1622
        self._ensure_real()
2643
1623
        return self._real_repository.texts
2644
1624
 
2645
 
    def _iter_revisions_rpc(self, revision_ids):
2646
 
        body = "\n".join(revision_ids)
2647
 
        path = self.bzrdir._path_for_remote_call(self._client)
2648
 
        response_tuple, response_handler = (
2649
 
            self._call_with_body_bytes_expecting_body(
2650
 
            "Repository.iter_revisions", (path, ), body))
2651
 
        if response_tuple[0] != "ok":
2652
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2653
 
        serializer_format = response_tuple[1]
2654
 
        serializer = serializer_format_registry.get(serializer_format)
2655
 
        byte_stream = response_handler.read_streamed_body()
2656
 
        decompressor = zlib.decompressobj()
2657
 
        chunks = []
2658
 
        for bytes in byte_stream:
2659
 
            chunks.append(decompressor.decompress(bytes))
2660
 
            if decompressor.unused_data != "":
2661
 
                chunks.append(decompressor.flush())
2662
 
                yield serializer.read_revision_from_string("".join(chunks))
2663
 
                unused = decompressor.unused_data
2664
 
                decompressor = zlib.decompressobj()
2665
 
                chunks = [decompressor.decompress(unused)]
2666
 
        chunks.append(decompressor.flush())
2667
 
        text = "".join(chunks)
2668
 
        if text != "":
2669
 
            yield serializer.read_revision_from_string("".join(chunks))
2670
 
 
2671
1625
    @needs_read_lock
2672
1626
    def get_revisions(self, revision_ids):
2673
 
        if revision_ids is None:
2674
 
            revision_ids = self.all_revision_ids()
2675
 
        else:
2676
 
            for rev_id in revision_ids:
2677
 
                if not rev_id or not isinstance(rev_id, basestring):
2678
 
                    raise errors.InvalidRevisionId(
2679
 
                        revision_id=rev_id, branch=self)
2680
 
        try:
2681
 
            missing = set(revision_ids)
2682
 
            revs = {}
2683
 
            for rev in self._iter_revisions_rpc(revision_ids):
2684
 
                missing.remove(rev.revision_id)
2685
 
                revs[rev.revision_id] = rev
2686
 
        except errors.UnknownSmartMethod:
2687
 
            self._ensure_real()
2688
 
            return self._real_repository.get_revisions(revision_ids)
2689
 
        for fallback in self._fallback_repositories:
2690
 
            if not missing:
2691
 
                break
2692
 
            for revid in list(missing):
2693
 
                # XXX JRV 2011-11-20: It would be nice if there was a
2694
 
                # public method on Repository that could be used to query
2695
 
                # for revision objects *without* failing completely if one
2696
 
                # was missing. There is VersionedFileRepository._iter_revisions,
2697
 
                # but unfortunately that's private and not provided by
2698
 
                # all repository implementations.
2699
 
                try:
2700
 
                    revs[revid] = fallback.get_revision(revid)
2701
 
                except errors.NoSuchRevision:
2702
 
                    pass
2703
 
                else:
2704
 
                    missing.remove(revid)
2705
 
        if missing:
2706
 
            raise errors.NoSuchRevision(self, list(missing)[0])
2707
 
        return [revs[revid] for revid in revision_ids]
 
1627
        self._ensure_real()
 
1628
        return self._real_repository.get_revisions(revision_ids)
2708
1629
 
2709
1630
    def supports_rich_root(self):
2710
1631
        return self._format.rich_root_data
2711
1632
 
2712
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2713
1633
    def iter_reverse_revision_history(self, revision_id):
2714
1634
        self._ensure_real()
2715
1635
        return self._real_repository.iter_reverse_revision_history(revision_id)
2718
1638
    def _serializer(self):
2719
1639
        return self._format._serializer
2720
1640
 
2721
 
    @needs_write_lock
2722
1641
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2723
 
        signature = gpg_strategy.sign(plaintext)
2724
 
        self.add_signature_text(revision_id, signature)
 
1642
        self._ensure_real()
 
1643
        return self._real_repository.store_revision_signature(
 
1644
            gpg_strategy, plaintext, revision_id)
2725
1645
 
2726
1646
    def add_signature_text(self, revision_id, signature):
2727
 
        if self._real_repository:
2728
 
            # If there is a real repository the write group will
2729
 
            # be in the real repository as well, so use that:
2730
 
            self._ensure_real()
2731
 
            return self._real_repository.add_signature_text(
2732
 
                revision_id, signature)
2733
 
        path = self.bzrdir._path_for_remote_call(self._client)
2734
 
        response, handler = self._call_with_body_bytes_expecting_body(
2735
 
            'Repository.add_signature_text', (path, self._lock_token,
2736
 
                revision_id) + tuple(self._write_group_tokens), signature)
2737
 
        handler.cancel_read_body()
2738
 
        self.refresh_data()
2739
 
        if response[0] != 'ok':
2740
 
            raise errors.UnexpectedSmartServerResponse(response)
2741
 
        self._write_group_tokens = response[1:]
 
1647
        self._ensure_real()
 
1648
        return self._real_repository.add_signature_text(revision_id, signature)
2742
1649
 
2743
1650
    def has_signature_for_revision_id(self, revision_id):
2744
 
        path = self.bzrdir._path_for_remote_call(self._client)
2745
 
        try:
2746
 
            response = self._call('Repository.has_signature_for_revision_id',
2747
 
                path, revision_id)
2748
 
        except errors.UnknownSmartMethod:
2749
 
            self._ensure_real()
2750
 
            return self._real_repository.has_signature_for_revision_id(
2751
 
                revision_id)
2752
 
        if response[0] not in ('yes', 'no'):
2753
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2754
 
        if response[0] == 'yes':
2755
 
            return True
2756
 
        for fallback in self._fallback_repositories:
2757
 
            if fallback.has_signature_for_revision_id(revision_id):
2758
 
                return True
2759
 
        return False
2760
 
 
2761
 
    @needs_read_lock
2762
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
2763
 
        if not self.has_signature_for_revision_id(revision_id):
2764
 
            return gpg.SIGNATURE_NOT_SIGNED, None
2765
 
        signature = self.get_signature_text(revision_id)
2766
 
 
2767
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2768
 
        plaintext = testament.as_short_text()
2769
 
 
2770
 
        return gpg_strategy.verify(signature, plaintext)
 
1651
        self._ensure_real()
 
1652
        return self._real_repository.has_signature_for_revision_id(revision_id)
2771
1653
 
2772
1654
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2773
1655
        self._ensure_real()
2774
1656
        return self._real_repository.item_keys_introduced_by(revision_ids,
2775
1657
            _files_pb=_files_pb)
2776
1658
 
 
1659
    def revision_graph_can_have_wrong_parents(self):
 
1660
        # The answer depends on the remote repo format.
 
1661
        self._ensure_real()
 
1662
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1663
 
2777
1664
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2778
1665
        self._ensure_real()
2779
1666
        return self._real_repository._find_inconsistent_revision_parents(
2787
1674
        providers = [self._unstacked_provider]
2788
1675
        if other is not None:
2789
1676
            providers.insert(0, other)
2790
 
        return graph.StackedParentsProvider(_LazyListJoin(
2791
 
            providers, self._fallback_repositories))
 
1677
        providers.extend(r._make_parents_provider() for r in
 
1678
                         self._fallback_repositories)
 
1679
        return graph.StackedParentsProvider(providers)
2792
1680
 
2793
1681
    def _serialise_search_recipe(self, recipe):
2794
1682
        """Serialise a graph search recipe.
2802
1690
        return '\n'.join((start_keys, stop_keys, count))
2803
1691
 
2804
1692
    def _serialise_search_result(self, search_result):
2805
 
        parts = search_result.get_network_struct()
 
1693
        if isinstance(search_result, graph.PendingAncestryResult):
 
1694
            parts = ['ancestry-of']
 
1695
            parts.extend(search_result.heads)
 
1696
        else:
 
1697
            recipe = search_result.get_recipe()
 
1698
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
2806
1699
        return '\n'.join(parts)
2807
1700
 
2808
1701
    def autopack(self):
2818
1711
            raise errors.UnexpectedSmartServerResponse(response)
2819
1712
 
2820
1713
 
2821
 
class RemoteStreamSink(vf_repository.StreamSink):
 
1714
class RemoteStreamSink(repository.StreamSink):
2822
1715
 
2823
1716
    def _insert_real(self, stream, src_format, resume_tokens):
2824
1717
        self.target_repo._ensure_real()
2925
1818
        self._last_substream and self._last_stream so that the stream can be
2926
1819
        resumed by _resume_stream_with_vfs.
2927
1820
        """
2928
 
 
 
1821
                    
2929
1822
        stream_iter = iter(stream)
2930
1823
        for substream_kind, substream in stream_iter:
2931
1824
            if substream_kind == 'inventory-deltas':
2934
1827
                return
2935
1828
            else:
2936
1829
                yield substream_kind, substream
2937
 
 
2938
 
 
2939
 
class RemoteStreamSource(vf_repository.StreamSource):
 
1830
            
 
1831
 
 
1832
class RemoteStreamSource(repository.StreamSource):
2940
1833
    """Stream data from a remote server."""
2941
1834
 
2942
1835
    def get_stream(self, search):
2963
1856
 
2964
1857
    def _real_stream(self, repo, search):
2965
1858
        """Get a stream for search from repo.
2966
 
 
2967
 
        This never called RemoteStreamSource.get_stream, and is a helper
2968
 
        for RemoteStreamSource._get_stream to allow getting a stream
 
1859
        
 
1860
        This never called RemoteStreamSource.get_stream, and is a heler
 
1861
        for RemoteStreamSource._get_stream to allow getting a stream 
2969
1862
        reliably whether fallback back because of old servers or trying
2970
1863
        to stream from a non-RemoteRepository (which the stacked support
2971
1864
        code will do).
3002
1895
        candidate_verbs = [
3003
1896
            ('Repository.get_stream_1.19', (1, 19)),
3004
1897
            ('Repository.get_stream', (1, 13))]
3005
 
 
3006
1898
        found_verb = False
3007
1899
        for verb, version in candidate_verbs:
3008
1900
            if medium._is_remote_before(version):
3012
1904
                    verb, args, search_bytes)
3013
1905
            except errors.UnknownSmartMethod:
3014
1906
                medium._remember_remote_is_before(version)
3015
 
            except errors.UnknownErrorFromSmartServer, e:
3016
 
                if isinstance(search, vf_search.EverythingResult):
3017
 
                    error_verb = e.error_from_smart_server.error_verb
3018
 
                    if error_verb == 'BadSearch':
3019
 
                        # Pre-2.4 servers don't support this sort of search.
3020
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
3021
 
                        # good idea in general?  It might provide a little bit
3022
 
                        # of protection against client-side bugs.
3023
 
                        medium._remember_remote_is_before((2, 4))
3024
 
                        break
3025
 
                raise
3026
1907
            else:
3027
1908
                response_tuple, response_handler = response
3028
1909
                found_verb = True
3032
1913
        if response_tuple[0] != 'ok':
3033
1914
            raise errors.UnexpectedSmartServerResponse(response_tuple)
3034
1915
        byte_stream = response_handler.read_streamed_body()
3035
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
3036
 
            self._record_counter)
 
1916
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
3037
1917
        if src_format.network_name() != repo._format.network_name():
3038
1918
            raise AssertionError(
3039
1919
                "Mismatched RemoteRepository and stream src %r, %r" % (
3111
1991
 
3112
1992
    def _ensure_real(self):
3113
1993
        if self._custom_format is None:
3114
 
            try:
3115
 
                self._custom_format = branch.network_format_registry.get(
3116
 
                    self._network_name)
3117
 
            except KeyError:
3118
 
                raise errors.UnknownFormatError(kind='branch',
3119
 
                    format=self._network_name)
 
1994
            self._custom_format = branch.network_format_registry.get(
 
1995
                self._network_name)
3120
1996
 
3121
1997
    def get_format_description(self):
3122
 
        self._ensure_real()
3123
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1998
        return 'Remote BZR Branch'
3124
1999
 
3125
2000
    def network_name(self):
3126
2001
        return self._network_name
3127
2002
 
3128
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
3129
 
        return a_bzrdir.open_branch(name=name, 
3130
 
            ignore_fallbacks=ignore_fallbacks)
 
2003
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
2004
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
3131
2005
 
3132
 
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
 
2006
    def _vfs_initialize(self, a_bzrdir):
3133
2007
        # Initialisation when using a local bzrdir object, or a non-vfs init
3134
2008
        # method is not available on the server.
3135
2009
        # self._custom_format is always set - the start of initialize ensures
3136
2010
        # that.
3137
2011
        if isinstance(a_bzrdir, RemoteBzrDir):
3138
2012
            a_bzrdir._ensure_real()
3139
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
3140
 
                name=name, append_revisions_only=append_revisions_only)
 
2013
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
3141
2014
        else:
3142
2015
            # We assume the bzrdir is parameterised; it may not be.
3143
 
            result = self._custom_format.initialize(a_bzrdir, name=name,
3144
 
                append_revisions_only=append_revisions_only)
 
2016
            result = self._custom_format.initialize(a_bzrdir)
3145
2017
        if (isinstance(a_bzrdir, RemoteBzrDir) and
3146
2018
            not isinstance(result, RemoteBranch)):
3147
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
3148
 
                                  name=name)
 
2019
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
3149
2020
        return result
3150
2021
 
3151
 
    def initialize(self, a_bzrdir, name=None, repository=None,
3152
 
                   append_revisions_only=None):
3153
 
        if name is None:
3154
 
            name = a_bzrdir._get_selected_branch()
 
2022
    def initialize(self, a_bzrdir):
3155
2023
        # 1) get the network name to use.
3156
2024
        if self._custom_format:
3157
2025
            network_name = self._custom_format.network_name()
3158
2026
        else:
3159
2027
            # Select the current bzrlib default and ask for that.
3160
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
2028
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
3161
2029
            reference_format = reference_bzrdir_format.get_branch_format()
3162
2030
            self._custom_format = reference_format
3163
2031
            network_name = reference_format.network_name()
3164
2032
        # Being asked to create on a non RemoteBzrDir:
3165
2033
        if not isinstance(a_bzrdir, RemoteBzrDir):
3166
 
            return self._vfs_initialize(a_bzrdir, name=name,
3167
 
                append_revisions_only=append_revisions_only)
 
2034
            return self._vfs_initialize(a_bzrdir)
3168
2035
        medium = a_bzrdir._client._medium
3169
2036
        if medium._is_remote_before((1, 13)):
3170
 
            return self._vfs_initialize(a_bzrdir, name=name,
3171
 
                append_revisions_only=append_revisions_only)
 
2037
            return self._vfs_initialize(a_bzrdir)
3172
2038
        # Creating on a remote bzr dir.
3173
2039
        # 2) try direct creation via RPC
3174
2040
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
3175
 
        if name != "":
3176
 
            # XXX JRV20100304: Support creating colocated branches
3177
 
            raise errors.NoColocatedBranchSupport(self)
3178
2041
        verb = 'BzrDir.create_branch'
3179
2042
        try:
3180
2043
            response = a_bzrdir._call(verb, path, network_name)
3181
2044
        except errors.UnknownSmartMethod:
3182
2045
            # Fallback - use vfs methods
3183
2046
            medium._remember_remote_is_before((1, 13))
3184
 
            return self._vfs_initialize(a_bzrdir, name=name,
3185
 
                    append_revisions_only=append_revisions_only)
 
2047
            return self._vfs_initialize(a_bzrdir)
3186
2048
        if response[0] != 'ok':
3187
2049
            raise errors.UnexpectedSmartServerResponse(response)
3188
2050
        # Turn the response into a RemoteRepository object.
3189
2051
        format = RemoteBranchFormat(network_name=response[1])
3190
2052
        repo_format = response_tuple_to_repo_format(response[3:])
3191
 
        repo_path = response[2]
3192
 
        if repository is not None:
3193
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
3194
 
            url_diff = urlutils.relative_url(repository.user_url,
3195
 
                    remote_repo_url)
3196
 
            if url_diff != '.':
3197
 
                raise AssertionError(
3198
 
                    'repository.user_url %r does not match URL from server '
3199
 
                    'response (%r + %r)'
3200
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
3201
 
            remote_repo = repository
 
2053
        if response[2] == '':
 
2054
            repo_bzrdir = a_bzrdir
3202
2055
        else:
3203
 
            if repo_path == '':
3204
 
                repo_bzrdir = a_bzrdir
3205
 
            else:
3206
 
                repo_bzrdir = RemoteBzrDir(
3207
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
3208
 
                    a_bzrdir._client)
3209
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2056
            repo_bzrdir = RemoteBzrDir(
 
2057
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
2058
                a_bzrdir._client)
 
2059
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
3210
2060
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
3211
 
            format=format, setup_stacking=False, name=name)
3212
 
        if append_revisions_only:
3213
 
            remote_branch.set_append_revisions_only(append_revisions_only)
 
2061
            format=format, setup_stacking=False)
3214
2062
        # XXX: We know this is a new branch, so it must have revno 0, revid
3215
2063
        # NULL_REVISION. Creating the branch locked would make this be unable
3216
2064
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
3235
2083
        self._ensure_real()
3236
2084
        return self._custom_format.supports_set_append_revisions_only()
3237
2085
 
3238
 
    def _use_default_local_heads_to_fetch(self):
3239
 
        # If the branch format is a metadir format *and* its heads_to_fetch
3240
 
        # implementation is not overridden vs the base class, we can use the
3241
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
3242
 
        # usually cheaper in terms of net round trips, as the last-revision and
3243
 
        # tags info fetched is cached and would be fetched anyway.
3244
 
        self._ensure_real()
3245
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
3246
 
            branch_class = self._custom_format._branch_class()
3247
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
3248
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
3249
 
                return True
3250
 
        return False
3251
 
 
3252
 
 
3253
 
class RemoteBranchStore(_mod_config.IniFileStore):
3254
 
    """Branch store which attempts to use HPSS calls to retrieve branch store.
3255
 
 
3256
 
    Note that this is specific to bzr-based formats.
3257
 
    """
3258
 
 
3259
 
    def __init__(self, branch):
3260
 
        super(RemoteBranchStore, self).__init__()
3261
 
        self.branch = branch
3262
 
        self.id = "branch"
3263
 
        self._real_store = None
3264
 
 
3265
 
    def external_url(self):
3266
 
        return self.branch.user_url
3267
 
 
3268
 
    def _load_content(self):
3269
 
        path = self.branch._remote_path()
3270
 
        try:
3271
 
            response, handler = self.branch._call_expecting_body(
3272
 
                'Branch.get_config_file', path)
3273
 
        except errors.UnknownSmartMethod:
3274
 
            self._ensure_real()
3275
 
            return self._real_store._load_content()
3276
 
        if len(response) and response[0] != 'ok':
3277
 
            raise errors.UnexpectedSmartServerResponse(response)
3278
 
        return handler.read_body_bytes()
3279
 
 
3280
 
    def _save_content(self, content):
3281
 
        path = self.branch._remote_path()
3282
 
        try:
3283
 
            response, handler = self.branch._call_with_body_bytes_expecting_body(
3284
 
                'Branch.put_config_file', (path,
3285
 
                    self.branch._lock_token, self.branch._repo_lock_token),
3286
 
                content)
3287
 
        except errors.UnknownSmartMethod:
3288
 
            self._ensure_real()
3289
 
            return self._real_store._save_content(content)
3290
 
        handler.cancel_read_body()
3291
 
        if response != ('ok', ):
3292
 
            raise errors.UnexpectedSmartServerResponse(response)
3293
 
 
3294
 
    def _ensure_real(self):
3295
 
        self.branch._ensure_real()
3296
 
        if self._real_store is None:
3297
 
            self._real_store = _mod_config.BranchStore(self.branch)
3298
 
 
3299
2086
 
3300
2087
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
3301
2088
    """Branch stored on a server accessed by HPSS RPC.
3304
2091
    """
3305
2092
 
3306
2093
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
3307
 
        _client=None, format=None, setup_stacking=True, name=None,
3308
 
        possible_transports=None):
 
2094
        _client=None, format=None, setup_stacking=True):
3309
2095
        """Create a RemoteBranch instance.
3310
2096
 
3311
2097
        :param real_branch: An optional local implementation of the branch
3317
2103
        :param setup_stacking: If True make an RPC call to determine the
3318
2104
            stacked (or not) status of the branch. If False assume the branch
3319
2105
            is not stacked.
3320
 
        :param name: Colocated branch name
3321
2106
        """
3322
2107
        # We intentionally don't call the parent class's __init__, because it
3323
2108
        # will try to assign to self.tags, which is a property in this subclass.
3324
2109
        # And the parent's __init__ doesn't do much anyway.
3325
2110
        self.bzrdir = remote_bzrdir
3326
 
        self.name = name
3327
2111
        if _client is not None:
3328
2112
            self._client = _client
3329
2113
        else:
3343
2127
            self._real_branch = None
3344
2128
        # Fill out expected attributes of branch for bzrlib API users.
3345
2129
        self._clear_cached_state()
3346
 
        # TODO: deprecate self.base in favor of user_url
3347
 
        self.base = self.bzrdir.user_url
3348
 
        self._name = name
 
2130
        self.base = self.bzrdir.root_transport.base
3349
2131
        self._control_files = None
3350
2132
        self._lock_mode = None
3351
2133
        self._lock_token = None
3352
2134
        self._repo_lock_token = None
3353
2135
        self._lock_count = 0
3354
2136
        self._leave_lock = False
3355
 
        self.conf_store = None
3356
2137
        # Setup a format: note that we cannot call _ensure_real until all the
3357
2138
        # attributes above are set: This code cannot be moved higher up in this
3358
2139
        # function.
3378
2159
            hook(self)
3379
2160
        self._is_stacked = False
3380
2161
        if setup_stacking:
3381
 
            self._setup_stacking(possible_transports)
 
2162
            self._setup_stacking()
3382
2163
 
3383
 
    def _setup_stacking(self, possible_transports):
 
2164
    def _setup_stacking(self):
3384
2165
        # configure stacking into the remote repository, by reading it from
3385
2166
        # the vfs branch.
3386
2167
        try:
3389
2170
            errors.UnstackableRepositoryFormat), e:
3390
2171
            return
3391
2172
        self._is_stacked = True
3392
 
        if possible_transports is None:
3393
 
            possible_transports = []
3394
 
        else:
3395
 
            possible_transports = list(possible_transports)
3396
 
        possible_transports.append(self.bzrdir.root_transport)
3397
 
        self._activate_fallback_location(fallback_url,
3398
 
            possible_transports=possible_transports)
 
2173
        self._activate_fallback_location(fallback_url)
3399
2174
 
3400
2175
    def _get_config(self):
3401
2176
        return RemoteBranchConfig(self)
3402
2177
 
3403
 
    def _get_config_store(self):
3404
 
        if self.conf_store is None:
3405
 
            self.conf_store =  RemoteBranchStore(self)
3406
 
        return self.conf_store
3407
 
 
3408
2178
    def _get_real_transport(self):
3409
2179
        # if we try vfs access, return the real branch's vfs transport
3410
2180
        self._ensure_real()
3428
2198
                    'to use vfs implementation')
3429
2199
            self.bzrdir._ensure_real()
3430
2200
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
3431
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
3432
 
            # The remote branch and the real branch shares the same store. If
3433
 
            # we don't, there will always be cases where one of the stores
3434
 
            # doesn't see an update made on the other.
3435
 
            self._real_branch.conf_store = self.conf_store
 
2201
                ignore_fallbacks=self._real_ignore_fallbacks)
3436
2202
            if self.repository._real_repository is None:
3437
2203
                # Give the remote repository the matching real repo.
3438
2204
                real_repo = self._real_branch.repository
3477
2243
                self.bzrdir, self._client)
3478
2244
        return self._control_files
3479
2245
 
 
2246
    def _get_checkout_format(self):
 
2247
        self._ensure_real()
 
2248
        return self._real_branch._get_checkout_format()
 
2249
 
3480
2250
    def get_physical_lock_status(self):
3481
2251
        """See Branch.get_physical_lock_status()."""
3482
 
        try:
3483
 
            response = self._client.call('Branch.get_physical_lock_status',
3484
 
                self._remote_path())
3485
 
        except errors.UnknownSmartMethod:
3486
 
            self._ensure_real()
3487
 
            return self._real_branch.get_physical_lock_status()
3488
 
        if response[0] not in ('yes', 'no'):
3489
 
            raise errors.UnexpectedSmartServerResponse(response)
3490
 
        return (response[0] == 'yes')
 
2252
        # should be an API call to the server, as branches must be lockable.
 
2253
        self._ensure_real()
 
2254
        return self._real_branch.get_physical_lock_status()
3491
2255
 
3492
2256
    def get_stacked_on_url(self):
3493
2257
        """Get the URL this branch is stacked against.
3516
2280
 
3517
2281
    def set_stacked_on_url(self, url):
3518
2282
        branch.Branch.set_stacked_on_url(self, url)
3519
 
        # We need the stacked_on_url to be visible both locally (to not query
3520
 
        # it repeatedly) and remotely (so smart verbs can get it server side)
3521
 
        # Without the following line,
3522
 
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
3523
 
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
3524
 
        # fails for remote branches -- vila 2012-01-04
3525
 
        self.conf_store.save_changes()
3526
2283
        if not url:
3527
2284
            self._is_stacked = False
3528
2285
        else:
3529
2286
            self._is_stacked = True
3530
 
 
 
2287
        
3531
2288
    def _vfs_get_tags_bytes(self):
3532
2289
        self._ensure_real()
3533
2290
        return self._real_branch._get_tags_bytes()
3534
2291
 
3535
 
    @needs_read_lock
3536
2292
    def _get_tags_bytes(self):
3537
 
        if self._tags_bytes is None:
3538
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
3539
 
        return self._tags_bytes
3540
 
 
3541
 
    def _get_tags_bytes_via_hpss(self):
3542
2293
        medium = self._client._medium
3543
2294
        if medium._is_remote_before((1, 13)):
3544
2295
            return self._vfs_get_tags_bytes()
3554
2305
        return self._real_branch._set_tags_bytes(bytes)
3555
2306
 
3556
2307
    def _set_tags_bytes(self, bytes):
3557
 
        if self.is_locked():
3558
 
            self._tags_bytes = bytes
3559
2308
        medium = self._client._medium
3560
2309
        if medium._is_remote_before((1, 18)):
3561
2310
            self._vfs_set_tags_bytes(bytes)
3570
2319
            self._vfs_set_tags_bytes(bytes)
3571
2320
 
3572
2321
    def lock_read(self):
3573
 
        """Lock the branch for read operations.
3574
 
 
3575
 
        :return: A bzrlib.lock.LogicalLockResult.
3576
 
        """
3577
2322
        self.repository.lock_read()
3578
2323
        if not self._lock_mode:
3579
2324
            self._note_lock('r')
3583
2328
                self._real_branch.lock_read()
3584
2329
        else:
3585
2330
            self._lock_count += 1
3586
 
        return lock.LogicalLockResult(self.unlock)
3587
2331
 
3588
2332
    def _remote_lock_write(self, token):
3589
2333
        if token is None:
3590
2334
            branch_token = repo_token = ''
3591
2335
        else:
3592
2336
            branch_token = token
3593
 
            repo_token = self.repository.lock_write().repository_token
 
2337
            repo_token = self.repository.lock_write()
3594
2338
            self.repository.unlock()
3595
2339
        err_context = {'token': token}
3596
 
        try:
3597
 
            response = self._call(
3598
 
                'Branch.lock_write', self._remote_path(), branch_token,
3599
 
                repo_token or '', **err_context)
3600
 
        except errors.LockContention, e:
3601
 
            # The LockContention from the server doesn't have any
3602
 
            # information about the lock_url. We re-raise LockContention
3603
 
            # with valid lock_url.
3604
 
            raise errors.LockContention('(remote lock)',
3605
 
                self.repository.base.split('.bzr/')[0])
 
2340
        response = self._call(
 
2341
            'Branch.lock_write', self._remote_path(), branch_token,
 
2342
            repo_token or '', **err_context)
3606
2343
        if response[0] != 'ok':
3607
2344
            raise errors.UnexpectedSmartServerResponse(response)
3608
2345
        ok, branch_token, repo_token = response
3629
2366
            self._lock_mode = 'w'
3630
2367
            self._lock_count = 1
3631
2368
        elif self._lock_mode == 'r':
3632
 
            raise errors.ReadOnlyError(self)
 
2369
            raise errors.ReadOnlyTransaction
3633
2370
        else:
3634
2371
            if token is not None:
3635
2372
                # A token was given to lock_write, and we're relocking, so
3640
2377
            self._lock_count += 1
3641
2378
            # Re-lock the repository too.
3642
2379
            self.repository.lock_write(self._repo_lock_token)
3643
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2380
        return self._lock_token or None
3644
2381
 
3645
2382
    def _unlock(self, branch_token, repo_token):
3646
2383
        err_context = {'token': str((branch_token, repo_token))}
3656
2393
        try:
3657
2394
            self._lock_count -= 1
3658
2395
            if not self._lock_count:
3659
 
                if self.conf_store is not None:
3660
 
                    self.conf_store.save_changes()
3661
2396
                self._clear_cached_state()
3662
2397
                mode = self._lock_mode
3663
2398
                self._lock_mode = None
3686
2421
            self.repository.unlock()
3687
2422
 
3688
2423
    def break_lock(self):
3689
 
        try:
3690
 
            response = self._call(
3691
 
                'Branch.break_lock', self._remote_path())
3692
 
        except errors.UnknownSmartMethod:
3693
 
            self._ensure_real()
3694
 
            return self._real_branch.break_lock()
3695
 
        if response != ('ok',):
3696
 
            raise errors.UnexpectedSmartServerResponse(response)
 
2424
        self._ensure_real()
 
2425
        return self._real_branch.break_lock()
3697
2426
 
3698
2427
    def leave_lock_in_place(self):
3699
2428
        if not self._lock_token:
3723
2452
            missing_parent = parent_map[missing_parent]
3724
2453
        raise errors.RevisionNotPresent(missing_parent, self.repository)
3725
2454
 
3726
 
    def _read_last_revision_info(self):
 
2455
    def _last_revision_info(self):
3727
2456
        response = self._call('Branch.last_revision_info', self._remote_path())
3728
2457
        if response[0] != 'ok':
3729
2458
            raise SmartProtocolError('unexpected response code %s' % (response,))
3792
2521
            raise errors.UnexpectedSmartServerResponse(response)
3793
2522
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3794
2523
 
 
2524
    @needs_write_lock
 
2525
    def set_revision_history(self, rev_history):
 
2526
        # Send just the tip revision of the history; the server will generate
 
2527
        # the full history from that.  If the revision doesn't exist in this
 
2528
        # branch, NoSuchRevision will be raised.
 
2529
        if rev_history == []:
 
2530
            rev_id = 'null:'
 
2531
        else:
 
2532
            rev_id = rev_history[-1]
 
2533
        self._set_last_revision(rev_id)
 
2534
        for hook in branch.Branch.hooks['set_rh']:
 
2535
            hook(self, rev_history)
 
2536
        self._cache_revision_history(rev_history)
 
2537
 
3795
2538
    def _get_parent_location(self):
3796
2539
        medium = self._client._medium
3797
2540
        if medium._is_remote_before((1, 13)):
3843
2586
            _override_hook_target=self, **kwargs)
3844
2587
 
3845
2588
    @needs_read_lock
3846
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
2589
    def push(self, target, overwrite=False, stop_revision=None):
3847
2590
        self._ensure_real()
3848
2591
        return self._real_branch.push(
3849
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
2592
            target, overwrite=overwrite, stop_revision=stop_revision,
3850
2593
            _override_hook_source_branch=self)
3851
2594
 
3852
2595
    def is_locked(self):
3853
2596
        return self._lock_count >= 1
3854
2597
 
3855
2598
    @needs_read_lock
3856
 
    def revision_id_to_dotted_revno(self, revision_id):
3857
 
        """Given a revision id, return its dotted revno.
3858
 
 
3859
 
        :return: a tuple like (1,) or (400,1,3).
3860
 
        """
3861
 
        try:
3862
 
            response = self._call('Branch.revision_id_to_revno',
3863
 
                self._remote_path(), revision_id)
3864
 
        except errors.UnknownSmartMethod:
3865
 
            self._ensure_real()
3866
 
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
3867
 
        if response[0] == 'ok':
3868
 
            return tuple([int(x) for x in response[1:]])
3869
 
        else:
3870
 
            raise errors.UnexpectedSmartServerResponse(response)
3871
 
 
3872
 
    @needs_read_lock
3873
2599
    def revision_id_to_revno(self, revision_id):
3874
 
        """Given a revision id on the branch mainline, return its revno.
3875
 
 
3876
 
        :return: an integer
3877
 
        """
3878
 
        try:
3879
 
            response = self._call('Branch.revision_id_to_revno',
3880
 
                self._remote_path(), revision_id)
3881
 
        except errors.UnknownSmartMethod:
3882
 
            self._ensure_real()
3883
 
            return self._real_branch.revision_id_to_revno(revision_id)
3884
 
        if response[0] == 'ok':
3885
 
            if len(response) == 2:
3886
 
                return int(response[1])
3887
 
            raise NoSuchRevision(self, revision_id)
3888
 
        else:
3889
 
            raise errors.UnexpectedSmartServerResponse(response)
 
2600
        self._ensure_real()
 
2601
        return self._real_branch.revision_id_to_revno(revision_id)
3890
2602
 
3891
2603
    @needs_write_lock
3892
2604
    def set_last_revision_info(self, revno, revision_id):
3893
2605
        # XXX: These should be returned by the set_last_revision_info verb
3894
2606
        old_revno, old_revid = self.last_revision_info()
3895
2607
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3896
 
        if not revision_id or not isinstance(revision_id, basestring):
3897
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2608
        revision_id = ensure_null(revision_id)
3898
2609
        try:
3899
2610
            response = self._call('Branch.set_last_revision_info',
3900
2611
                self._remote_path(), self._lock_token, self._repo_lock_token,
3929
2640
            except errors.UnknownSmartMethod:
3930
2641
                medium._remember_remote_is_before((1, 6))
3931
2642
        self._clear_cached_state_of_remote_branch_only()
3932
 
        graph = self.repository.get_graph()
3933
 
        (last_revno, last_revid) = self.last_revision_info()
3934
 
        known_revision_ids = [
3935
 
            (last_revid, last_revno),
3936
 
            (_mod_revision.NULL_REVISION, 0),
3937
 
            ]
3938
 
        if last_rev is not None:
3939
 
            if not graph.is_ancestor(last_rev, revision_id):
3940
 
                # our previous tip is not merged into stop_revision
3941
 
                raise errors.DivergedBranches(self, other_branch)
3942
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
3943
 
        self.set_last_revision_info(revno, revision_id)
 
2643
        self.set_revision_history(self._lefthand_history(revision_id,
 
2644
            last_rev=last_rev,other_branch=other_branch))
3944
2645
 
3945
2646
    def set_push_location(self, location):
3946
 
        self._set_config_location('push_location', location)
3947
 
 
3948
 
    def heads_to_fetch(self):
3949
 
        if self._format._use_default_local_heads_to_fetch():
3950
 
            # We recognise this format, and its heads-to-fetch implementation
3951
 
            # is the default one (tip + tags).  In this case it's cheaper to
3952
 
            # just use the default implementation rather than a special RPC as
3953
 
            # the tip and tags data is cached.
3954
 
            return branch.Branch.heads_to_fetch(self)
3955
 
        medium = self._client._medium
3956
 
        if medium._is_remote_before((2, 4)):
3957
 
            return self._vfs_heads_to_fetch()
3958
 
        try:
3959
 
            return self._rpc_heads_to_fetch()
3960
 
        except errors.UnknownSmartMethod:
3961
 
            medium._remember_remote_is_before((2, 4))
3962
 
            return self._vfs_heads_to_fetch()
3963
 
 
3964
 
    def _rpc_heads_to_fetch(self):
3965
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3966
 
        if len(response) != 2:
3967
 
            raise errors.UnexpectedSmartServerResponse(response)
3968
 
        must_fetch, if_present_fetch = response
3969
 
        return set(must_fetch), set(if_present_fetch)
3970
 
 
3971
 
    def _vfs_heads_to_fetch(self):
3972
2647
        self._ensure_real()
3973
 
        return self._real_branch.heads_to_fetch()
 
2648
        return self._real_branch.set_push_location(location)
3974
2649
 
3975
2650
 
3976
2651
class RemoteConfig(object):
3991
2666
        """
3992
2667
        try:
3993
2668
            configobj = self._get_configobj()
3994
 
            section_obj = None
3995
2669
            if section is None:
3996
2670
                section_obj = configobj
3997
2671
            else:
3998
2672
                try:
3999
2673
                    section_obj = configobj[section]
4000
2674
                except KeyError:
4001
 
                    pass
4002
 
            if section_obj is None:
4003
 
                value = default
4004
 
            else:
4005
 
                value = section_obj.get(name, default)
 
2675
                    return default
 
2676
            return section_obj.get(name, default)
4006
2677
        except errors.UnknownSmartMethod:
4007
 
            value = self._vfs_get_option(name, section, default)
4008
 
        for hook in _mod_config.OldConfigHooks['get']:
4009
 
            hook(self, name, value)
4010
 
        return value
 
2678
            return self._vfs_get_option(name, section, default)
4011
2679
 
4012
2680
    def _response_to_configobj(self, response):
4013
2681
        if len(response[0]) and response[0][0] != 'ok':
4014
2682
            raise errors.UnexpectedSmartServerResponse(response)
4015
2683
        lines = response[1].read_body_bytes().splitlines()
4016
 
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
4017
 
        for hook in _mod_config.OldConfigHooks['load']:
4018
 
            hook(self)
4019
 
        return conf
 
2684
        return config.ConfigObj(lines, encoding='utf-8')
4020
2685
 
4021
2686
 
4022
2687
class RemoteBranchConfig(RemoteConfig):
4041
2706
        medium = self._branch._client._medium
4042
2707
        if medium._is_remote_before((1, 14)):
4043
2708
            return self._vfs_set_option(value, name, section)
4044
 
        if isinstance(value, dict):
4045
 
            if medium._is_remote_before((2, 2)):
4046
 
                return self._vfs_set_option(value, name, section)
4047
 
            return self._set_config_option_dict(value, name, section)
4048
 
        else:
4049
 
            return self._set_config_option(value, name, section)
4050
 
 
4051
 
    def _set_config_option(self, value, name, section):
4052
2709
        try:
4053
2710
            path = self._branch._remote_path()
4054
2711
            response = self._branch._client.call('Branch.set_config_option',
4055
2712
                path, self._branch._lock_token, self._branch._repo_lock_token,
4056
2713
                value.encode('utf8'), name, section or '')
4057
2714
        except errors.UnknownSmartMethod:
4058
 
            medium = self._branch._client._medium
4059
2715
            medium._remember_remote_is_before((1, 14))
4060
2716
            return self._vfs_set_option(value, name, section)
4061
2717
        if response != ():
4062
2718
            raise errors.UnexpectedSmartServerResponse(response)
4063
2719
 
4064
 
    def _serialize_option_dict(self, option_dict):
4065
 
        utf8_dict = {}
4066
 
        for key, value in option_dict.items():
4067
 
            if isinstance(key, unicode):
4068
 
                key = key.encode('utf8')
4069
 
            if isinstance(value, unicode):
4070
 
                value = value.encode('utf8')
4071
 
            utf8_dict[key] = value
4072
 
        return bencode.bencode(utf8_dict)
4073
 
 
4074
 
    def _set_config_option_dict(self, value, name, section):
4075
 
        try:
4076
 
            path = self._branch._remote_path()
4077
 
            serialised_dict = self._serialize_option_dict(value)
4078
 
            response = self._branch._client.call(
4079
 
                'Branch.set_config_option_dict',
4080
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
4081
 
                serialised_dict, name, section or '')
4082
 
        except errors.UnknownSmartMethod:
4083
 
            medium = self._branch._client._medium
4084
 
            medium._remember_remote_is_before((2, 2))
4085
 
            return self._vfs_set_option(value, name, section)
4086
 
        if response != ():
4087
 
            raise errors.UnexpectedSmartServerResponse(response)
4088
 
 
4089
2720
    def _real_object(self):
4090
2721
        self._branch._ensure_real()
4091
2722
        return self._branch._real_branch
4130
2761
        return self._bzrdir._real_bzrdir
4131
2762
 
4132
2763
 
 
2764
 
4133
2765
def _extract_tar(tar, to_dir):
4134
2766
    """Extract all the contents of a tarfile object.
4135
2767
 
4139
2771
        tar.extract(tarinfo, to_dir)
4140
2772
 
4141
2773
 
4142
 
error_translators = registry.Registry()
4143
 
no_context_error_translators = registry.Registry()
4144
 
 
4145
 
 
4146
2774
def _translate_error(err, **context):
4147
2775
    """Translate an ErrorFromSmartServer into a more useful error.
4148
2776
 
4177
2805
                    'Missing key %r in context %r', key_err.args[0], context)
4178
2806
                raise err
4179
2807
 
4180
 
    try:
4181
 
        translator = error_translators.get(err.error_verb)
4182
 
    except KeyError:
4183
 
        pass
4184
 
    else:
4185
 
        raise translator(err, find, get_path)
4186
 
    try:
4187
 
        translator = no_context_error_translators.get(err.error_verb)
4188
 
    except KeyError:
4189
 
        raise errors.UnknownErrorFromSmartServer(err)
4190
 
    else:
4191
 
        raise translator(err)
4192
 
 
4193
 
 
4194
 
error_translators.register('NoSuchRevision',
4195
 
    lambda err, find, get_path: NoSuchRevision(
4196
 
        find('branch'), err.error_args[0]))
4197
 
error_translators.register('nosuchrevision',
4198
 
    lambda err, find, get_path: NoSuchRevision(
4199
 
        find('repository'), err.error_args[0]))
4200
 
 
4201
 
def _translate_nobranch_error(err, find, get_path):
4202
 
    if len(err.error_args) >= 1:
4203
 
        extra = err.error_args[0]
4204
 
    else:
4205
 
        extra = None
4206
 
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
4207
 
        detail=extra)
4208
 
 
4209
 
error_translators.register('nobranch', _translate_nobranch_error)
4210
 
error_translators.register('norepository',
4211
 
    lambda err, find, get_path: errors.NoRepositoryPresent(
4212
 
        find('bzrdir')))
4213
 
error_translators.register('UnlockableTransport',
4214
 
    lambda err, find, get_path: errors.UnlockableTransport(
4215
 
        find('bzrdir').root_transport))
4216
 
error_translators.register('TokenMismatch',
4217
 
    lambda err, find, get_path: errors.TokenMismatch(
4218
 
        find('token'), '(remote token)'))
4219
 
error_translators.register('Diverged',
4220
 
    lambda err, find, get_path: errors.DivergedBranches(
4221
 
        find('branch'), find('other_branch')))
4222
 
error_translators.register('NotStacked',
4223
 
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
4224
 
 
4225
 
def _translate_PermissionDenied(err, find, get_path):
4226
 
    path = get_path()
4227
 
    if len(err.error_args) >= 2:
4228
 
        extra = err.error_args[1]
4229
 
    else:
4230
 
        extra = None
4231
 
    return errors.PermissionDenied(path, extra=extra)
4232
 
 
4233
 
error_translators.register('PermissionDenied', _translate_PermissionDenied)
4234
 
error_translators.register('ReadError',
4235
 
    lambda err, find, get_path: errors.ReadError(get_path()))
4236
 
error_translators.register('NoSuchFile',
4237
 
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
4238
 
error_translators.register('TokenLockingNotSupported',
4239
 
    lambda err, find, get_path: errors.TokenLockingNotSupported(
4240
 
        find('repository')))
4241
 
error_translators.register('UnsuspendableWriteGroup',
4242
 
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
4243
 
        repository=find('repository')))
4244
 
error_translators.register('UnresumableWriteGroup',
4245
 
    lambda err, find, get_path: errors.UnresumableWriteGroup(
4246
 
        repository=find('repository'), write_groups=err.error_args[0],
4247
 
        reason=err.error_args[1]))
4248
 
no_context_error_translators.register('IncompatibleRepositories',
4249
 
    lambda err: errors.IncompatibleRepositories(
4250
 
        err.error_args[0], err.error_args[1], err.error_args[2]))
4251
 
no_context_error_translators.register('LockContention',
4252
 
    lambda err: errors.LockContention('(remote lock)'))
4253
 
no_context_error_translators.register('LockFailed',
4254
 
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
4255
 
no_context_error_translators.register('TipChangeRejected',
4256
 
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
4257
 
no_context_error_translators.register('UnstackableBranchFormat',
4258
 
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
4259
 
no_context_error_translators.register('UnstackableRepositoryFormat',
4260
 
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
4261
 
no_context_error_translators.register('FileExists',
4262
 
    lambda err: errors.FileExists(err.error_args[0]))
4263
 
no_context_error_translators.register('DirectoryNotEmpty',
4264
 
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
4265
 
 
4266
 
def _translate_short_readv_error(err):
4267
 
    args = err.error_args
4268
 
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
4269
 
        int(args[3]))
4270
 
 
4271
 
no_context_error_translators.register('ShortReadvError',
4272
 
    _translate_short_readv_error)
4273
 
 
4274
 
def _translate_unicode_error(err):
 
2808
    if err.error_verb == 'IncompatibleRepositories':
 
2809
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2810
            err.error_args[1], err.error_args[2])
 
2811
    elif err.error_verb == 'NoSuchRevision':
 
2812
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
2813
    elif err.error_verb == 'nosuchrevision':
 
2814
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
2815
    elif err.error_tuple == ('nobranch',):
 
2816
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
2817
    elif err.error_verb == 'norepository':
 
2818
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2819
    elif err.error_verb == 'LockContention':
 
2820
        raise errors.LockContention('(remote lock)')
 
2821
    elif err.error_verb == 'UnlockableTransport':
 
2822
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2823
    elif err.error_verb == 'LockFailed':
 
2824
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
2825
    elif err.error_verb == 'TokenMismatch':
 
2826
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
2827
    elif err.error_verb == 'Diverged':
 
2828
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2829
    elif err.error_verb == 'TipChangeRejected':
 
2830
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2831
    elif err.error_verb == 'UnstackableBranchFormat':
 
2832
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2833
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2834
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
2835
    elif err.error_verb == 'NotStacked':
 
2836
        raise errors.NotStacked(branch=find('branch'))
 
2837
    elif err.error_verb == 'PermissionDenied':
 
2838
        path = get_path()
 
2839
        if len(err.error_args) >= 2:
 
2840
            extra = err.error_args[1]
 
2841
        else:
 
2842
            extra = None
 
2843
        raise errors.PermissionDenied(path, extra=extra)
 
2844
    elif err.error_verb == 'ReadError':
 
2845
        path = get_path()
 
2846
        raise errors.ReadError(path)
 
2847
    elif err.error_verb == 'NoSuchFile':
 
2848
        path = get_path()
 
2849
        raise errors.NoSuchFile(path)
 
2850
    elif err.error_verb == 'FileExists':
 
2851
        raise errors.FileExists(err.error_args[0])
 
2852
    elif err.error_verb == 'DirectoryNotEmpty':
 
2853
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
2854
    elif err.error_verb == 'ShortReadvError':
 
2855
        args = err.error_args
 
2856
        raise errors.ShortReadvError(
 
2857
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
2858
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
4275
2859
        encoding = str(err.error_args[0]) # encoding must always be a string
4276
2860
        val = err.error_args[1]
4277
2861
        start = int(err.error_args[2])
4285
2869
            raise UnicodeDecodeError(encoding, val, start, end, reason)
4286
2870
        elif err.error_verb == 'UnicodeEncodeError':
4287
2871
            raise UnicodeEncodeError(encoding, val, start, end, reason)
4288
 
 
4289
 
no_context_error_translators.register('UnicodeEncodeError',
4290
 
    _translate_unicode_error)
4291
 
no_context_error_translators.register('UnicodeDecodeError',
4292
 
    _translate_unicode_error)
4293
 
no_context_error_translators.register('ReadOnlyError',
4294
 
    lambda err: errors.TransportNotPossible('readonly transport'))
4295
 
no_context_error_translators.register('MemoryError',
4296
 
    lambda err: errors.BzrError("remote server out of memory\n"
4297
 
        "Retry non-remotely, or contact the server admin for details."))
4298
 
no_context_error_translators.register('RevisionNotPresent',
4299
 
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
4300
 
 
4301
 
no_context_error_translators.register('BzrCheckError',
4302
 
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
4303
 
 
 
2872
    elif err.error_verb == 'ReadOnlyError':
 
2873
        raise errors.TransportNotPossible('readonly transport')
 
2874
    raise errors.UnknownErrorFromSmartServer(err)