~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 15:44:55 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719154455-j7y8fm7o9y95vo38
Eliminate get_stored_uncommitted from API.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import bz2
 
20
import zlib
18
21
 
19
22
from bzrlib import (
20
23
    bencode,
21
24
    branch,
22
 
    bzrdir,
23
 
    config,
 
25
    bzrdir as _mod_bzrdir,
 
26
    config as _mod_config,
 
27
    controldir,
24
28
    debug,
25
29
    errors,
 
30
    gpg,
26
31
    graph,
 
32
    inventory_delta,
27
33
    lock,
28
34
    lockdir,
29
 
    repository,
 
35
    osutils,
 
36
    registry,
30
37
    repository as _mod_repository,
31
 
    revision,
32
38
    revision as _mod_revision,
33
39
    static_tuple,
34
40
    symbol_versioning,
35
 
)
36
 
from bzrlib.branch import BranchReferenceFormat
37
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
41
    testament as _mod_testament,
 
42
    urlutils,
 
43
    vf_repository,
 
44
    vf_search,
 
45
    )
 
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
48
from bzrlib.errors import (
40
49
    NoSuchRevision,
41
50
    SmartProtocolError,
42
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
43
54
from bzrlib.lockable_files import LockableFiles
44
55
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.trace import mutter, note, warning
 
56
from bzrlib.smart.client import _SmartClient
 
57
from bzrlib.revision import NULL_REVISION
 
58
from bzrlib.revisiontree import InventoryRevisionTree
 
59
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
 
60
from bzrlib.serializer import format_registry as serializer_format_registry
 
61
from bzrlib.trace import mutter, note, warning, log_exception_quietly
 
62
from bzrlib.versionedfile import FulltextContentFactory
 
63
 
 
64
 
 
65
_DEFAULT_SEARCH_DEPTH = 100
47
66
 
48
67
 
49
68
class _RpcHelper(object):
86
105
    return format
87
106
 
88
107
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
108
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
 
109
# does not have to be imported unless a remote format is involved.
 
110
 
 
111
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
 
112
    """Format representing bzrdirs accessed via a smart server"""
 
113
 
 
114
    supports_workingtrees = False
 
115
 
 
116
    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):
92
411
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
412
 
94
413
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
416
        :param _client: Private parameter for testing. Disables probing and the
98
417
            use of a real bzrdir.
99
418
        """
100
 
        BzrDir.__init__(self, transport, format)
 
419
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
420
        # this object holds a delegated bzrdir that uses file-level operations
102
421
        # to talk to the other side
103
422
        self._real_bzrdir = None
163
482
                import traceback
164
483
                warning('VFS BzrDir access triggered\n%s',
165
484
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
167
 
                self.root_transport, _server_formats=False)
 
485
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
486
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
168
487
            self._format._network_name = \
169
488
                self._real_bzrdir._format.network_name()
170
489
 
175
494
        # Prevent aliasing problems in the next_open_branch_result cache.
176
495
        # See create_branch for rationale.
177
496
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
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
179
540
 
180
541
    def _vfs_cloning_metadir(self, require_stacking=False):
181
542
        self._ensure_real()
212
573
        if len(branch_info) != 2:
213
574
            raise errors.UnexpectedSmartServerResponse(response)
214
575
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
576
        try:
 
577
            format = controldir.network_format_registry.get(control_name)
 
578
        except KeyError:
 
579
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
580
 
216
581
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
218
 
                repo_name)
 
582
            try:
 
583
                format.repository_format = _mod_repository.network_format_registry.get(
 
584
                    repo_name)
 
585
            except KeyError:
 
586
                raise errors.UnknownFormatError(kind='repository',
 
587
                    format=repo_name)
219
588
        if branch_ref == 'ref':
220
589
            # XXX: we need possible_transports here to avoid reopening the
221
590
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
591
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
592
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
593
            format.set_branch_format(branch_format)
225
594
        elif branch_ref == 'branch':
226
595
            if branch_name:
227
 
                format.set_branch_format(
228
 
                    branch.network_format_registry.get(branch_name))
 
596
                try:
 
597
                    branch_format = branch.network_format_registry.get(
 
598
                        branch_name)
 
599
                except KeyError:
 
600
                    raise errors.UnknownFormatError(kind='branch',
 
601
                        format=branch_name)
 
602
                format.set_branch_format(branch_format)
229
603
        else:
230
604
            raise errors.UnexpectedSmartServerResponse(response)
231
605
        return format
241
615
 
242
616
    def destroy_repository(self):
243
617
        """See BzrDir.destroy_repository"""
244
 
        self._ensure_real()
245
 
        self._real_bzrdir.destroy_repository()
 
618
        path = self._path_for_remote_call(self._client)
 
619
        try:
 
620
            response = self._call('BzrDir.destroy_repository', path)
 
621
        except errors.UnknownSmartMethod:
 
622
            self._ensure_real()
 
623
            self._real_bzrdir.destroy_repository()
 
624
            return
 
625
        if response[0] != 'ok':
 
626
            raise SmartProtocolError('unexpected response code %s' % (response,))
246
627
 
247
 
    def create_branch(self, name=None):
 
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)
248
634
        # as per meta1 formats - just delegate to the format object which may
249
635
        # be parameterised.
250
636
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
637
            name=name, repository=repository,
 
638
            append_revisions_only=append_revisions_only)
252
639
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
640
            if not isinstance(repository, RemoteRepository):
 
641
                raise AssertionError(
 
642
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
643
                    % (repository,))
 
644
            result = RemoteBranch(self, repository, real_branch, name=name)
255
645
        else:
256
646
            result = real_branch
257
647
        # BzrDir.clone_on_transport() uses the result of create_branch but does
265
655
 
266
656
    def destroy_branch(self, name=None):
267
657
        """See BzrDir.destroy_branch"""
268
 
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
658
        if name is None:
 
659
            name = self._get_selected_branch()
 
660
        if name != "":
 
661
            raise errors.NoColocatedBranchSupport(self)
 
662
        path = self._path_for_remote_call(self._client)
 
663
        try:
 
664
            if name != "":
 
665
                args = (name, )
 
666
            else:
 
667
                args = ()
 
668
            response = self._call('BzrDir.destroy_branch', path, *args)
 
669
        except errors.UnknownSmartMethod:
 
670
            self._ensure_real()
 
671
            self._real_bzrdir.destroy_branch(name=name)
 
672
            self._next_open_branch_result = None
 
673
            return
270
674
        self._next_open_branch_result = None
 
675
        if response[0] != 'ok':
 
676
            raise SmartProtocolError('unexpected response code %s' % (response,))
271
677
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
678
    def create_workingtree(self, revision_id=None, from_branch=None,
 
679
        accelerator_tree=None, hardlink=False):
273
680
        raise errors.NotLocalUrl(self.transport.base)
274
681
 
275
 
    def find_branch_format(self):
 
682
    def find_branch_format(self, name=None):
276
683
        """Find the branch 'format' for this bzrdir.
277
684
 
278
685
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
686
        """
280
 
        b = self.open_branch()
 
687
        b = self.open_branch(name=name)
281
688
        return b._format
282
689
 
283
 
    def get_branch_reference(self):
 
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):
284
718
        """See BzrDir.get_branch_reference()."""
 
719
        if name is None:
 
720
            name = self._get_selected_branch()
 
721
        if name != "":
 
722
            raise errors.NoColocatedBranchSupport(self)
285
723
        response = self._get_branch_reference()
286
724
        if response[0] == 'ref':
287
725
            return response[1]
318
756
            raise errors.UnexpectedSmartServerResponse(response)
319
757
        return response
320
758
 
321
 
    def _get_tree_branch(self):
 
759
    def _get_tree_branch(self, name=None):
322
760
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
761
        return None, self.open_branch(name=name)
324
762
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
328
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
 
        if self._next_open_branch_result is not None:
330
 
            # See create_branch for details.
331
 
            result = self._next_open_branch_result
332
 
            self._next_open_branch_result = None
333
 
            return result
334
 
        response = self._get_branch_reference()
335
 
        if response[0] == 'ref':
 
763
    def _open_branch(self, name, kind, location_or_format,
 
764
                     ignore_fallbacks=False, possible_transports=None):
 
765
        if kind == 'ref':
336
766
            # a branch reference, use the existing BranchReference logic.
337
767
            format = BranchReferenceFormat()
338
768
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
340
 
        branch_format_name = response[1]
 
769
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
 
770
                possible_transports=possible_transports)
 
771
        branch_format_name = location_or_format
341
772
        if not branch_format_name:
342
773
            branch_format_name = None
343
774
        format = RemoteBranchFormat(network_name=branch_format_name)
344
775
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
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)
346
796
 
347
797
    def _open_repo_v1(self, path):
348
798
        verb = 'BzrDir.find_repository'
411
861
 
412
862
    def has_workingtree(self):
413
863
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
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')
416
874
        return self._has_working_tree
417
875
 
418
876
    def open_workingtree(self, recommend_upgrade=True):
423
881
 
424
882
    def _path_for_remote_call(self, client):
425
883
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
884
        return urlutils.split_segment_parameters_raw(
 
885
            client.remote_path_from_transport(self.root_transport))[0]
427
886
 
428
887
    def get_branch_transport(self, branch_format, name=None):
429
888
        self._ensure_real()
441
900
        """Upgrading of remote bzrdirs is not supported yet."""
442
901
        return False
443
902
 
444
 
    def needs_format_conversion(self, format=None):
 
903
    def needs_format_conversion(self, format):
445
904
        """Upgrading of remote bzrdirs is not supported yet."""
446
 
        if format is None:
447
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
448
 
                % 'needs_format_conversion(format=None)')
449
905
        return False
450
906
 
451
 
    def clone(self, url, revision_id=None, force_new_repo=False,
452
 
              preserve_stacking=False):
453
 
        self._ensure_real()
454
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
 
 
457
907
    def _get_config(self):
458
908
        return RemoteBzrDirConfig(self)
459
909
 
460
 
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
910
    def _get_config_store(self):
 
911
        return RemoteControlStore(self)
 
912
 
 
913
 
 
914
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
915
    """Format for repositories accessed over a _SmartClient.
463
916
 
464
917
    Instances of this repository are represented by RemoteRepository
479
932
    """
480
933
 
481
934
    _matchingbzrdir = RemoteBzrDirFormat()
 
935
    supports_full_versioned_files = True
 
936
    supports_leaving_lock = True
482
937
 
483
938
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
939
        _mod_repository.RepositoryFormat.__init__(self)
485
940
        self._custom_format = None
486
941
        self._network_name = None
487
942
        self._creating_bzrdir = None
 
943
        self._revision_graph_can_have_wrong_parents = None
488
944
        self._supports_chks = None
489
945
        self._supports_external_lookups = None
490
946
        self._supports_tree_reference = None
 
947
        self._supports_funky_characters = None
 
948
        self._supports_nesting_repositories = None
491
949
        self._rich_root_data = None
492
950
 
493
951
    def __repr__(self):
522
980
        return self._supports_external_lookups
523
981
 
524
982
    @property
 
983
    def supports_funky_characters(self):
 
984
        if self._supports_funky_characters is None:
 
985
            self._ensure_real()
 
986
            self._supports_funky_characters = \
 
987
                self._custom_format.supports_funky_characters
 
988
        return self._supports_funky_characters
 
989
 
 
990
    @property
 
991
    def supports_nesting_repositories(self):
 
992
        if self._supports_nesting_repositories is None:
 
993
            self._ensure_real()
 
994
            self._supports_nesting_repositories = \
 
995
                self._custom_format.supports_nesting_repositories
 
996
        return self._supports_nesting_repositories
 
997
 
 
998
    @property
525
999
    def supports_tree_reference(self):
526
1000
        if self._supports_tree_reference is None:
527
1001
            self._ensure_real()
529
1003
                self._custom_format.supports_tree_reference
530
1004
        return self._supports_tree_reference
531
1005
 
 
1006
    @property
 
1007
    def revision_graph_can_have_wrong_parents(self):
 
1008
        if self._revision_graph_can_have_wrong_parents is None:
 
1009
            self._ensure_real()
 
1010
            self._revision_graph_can_have_wrong_parents = \
 
1011
                self._custom_format.revision_graph_can_have_wrong_parents
 
1012
        return self._revision_graph_can_have_wrong_parents
 
1013
 
532
1014
    def _vfs_initialize(self, a_bzrdir, shared):
533
1015
        """Helper for common code in initialize."""
534
1016
        if self._custom_format:
569
1051
            network_name = self._network_name
570
1052
        else:
571
1053
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1054
            reference_bzrdir_format = controldir.format_registry.get('default')()
573
1055
            reference_format = reference_bzrdir_format.repository_format
574
1056
            network_name = reference_format.network_name()
575
1057
        # 2) try direct creation via RPC
601
1083
 
602
1084
    def _ensure_real(self):
603
1085
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
605
 
                self._network_name)
 
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)
606
1092
 
607
1093
    @property
608
1094
    def _fetch_order(self):
643
1129
        return self._custom_format._serializer
644
1130
 
645
1131
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
1132
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1133
        lock._RelockDebugMixin):
648
1134
    """Repository accessed over rpc.
649
1135
 
650
1136
    For the moment most operations are performed using local transport-backed
674
1160
        self._format = format
675
1161
        self._lock_mode = None
676
1162
        self._lock_token = None
 
1163
        self._write_group_tokens = None
677
1164
        self._lock_count = 0
678
1165
        self._leave_lock = False
679
1166
        # Cache of revision parents; misses are cached during read locks, and
703
1190
        # transport, but I'm not sure it's worth making this method
704
1191
        # optional -- mbp 2010-04-21
705
1192
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
1193
 
707
1194
    def __str__(self):
708
1195
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
1196
 
719
1206
 
720
1207
        :param suppress_errors: see Repository.abort_write_group.
721
1208
        """
722
 
        self._ensure_real()
723
 
        return self._real_repository.abort_write_group(
724
 
            suppress_errors=suppress_errors)
 
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
725
1233
 
726
1234
    @property
727
1235
    def chk_bytes(self):
741
1249
        for older plugins that don't use e.g. the CommitBuilder
742
1250
        facility.
743
1251
        """
744
 
        self._ensure_real()
745
 
        return self._real_repository.commit_write_group()
 
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()
746
1265
 
747
1266
    def resume_write_group(self, tokens):
748
 
        self._ensure_real()
749
 
        return self._real_repository.resume_write_group(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
750
1279
 
751
1280
    def suspend_write_group(self):
752
 
        self._ensure_real()
753
 
        return self._real_repository.suspend_write_group()
 
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
754
1286
 
755
1287
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
1288
        self._ensure_real()
817
1349
    def find_text_key_references(self):
818
1350
        """Find the text key references within the repository.
819
1351
 
820
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
821
 
        revision_ids. Each altered file-ids has the exact revision_ids that
822
 
        altered it listed explicitly.
823
1352
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1353
            to whether they were referred to by the inventory of the
825
1354
            revision_id that they contain. The inventory texts from all present
843
1372
        """Private method for using with old (< 1.2) servers to fallback."""
844
1373
        if revision_id is None:
845
1374
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1375
        elif _mod_revision.is_null(revision_id):
847
1376
            return {}
848
1377
 
849
1378
        path = self.bzrdir._path_for_remote_call(self._client)
873
1402
        return RemoteStreamSource(self, to_format)
874
1403
 
875
1404
    @needs_read_lock
 
1405
    def get_file_graph(self):
 
1406
        return graph.Graph(self.texts)
 
1407
 
 
1408
    @needs_read_lock
876
1409
    def has_revision(self, revision_id):
877
1410
        """True if this repository has a copy of the revision."""
878
1411
        # Copy of bzrlib.repository.Repository.has_revision
895
1428
    def _has_same_fallbacks(self, other_repo):
896
1429
        """Returns true if the repositories have the same fallbacks."""
897
1430
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1431
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1432
        my_fb = self._fallback_repositories
900
1433
        other_fb = other_repo._fallback_repositories
901
1434
        if len(my_fb) != len(other_fb):
930
1463
        """See Repository.gather_stats()."""
931
1464
        path = self.bzrdir._path_for_remote_call(self._client)
932
1465
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1466
        if revid is None or _mod_revision.is_null(revid):
934
1467
            fmt_revid = ''
935
1468
        else:
936
1469
            fmt_revid = revid
965
1498
 
966
1499
    def get_physical_lock_status(self):
967
1500
        """See Repository.get_physical_lock_status()."""
968
 
        # should be an API call to the server.
969
 
        self._ensure_real()
970
 
        return self._real_repository.get_physical_lock_status()
 
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')
971
1510
 
972
1511
    def is_in_write_group(self):
973
1512
        """Return True if there is an open write group.
974
1513
 
975
1514
        write groups are only applicable locally for the smart server..
976
1515
        """
 
1516
        if self._write_group_tokens is not None:
 
1517
            return True
977
1518
        if self._real_repository:
978
1519
            return self._real_repository.is_in_write_group()
979
1520
 
997
1538
        pass
998
1539
 
999
1540
    def lock_read(self):
 
1541
        """Lock the repository for read operations.
 
1542
 
 
1543
        :return: A bzrlib.lock.LogicalLockResult.
 
1544
        """
1000
1545
        # wrong eventually - want a local lock cache context
1001
1546
        if not self._lock_mode:
1002
1547
            self._note_lock('r')
1009
1554
                repo.lock_read()
1010
1555
        else:
1011
1556
            self._lock_count += 1
 
1557
        return lock.LogicalLockResult(self.unlock)
1012
1558
 
1013
1559
    def _remote_lock_write(self, token):
1014
1560
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1600
            raise errors.ReadOnlyError(self)
1055
1601
        else:
1056
1602
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1603
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1604
 
1059
1605
    def leave_lock_in_place(self):
1060
1606
        if not self._lock_token:
1109
1655
            self._real_repository.lock_write(self._lock_token)
1110
1656
        elif self._lock_mode == 'r':
1111
1657
            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
1112
1662
 
1113
1663
    def start_write_group(self):
1114
1664
        """Start a write group on the decorated repository.
1118
1668
        for older plugins that don't use e.g. the CommitBuilder
1119
1669
        facility.
1120
1670
        """
1121
 
        self._ensure_real()
1122
 
        return self._real_repository.start_write_group()
 
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]
1123
1688
 
1124
1689
    def _unlock(self, token):
1125
1690
        path = self.bzrdir._path_for_remote_call(self._client)
1152
1717
            # This is just to let the _real_repository stay up to date.
1153
1718
            if self._real_repository is not None:
1154
1719
                self._real_repository.unlock()
 
1720
            elif self._write_group_tokens is not None:
 
1721
                self.abort_write_group()
1155
1722
        finally:
1156
1723
            # The rpc-level lock should be released even if there was a
1157
1724
            # problem releasing the vfs-based lock.
1169
1736
 
1170
1737
    def break_lock(self):
1171
1738
        # should hand off to the network
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.break_lock()
 
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)
1174
1747
 
1175
1748
    def _get_tarball(self, compression):
1176
1749
        """Return a TemporaryFile containing a repository tarball.
1194
1767
            return t
1195
1768
        raise errors.UnexpectedSmartServerResponse(response)
1196
1769
 
 
1770
    @needs_read_lock
1197
1771
    def sprout(self, to_bzrdir, revision_id=None):
1198
 
        # TODO: Option to control what format is created?
1199
 
        self._ensure_real()
1200
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1201
 
                                                             shared=False)
 
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)
1202
1777
        dest_repo.fetch(self, revision_id=revision_id)
1203
1778
        return dest_repo
1204
1779
 
 
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
 
1205
1793
    ### These methods are just thin shims to the VFS object for now.
1206
1794
 
 
1795
    @needs_read_lock
1207
1796
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(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]
1210
1803
 
1211
1804
    def get_serializer_format(self):
1212
 
        self._ensure_real()
1213
 
        return self._real_repository.get_serializer_format()
 
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]
1214
1815
 
1215
1816
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1817
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
1218
 
        # FIXME: It ought to be possible to call this without immediately
1219
 
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
 
        self._ensure_real()
1221
 
        real_repo = self._real_repository
1222
 
        builder = real_repo.get_commit_builder(branch, parents,
1223
 
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
1225
 
        return builder
 
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
1226
1845
 
1227
1846
    def add_fallback_repository(self, repository):
1228
1847
        """Add a repository to use for looking up data not held locally.
1235
1854
        # We need to accumulate additional repositories here, to pass them in
1236
1855
        # on various RPC's.
1237
1856
        #
 
1857
        # Make the check before we lock: this raises an exception.
 
1858
        self._check_fallback_repository(repository)
1238
1859
        if self.is_locked():
1239
1860
            # We will call fallback.unlock() when we transition to the unlocked
1240
1861
            # state, so always add a lock here. If a caller passes us a locked
1241
1862
            # repository, they are responsible for unlocking it later.
1242
1863
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1864
        self._fallback_repositories.append(repository)
1245
1865
        # If self._real_repository was parameterised already (e.g. because a
1246
1866
        # _real_branch had its get_stacked_on_url method called), then the
1272
1892
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
1893
            propagate_caches=propagate_caches)
1274
1894
 
1275
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
 
        self._ensure_real()
1277
 
        return self._real_repository.add_revision(
1278
 
            rev_id, rev, inv=inv, config=config)
 
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)
1279
1920
 
1280
1921
    @needs_read_lock
1281
1922
    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):
1282
1966
        self._ensure_real()
1283
 
        return self._real_repository.get_inventory(revision_id)
 
1967
        return self._real_repository._iter_inventories(revision_ids, ordering)
1284
1968
 
1285
1969
    def iter_inventories(self, revision_ids, ordering=None):
1286
 
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
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()
1288
2044
 
1289
2045
    @needs_read_lock
1290
2046
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
2047
        return self.get_revisions([revision_id])[0]
1293
2048
 
1294
2049
    def get_transaction(self):
1295
2050
        self._ensure_real()
1297
2052
 
1298
2053
    @needs_read_lock
1299
2054
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
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
1302
2059
 
1303
2060
    def make_working_trees(self):
1304
2061
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_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'
1307
2071
 
1308
2072
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
2073
        """Re-read any data needed to synchronise with disk.
1310
2074
 
1311
2075
        This method is intended to be called after another repository instance
1312
2076
        (such as one used by a smart server) has inserted data into the
1313
 
        repository. It may not be called during a write group, but may be
1314
 
        called at any other time.
 
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.
1315
2082
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
2083
        if self._real_repository is not None:
1320
2084
            self._real_repository.refresh_data()
 
2085
        # Refresh the parents cache for this object
 
2086
        self._unstacked_provider.disable_cache()
 
2087
        self._unstacked_provider.enable_cache()
1321
2088
 
1322
2089
    def revision_ids_to_search_result(self, result_set):
1323
2090
        """Convert a set of revision ids to a graph SearchResult."""
1328
2095
        included_keys = result_set.intersection(result_parents)
1329
2096
        start_keys = result_set.difference(included_keys)
1330
2097
        exclude_keys = result_parents.difference(result_set)
1331
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2098
        result = vf_search.SearchResult(start_keys, exclude_keys,
1332
2099
            len(result_set), result_set)
1333
2100
        return result
1334
2101
 
1335
2102
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
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):
1337
2107
        """Return the revision ids that other has that this does not.
1338
2108
 
1339
2109
        These are returned in topological order.
1340
2110
 
1341
2111
        revision_id: only return revision ids included by revision_id.
1342
2112
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
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)
1345
2127
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
2128
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
2129
            fetch_spec=None):
1348
2130
        # No base implementation to use as RemoteRepository is not a subclass
1349
2131
        # of Repository; so this is a copy of Repository.fetch().
1360
2142
            # check that last_revision is in 'from' and then return a
1361
2143
            # no-operation.
1362
2144
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
2145
                not _mod_revision.is_null(revision_id)):
1364
2146
                self.get_revision(revision_id)
1365
2147
            return 0, []
1366
2148
        # if there is no specific appropriate InterRepository, this will get
1367
2149
        # the InterRepository base class, which raises an
1368
2150
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
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,
1371
2157
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
2158
 
1373
2159
    def create_bundle(self, target, base, fileobj, format=None):
1374
2160
        self._ensure_real()
1375
2161
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
2162
 
1377
 
    @needs_read_lock
1378
 
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
 
        self._ensure_real()
1380
 
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1381
 
 
1382
2163
    def fileids_altered_by_revision_ids(self, revision_ids):
1383
2164
        self._ensure_real()
1384
2165
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1388
2169
        return self._real_repository._get_versioned_file_checker(
1389
2170
            revisions, revision_versions_cache)
1390
2171
 
 
2172
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2173
        path = self.bzrdir._path_for_remote_call(self._client)
 
2174
        lines = []
 
2175
        identifiers = []
 
2176
        for (file_id, revid, identifier) in desired_files:
 
2177
            lines.append("%s\0%s" % (
 
2178
                osutils.safe_file_id(file_id),
 
2179
                osutils.safe_revision_id(revid)))
 
2180
            identifiers.append(identifier)
 
2181
        (response_tuple, response_handler) = (
 
2182
            self._call_with_body_bytes_expecting_body(
 
2183
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2184
        if response_tuple != ('ok', ):
 
2185
            response_handler.cancel_read_body()
 
2186
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2187
        byte_stream = response_handler.read_streamed_body()
 
2188
        def decompress_stream(start, byte_stream, unused):
 
2189
            decompressor = zlib.decompressobj()
 
2190
            yield decompressor.decompress(start)
 
2191
            while decompressor.unused_data == "":
 
2192
                try:
 
2193
                    data = byte_stream.next()
 
2194
                except StopIteration:
 
2195
                    break
 
2196
                yield decompressor.decompress(data)
 
2197
            yield decompressor.flush()
 
2198
            unused.append(decompressor.unused_data)
 
2199
        unused = ""
 
2200
        while True:
 
2201
            while not "\n" in unused:
 
2202
                unused += byte_stream.next()
 
2203
            header, rest = unused.split("\n", 1)
 
2204
            args = header.split("\0")
 
2205
            if args[0] == "absent":
 
2206
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2207
                unused = rest
 
2208
                continue
 
2209
            elif args[0] == "ok":
 
2210
                idx = int(args[1])
 
2211
            else:
 
2212
                raise errors.UnexpectedSmartServerResponse(args)
 
2213
            unused_chunks = []
 
2214
            yield (identifiers[idx],
 
2215
                decompress_stream(rest, byte_stream, unused_chunks))
 
2216
            unused = "".join(unused_chunks)
 
2217
 
1391
2218
    def iter_files_bytes(self, desired_files):
1392
2219
        """See Repository.iter_file_bytes.
1393
2220
        """
1394
 
        self._ensure_real()
1395
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2221
        try:
 
2222
            absent = {}
 
2223
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2224
                    desired_files, absent):
 
2225
                yield identifier, bytes_iterator
 
2226
            for fallback in self._fallback_repositories:
 
2227
                if not absent:
 
2228
                    break
 
2229
                desired_files = [(key[0], key[1], identifier) for
 
2230
                    (identifier, key) in absent.iteritems()]
 
2231
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2232
                    del absent[identifier]
 
2233
                    yield identifier, bytes_iterator
 
2234
            if absent:
 
2235
                # There may be more missing items, but raise an exception
 
2236
                # for just one.
 
2237
                missing_identifier = absent.keys()[0]
 
2238
                missing_key = absent[missing_identifier]
 
2239
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2240
                    file_id=missing_key[0])
 
2241
        except errors.UnknownSmartMethod:
 
2242
            self._ensure_real()
 
2243
            for (identifier, bytes_iterator) in (
 
2244
                self._real_repository.iter_files_bytes(desired_files)):
 
2245
                yield identifier, bytes_iterator
 
2246
 
 
2247
    def get_cached_parent_map(self, revision_ids):
 
2248
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2249
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1396
2250
 
1397
2251
    def get_parent_map(self, revision_ids):
1398
2252
        """See bzrlib.Graph.get_parent_map()."""
1457
2311
        if parents_map is None:
1458
2312
            # Repository is not locked, so there's no cache.
1459
2313
            parents_map = {}
1460
 
        # start_set is all the keys in the cache
1461
 
        start_set = set(parents_map)
1462
 
        # result set is all the references to keys in the cache
1463
 
        result_parents = set()
1464
 
        for parents in parents_map.itervalues():
1465
 
            result_parents.update(parents)
1466
 
        stop_keys = result_parents.difference(start_set)
1467
 
        # We don't need to send ghosts back to the server as a position to
1468
 
        # stop either.
1469
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1470
 
        key_count = len(parents_map)
1471
 
        if (NULL_REVISION in result_parents
1472
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1473
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1474
 
            # in our cache of "missing" keys we need to increment our key count
1475
 
            # by 1, because the reconsitituted SearchResult on the server will
1476
 
            # still consider NULL_REVISION to be an included key.
1477
 
            key_count += 1
1478
 
        included_keys = start_set.intersection(result_parents)
1479
 
        start_set.difference_update(included_keys)
 
2314
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2315
            (start_set, stop_keys,
 
2316
             key_count) = vf_search.search_result_from_parent_map(
 
2317
                parents_map, self._unstacked_provider.missing_keys)
 
2318
        else:
 
2319
            (start_set, stop_keys,
 
2320
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2321
                parents_map, self._unstacked_provider.missing_keys,
 
2322
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
2323
        recipe = ('manual', start_set, stop_keys, key_count)
1481
2324
        body = self._serialise_search_recipe(recipe)
1482
2325
        path = self.bzrdir._path_for_remote_call(self._client)
1531
2374
 
1532
2375
    @needs_read_lock
1533
2376
    def get_signature_text(self, revision_id):
1534
 
        self._ensure_real()
1535
 
        return self._real_repository.get_signature_text(revision_id)
 
2377
        path = self.bzrdir._path_for_remote_call(self._client)
 
2378
        try:
 
2379
            response_tuple, response_handler = self._call_expecting_body(
 
2380
                'Repository.get_revision_signature_text', path, revision_id)
 
2381
        except errors.UnknownSmartMethod:
 
2382
            self._ensure_real()
 
2383
            return self._real_repository.get_signature_text(revision_id)
 
2384
        except errors.NoSuchRevision, err:
 
2385
            for fallback in self._fallback_repositories:
 
2386
                try:
 
2387
                    return fallback.get_signature_text(revision_id)
 
2388
                except errors.NoSuchRevision:
 
2389
                    pass
 
2390
            raise err
 
2391
        else:
 
2392
            if response_tuple[0] != 'ok':
 
2393
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2394
            return response_handler.read_body_bytes()
1536
2395
 
1537
2396
    @needs_read_lock
1538
2397
    def _get_inventory_xml(self, revision_id):
 
2398
        # This call is used by older working tree formats,
 
2399
        # which stored a serialized basis inventory.
1539
2400
        self._ensure_real()
1540
2401
        return self._real_repository._get_inventory_xml(revision_id)
1541
2402
 
 
2403
    @needs_write_lock
1542
2404
    def reconcile(self, other=None, thorough=False):
1543
 
        self._ensure_real()
1544
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2405
        from bzrlib.reconcile import RepoReconciler
 
2406
        path = self.bzrdir._path_for_remote_call(self._client)
 
2407
        try:
 
2408
            response, handler = self._call_expecting_body(
 
2409
                'Repository.reconcile', path, self._lock_token)
 
2410
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2411
            self._ensure_real()
 
2412
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2413
        if response != ('ok', ):
 
2414
            raise errors.UnexpectedSmartServerResponse(response)
 
2415
        body = handler.read_body_bytes()
 
2416
        result = RepoReconciler(self)
 
2417
        for line in body.split('\n'):
 
2418
            if not line:
 
2419
                continue
 
2420
            key, val_text = line.split(':')
 
2421
            if key == "garbage_inventories":
 
2422
                result.garbage_inventories = int(val_text)
 
2423
            elif key == "inconsistent_parents":
 
2424
                result.inconsistent_parents = int(val_text)
 
2425
            else:
 
2426
                mutter("unknown reconcile key %r" % key)
 
2427
        return result
1545
2428
 
1546
2429
    def all_revision_ids(self):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.all_revision_ids()
 
2430
        path = self.bzrdir._path_for_remote_call(self._client)
 
2431
        try:
 
2432
            response_tuple, response_handler = self._call_expecting_body(
 
2433
                "Repository.all_revision_ids", path)
 
2434
        except errors.UnknownSmartMethod:
 
2435
            self._ensure_real()
 
2436
            return self._real_repository.all_revision_ids()
 
2437
        if response_tuple != ("ok", ):
 
2438
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2439
        revids = set(response_handler.read_body_bytes().splitlines())
 
2440
        for fallback in self._fallback_repositories:
 
2441
            revids.update(set(fallback.all_revision_ids()))
 
2442
        return list(revids)
 
2443
 
 
2444
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2445
        """Return Tree for a revision on this branch with only some files.
 
2446
 
 
2447
        :param revision_ids: a sequence of revision-ids;
 
2448
          a revision-id may not be None or 'null:'
 
2449
        :param file_ids: if not None, the result is filtered
 
2450
          so that only those file-ids, their parents and their
 
2451
          children are included.
 
2452
        """
 
2453
        inventories = self.iter_inventories(revision_ids)
 
2454
        for inv in inventories:
 
2455
            # Should we introduce a FilteredRevisionTree class rather
 
2456
            # than pre-filter the inventory here?
 
2457
            filtered_inv = inv.filter(file_ids)
 
2458
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1549
2459
 
1550
2460
    @needs_read_lock
1551
2461
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1552
 
        self._ensure_real()
1553
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1554
 
            specific_fileids=specific_fileids)
 
2462
        medium = self._client._medium
 
2463
        if medium._is_remote_before((1, 2)):
 
2464
            self._ensure_real()
 
2465
            for delta in self._real_repository.get_deltas_for_revisions(
 
2466
                    revisions, specific_fileids):
 
2467
                yield delta
 
2468
            return
 
2469
        # Get the revision-ids of interest
 
2470
        required_trees = set()
 
2471
        for revision in revisions:
 
2472
            required_trees.add(revision.revision_id)
 
2473
            required_trees.update(revision.parent_ids[:1])
 
2474
 
 
2475
        # Get the matching filtered trees. Note that it's more
 
2476
        # efficient to pass filtered trees to changes_from() rather
 
2477
        # than doing the filtering afterwards. changes_from() could
 
2478
        # arguably do the filtering itself but it's path-based, not
 
2479
        # file-id based, so filtering before or afterwards is
 
2480
        # currently easier.
 
2481
        if specific_fileids is None:
 
2482
            trees = dict((t.get_revision_id(), t) for
 
2483
                t in self.revision_trees(required_trees))
 
2484
        else:
 
2485
            trees = dict((t.get_revision_id(), t) for
 
2486
                t in self._filtered_revision_trees(required_trees,
 
2487
                specific_fileids))
 
2488
 
 
2489
        # Calculate the deltas
 
2490
        for revision in revisions:
 
2491
            if not revision.parent_ids:
 
2492
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2493
            else:
 
2494
                old_tree = trees[revision.parent_ids[0]]
 
2495
            yield trees[revision.revision_id].changes_from(old_tree)
1555
2496
 
1556
2497
    @needs_read_lock
1557
2498
    def get_revision_delta(self, revision_id, specific_fileids=None):
1558
 
        self._ensure_real()
1559
 
        return self._real_repository.get_revision_delta(revision_id,
1560
 
            specific_fileids=specific_fileids)
 
2499
        r = self.get_revision(revision_id)
 
2500
        return list(self.get_deltas_for_revisions([r],
 
2501
            specific_fileids=specific_fileids))[0]
1561
2502
 
1562
2503
    @needs_read_lock
1563
2504
    def revision_trees(self, revision_ids):
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.revision_trees(revision_ids)
 
2505
        inventories = self.iter_inventories(revision_ids)
 
2506
        for inv in inventories:
 
2507
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1566
2508
 
1567
2509
    @needs_read_lock
1568
2510
    def get_revision_reconcile(self, revision_id):
1576
2518
            callback_refs=callback_refs, check_repo=check_repo)
1577
2519
 
1578
2520
    def copy_content_into(self, destination, revision_id=None):
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.copy_content_into(
1581
 
            destination, revision_id=revision_id)
 
2521
        """Make a complete copy of the content in self into destination.
 
2522
 
 
2523
        This is a destructive operation! Do not use it on existing
 
2524
        repositories.
 
2525
        """
 
2526
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2527
        return interrepo.copy_content(revision_id)
1582
2528
 
1583
2529
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
2530
        # get a tarball of the remote repository, and copy from that into the
1585
2531
        # destination
1586
 
        from bzrlib import osutils
1587
2532
        import tarfile
1588
2533
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
2534
        note(gettext("Copying repository content as tarball..."))
1590
2535
        tar_file = self._get_tarball('bz2')
1591
2536
        if tar_file is None:
1592
2537
            return None
1597
2542
            tmpdir = osutils.mkdtemp()
1598
2543
            try:
1599
2544
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2545
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
2546
                tmp_repo = tmp_bzrdir.open_repository()
1602
2547
                tmp_repo.copy_content_into(destination, revision_id)
1603
2548
            finally:
1621
2566
    @needs_write_lock
1622
2567
    def pack(self, hint=None, clean_obsolete_packs=False):
1623
2568
        """Compress the data within the repository.
1624
 
 
1625
 
        This is not currently implemented within the smart server.
1626
2569
        """
1627
 
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2570
        if hint is None:
 
2571
            body = ""
 
2572
        else:
 
2573
            body = "".join([l+"\n" for l in hint])
 
2574
        path = self.bzrdir._path_for_remote_call(self._client)
 
2575
        try:
 
2576
            response, handler = self._call_with_body_bytes_expecting_body(
 
2577
                'Repository.pack', (path, self._lock_token,
 
2578
                    str(clean_obsolete_packs)), body)
 
2579
        except errors.UnknownSmartMethod:
 
2580
            self._ensure_real()
 
2581
            return self._real_repository.pack(hint=hint,
 
2582
                clean_obsolete_packs=clean_obsolete_packs)
 
2583
        handler.cancel_read_body()
 
2584
        if response != ('ok', ):
 
2585
            raise errors.UnexpectedSmartServerResponse(response)
1629
2586
 
1630
2587
    @property
1631
2588
    def revisions(self):
1632
2589
        """Decorate the real repository for now.
1633
2590
 
1634
 
        In the short term this should become a real object to intercept graph
1635
 
        lookups.
1636
 
 
1637
2591
        In the long term a full blown network facility is needed.
1638
2592
        """
1639
2593
        self._ensure_real()
1667
2621
 
1668
2622
    @needs_write_lock
1669
2623
    def sign_revision(self, revision_id, gpg_strategy):
1670
 
        self._ensure_real()
1671
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2624
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2625
        plaintext = testament.as_short_text()
 
2626
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1672
2627
 
1673
2628
    @property
1674
2629
    def texts(self):
1680
2635
        self._ensure_real()
1681
2636
        return self._real_repository.texts
1682
2637
 
 
2638
    def _iter_revisions_rpc(self, revision_ids):
 
2639
        body = "\n".join(revision_ids)
 
2640
        path = self.bzrdir._path_for_remote_call(self._client)
 
2641
        response_tuple, response_handler = (
 
2642
            self._call_with_body_bytes_expecting_body(
 
2643
            "Repository.iter_revisions", (path, ), body))
 
2644
        if response_tuple[0] != "ok":
 
2645
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2646
        serializer_format = response_tuple[1]
 
2647
        serializer = serializer_format_registry.get(serializer_format)
 
2648
        byte_stream = response_handler.read_streamed_body()
 
2649
        decompressor = zlib.decompressobj()
 
2650
        chunks = []
 
2651
        for bytes in byte_stream:
 
2652
            chunks.append(decompressor.decompress(bytes))
 
2653
            if decompressor.unused_data != "":
 
2654
                chunks.append(decompressor.flush())
 
2655
                yield serializer.read_revision_from_string("".join(chunks))
 
2656
                unused = decompressor.unused_data
 
2657
                decompressor = zlib.decompressobj()
 
2658
                chunks = [decompressor.decompress(unused)]
 
2659
        chunks.append(decompressor.flush())
 
2660
        text = "".join(chunks)
 
2661
        if text != "":
 
2662
            yield serializer.read_revision_from_string("".join(chunks))
 
2663
 
1683
2664
    @needs_read_lock
1684
2665
    def get_revisions(self, revision_ids):
1685
 
        self._ensure_real()
1686
 
        return self._real_repository.get_revisions(revision_ids)
 
2666
        if revision_ids is None:
 
2667
            revision_ids = self.all_revision_ids()
 
2668
        else:
 
2669
            for rev_id in revision_ids:
 
2670
                if not rev_id or not isinstance(rev_id, basestring):
 
2671
                    raise errors.InvalidRevisionId(
 
2672
                        revision_id=rev_id, branch=self)
 
2673
        try:
 
2674
            missing = set(revision_ids)
 
2675
            revs = {}
 
2676
            for rev in self._iter_revisions_rpc(revision_ids):
 
2677
                missing.remove(rev.revision_id)
 
2678
                revs[rev.revision_id] = rev
 
2679
        except errors.UnknownSmartMethod:
 
2680
            self._ensure_real()
 
2681
            return self._real_repository.get_revisions(revision_ids)
 
2682
        for fallback in self._fallback_repositories:
 
2683
            if not missing:
 
2684
                break
 
2685
            for revid in list(missing):
 
2686
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2687
                # public method on Repository that could be used to query
 
2688
                # for revision objects *without* failing completely if one
 
2689
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2690
                # but unfortunately that's private and not provided by
 
2691
                # all repository implementations.
 
2692
                try:
 
2693
                    revs[revid] = fallback.get_revision(revid)
 
2694
                except errors.NoSuchRevision:
 
2695
                    pass
 
2696
                else:
 
2697
                    missing.remove(revid)
 
2698
        if missing:
 
2699
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2700
        return [revs[revid] for revid in revision_ids]
1687
2701
 
1688
2702
    def supports_rich_root(self):
1689
2703
        return self._format.rich_root_data
1690
2704
 
1691
 
    def iter_reverse_revision_history(self, revision_id):
1692
 
        self._ensure_real()
1693
 
        return self._real_repository.iter_reverse_revision_history(revision_id)
1694
 
 
1695
2705
    @property
1696
2706
    def _serializer(self):
1697
2707
        return self._format._serializer
1698
2708
 
 
2709
    @needs_write_lock
1699
2710
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1700
 
        self._ensure_real()
1701
 
        return self._real_repository.store_revision_signature(
1702
 
            gpg_strategy, plaintext, revision_id)
 
2711
        signature = gpg_strategy.sign(plaintext)
 
2712
        self.add_signature_text(revision_id, signature)
1703
2713
 
1704
2714
    def add_signature_text(self, revision_id, signature):
1705
 
        self._ensure_real()
1706
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2715
        if self._real_repository:
 
2716
            # If there is a real repository the write group will
 
2717
            # be in the real repository as well, so use that:
 
2718
            self._ensure_real()
 
2719
            return self._real_repository.add_signature_text(
 
2720
                revision_id, signature)
 
2721
        path = self.bzrdir._path_for_remote_call(self._client)
 
2722
        response, handler = self._call_with_body_bytes_expecting_body(
 
2723
            'Repository.add_signature_text', (path, self._lock_token,
 
2724
                revision_id) + tuple(self._write_group_tokens), signature)
 
2725
        handler.cancel_read_body()
 
2726
        self.refresh_data()
 
2727
        if response[0] != 'ok':
 
2728
            raise errors.UnexpectedSmartServerResponse(response)
 
2729
        self._write_group_tokens = response[1:]
1707
2730
 
1708
2731
    def has_signature_for_revision_id(self, revision_id):
1709
 
        self._ensure_real()
1710
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2732
        path = self.bzrdir._path_for_remote_call(self._client)
 
2733
        try:
 
2734
            response = self._call('Repository.has_signature_for_revision_id',
 
2735
                path, revision_id)
 
2736
        except errors.UnknownSmartMethod:
 
2737
            self._ensure_real()
 
2738
            return self._real_repository.has_signature_for_revision_id(
 
2739
                revision_id)
 
2740
        if response[0] not in ('yes', 'no'):
 
2741
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2742
        if response[0] == 'yes':
 
2743
            return True
 
2744
        for fallback in self._fallback_repositories:
 
2745
            if fallback.has_signature_for_revision_id(revision_id):
 
2746
                return True
 
2747
        return False
 
2748
 
 
2749
    @needs_read_lock
 
2750
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2751
        if not self.has_signature_for_revision_id(revision_id):
 
2752
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2753
        signature = self.get_signature_text(revision_id)
 
2754
 
 
2755
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2756
        plaintext = testament.as_short_text()
 
2757
 
 
2758
        return gpg_strategy.verify(signature, plaintext)
1711
2759
 
1712
2760
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2761
        self._ensure_real()
1714
2762
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2763
            _files_pb=_files_pb)
1716
2764
 
1717
 
    def revision_graph_can_have_wrong_parents(self):
1718
 
        # The answer depends on the remote repo format.
1719
 
        self._ensure_real()
1720
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
 
 
1722
2765
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2766
        self._ensure_real()
1724
2767
        return self._real_repository._find_inconsistent_revision_parents(
1732
2775
        providers = [self._unstacked_provider]
1733
2776
        if other is not None:
1734
2777
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2778
        return graph.StackedParentsProvider(_LazyListJoin(
 
2779
            providers, self._fallback_repositories))
1738
2780
 
1739
2781
    def _serialise_search_recipe(self, recipe):
1740
2782
        """Serialise a graph search recipe.
1748
2790
        return '\n'.join((start_keys, stop_keys, count))
1749
2791
 
1750
2792
    def _serialise_search_result(self, search_result):
1751
 
        if isinstance(search_result, graph.PendingAncestryResult):
1752
 
            parts = ['ancestry-of']
1753
 
            parts.extend(search_result.heads)
1754
 
        else:
1755
 
            recipe = search_result.get_recipe()
1756
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
2793
        parts = search_result.get_network_struct()
1757
2794
        return '\n'.join(parts)
1758
2795
 
1759
2796
    def autopack(self):
1769
2806
            raise errors.UnexpectedSmartServerResponse(response)
1770
2807
 
1771
2808
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2809
class RemoteStreamSink(vf_repository.StreamSink):
1773
2810
 
1774
2811
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2812
        self.target_repo._ensure_real()
1876
2913
        self._last_substream and self._last_stream so that the stream can be
1877
2914
        resumed by _resume_stream_with_vfs.
1878
2915
        """
1879
 
                    
 
2916
 
1880
2917
        stream_iter = iter(stream)
1881
2918
        for substream_kind, substream in stream_iter:
1882
2919
            if substream_kind == 'inventory-deltas':
1885
2922
                return
1886
2923
            else:
1887
2924
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2925
 
 
2926
 
 
2927
class RemoteStreamSource(vf_repository.StreamSource):
1891
2928
    """Stream data from a remote server."""
1892
2929
 
1893
2930
    def get_stream(self, search):
1914
2951
 
1915
2952
    def _real_stream(self, repo, search):
1916
2953
        """Get a stream for search from repo.
1917
 
        
1918
 
        This never called RemoteStreamSource.get_stream, and is a heler
1919
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
2954
 
 
2955
        This never called RemoteStreamSource.get_stream, and is a helper
 
2956
        for RemoteStreamSource._get_stream to allow getting a stream
1920
2957
        reliably whether fallback back because of old servers or trying
1921
2958
        to stream from a non-RemoteRepository (which the stacked support
1922
2959
        code will do).
1953
2990
        candidate_verbs = [
1954
2991
            ('Repository.get_stream_1.19', (1, 19)),
1955
2992
            ('Repository.get_stream', (1, 13))]
 
2993
 
1956
2994
        found_verb = False
1957
2995
        for verb, version in candidate_verbs:
1958
2996
            if medium._is_remote_before(version):
1962
3000
                    verb, args, search_bytes)
1963
3001
            except errors.UnknownSmartMethod:
1964
3002
                medium._remember_remote_is_before(version)
 
3003
            except errors.UnknownErrorFromSmartServer, e:
 
3004
                if isinstance(search, vf_search.EverythingResult):
 
3005
                    error_verb = e.error_from_smart_server.error_verb
 
3006
                    if error_verb == 'BadSearch':
 
3007
                        # Pre-2.4 servers don't support this sort of search.
 
3008
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
3009
                        # good idea in general?  It might provide a little bit
 
3010
                        # of protection against client-side bugs.
 
3011
                        medium._remember_remote_is_before((2, 4))
 
3012
                        break
 
3013
                raise
1965
3014
            else:
1966
3015
                response_tuple, response_handler = response
1967
3016
                found_verb = True
1971
3020
        if response_tuple[0] != 'ok':
1972
3021
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
3022
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
3023
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
3024
            self._record_counter)
1975
3025
        if src_format.network_name() != repo._format.network_name():
1976
3026
            raise AssertionError(
1977
3027
                "Mismatched RemoteRepository and stream src %r, %r" % (
2049
3099
 
2050
3100
    def _ensure_real(self):
2051
3101
        if self._custom_format is None:
2052
 
            self._custom_format = branch.network_format_registry.get(
2053
 
                self._network_name)
 
3102
            try:
 
3103
                self._custom_format = branch.network_format_registry.get(
 
3104
                    self._network_name)
 
3105
            except KeyError:
 
3106
                raise errors.UnknownFormatError(kind='branch',
 
3107
                    format=self._network_name)
2054
3108
 
2055
3109
    def get_format_description(self):
2056
3110
        self._ensure_real()
2063
3117
        return a_bzrdir.open_branch(name=name, 
2064
3118
            ignore_fallbacks=ignore_fallbacks)
2065
3119
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3120
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
3121
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
3122
        # method is not available on the server.
2069
3123
        # self._custom_format is always set - the start of initialize ensures
2071
3125
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
3126
            a_bzrdir._ensure_real()
2073
3127
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
3128
                name=name, append_revisions_only=append_revisions_only)
2075
3129
        else:
2076
3130
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3131
            result = self._custom_format.initialize(a_bzrdir, name=name,
 
3132
                append_revisions_only=append_revisions_only)
2078
3133
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
3134
            not isinstance(result, RemoteBranch)):
2080
3135
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
3136
                                  name=name)
2082
3137
        return result
2083
3138
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
3139
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3140
                   append_revisions_only=None):
 
3141
        if name is None:
 
3142
            name = a_bzrdir._get_selected_branch()
2085
3143
        # 1) get the network name to use.
2086
3144
        if self._custom_format:
2087
3145
            network_name = self._custom_format.network_name()
2088
3146
        else:
2089
3147
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3148
            reference_bzrdir_format = controldir.format_registry.get('default')()
2091
3149
            reference_format = reference_bzrdir_format.get_branch_format()
2092
3150
            self._custom_format = reference_format
2093
3151
            network_name = reference_format.network_name()
2094
3152
        # Being asked to create on a non RemoteBzrDir:
2095
3153
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3154
            return self._vfs_initialize(a_bzrdir, name=name,
 
3155
                append_revisions_only=append_revisions_only)
2097
3156
        medium = a_bzrdir._client._medium
2098
3157
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3158
            return self._vfs_initialize(a_bzrdir, name=name,
 
3159
                append_revisions_only=append_revisions_only)
2100
3160
        # Creating on a remote bzr dir.
2101
3161
        # 2) try direct creation via RPC
2102
3162
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
 
        if name is not None:
 
3163
        if name != "":
2104
3164
            # XXX JRV20100304: Support creating colocated branches
2105
3165
            raise errors.NoColocatedBranchSupport(self)
2106
3166
        verb = 'BzrDir.create_branch'
2109
3169
        except errors.UnknownSmartMethod:
2110
3170
            # Fallback - use vfs methods
2111
3171
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3172
            return self._vfs_initialize(a_bzrdir, name=name,
 
3173
                    append_revisions_only=append_revisions_only)
2113
3174
        if response[0] != 'ok':
2114
3175
            raise errors.UnexpectedSmartServerResponse(response)
2115
3176
        # Turn the response into a RemoteRepository object.
2116
3177
        format = RemoteBranchFormat(network_name=response[1])
2117
3178
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
3179
        repo_path = response[2]
 
3180
        if repository is not None:
 
3181
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
3182
            url_diff = urlutils.relative_url(repository.user_url,
 
3183
                    remote_repo_url)
 
3184
            if url_diff != '.':
 
3185
                raise AssertionError(
 
3186
                    'repository.user_url %r does not match URL from server '
 
3187
                    'response (%r + %r)'
 
3188
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
3189
            remote_repo = repository
2120
3190
        else:
2121
 
            repo_bzrdir = RemoteBzrDir(
2122
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2123
 
                a_bzrdir._client)
2124
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
3191
            if repo_path == '':
 
3192
                repo_bzrdir = a_bzrdir
 
3193
            else:
 
3194
                repo_bzrdir = RemoteBzrDir(
 
3195
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
3196
                    a_bzrdir._client)
 
3197
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
3198
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
3199
            format=format, setup_stacking=False, name=name)
 
3200
        if append_revisions_only:
 
3201
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
3202
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
3203
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
3204
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
3223
        self._ensure_real()
2149
3224
        return self._custom_format.supports_set_append_revisions_only()
2150
3225
 
 
3226
    def _use_default_local_heads_to_fetch(self):
 
3227
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3228
        # implementation is not overridden vs the base class, we can use the
 
3229
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3230
        # usually cheaper in terms of net round trips, as the last-revision and
 
3231
        # tags info fetched is cached and would be fetched anyway.
 
3232
        self._ensure_real()
 
3233
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
3234
            branch_class = self._custom_format._branch_class()
 
3235
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
3236
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
3237
                return True
 
3238
        return False
 
3239
 
 
3240
 
 
3241
class RemoteBranchStore(_mod_config.IniFileStore):
 
3242
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3243
 
 
3244
    Note that this is specific to bzr-based formats.
 
3245
    """
 
3246
 
 
3247
    def __init__(self, branch):
 
3248
        super(RemoteBranchStore, self).__init__()
 
3249
        self.branch = branch
 
3250
        self.id = "branch"
 
3251
        self._real_store = None
 
3252
 
 
3253
    def external_url(self):
 
3254
        return self.branch.user_url
 
3255
 
 
3256
    def _load_content(self):
 
3257
        path = self.branch._remote_path()
 
3258
        try:
 
3259
            response, handler = self.branch._call_expecting_body(
 
3260
                'Branch.get_config_file', path)
 
3261
        except errors.UnknownSmartMethod:
 
3262
            self._ensure_real()
 
3263
            return self._real_store._load_content()
 
3264
        if len(response) and response[0] != 'ok':
 
3265
            raise errors.UnexpectedSmartServerResponse(response)
 
3266
        return handler.read_body_bytes()
 
3267
 
 
3268
    def _save_content(self, content):
 
3269
        path = self.branch._remote_path()
 
3270
        try:
 
3271
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3272
                'Branch.put_config_file', (path,
 
3273
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3274
                content)
 
3275
        except errors.UnknownSmartMethod:
 
3276
            self._ensure_real()
 
3277
            return self._real_store._save_content(content)
 
3278
        handler.cancel_read_body()
 
3279
        if response != ('ok', ):
 
3280
            raise errors.UnexpectedSmartServerResponse(response)
 
3281
 
 
3282
    def _ensure_real(self):
 
3283
        self.branch._ensure_real()
 
3284
        if self._real_store is None:
 
3285
            self._real_store = _mod_config.BranchStore(self.branch)
 
3286
 
2151
3287
 
2152
3288
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
3289
    """Branch stored on a server accessed by HPSS RPC.
2156
3292
    """
2157
3293
 
2158
3294
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3295
        _client=None, format=None, setup_stacking=True, name=None,
 
3296
        possible_transports=None):
2160
3297
        """Create a RemoteBranch instance.
2161
3298
 
2162
3299
        :param real_branch: An optional local implementation of the branch
2174
3311
        # will try to assign to self.tags, which is a property in this subclass.
2175
3312
        # And the parent's __init__ doesn't do much anyway.
2176
3313
        self.bzrdir = remote_bzrdir
 
3314
        self.name = name
2177
3315
        if _client is not None:
2178
3316
            self._client = _client
2179
3317
        else:
2202
3340
        self._repo_lock_token = None
2203
3341
        self._lock_count = 0
2204
3342
        self._leave_lock = False
 
3343
        self.conf_store = None
2205
3344
        # Setup a format: note that we cannot call _ensure_real until all the
2206
3345
        # attributes above are set: This code cannot be moved higher up in this
2207
3346
        # function.
2227
3366
            hook(self)
2228
3367
        self._is_stacked = False
2229
3368
        if setup_stacking:
2230
 
            self._setup_stacking()
 
3369
            self._setup_stacking(possible_transports)
2231
3370
 
2232
 
    def _setup_stacking(self):
 
3371
    def _setup_stacking(self, possible_transports):
2233
3372
        # configure stacking into the remote repository, by reading it from
2234
3373
        # the vfs branch.
2235
3374
        try:
2238
3377
            errors.UnstackableRepositoryFormat), e:
2239
3378
            return
2240
3379
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
 
3380
        if possible_transports is None:
 
3381
            possible_transports = []
 
3382
        else:
 
3383
            possible_transports = list(possible_transports)
 
3384
        possible_transports.append(self.bzrdir.root_transport)
 
3385
        self._activate_fallback_location(fallback_url,
 
3386
            possible_transports=possible_transports)
2242
3387
 
2243
3388
    def _get_config(self):
2244
3389
        return RemoteBranchConfig(self)
2245
3390
 
 
3391
    def _get_config_store(self):
 
3392
        if self.conf_store is None:
 
3393
            self.conf_store =  RemoteBranchStore(self)
 
3394
        return self.conf_store
 
3395
 
 
3396
    def has_stored_uncommitted(self):
 
3397
        self._ensure_real()
 
3398
        return self._real_branch.has_stored_uncommitted()
 
3399
 
 
3400
    def store_uncommitted(self, creator, message=None):
 
3401
        self._ensure_real()
 
3402
        return self._real_branch.store_uncommitted(creator, message)
 
3403
 
 
3404
    def get_unshelver(self, tree):
 
3405
        self._ensure_real()
 
3406
        return self._real_branch.get_unshelver(tree)
 
3407
 
 
3408
    def _get_uncommitted(self):
 
3409
        self._ensure_real()
 
3410
        return self._real_branch._get_uncommitted()
 
3411
 
 
3412
    def _put_uncommitted(self, transform):
 
3413
        self._ensure_real()
 
3414
        return self._real_branch._put_uncommitted(transform)
 
3415
 
2246
3416
    def _get_real_transport(self):
2247
3417
        # if we try vfs access, return the real branch's vfs transport
2248
3418
        self._ensure_real()
2267
3437
            self.bzrdir._ensure_real()
2268
3438
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2269
3439
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
3440
            # The remote branch and the real branch shares the same store. If
 
3441
            # we don't, there will always be cases where one of the stores
 
3442
            # doesn't see an update made on the other.
 
3443
            self._real_branch.conf_store = self.conf_store
2270
3444
            if self.repository._real_repository is None:
2271
3445
                # Give the remote repository the matching real repo.
2272
3446
                real_repo = self._real_branch.repository
2311
3485
                self.bzrdir, self._client)
2312
3486
        return self._control_files
2313
3487
 
2314
 
    def _get_checkout_format(self):
2315
 
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
2317
 
 
2318
3488
    def get_physical_lock_status(self):
2319
3489
        """See Branch.get_physical_lock_status()."""
2320
 
        # should be an API call to the server, as branches must be lockable.
2321
 
        self._ensure_real()
2322
 
        return self._real_branch.get_physical_lock_status()
 
3490
        try:
 
3491
            response = self._client.call('Branch.get_physical_lock_status',
 
3492
                self._remote_path())
 
3493
        except errors.UnknownSmartMethod:
 
3494
            self._ensure_real()
 
3495
            return self._real_branch.get_physical_lock_status()
 
3496
        if response[0] not in ('yes', 'no'):
 
3497
            raise errors.UnexpectedSmartServerResponse(response)
 
3498
        return (response[0] == 'yes')
2323
3499
 
2324
3500
    def get_stacked_on_url(self):
2325
3501
        """Get the URL this branch is stacked against.
2348
3524
 
2349
3525
    def set_stacked_on_url(self, url):
2350
3526
        branch.Branch.set_stacked_on_url(self, url)
 
3527
        # We need the stacked_on_url to be visible both locally (to not query
 
3528
        # it repeatedly) and remotely (so smart verbs can get it server side)
 
3529
        # Without the following line,
 
3530
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
 
3531
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
 
3532
        # fails for remote branches -- vila 2012-01-04
 
3533
        self.conf_store.save_changes()
2351
3534
        if not url:
2352
3535
            self._is_stacked = False
2353
3536
        else:
2354
3537
            self._is_stacked = True
2355
 
        
 
3538
 
2356
3539
    def _vfs_get_tags_bytes(self):
2357
3540
        self._ensure_real()
2358
3541
        return self._real_branch._get_tags_bytes()
2359
3542
 
 
3543
    @needs_read_lock
2360
3544
    def _get_tags_bytes(self):
 
3545
        if self._tags_bytes is None:
 
3546
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3547
        return self._tags_bytes
 
3548
 
 
3549
    def _get_tags_bytes_via_hpss(self):
2361
3550
        medium = self._client._medium
2362
3551
        if medium._is_remote_before((1, 13)):
2363
3552
            return self._vfs_get_tags_bytes()
2373
3562
        return self._real_branch._set_tags_bytes(bytes)
2374
3563
 
2375
3564
    def _set_tags_bytes(self, bytes):
 
3565
        if self.is_locked():
 
3566
            self._tags_bytes = bytes
2376
3567
        medium = self._client._medium
2377
3568
        if medium._is_remote_before((1, 18)):
2378
3569
            self._vfs_set_tags_bytes(bytes)
2387
3578
            self._vfs_set_tags_bytes(bytes)
2388
3579
 
2389
3580
    def lock_read(self):
 
3581
        """Lock the branch for read operations.
 
3582
 
 
3583
        :return: A bzrlib.lock.LogicalLockResult.
 
3584
        """
2390
3585
        self.repository.lock_read()
2391
3586
        if not self._lock_mode:
2392
3587
            self._note_lock('r')
2396
3591
                self._real_branch.lock_read()
2397
3592
        else:
2398
3593
            self._lock_count += 1
 
3594
        return lock.LogicalLockResult(self.unlock)
2399
3595
 
2400
3596
    def _remote_lock_write(self, token):
2401
3597
        if token is None:
2402
3598
            branch_token = repo_token = ''
2403
3599
        else:
2404
3600
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
3601
            repo_token = self.repository.lock_write().repository_token
2406
3602
            self.repository.unlock()
2407
3603
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
3604
        try:
 
3605
            response = self._call(
 
3606
                'Branch.lock_write', self._remote_path(), branch_token,
 
3607
                repo_token or '', **err_context)
 
3608
        except errors.LockContention, e:
 
3609
            # The LockContention from the server doesn't have any
 
3610
            # information about the lock_url. We re-raise LockContention
 
3611
            # with valid lock_url.
 
3612
            raise errors.LockContention('(remote lock)',
 
3613
                self.repository.base.split('.bzr/')[0])
2411
3614
        if response[0] != 'ok':
2412
3615
            raise errors.UnexpectedSmartServerResponse(response)
2413
3616
        ok, branch_token, repo_token = response
2434
3637
            self._lock_mode = 'w'
2435
3638
            self._lock_count = 1
2436
3639
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
3640
            raise errors.ReadOnlyError(self)
2438
3641
        else:
2439
3642
            if token is not None:
2440
3643
                # A token was given to lock_write, and we're relocking, so
2445
3648
            self._lock_count += 1
2446
3649
            # Re-lock the repository too.
2447
3650
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
3651
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
3652
 
2450
3653
    def _unlock(self, branch_token, repo_token):
2451
3654
        err_context = {'token': str((branch_token, repo_token))}
2461
3664
        try:
2462
3665
            self._lock_count -= 1
2463
3666
            if not self._lock_count:
 
3667
                if self.conf_store is not None:
 
3668
                    self.conf_store.save_changes()
2464
3669
                self._clear_cached_state()
2465
3670
                mode = self._lock_mode
2466
3671
                self._lock_mode = None
2489
3694
            self.repository.unlock()
2490
3695
 
2491
3696
    def break_lock(self):
2492
 
        self._ensure_real()
2493
 
        return self._real_branch.break_lock()
 
3697
        try:
 
3698
            response = self._call(
 
3699
                'Branch.break_lock', self._remote_path())
 
3700
        except errors.UnknownSmartMethod:
 
3701
            self._ensure_real()
 
3702
            return self._real_branch.break_lock()
 
3703
        if response != ('ok',):
 
3704
            raise errors.UnexpectedSmartServerResponse(response)
2494
3705
 
2495
3706
    def leave_lock_in_place(self):
2496
3707
        if not self._lock_token:
2520
3731
            missing_parent = parent_map[missing_parent]
2521
3732
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
3733
 
2523
 
    def _last_revision_info(self):
 
3734
    def _read_last_revision_info(self):
2524
3735
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
3736
        if response[0] != 'ok':
2526
3737
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
3800
            raise errors.UnexpectedSmartServerResponse(response)
2590
3801
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
3802
 
2592
 
    @needs_write_lock
2593
 
    def set_revision_history(self, rev_history):
2594
 
        # Send just the tip revision of the history; the server will generate
2595
 
        # the full history from that.  If the revision doesn't exist in this
2596
 
        # branch, NoSuchRevision will be raised.
2597
 
        if rev_history == []:
2598
 
            rev_id = 'null:'
2599
 
        else:
2600
 
            rev_id = rev_history[-1]
2601
 
        self._set_last_revision(rev_id)
2602
 
        for hook in branch.Branch.hooks['set_rh']:
2603
 
            hook(self, rev_history)
2604
 
        self._cache_revision_history(rev_history)
2605
 
 
2606
3803
    def _get_parent_location(self):
2607
3804
        medium = self._client._medium
2608
3805
        if medium._is_remote_before((1, 13)):
2654
3851
            _override_hook_target=self, **kwargs)
2655
3852
 
2656
3853
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3854
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3855
        self._ensure_real()
2659
3856
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3857
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3858
            _override_hook_source_branch=self)
2662
3859
 
2663
3860
    def is_locked(self):
2664
3861
        return self._lock_count >= 1
2665
3862
 
2666
3863
    @needs_read_lock
 
3864
    def revision_id_to_dotted_revno(self, revision_id):
 
3865
        """Given a revision id, return its dotted revno.
 
3866
 
 
3867
        :return: a tuple like (1,) or (400,1,3).
 
3868
        """
 
3869
        try:
 
3870
            response = self._call('Branch.revision_id_to_revno',
 
3871
                self._remote_path(), revision_id)
 
3872
        except errors.UnknownSmartMethod:
 
3873
            self._ensure_real()
 
3874
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3875
        if response[0] == 'ok':
 
3876
            return tuple([int(x) for x in response[1:]])
 
3877
        else:
 
3878
            raise errors.UnexpectedSmartServerResponse(response)
 
3879
 
 
3880
    @needs_read_lock
2667
3881
    def revision_id_to_revno(self, revision_id):
2668
 
        self._ensure_real()
2669
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3882
        """Given a revision id on the branch mainline, return its revno.
 
3883
 
 
3884
        :return: an integer
 
3885
        """
 
3886
        try:
 
3887
            response = self._call('Branch.revision_id_to_revno',
 
3888
                self._remote_path(), revision_id)
 
3889
        except errors.UnknownSmartMethod:
 
3890
            self._ensure_real()
 
3891
            return self._real_branch.revision_id_to_revno(revision_id)
 
3892
        if response[0] == 'ok':
 
3893
            if len(response) == 2:
 
3894
                return int(response[1])
 
3895
            raise NoSuchRevision(self, revision_id)
 
3896
        else:
 
3897
            raise errors.UnexpectedSmartServerResponse(response)
2670
3898
 
2671
3899
    @needs_write_lock
2672
3900
    def set_last_revision_info(self, revno, revision_id):
2673
3901
        # XXX: These should be returned by the set_last_revision_info verb
2674
3902
        old_revno, old_revid = self.last_revision_info()
2675
3903
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3904
        if not revision_id or not isinstance(revision_id, basestring):
 
3905
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3906
        try:
2678
3907
            response = self._call('Branch.set_last_revision_info',
2679
3908
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3937
            except errors.UnknownSmartMethod:
2709
3938
                medium._remember_remote_is_before((1, 6))
2710
3939
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
2712
 
            last_rev=last_rev,other_branch=other_branch))
 
3940
        graph = self.repository.get_graph()
 
3941
        (last_revno, last_revid) = self.last_revision_info()
 
3942
        known_revision_ids = [
 
3943
            (last_revid, last_revno),
 
3944
            (_mod_revision.NULL_REVISION, 0),
 
3945
            ]
 
3946
        if last_rev is not None:
 
3947
            if not graph.is_ancestor(last_rev, revision_id):
 
3948
                # our previous tip is not merged into stop_revision
 
3949
                raise errors.DivergedBranches(self, other_branch)
 
3950
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
3951
        self.set_last_revision_info(revno, revision_id)
2713
3952
 
2714
3953
    def set_push_location(self, location):
 
3954
        self._set_config_location('push_location', location)
 
3955
 
 
3956
    def heads_to_fetch(self):
 
3957
        if self._format._use_default_local_heads_to_fetch():
 
3958
            # We recognise this format, and its heads-to-fetch implementation
 
3959
            # is the default one (tip + tags).  In this case it's cheaper to
 
3960
            # just use the default implementation rather than a special RPC as
 
3961
            # the tip and tags data is cached.
 
3962
            return branch.Branch.heads_to_fetch(self)
 
3963
        medium = self._client._medium
 
3964
        if medium._is_remote_before((2, 4)):
 
3965
            return self._vfs_heads_to_fetch()
 
3966
        try:
 
3967
            return self._rpc_heads_to_fetch()
 
3968
        except errors.UnknownSmartMethod:
 
3969
            medium._remember_remote_is_before((2, 4))
 
3970
            return self._vfs_heads_to_fetch()
 
3971
 
 
3972
    def _rpc_heads_to_fetch(self):
 
3973
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3974
        if len(response) != 2:
 
3975
            raise errors.UnexpectedSmartServerResponse(response)
 
3976
        must_fetch, if_present_fetch = response
 
3977
        return set(must_fetch), set(if_present_fetch)
 
3978
 
 
3979
    def _vfs_heads_to_fetch(self):
2715
3980
        self._ensure_real()
2716
 
        return self._real_branch.set_push_location(location)
 
3981
        return self._real_branch.heads_to_fetch()
2717
3982
 
2718
3983
 
2719
3984
class RemoteConfig(object):
2734
3999
        """
2735
4000
        try:
2736
4001
            configobj = self._get_configobj()
 
4002
            section_obj = None
2737
4003
            if section is None:
2738
4004
                section_obj = configobj
2739
4005
            else:
2740
4006
                try:
2741
4007
                    section_obj = configobj[section]
2742
4008
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
4009
                    pass
 
4010
            if section_obj is None:
 
4011
                value = default
 
4012
            else:
 
4013
                value = section_obj.get(name, default)
2745
4014
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
4015
            value = self._vfs_get_option(name, section, default)
 
4016
        for hook in _mod_config.OldConfigHooks['get']:
 
4017
            hook(self, name, value)
 
4018
        return value
2747
4019
 
2748
4020
    def _response_to_configobj(self, response):
2749
4021
        if len(response[0]) and response[0][0] != 'ok':
2750
4022
            raise errors.UnexpectedSmartServerResponse(response)
2751
4023
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
4024
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
4025
        for hook in _mod_config.OldConfigHooks['load']:
 
4026
            hook(self)
 
4027
        return conf
2753
4028
 
2754
4029
 
2755
4030
class RemoteBranchConfig(RemoteConfig):
2774
4049
        medium = self._branch._client._medium
2775
4050
        if medium._is_remote_before((1, 14)):
2776
4051
            return self._vfs_set_option(value, name, section)
 
4052
        if isinstance(value, dict):
 
4053
            if medium._is_remote_before((2, 2)):
 
4054
                return self._vfs_set_option(value, name, section)
 
4055
            return self._set_config_option_dict(value, name, section)
 
4056
        else:
 
4057
            return self._set_config_option(value, name, section)
 
4058
 
 
4059
    def _set_config_option(self, value, name, section):
2777
4060
        try:
2778
4061
            path = self._branch._remote_path()
2779
4062
            response = self._branch._client.call('Branch.set_config_option',
2780
4063
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
4064
                value.encode('utf8'), name, section or '')
2782
4065
        except errors.UnknownSmartMethod:
 
4066
            medium = self._branch._client._medium
2783
4067
            medium._remember_remote_is_before((1, 14))
2784
4068
            return self._vfs_set_option(value, name, section)
2785
4069
        if response != ():
2786
4070
            raise errors.UnexpectedSmartServerResponse(response)
2787
4071
 
 
4072
    def _serialize_option_dict(self, option_dict):
 
4073
        utf8_dict = {}
 
4074
        for key, value in option_dict.items():
 
4075
            if isinstance(key, unicode):
 
4076
                key = key.encode('utf8')
 
4077
            if isinstance(value, unicode):
 
4078
                value = value.encode('utf8')
 
4079
            utf8_dict[key] = value
 
4080
        return bencode.bencode(utf8_dict)
 
4081
 
 
4082
    def _set_config_option_dict(self, value, name, section):
 
4083
        try:
 
4084
            path = self._branch._remote_path()
 
4085
            serialised_dict = self._serialize_option_dict(value)
 
4086
            response = self._branch._client.call(
 
4087
                'Branch.set_config_option_dict',
 
4088
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
4089
                serialised_dict, name, section or '')
 
4090
        except errors.UnknownSmartMethod:
 
4091
            medium = self._branch._client._medium
 
4092
            medium._remember_remote_is_before((2, 2))
 
4093
            return self._vfs_set_option(value, name, section)
 
4094
        if response != ():
 
4095
            raise errors.UnexpectedSmartServerResponse(response)
 
4096
 
2788
4097
    def _real_object(self):
2789
4098
        self._branch._ensure_real()
2790
4099
        return self._branch._real_branch
2829
4138
        return self._bzrdir._real_bzrdir
2830
4139
 
2831
4140
 
2832
 
 
2833
4141
def _extract_tar(tar, to_dir):
2834
4142
    """Extract all the contents of a tarfile object.
2835
4143
 
2839
4147
        tar.extract(tarinfo, to_dir)
2840
4148
 
2841
4149
 
 
4150
error_translators = registry.Registry()
 
4151
no_context_error_translators = registry.Registry()
 
4152
 
 
4153
 
2842
4154
def _translate_error(err, **context):
2843
4155
    """Translate an ErrorFromSmartServer into a more useful error.
2844
4156
 
2873
4185
                    'Missing key %r in context %r', key_err.args[0], context)
2874
4186
                raise err
2875
4187
 
2876
 
    if err.error_verb == 'IncompatibleRepositories':
2877
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2878
 
            err.error_args[1], err.error_args[2])
2879
 
    elif err.error_verb == 'NoSuchRevision':
2880
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
 
    elif err.error_verb == 'nosuchrevision':
2882
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
2883
 
    elif err.error_verb == 'nobranch':
2884
 
        if len(err.error_args) >= 1:
2885
 
            extra = err.error_args[0]
2886
 
        else:
2887
 
            extra = None
2888
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2889
 
            detail=extra)
2890
 
    elif err.error_verb == 'norepository':
2891
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
 
    elif err.error_verb == 'UnlockableTransport':
2895
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2896
 
    elif err.error_verb == 'LockFailed':
2897
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2898
 
    elif err.error_verb == 'TokenMismatch':
2899
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
 
    elif err.error_verb == 'Diverged':
2901
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2902
 
    elif err.error_verb == 'TipChangeRejected':
2903
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2904
 
    elif err.error_verb == 'UnstackableBranchFormat':
2905
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2906
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2907
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2908
 
    elif err.error_verb == 'NotStacked':
2909
 
        raise errors.NotStacked(branch=find('branch'))
2910
 
    elif err.error_verb == 'PermissionDenied':
2911
 
        path = get_path()
2912
 
        if len(err.error_args) >= 2:
2913
 
            extra = err.error_args[1]
2914
 
        else:
2915
 
            extra = None
2916
 
        raise errors.PermissionDenied(path, extra=extra)
2917
 
    elif err.error_verb == 'ReadError':
2918
 
        path = get_path()
2919
 
        raise errors.ReadError(path)
2920
 
    elif err.error_verb == 'NoSuchFile':
2921
 
        path = get_path()
2922
 
        raise errors.NoSuchFile(path)
2923
 
    elif err.error_verb == 'FileExists':
2924
 
        raise errors.FileExists(err.error_args[0])
2925
 
    elif err.error_verb == 'DirectoryNotEmpty':
2926
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
2927
 
    elif err.error_verb == 'ShortReadvError':
2928
 
        args = err.error_args
2929
 
        raise errors.ShortReadvError(
2930
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
2931
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
4188
    try:
 
4189
        translator = error_translators.get(err.error_verb)
 
4190
    except KeyError:
 
4191
        pass
 
4192
    else:
 
4193
        raise translator(err, find, get_path)
 
4194
    try:
 
4195
        translator = no_context_error_translators.get(err.error_verb)
 
4196
    except KeyError:
 
4197
        raise errors.UnknownErrorFromSmartServer(err)
 
4198
    else:
 
4199
        raise translator(err)
 
4200
 
 
4201
 
 
4202
error_translators.register('NoSuchRevision',
 
4203
    lambda err, find, get_path: NoSuchRevision(
 
4204
        find('branch'), err.error_args[0]))
 
4205
error_translators.register('nosuchrevision',
 
4206
    lambda err, find, get_path: NoSuchRevision(
 
4207
        find('repository'), err.error_args[0]))
 
4208
 
 
4209
def _translate_nobranch_error(err, find, get_path):
 
4210
    if len(err.error_args) >= 1:
 
4211
        extra = err.error_args[0]
 
4212
    else:
 
4213
        extra = None
 
4214
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4215
        detail=extra)
 
4216
 
 
4217
error_translators.register('nobranch', _translate_nobranch_error)
 
4218
error_translators.register('norepository',
 
4219
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4220
        find('bzrdir')))
 
4221
error_translators.register('UnlockableTransport',
 
4222
    lambda err, find, get_path: errors.UnlockableTransport(
 
4223
        find('bzrdir').root_transport))
 
4224
error_translators.register('TokenMismatch',
 
4225
    lambda err, find, get_path: errors.TokenMismatch(
 
4226
        find('token'), '(remote token)'))
 
4227
error_translators.register('Diverged',
 
4228
    lambda err, find, get_path: errors.DivergedBranches(
 
4229
        find('branch'), find('other_branch')))
 
4230
error_translators.register('NotStacked',
 
4231
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4232
 
 
4233
def _translate_PermissionDenied(err, find, get_path):
 
4234
    path = get_path()
 
4235
    if len(err.error_args) >= 2:
 
4236
        extra = err.error_args[1]
 
4237
    else:
 
4238
        extra = None
 
4239
    return errors.PermissionDenied(path, extra=extra)
 
4240
 
 
4241
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4242
error_translators.register('ReadError',
 
4243
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4244
error_translators.register('NoSuchFile',
 
4245
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4246
error_translators.register('TokenLockingNotSupported',
 
4247
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4248
        find('repository')))
 
4249
error_translators.register('UnsuspendableWriteGroup',
 
4250
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4251
        repository=find('repository')))
 
4252
error_translators.register('UnresumableWriteGroup',
 
4253
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4254
        repository=find('repository'), write_groups=err.error_args[0],
 
4255
        reason=err.error_args[1]))
 
4256
no_context_error_translators.register('IncompatibleRepositories',
 
4257
    lambda err: errors.IncompatibleRepositories(
 
4258
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4259
no_context_error_translators.register('LockContention',
 
4260
    lambda err: errors.LockContention('(remote lock)'))
 
4261
no_context_error_translators.register('LockFailed',
 
4262
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4263
no_context_error_translators.register('TipChangeRejected',
 
4264
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4265
no_context_error_translators.register('UnstackableBranchFormat',
 
4266
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4267
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4268
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4269
no_context_error_translators.register('FileExists',
 
4270
    lambda err: errors.FileExists(err.error_args[0]))
 
4271
no_context_error_translators.register('DirectoryNotEmpty',
 
4272
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4273
 
 
4274
def _translate_short_readv_error(err):
 
4275
    args = err.error_args
 
4276
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4277
        int(args[3]))
 
4278
 
 
4279
no_context_error_translators.register('ShortReadvError',
 
4280
    _translate_short_readv_error)
 
4281
 
 
4282
def _translate_unicode_error(err):
2932
4283
        encoding = str(err.error_args[0]) # encoding must always be a string
2933
4284
        val = err.error_args[1]
2934
4285
        start = int(err.error_args[2])
2942
4293
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2943
4294
        elif err.error_verb == 'UnicodeEncodeError':
2944
4295
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
 
    elif err.error_verb == 'ReadOnlyError':
2946
 
        raise errors.TransportNotPossible('readonly transport')
2947
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4296
 
 
4297
no_context_error_translators.register('UnicodeEncodeError',
 
4298
    _translate_unicode_error)
 
4299
no_context_error_translators.register('UnicodeDecodeError',
 
4300
    _translate_unicode_error)
 
4301
no_context_error_translators.register('ReadOnlyError',
 
4302
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4303
no_context_error_translators.register('MemoryError',
 
4304
    lambda err: errors.BzrError("remote server out of memory\n"
 
4305
        "Retry non-remotely, or contact the server admin for details."))
 
4306
no_context_error_translators.register('RevisionNotPresent',
 
4307
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4308
 
 
4309
no_context_error_translators.register('BzrCheckError',
 
4310
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4311