/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Ian Clatworthy
  • Date: 2009-03-17 06:27:18 UTC
  • mto: (4157.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4158.
  • Revision ID: ian.clatworthy@canonical.com-20090317062718-dvnbbcgpcwsketx4
tweak docstring

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
16
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
24
    bzrdir,
23
 
    config,
24
25
    debug,
25
26
    errors,
26
27
    graph,
27
 
    lock,
28
28
    lockdir,
 
29
    pack,
29
30
    repository,
30
 
    repository as _mod_repository,
31
31
    revision,
32
 
    revision as _mod_revision,
33
 
    static_tuple,
34
32
    symbol_versioning,
 
33
    urlutils,
35
34
)
36
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
35
from bzrlib.branch import BranchReferenceFormat
37
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
38
from bzrlib.errors import (
40
39
    NoSuchRevision,
41
40
    SmartProtocolError,
43
42
from bzrlib.lockable_files import LockableFiles
44
43
from bzrlib.smart import client, vfs, repository as smart_repo
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
48
47
 
49
48
 
50
49
class _RpcHelper(object):
62
61
        except errors.ErrorFromSmartServer, err:
63
62
            self._translate_error(err, **err_context)
64
63
 
65
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
66
 
        try:
67
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
68
 
        except errors.ErrorFromSmartServer, err:
69
 
            self._translate_error(err, **err_context)
70
 
 
71
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
65
                                             **err_context):
73
66
        try:
92
85
class RemoteBzrDir(BzrDir, _RpcHelper):
93
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
87
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
96
89
        """Construct a RemoteBzrDir.
97
90
 
98
91
        :param _client: Private parameter for testing. Disables probing and the
102
95
        # this object holds a delegated bzrdir that uses file-level operations
103
96
        # to talk to the other side
104
97
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
99
        # create_branch for details.
108
100
        self._next_open_branch_result = None
112
104
            self._client = client._SmartClient(medium)
113
105
        else:
114
106
            self._client = _client
115
 
            if not _force_probe:
116
 
                return
117
 
 
118
 
        self._probe_bzrdir()
119
 
 
120
 
    def __repr__(self):
121
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
122
 
 
123
 
    def _probe_bzrdir(self):
124
 
        medium = self._client._medium
 
107
            return
 
108
 
125
109
        path = self._path_for_remote_call(self._client)
126
 
        if medium._is_remote_before((2, 1)):
127
 
            self._rpc_open(path)
128
 
            return
129
 
        try:
130
 
            self._rpc_open_2_1(path)
131
 
            return
132
 
        except errors.UnknownSmartMethod:
133
 
            medium._remember_remote_is_before((2, 1))
134
 
            self._rpc_open(path)
135
 
 
136
 
    def _rpc_open_2_1(self, path):
137
 
        response = self._call('BzrDir.open_2.1', path)
138
 
        if response == ('no',):
139
 
            raise errors.NotBranchError(path=self.root_transport.base)
140
 
        elif response[0] == 'yes':
141
 
            if response[1] == 'yes':
142
 
                self._has_working_tree = True
143
 
            elif response[1] == 'no':
144
 
                self._has_working_tree = False
145
 
            else:
146
 
                raise errors.UnexpectedSmartServerResponse(response)
147
 
        else:
148
 
            raise errors.UnexpectedSmartServerResponse(response)
149
 
 
150
 
    def _rpc_open(self, path):
151
110
        response = self._call('BzrDir.open', path)
152
111
        if response not in [('yes',), ('no',)]:
153
112
            raise errors.UnexpectedSmartServerResponse(response)
154
113
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
156
115
 
157
116
    def _ensure_real(self):
158
117
        """Ensure that there is a _real_bzrdir set.
160
119
        Used before calls to self._real_bzrdir.
161
120
        """
162
121
        if not self._real_bzrdir:
163
 
            if 'hpssvfs' in debug.debug_flags:
164
 
                import traceback
165
 
                warning('VFS BzrDir access triggered\n%s',
166
 
                    ''.join(traceback.format_stack()))
167
122
            self._real_bzrdir = BzrDir.open_from_transport(
168
123
                self.root_transport, _server_formats=False)
169
124
            self._format._network_name = \
198
153
        except errors.UnknownSmartMethod:
199
154
            medium._remember_remote_is_before((1, 13))
200
155
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
201
 
        except errors.UnknownErrorFromSmartServer, err:
202
 
            if err.error_tuple != ('BranchReference',):
203
 
                raise
204
 
            # We need to resolve the branch reference to determine the
205
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
206
 
            # referenced branch (and bzrdir, etc) but only when the caller
207
 
            # didn't already resolve the branch reference.
208
 
            referenced_branch = self.open_branch()
209
 
            return referenced_branch.bzrdir.cloning_metadir()
210
156
        if len(response) != 3:
211
157
            raise errors.UnexpectedSmartServerResponse(response)
212
158
        control_name, repo_name, branch_info = response
245
191
        self._ensure_real()
246
192
        self._real_bzrdir.destroy_repository()
247
193
 
248
 
    def create_branch(self, name=None):
 
194
    def create_branch(self):
249
195
        # as per meta1 formats - just delegate to the format object which may
250
196
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
197
        real_branch = self._format.get_branch_format().initialize(self)
253
198
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
199
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
200
        else:
257
201
            result = real_branch
258
202
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
208
        self._next_open_branch_result = result
265
209
        return result
266
210
 
267
 
    def destroy_branch(self, name=None):
 
211
    def destroy_branch(self):
268
212
        """See BzrDir.destroy_branch"""
269
213
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
214
        self._real_bzrdir.destroy_branch()
271
215
        self._next_open_branch_result = None
272
216
 
273
217
    def create_workingtree(self, revision_id=None, from_branch=None):
292
236
    def _get_branch_reference(self):
293
237
        path = self._path_for_remote_call(self._client)
294
238
        medium = self._client._medium
295
 
        candidate_calls = [
296
 
            ('BzrDir.open_branchV3', (2, 1)),
297
 
            ('BzrDir.open_branchV2', (1, 13)),
298
 
            ('BzrDir.open_branch', None),
299
 
            ]
300
 
        for verb, required_version in candidate_calls:
301
 
            if required_version and medium._is_remote_before(required_version):
302
 
                continue
 
239
        if not medium._is_remote_before((1, 13)):
303
240
            try:
304
 
                response = self._call(verb, path)
 
241
                response = self._call('BzrDir.open_branchV2', path)
 
242
                if response[0] not in ('ref', 'branch'):
 
243
                    raise errors.UnexpectedSmartServerResponse(response)
 
244
                return response
305
245
            except errors.UnknownSmartMethod:
306
 
                if required_version is None:
307
 
                    raise
308
 
                medium._remember_remote_is_before(required_version)
309
 
            else:
310
 
                break
311
 
        if verb == 'BzrDir.open_branch':
312
 
            if response[0] != 'ok':
313
 
                raise errors.UnexpectedSmartServerResponse(response)
314
 
            if response[1] != '':
315
 
                return ('ref', response[1])
316
 
            else:
317
 
                return ('branch', '')
318
 
        if response[0] not in ('ref', 'branch'):
 
246
                medium._remember_remote_is_before((1, 13))
 
247
        response = self._call('BzrDir.open_branch', path)
 
248
        if response[0] != 'ok':
319
249
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
 
250
        if response[1] != '':
 
251
            return ('ref', response[1])
 
252
        else:
 
253
            return ('branch', '')
321
254
 
322
255
    def _get_tree_branch(self):
323
256
        """See BzrDir._get_tree_branch()."""
324
257
        return None, self.open_branch()
325
258
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
259
    def open_branch(self, _unsupported=False):
 
260
        if _unsupported:
329
261
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
262
        if self._next_open_branch_result is not None:
331
263
            # See create_branch for details.
336
268
        if response[0] == 'ref':
337
269
            # a branch reference, use the existing BranchReference logic.
338
270
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
271
            return format.open(self, _found=True, location=response[1])
341
272
        branch_format_name = response[1]
342
273
        if not branch_format_name:
343
274
            branch_format_name = None
344
275
        format = RemoteBranchFormat(network_name=branch_format_name)
345
 
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
 
276
        return RemoteBranch(self, self.find_repository(), format=format)
347
277
 
348
278
    def _open_repo_v1(self, path):
349
279
        verb = 'BzrDir.find_repository'
410
340
        else:
411
341
            raise errors.NoRepositoryPresent(self)
412
342
 
413
 
    def has_workingtree(self):
414
 
        if self._has_working_tree is None:
415
 
            self._ensure_real()
416
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
417
 
        return self._has_working_tree
418
 
 
419
343
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
344
        self._ensure_real()
 
345
        if self._real_bzrdir.has_workingtree():
421
346
            raise errors.NotLocalUrl(self.root_transport)
422
347
        else:
423
348
            raise errors.NoWorkingTree(self.root_transport.base)
426
351
        """Return the path to be used for this bzrdir in a remote call."""
427
352
        return client.remote_path_from_transport(self.root_transport)
428
353
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
354
    def get_branch_transport(self, branch_format):
430
355
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
356
        return self._real_bzrdir.get_branch_transport(branch_format)
432
357
 
433
358
    def get_repository_transport(self, repository_format):
434
359
        self._ensure_real()
455
380
        return self._real_bzrdir.clone(url, revision_id=revision_id,
456
381
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
457
382
 
458
 
    def _get_config(self):
459
 
        return RemoteBzrDirConfig(self)
 
383
    def get_config(self):
 
384
        self._ensure_real()
 
385
        return self._real_bzrdir.get_config()
460
386
 
461
387
 
462
388
class RemoteRepositoryFormat(repository.RepositoryFormat):
486
412
        self._custom_format = None
487
413
        self._network_name = None
488
414
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
415
        self._supports_external_lookups = None
491
416
        self._supports_tree_reference = None
492
417
        self._rich_root_data = None
493
418
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
 
    @property
499
 
    def fast_deltas(self):
500
 
        self._ensure_real()
501
 
        return self._custom_format.fast_deltas
502
 
 
503
419
    @property
504
420
    def rich_root_data(self):
505
421
        if self._rich_root_data is None:
508
424
        return self._rich_root_data
509
425
 
510
426
    @property
511
 
    def supports_chks(self):
512
 
        if self._supports_chks is None:
513
 
            self._ensure_real()
514
 
            self._supports_chks = self._custom_format.supports_chks
515
 
        return self._supports_chks
516
 
 
517
 
    @property
518
427
    def supports_external_lookups(self):
519
428
        if self._supports_external_lookups is None:
520
429
            self._ensure_real()
521
430
            self._supports_external_lookups = \
522
 
                self._custom_format.supports_external_lookups
 
431
                self._custom_format.supports_external_lookups 
523
432
        return self._supports_external_lookups
524
433
 
525
434
    @property
566
475
        # 1) get the network name to use.
567
476
        if self._custom_format:
568
477
            network_name = self._custom_format.network_name()
569
 
        elif self._network_name:
570
 
            network_name = self._network_name
571
478
        else:
572
479
            # Select the current bzrlib default and ask for that.
573
480
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
621
528
        return self._custom_format._fetch_reconcile
622
529
 
623
530
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
531
        return 'bzr remote repository'
626
532
 
627
533
    def __eq__(self, other):
628
534
        return self.__class__ is other.__class__
629
535
 
 
536
    def check_conversion_target(self, target_format):
 
537
        if self.rich_root_data and not target_format.rich_root_data:
 
538
            raise errors.BadConversionTarget(
 
539
                'Does not support rich root data.', target_format)
 
540
        if (self.supports_tree_reference and
 
541
            not getattr(target_format, 'supports_tree_reference', False)):
 
542
            raise errors.BadConversionTarget(
 
543
                'Does not support nested trees', target_format)
 
544
 
630
545
    def network_name(self):
631
546
        if self._network_name:
632
547
            return self._network_name
634
549
        return self._creating_repo._real_repository._format.network_name()
635
550
 
636
551
    @property
637
 
    def pack_compresses(self):
638
 
        self._ensure_real()
639
 
        return self._custom_format.pack_compresses
640
 
 
641
 
    @property
642
552
    def _serializer(self):
643
553
        self._ensure_real()
644
554
        return self._custom_format._serializer
645
555
 
646
556
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
557
class RemoteRepository(_RpcHelper):
649
558
    """Repository accessed over rpc.
650
559
 
651
560
    For the moment most operations are performed using local transport-backed
677
586
        self._lock_token = None
678
587
        self._lock_count = 0
679
588
        self._leave_lock = False
680
 
        # Cache of revision parents; misses are cached during read locks, and
681
 
        # write locks when no _real_repository has been set.
682
589
        self._unstacked_provider = graph.CachingParentsProvider(
683
590
            get_parent_map=self._get_parent_map_rpc)
684
591
        self._unstacked_provider.disable_cache()
694
601
        # Additional places to query for data.
695
602
        self._fallback_repositories = []
696
603
 
697
 
    @property
698
 
    def user_transport(self):
699
 
        return self.bzrdir.user_transport
700
 
 
701
 
    @property
702
 
    def control_transport(self):
703
 
        # XXX: Normally you shouldn't directly get at the remote repository
704
 
        # transport, but I'm not sure it's worth making this method
705
 
        # optional -- mbp 2010-04-21
706
 
        return self.bzrdir.get_repository_transport(None)
707
 
        
708
604
    def __str__(self):
709
605
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
606
 
713
609
    def abort_write_group(self, suppress_errors=False):
714
610
        """Complete a write group on the decorated repository.
715
611
 
716
 
        Smart methods perform operations in a single step so this API
 
612
        Smart methods peform operations in a single step so this api
717
613
        is not really applicable except as a compatibility thunk
718
614
        for older plugins that don't use e.g. the CommitBuilder
719
615
        facility.
724
620
        return self._real_repository.abort_write_group(
725
621
            suppress_errors=suppress_errors)
726
622
 
727
 
    @property
728
 
    def chk_bytes(self):
729
 
        """Decorate the real repository for now.
730
 
 
731
 
        In the long term a full blown network facility is needed to avoid
732
 
        creating a real repository object locally.
733
 
        """
734
 
        self._ensure_real()
735
 
        return self._real_repository.chk_bytes
736
 
 
737
623
    def commit_write_group(self):
738
624
        """Complete a write group on the decorated repository.
739
625
 
740
 
        Smart methods perform operations in a single step so this API
 
626
        Smart methods peform operations in a single step so this api
741
627
        is not really applicable except as a compatibility thunk
742
628
        for older plugins that don't use e.g. the CommitBuilder
743
629
        facility.
753
639
        self._ensure_real()
754
640
        return self._real_repository.suspend_write_group()
755
641
 
756
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
757
 
        self._ensure_real()
758
 
        return self._real_repository.get_missing_parent_inventories(
759
 
            check_for_missing_texts=check_for_missing_texts)
760
 
 
761
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
762
 
        self._ensure_real()
763
 
        return self._real_repository.get_rev_id_for_revno(
764
 
            revno, known_pair)
765
 
 
766
 
    def get_rev_id_for_revno(self, revno, known_pair):
767
 
        """See Repository.get_rev_id_for_revno."""
768
 
        path = self.bzrdir._path_for_remote_call(self._client)
769
 
        try:
770
 
            if self._client._medium._is_remote_before((1, 17)):
771
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
772
 
            response = self._call(
773
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
774
 
        except errors.UnknownSmartMethod:
775
 
            self._client._medium._remember_remote_is_before((1, 17))
776
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
777
 
        if response[0] == 'ok':
778
 
            return True, response[1]
779
 
        elif response[0] == 'history-incomplete':
780
 
            known_pair = response[1:3]
781
 
            for fallback in self._fallback_repositories:
782
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
783
 
                if found:
784
 
                    return True, result
785
 
                else:
786
 
                    known_pair = result
787
 
            # Not found in any fallbacks
788
 
            return False, known_pair
789
 
        else:
790
 
            raise errors.UnexpectedSmartServerResponse(response)
791
 
 
792
642
    def _ensure_real(self):
793
643
        """Ensure that there is a _real_repository set.
794
644
 
803
653
        invocation. If in doubt chat to the bzr network team.
804
654
        """
805
655
        if self._real_repository is None:
806
 
            if 'hpssvfs' in debug.debug_flags:
807
 
                import traceback
808
 
                warning('VFS Repository access triggered\n%s',
809
 
                    ''.join(traceback.format_stack()))
810
 
            self._unstacked_provider.missing_keys.clear()
811
656
            self.bzrdir._ensure_real()
812
657
            self._set_real_repository(
813
658
                self.bzrdir._real_bzrdir.open_repository())
840
685
        self._ensure_real()
841
686
        return self._real_repository._generate_text_key_index()
842
687
 
 
688
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
689
    def get_revision_graph(self, revision_id=None):
 
690
        """See Repository.get_revision_graph()."""
 
691
        return self._get_revision_graph(revision_id)
 
692
 
843
693
    def _get_revision_graph(self, revision_id):
844
694
        """Private method for using with old (< 1.2) servers to fallback."""
845
695
        if revision_id is None:
873
723
        """Return a source for streaming from this repository."""
874
724
        return RemoteStreamSource(self, to_format)
875
725
 
876
 
    @needs_read_lock
877
726
    def has_revision(self, revision_id):
878
 
        """True if this repository has a copy of the revision."""
879
 
        # Copy of bzrlib.repository.Repository.has_revision
880
 
        return revision_id in self.has_revisions((revision_id,))
 
727
        """See Repository.has_revision()."""
 
728
        if revision_id == NULL_REVISION:
 
729
            # The null revision is always present.
 
730
            return True
 
731
        path = self.bzrdir._path_for_remote_call(self._client)
 
732
        response = self._call('Repository.has_revision', path, revision_id)
 
733
        if response[0] not in ('yes', 'no'):
 
734
            raise errors.UnexpectedSmartServerResponse(response)
 
735
        if response[0] == 'yes':
 
736
            return True
 
737
        for fallback_repo in self._fallback_repositories:
 
738
            if fallback_repo.has_revision(revision_id):
 
739
                return True
 
740
        return False
881
741
 
882
 
    @needs_read_lock
883
742
    def has_revisions(self, revision_ids):
884
 
        """Probe to find out the presence of multiple revisions.
885
 
 
886
 
        :param revision_ids: An iterable of revision_ids.
887
 
        :return: A set of the revision_ids that were present.
888
 
        """
889
 
        # Copy of bzrlib.repository.Repository.has_revisions
890
 
        parent_map = self.get_parent_map(revision_ids)
891
 
        result = set(parent_map)
892
 
        if _mod_revision.NULL_REVISION in revision_ids:
893
 
            result.add(_mod_revision.NULL_REVISION)
 
743
        """See Repository.has_revisions()."""
 
744
        # FIXME: This does many roundtrips, particularly when there are
 
745
        # fallback repositories.  -- mbp 20080905
 
746
        result = set()
 
747
        for revision_id in revision_ids:
 
748
            if self.has_revision(revision_id):
 
749
                result.add(revision_id)
894
750
        return result
895
751
 
896
 
    def _has_same_fallbacks(self, other_repo):
897
 
        """Returns true if the repositories have the same fallbacks."""
898
 
        # XXX: copied from Repository; it should be unified into a base class
899
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
900
 
        my_fb = self._fallback_repositories
901
 
        other_fb = other_repo._fallback_repositories
902
 
        if len(my_fb) != len(other_fb):
903
 
            return False
904
 
        for f, g in zip(my_fb, other_fb):
905
 
            if not f.has_same_location(g):
906
 
                return False
907
 
        return True
908
 
 
909
752
    def has_same_location(self, other):
910
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
911
 
        # one; unfortunately the tests rely on slightly different behaviour at
912
 
        # present -- mbp 20090710
913
753
        return (self.__class__ is other.__class__ and
914
754
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
755
 
918
758
        parents_provider = self._make_parents_provider(other_repository)
919
759
        return graph.Graph(parents_provider)
920
760
 
921
 
    @needs_read_lock
922
 
    def get_known_graph_ancestry(self, revision_ids):
923
 
        """Return the known graph for a set of revision ids and their ancestors.
924
 
        """
925
 
        st = static_tuple.StaticTuple
926
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
927
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
928
 
        return graph.GraphThunkIdsToKeys(known_graph)
929
 
 
930
761
    def gather_stats(self, revid=None, committers=None):
931
762
        """See Repository.gather_stats()."""
932
763
        path = self.bzrdir._path_for_remote_call(self._client)
992
823
    def is_write_locked(self):
993
824
        return self._lock_mode == 'w'
994
825
 
995
 
    def _warn_if_deprecated(self, branch=None):
996
 
        # If we have a real repository, the check will be done there, if we
997
 
        # don't the check will be done remotely.
998
 
        pass
999
 
 
1000
826
    def lock_read(self):
1001
 
        """Lock the repository for read operations.
1002
 
 
1003
 
        :return: An object with an unlock method which will release the lock
1004
 
            obtained.
1005
 
        """
1006
827
        # wrong eventually - want a local lock cache context
1007
828
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
829
            self._lock_mode = 'r'
1010
830
            self._lock_count = 1
1011
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
831
            self._unstacked_provider.enable_cache(cache_misses=False)
1012
832
            if self._real_repository is not None:
1013
833
                self._real_repository.lock_read()
1014
 
            for repo in self._fallback_repositories:
1015
 
                repo.lock_read()
1016
834
        else:
1017
835
            self._lock_count += 1
1018
 
        return self
1019
836
 
1020
837
    def _remote_lock_write(self, token):
1021
838
        path = self.bzrdir._path_for_remote_call(self._client)
1032
849
 
1033
850
    def lock_write(self, token=None, _skip_rpc=False):
1034
851
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
852
            if _skip_rpc:
1037
853
                if self._lock_token is not None:
1038
854
                    if token != self._lock_token:
1052
868
                self._leave_lock = False
1053
869
            self._lock_mode = 'w'
1054
870
            self._lock_count = 1
1055
 
            cache_misses = self._real_repository is None
1056
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1057
 
            for repo in self._fallback_repositories:
1058
 
                # Writes don't affect fallback repos
1059
 
                repo.lock_read()
 
871
            self._unstacked_provider.enable_cache(cache_misses=False)
1060
872
        elif self._lock_mode == 'r':
1061
873
            raise errors.ReadOnlyError(self)
1062
874
        else:
1063
875
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
876
        return self._lock_token or None
1065
877
 
1066
878
    def leave_lock_in_place(self):
1067
879
        if not self._lock_token:
1088
900
        if isinstance(repository, RemoteRepository):
1089
901
            raise AssertionError()
1090
902
        self._real_repository = repository
1091
 
        # three code paths happen here:
1092
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1093
 
        # up stacking. In this case self._fallback_repositories is [], and the
1094
 
        # real repo is already setup. Preserve the real repo and
1095
 
        # RemoteRepository.add_fallback_repository will avoid adding
1096
 
        # duplicates.
1097
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1098
 
        # ensure_real is triggered from a branch, the real repository to
1099
 
        # set already has a matching list with separate instances, but
1100
 
        # as they are also RemoteRepositories we don't worry about making the
1101
 
        # lists be identical.
1102
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1103
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1104
 
        # and need to populate it.
1105
 
        if (self._fallback_repositories and
1106
 
            len(self._real_repository._fallback_repositories) !=
1107
 
            len(self._fallback_repositories)):
1108
 
            if len(self._real_repository._fallback_repositories):
1109
 
                raise AssertionError(
1110
 
                    "cannot cleanly remove existing _fallback_repositories")
 
903
        # If the _real_repository has _fallback_repositories, clear them out,
 
904
        # because we want it to have the same set as this repository.  This is
 
905
        # reasonable to do because the fallbacks we clear here are from a
 
906
        # "real" branch, and we're about to replace them with the equivalents
 
907
        # from a RemoteBranch.
 
908
        self._real_repository._fallback_repositories = []
1111
909
        for fb in self._fallback_repositories:
1112
910
            self._real_repository.add_fallback_repository(fb)
1113
911
        if self._lock_mode == 'w':
1120
918
    def start_write_group(self):
1121
919
        """Start a write group on the decorated repository.
1122
920
 
1123
 
        Smart methods perform operations in a single step so this API
 
921
        Smart methods peform operations in a single step so this api
1124
922
        is not really applicable except as a compatibility thunk
1125
923
        for older plugins that don't use e.g. the CommitBuilder
1126
924
        facility.
1141
939
        else:
1142
940
            raise errors.UnexpectedSmartServerResponse(response)
1143
941
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
942
    def unlock(self):
1146
943
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
944
            raise errors.LockNotHeld(self)
1148
945
        self._lock_count -= 1
1149
946
        if self._lock_count > 0:
1150
947
            return
1164
961
            # problem releasing the vfs-based lock.
1165
962
            if old_mode == 'w':
1166
963
                # Only write-locked repositories need to make a remote method
1167
 
                # call to perform the unlock.
 
964
                # call to perfom the unlock.
1168
965
                old_token = self._lock_token
1169
966
                self._lock_token = None
1170
967
                if not self._leave_lock:
1171
968
                    self._unlock(old_token)
1172
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1173
 
        # self._leave_lock
1174
 
        for repo in self._fallback_repositories:
1175
 
            repo.unlock()
1176
969
 
1177
970
    def break_lock(self):
1178
971
        # should hand off to the network
1242
1035
        # We need to accumulate additional repositories here, to pass them in
1243
1036
        # on various RPC's.
1244
1037
        #
1245
 
        if self.is_locked():
1246
 
            # We will call fallback.unlock() when we transition to the unlocked
1247
 
            # state, so always add a lock here. If a caller passes us a locked
1248
 
            # repository, they are responsible for unlocking it later.
1249
 
            repository.lock_read()
1250
 
        self._check_fallback_repository(repository)
1251
1038
        self._fallback_repositories.append(repository)
1252
1039
        # If self._real_repository was parameterised already (e.g. because a
1253
1040
        # _real_branch had its get_stacked_on_url method called), then the
1254
1041
        # repository to be added may already be in the _real_repositories list.
1255
1042
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
1257
 
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
1043
            if repository not in self._real_repository._fallback_repositories:
1259
1044
                self._real_repository.add_fallback_repository(repository)
1260
 
 
1261
 
    def _check_fallback_repository(self, repository):
1262
 
        """Check that this repository can fallback to repository safely.
1263
 
 
1264
 
        Raise an error if not.
1265
 
 
1266
 
        :param repository: A repository to fallback to.
1267
 
        """
1268
 
        return _mod_repository.InterRepository._assert_same_model(
1269
 
            self, repository)
 
1045
        else:
 
1046
            # They are also seen by the fallback repository.  If it doesn't
 
1047
            # exist yet they'll be added then.  This implicitly copies them.
 
1048
            self._ensure_real()
1270
1049
 
1271
1050
    def add_inventory(self, revid, inv, parents):
1272
1051
        self._ensure_real()
1273
1052
        return self._real_repository.add_inventory(revid, inv, parents)
1274
1053
 
1275
1054
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
1055
                               parents):
1277
1056
        self._ensure_real()
1278
1057
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1279
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1280
 
            propagate_caches=propagate_caches)
 
1058
            delta, new_revision_id, parents)
1281
1059
 
1282
1060
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1061
        self._ensure_real()
1289
1067
        self._ensure_real()
1290
1068
        return self._real_repository.get_inventory(revision_id)
1291
1069
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1070
    def iter_inventories(self, revision_ids):
1293
1071
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1072
        return self._real_repository.iter_inventories(revision_ids)
1295
1073
 
1296
1074
    @needs_read_lock
1297
1075
    def get_revision(self, revision_id):
1361
1139
            raise errors.InternalBzrError(
1362
1140
                "May not fetch while in a write group.")
1363
1141
        # fast path same-url fetch operations
1364
 
        if (self.has_same_location(source)
1365
 
            and fetch_spec is None
1366
 
            and self._has_same_fallbacks(source)):
 
1142
        if self.has_same_location(source) and fetch_spec is None:
1367
1143
            # check that last_revision is in 'from' and then return a
1368
1144
            # no-operation.
1369
1145
            if (revision_id is not None and
1412
1188
            # We already found out that the server can't understand
1413
1189
            # Repository.get_parent_map requests, so just fetch the whole
1414
1190
            # graph.
1415
 
            #
1416
 
            # Note that this reads the whole graph, when only some keys are
1417
 
            # wanted.  On this old server there's no way (?) to get them all
1418
 
            # in one go, and the user probably will have seen a warning about
1419
 
            # the server being old anyhow.
1420
 
            rg = self._get_revision_graph(None)
1421
 
            # There is an API discrepancy between get_parent_map and
 
1191
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1192
            # :- its because we're working with a deprecated server anyway, and
 
1193
            # the user will almost certainly have seen a warning about the
 
1194
            # server version already.
 
1195
            rg = self.get_revision_graph()
 
1196
            # There is an api discrepency between get_parent_map and
1422
1197
            # get_revision_graph. Specifically, a "key:()" pair in
1423
1198
            # get_revision_graph just means a node has no parents. For
1424
1199
            # "get_parent_map" it means the node is a ghost. So fix up the
1454
1229
        # TODO: Manage this incrementally to avoid covering the same path
1455
1230
        # repeatedly. (The server will have to on each request, but the less
1456
1231
        # work done the better).
1457
 
        #
1458
 
        # Negative caching notes:
1459
 
        # new server sends missing when a request including the revid
1460
 
        # 'include-missing:' is present in the request.
1461
 
        # missing keys are serialised as missing:X, and we then call
1462
 
        # provider.note_missing(X) for-all X
1463
1232
        parents_map = self._unstacked_provider.get_cached_map()
1464
1233
        if parents_map is None:
1465
1234
            # Repository is not locked, so there's no cache.
1466
1235
            parents_map = {}
1467
 
        # start_set is all the keys in the cache
1468
1236
        start_set = set(parents_map)
1469
 
        # result set is all the references to keys in the cache
1470
1237
        result_parents = set()
1471
1238
        for parents in parents_map.itervalues():
1472
1239
            result_parents.update(parents)
1473
1240
        stop_keys = result_parents.difference(start_set)
1474
 
        # We don't need to send ghosts back to the server as a position to
1475
 
        # stop either.
1476
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1477
 
        key_count = len(parents_map)
1478
 
        if (NULL_REVISION in result_parents
1479
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1480
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1481
 
            # in our cache of "missing" keys we need to increment our key count
1482
 
            # by 1, because the reconsitituted SearchResult on the server will
1483
 
            # still consider NULL_REVISION to be an included key.
1484
 
            key_count += 1
1485
1241
        included_keys = start_set.intersection(result_parents)
1486
1242
        start_set.difference_update(included_keys)
1487
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1243
        recipe = (start_set, stop_keys, len(parents_map))
1488
1244
        body = self._serialise_search_recipe(recipe)
1489
1245
        path = self.bzrdir._path_for_remote_call(self._client)
1490
1246
        for key in keys:
1492
1248
                raise ValueError(
1493
1249
                    "key %r not a plain string" % (key,))
1494
1250
        verb = 'Repository.get_parent_map'
1495
 
        args = (path, 'include-missing:') + tuple(keys)
 
1251
        args = (path,) + tuple(keys)
1496
1252
        try:
1497
1253
            response = self._call_with_body_bytes_expecting_body(
1498
1254
                verb, args, body)
1508
1264
            # To avoid having to disconnect repeatedly, we keep track of the
1509
1265
            # fact the server doesn't understand remote methods added in 1.2.
1510
1266
            medium._remember_remote_is_before((1, 2))
1511
 
            # Recurse just once and we should use the fallback code.
1512
 
            return self._get_parent_map_rpc(keys)
 
1267
            return self.get_revision_graph(None)
1513
1268
        response_tuple, response_handler = response
1514
1269
        if response_tuple[0] not in ['ok']:
1515
1270
            response_handler.cancel_read_body()
1526
1281
                if len(d) > 1:
1527
1282
                    revision_graph[d[0]] = d[1:]
1528
1283
                else:
1529
 
                    # No parents:
1530
 
                    if d[0].startswith('missing:'):
1531
 
                        revid = d[0][8:]
1532
 
                        self._unstacked_provider.note_missing_key(revid)
1533
 
                    else:
1534
 
                        # no parents - so give the Graph result
1535
 
                        # (NULL_REVISION,).
1536
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
1284
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1285
                    revision_graph[d[0]] = (NULL_REVISION,)
1537
1286
            return revision_graph
1538
1287
 
1539
1288
    @needs_read_lock
1542
1291
        return self._real_repository.get_signature_text(revision_id)
1543
1292
 
1544
1293
    @needs_read_lock
1545
 
    def _get_inventory_xml(self, revision_id):
1546
 
        self._ensure_real()
1547
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1294
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1295
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1296
        self._ensure_real()
 
1297
        return self._real_repository.get_revision_graph_with_ghosts(
 
1298
            revision_ids=revision_ids)
 
1299
 
 
1300
    @needs_read_lock
 
1301
    def get_inventory_xml(self, revision_id):
 
1302
        self._ensure_real()
 
1303
        return self._real_repository.get_inventory_xml(revision_id)
 
1304
 
 
1305
    def deserialise_inventory(self, revision_id, xml):
 
1306
        self._ensure_real()
 
1307
        return self._real_repository.deserialise_inventory(revision_id, xml)
1548
1308
 
1549
1309
    def reconcile(self, other=None, thorough=False):
1550
1310
        self._ensure_real()
1555
1315
        return self._real_repository.all_revision_ids()
1556
1316
 
1557
1317
    @needs_read_lock
1558
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1318
    def get_deltas_for_revisions(self, revisions):
1559
1319
        self._ensure_real()
1560
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1561
 
            specific_fileids=specific_fileids)
 
1320
        return self._real_repository.get_deltas_for_revisions(revisions)
1562
1321
 
1563
1322
    @needs_read_lock
1564
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1323
    def get_revision_delta(self, revision_id):
1565
1324
        self._ensure_real()
1566
 
        return self._real_repository.get_revision_delta(revision_id,
1567
 
            specific_fileids=specific_fileids)
 
1325
        return self._real_repository.get_revision_delta(revision_id)
1568
1326
 
1569
1327
    @needs_read_lock
1570
1328
    def revision_trees(self, revision_ids):
1577
1335
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1336
 
1579
1337
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1338
    def check(self, revision_ids=None):
1581
1339
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1340
        return self._real_repository.check(revision_ids=revision_ids)
1584
1341
 
1585
1342
    def copy_content_into(self, destination, revision_id=None):
1586
1343
        self._ensure_real()
1626
1383
        return self._real_repository.inventories
1627
1384
 
1628
1385
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1386
    def pack(self):
1630
1387
        """Compress the data within the repository.
1631
1388
 
1632
1389
        This is not currently implemented within the smart server.
1633
1390
        """
1634
1391
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1392
        return self._real_repository.pack()
1636
1393
 
1637
1394
    @property
1638
1395
    def revisions(self):
1726
1483
        self._ensure_real()
1727
1484
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1485
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1486
    def _find_inconsistent_revision_parents(self):
1730
1487
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1488
        return self._real_repository._find_inconsistent_revision_parents()
1733
1489
 
1734
1490
    def _check_for_inconsistent_revision_parents(self):
1735
1491
        self._ensure_real()
1741
1497
            providers.insert(0, other)
1742
1498
        providers.extend(r._make_parents_provider() for r in
1743
1499
                         self._fallback_repositories)
1744
 
        return graph.StackedParentsProvider(providers)
 
1500
        return graph._StackedParentsProvider(providers)
1745
1501
 
1746
1502
    def _serialise_search_recipe(self, recipe):
1747
1503
        """Serialise a graph search recipe.
1749
1505
        :param recipe: A search recipe (start, stop, count).
1750
1506
        :return: Serialised bytes.
1751
1507
        """
1752
 
        start_keys = ' '.join(recipe[1])
1753
 
        stop_keys = ' '.join(recipe[2])
1754
 
        count = str(recipe[3])
 
1508
        start_keys = ' '.join(recipe[0])
 
1509
        stop_keys = ' '.join(recipe[1])
 
1510
        count = str(recipe[2])
1755
1511
        return '\n'.join((start_keys, stop_keys, count))
1756
1512
 
1757
1513
    def _serialise_search_result(self, search_result):
1760
1516
            parts.extend(search_result.heads)
1761
1517
        else:
1762
1518
            recipe = search_result.get_recipe()
1763
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
1519
            parts = ['search', self._serialise_search_recipe(recipe)]
1764
1520
        return '\n'.join(parts)
1765
1521
 
1766
1522
    def autopack(self):
1788
1544
 
1789
1545
    def insert_stream(self, stream, src_format, resume_tokens):
1790
1546
        target = self.target_repo
1791
 
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
1547
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
 
1548
            verb = 'Repository.insert_stream_locked'
 
1549
            extra_args = (target._lock_token or '',)
 
1550
            required_version = (1, 14)
1796
1551
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
 
1552
            verb = 'Repository.insert_stream'
 
1553
            extra_args = ()
 
1554
            required_version = (1, 13)
1799
1555
        client = target._client
1800
1556
        medium = client._medium
 
1557
        if medium._is_remote_before(required_version):
 
1558
            # No possible way this can work.
 
1559
            return self._insert_real(stream, src_format, resume_tokens)
1801
1560
        path = target.bzrdir._path_for_remote_call(client)
1802
 
        # Probe for the verb to use with an empty stream before sending the
1803
 
        # real stream to it.  We do this both to avoid the risk of sending a
1804
 
        # large request that is then rejected, and because we don't want to
1805
 
        # implement a way to buffer, rewind, or restart the stream.
1806
 
        found_verb = False
1807
 
        for verb, required_version in candidate_calls:
1808
 
            if medium._is_remote_before(required_version):
1809
 
                continue
1810
 
            if resume_tokens:
1811
 
                # We've already done the probing (and set _is_remote_before) on
1812
 
                # a previous insert.
1813
 
                found_verb = True
1814
 
                break
 
1561
        if not resume_tokens:
 
1562
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1563
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1564
            # fallback to the _real_repositories sink *with a partial stream*.
 
1565
            # Thats bad because we insert less data than bzr expected. To avoid
 
1566
            # this we do a trial push to make sure the verb is accessible, and
 
1567
            # do not fallback when actually pushing the stream. A cleanup patch
 
1568
            # is going to look at rewinding/restarting the stream/partial
 
1569
            # buffering etc.
1815
1570
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
1571
            try:
1817
1572
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1573
                    (verb, path, '') + extra_args, byte_stream)
1819
1574
            except errors.UnknownSmartMethod:
1820
1575
                medium._remember_remote_is_before(required_version)
1821
 
            else:
1822
 
                found_verb = True
1823
 
                break
1824
 
        if not found_verb:
1825
 
            # Have to use VFS.
1826
 
            return self._insert_real(stream, src_format, resume_tokens)
1827
 
        self._last_inv_record = None
1828
 
        self._last_substream = None
1829
 
        if required_version < (1, 19):
1830
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1831
 
            # make sure we don't send any.  If the stream contains inventory
1832
 
            # deltas we'll interrupt the smart insert_stream request and
1833
 
            # fallback to VFS.
1834
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1576
                return self._insert_real(stream, src_format, resume_tokens)
1835
1577
        byte_stream = smart_repo._stream_to_byte_stream(
1836
1578
            stream, src_format)
1837
1579
        resume_tokens = ' '.join(resume_tokens)
1838
1580
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1581
            (verb, path, resume_tokens) + extra_args, byte_stream)
1840
1582
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1583
            raise errors.UnexpectedSmartServerResponse(response)
1842
 
        if self._last_substream is not None:
1843
 
            # The stream included an inventory-delta record, but the remote
1844
 
            # side isn't new enough to support them.  So we need to send the
1845
 
            # rest of the stream via VFS.
1846
 
            self.target_repo.refresh_data()
1847
 
            return self._resume_stream_with_vfs(response, src_format)
1848
1584
        if response[0][0] == 'missing-basis':
1849
1585
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1586
            resume_tokens = tokens
1851
 
            return resume_tokens, set(missing_keys)
 
1587
            return resume_tokens, missing_keys
1852
1588
        else:
1853
1589
            self.target_repo.refresh_data()
1854
1590
            return [], set()
1855
1591
 
1856
 
    def _resume_stream_with_vfs(self, response, src_format):
1857
 
        """Resume sending a stream via VFS, first resending the record and
1858
 
        substream that couldn't be sent via an insert_stream verb.
1859
 
        """
1860
 
        if response[0][0] == 'missing-basis':
1861
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1862
 
            # Ignore missing_keys, we haven't finished inserting yet
1863
 
        else:
1864
 
            tokens = []
1865
 
        def resume_substream():
1866
 
            # Yield the substream that was interrupted.
1867
 
            for record in self._last_substream:
1868
 
                yield record
1869
 
            self._last_substream = None
1870
 
        def resume_stream():
1871
 
            # Finish sending the interrupted substream
1872
 
            yield ('inventory-deltas', resume_substream())
1873
 
            # Then simply continue sending the rest of the stream.
1874
 
            for substream_kind, substream in self._last_stream:
1875
 
                yield substream_kind, substream
1876
 
        return self._insert_real(resume_stream(), src_format, tokens)
1877
 
 
1878
 
    def _stop_stream_if_inventory_delta(self, stream):
1879
 
        """Normally this just lets the original stream pass-through unchanged.
1880
 
 
1881
 
        However if any 'inventory-deltas' substream occurs it will stop
1882
 
        streaming, and store the interrupted substream and stream in
1883
 
        self._last_substream and self._last_stream so that the stream can be
1884
 
        resumed by _resume_stream_with_vfs.
1885
 
        """
1886
 
                    
1887
 
        stream_iter = iter(stream)
1888
 
        for substream_kind, substream in stream_iter:
1889
 
            if substream_kind == 'inventory-deltas':
1890
 
                self._last_substream = substream
1891
 
                self._last_stream = stream_iter
1892
 
                return
1893
 
            else:
1894
 
                yield substream_kind, substream
1895
 
            
1896
1592
 
1897
1593
class RemoteStreamSource(repository.StreamSource):
1898
1594
    """Stream data from a remote server."""
1899
1595
 
1900
1596
    def get_stream(self, search):
1901
 
        if (self.from_repository._fallback_repositories and
1902
 
            self.to_format._fetch_order == 'topological'):
1903
 
            return self._real_stream(self.from_repository, search)
1904
 
        sources = []
1905
 
        seen = set()
1906
 
        repos = [self.from_repository]
1907
 
        while repos:
1908
 
            repo = repos.pop(0)
1909
 
            if repo in seen:
1910
 
                continue
1911
 
            seen.add(repo)
1912
 
            repos.extend(repo._fallback_repositories)
1913
 
            sources.append(repo)
1914
 
        return self.missing_parents_chain(search, sources)
1915
 
 
1916
 
    def get_stream_for_missing_keys(self, missing_keys):
1917
 
        self.from_repository._ensure_real()
1918
 
        real_repo = self.from_repository._real_repository
1919
 
        real_source = real_repo._get_source(self.to_format)
1920
 
        return real_source.get_stream_for_missing_keys(missing_keys)
1921
 
 
1922
 
    def _real_stream(self, repo, search):
1923
 
        """Get a stream for search from repo.
1924
 
        
1925
 
        This never called RemoteStreamSource.get_stream, and is a heler
1926
 
        for RemoteStreamSource._get_stream to allow getting a stream 
1927
 
        reliably whether fallback back because of old servers or trying
1928
 
        to stream from a non-RemoteRepository (which the stacked support
1929
 
        code will do).
1930
 
        """
1931
 
        source = repo._get_source(self.to_format)
1932
 
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
1935
 
        return source.get_stream(search)
1936
 
 
1937
 
    def _get_stream(self, repo, search):
1938
 
        """Core worker to get a stream from repo for search.
1939
 
 
1940
 
        This is used by both get_stream and the stacking support logic. It
1941
 
        deliberately gets a stream for repo which does not need to be
1942
 
        self.from_repository. In the event that repo is not Remote, or
1943
 
        cannot do a smart stream, a fallback is made to the generic
1944
 
        repository._get_stream() interface, via self._real_stream.
1945
 
 
1946
 
        In the event of stacking, streams from _get_stream will not
1947
 
        contain all the data for search - this is normal (see get_stream).
1948
 
 
1949
 
        :param repo: A repository.
1950
 
        :param search: A search.
1951
 
        """
1952
 
        # Fallbacks may be non-smart
1953
 
        if not isinstance(repo, RemoteRepository):
1954
 
            return self._real_stream(repo, search)
 
1597
        # streaming with fallback repositories is not well defined yet: The
 
1598
        # remote repository cannot see the fallback repositories, and thus
 
1599
        # cannot satisfy the entire search in the general case. Likewise the
 
1600
        # fallback repositories cannot reify the search to determine what they
 
1601
        # should send. It likely needs a return value in the stream listing the
 
1602
        # edge of the search to resume from in fallback repositories.
 
1603
        if self.from_repository._fallback_repositories:
 
1604
            return repository.StreamSource.get_stream(self, search)
 
1605
        repo = self.from_repository
1955
1606
        client = repo._client
1956
1607
        medium = client._medium
 
1608
        if medium._is_remote_before((1, 13)):
 
1609
            # No possible way this can work.
 
1610
            return repository.StreamSource.get_stream(self, search)
1957
1611
        path = repo.bzrdir._path_for_remote_call(client)
1958
 
        search_bytes = repo._serialise_search_result(search)
1959
 
        args = (path, self.to_format.network_name())
1960
 
        candidate_verbs = [
1961
 
            ('Repository.get_stream_1.19', (1, 19)),
1962
 
            ('Repository.get_stream', (1, 13))]
1963
 
        found_verb = False
1964
 
        for verb, version in candidate_verbs:
1965
 
            if medium._is_remote_before(version):
1966
 
                continue
1967
 
            try:
1968
 
                response = repo._call_with_body_bytes_expecting_body(
1969
 
                    verb, args, search_bytes)
1970
 
            except errors.UnknownSmartMethod:
1971
 
                medium._remember_remote_is_before(version)
1972
 
            else:
1973
 
                response_tuple, response_handler = response
1974
 
                found_verb = True
1975
 
                break
1976
 
        if not found_verb:
1977
 
            return self._real_stream(repo, search)
 
1612
        try:
 
1613
            search_bytes = repo._serialise_search_result(search)
 
1614
            response = repo._call_with_body_bytes_expecting_body(
 
1615
                'Repository.get_stream',
 
1616
                (path, self.to_format.network_name()), search_bytes)
 
1617
            response_tuple, response_handler = response
 
1618
        except errors.UnknownSmartMethod:
 
1619
            medium._remember_remote_is_before((1,13))
 
1620
            return repository.StreamSource.get_stream(self, search)
1978
1621
        if response_tuple[0] != 'ok':
1979
1622
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1980
1623
        byte_stream = response_handler.read_streamed_body()
1985
1628
                src_format.network_name(), repo._format.network_name()))
1986
1629
        return stream
1987
1630
 
1988
 
    def missing_parents_chain(self, search, sources):
1989
 
        """Chain multiple streams together to handle stacking.
1990
 
 
1991
 
        :param search: The overall search to satisfy with streams.
1992
 
        :param sources: A list of Repository objects to query.
1993
 
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
1995
 
        self.seen_revs = set()
1996
 
        self.referenced_revs = set()
1997
 
        # If there are heads in the search, or the key count is > 0, we are not
1998
 
        # done.
1999
 
        while not search.is_empty() and len(sources) > 1:
2000
 
            source = sources.pop(0)
2001
 
            stream = self._get_stream(source, search)
2002
 
            for kind, substream in stream:
2003
 
                if kind != 'revisions':
2004
 
                    yield kind, substream
2005
 
                else:
2006
 
                    yield kind, self.missing_parents_rev_handler(substream)
2007
 
            search = search.refine(self.seen_revs, self.referenced_revs)
2008
 
            self.seen_revs = set()
2009
 
            self.referenced_revs = set()
2010
 
        if not search.is_empty():
2011
 
            for kind, stream in self._get_stream(sources[0], search):
2012
 
                yield kind, stream
2013
 
 
2014
 
    def missing_parents_rev_handler(self, substream):
2015
 
        for content in substream:
2016
 
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
2019
 
            self.seen_revs.add(content.key[-1])
2020
 
            self.referenced_revs.update(revision.parent_ids)
2021
 
            yield content
2022
 
 
2023
1631
 
2024
1632
class RemoteBranchLockableFiles(LockableFiles):
2025
1633
    """A 'LockableFiles' implementation that talks to a smart server.
2060
1668
                self._network_name)
2061
1669
 
2062
1670
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1671
        return 'Remote BZR Branch'
2065
1672
 
2066
1673
    def network_name(self):
2067
1674
        return self._network_name
2068
1675
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1676
    def open(self, a_bzrdir):
 
1677
        return a_bzrdir.open_branch()
2072
1678
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1679
    def _vfs_initialize(self, a_bzrdir):
2074
1680
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1681
        # method is not available on the server.
2076
1682
        # self._custom_format is always set - the start of initialize ensures
2077
1683
        # that.
2078
1684
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1685
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1686
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1687
        else:
2083
1688
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1689
            result = self._custom_format.initialize(a_bzrdir)
2085
1690
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1691
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1692
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1693
        return result
2090
1694
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1695
    def initialize(self, a_bzrdir):
2092
1696
        # 1) get the network name to use.
2093
1697
        if self._custom_format:
2094
1698
            network_name = self._custom_format.network_name()
2100
1704
            network_name = reference_format.network_name()
2101
1705
        # Being asked to create on a non RemoteBzrDir:
2102
1706
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1707
            return self._vfs_initialize(a_bzrdir)
2104
1708
        medium = a_bzrdir._client._medium
2105
1709
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1710
            return self._vfs_initialize(a_bzrdir)
2107
1711
        # Creating on a remote bzr dir.
2108
1712
        # 2) try direct creation via RPC
2109
1713
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2110
 
        if name is not None:
2111
 
            # XXX JRV20100304: Support creating colocated branches
2112
 
            raise errors.NoColocatedBranchSupport(self)
2113
1714
        verb = 'BzrDir.create_branch'
2114
1715
        try:
2115
1716
            response = a_bzrdir._call(verb, path, network_name)
2116
1717
        except errors.UnknownSmartMethod:
2117
1718
            # Fallback - use vfs methods
2118
1719
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1720
            return self._vfs_initialize(a_bzrdir)
2120
1721
        if response[0] != 'ok':
2121
1722
            raise errors.UnexpectedSmartServerResponse(response)
2122
1723
        # Turn the response into a RemoteRepository object.
2130
1731
                a_bzrdir._client)
2131
1732
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1733
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1734
            format=format, setup_stacking=False)
2134
1735
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1736
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1737
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2151
1752
        self._ensure_real()
2152
1753
        return self._custom_format.supports_stacking()
2153
1754
 
2154
 
    def supports_set_append_revisions_only(self):
2155
 
        self._ensure_real()
2156
 
        return self._custom_format.supports_set_append_revisions_only()
2157
 
 
2158
 
 
2159
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1755
 
 
1756
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1757
    """Branch stored on a server accessed by HPSS RPC.
2161
1758
 
2162
1759
    At the moment most operations are mapped down to simple file operations.
2163
1760
    """
2164
1761
 
2165
1762
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1763
        _client=None, format=None, setup_stacking=True):
2167
1764
        """Create a RemoteBranch instance.
2168
1765
 
2169
1766
        :param real_branch: An optional local implementation of the branch
2175
1772
        :param setup_stacking: If True make an RPC call to determine the
2176
1773
            stacked (or not) status of the branch. If False assume the branch
2177
1774
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1775
        """
2180
1776
        # We intentionally don't call the parent class's __init__, because it
2181
1777
        # will try to assign to self.tags, which is a property in this subclass.
2182
1778
        # And the parent's __init__ doesn't do much anyway.
 
1779
        self._revision_id_to_revno_cache = None
 
1780
        self._partial_revision_id_to_revno_cache = {}
 
1781
        self._revision_history_cache = None
 
1782
        self._last_revision_info_cache = None
 
1783
        self._merge_sorted_revisions_cache = None
2183
1784
        self.bzrdir = remote_bzrdir
2184
1785
        if _client is not None:
2185
1786
            self._client = _client
2198
1799
            self._real_branch.repository = self.repository
2199
1800
        else:
2200
1801
            self._real_branch = None
2201
 
        # Fill out expected attributes of branch for bzrlib API users.
2202
 
        self._clear_cached_state()
2203
 
        # TODO: deprecate self.base in favor of user_url
2204
 
        self.base = self.bzrdir.user_url
2205
 
        self._name = name
 
1802
        # Fill out expected attributes of branch for bzrlib api users.
 
1803
        self.base = self.bzrdir.root_transport.base
2206
1804
        self._control_files = None
2207
1805
        self._lock_mode = None
2208
1806
        self._lock_token = None
2219
1817
                    self._real_branch._format.network_name()
2220
1818
        else:
2221
1819
            self._format = format
2222
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2223
 
        # branch.open_branch method.
2224
 
        self._real_ignore_fallbacks = not setup_stacking
2225
1820
        if not self._format._network_name:
2226
1821
            # Did not get from open_branchV2 - old server.
2227
1822
            self._ensure_real()
2232
1827
        hooks = branch.Branch.hooks['open']
2233
1828
        for hook in hooks:
2234
1829
            hook(self)
2235
 
        self._is_stacked = False
2236
1830
        if setup_stacking:
2237
1831
            self._setup_stacking()
2238
1832
 
2244
1838
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2245
1839
            errors.UnstackableRepositoryFormat), e:
2246
1840
            return
2247
 
        self._is_stacked = True
2248
 
        self._activate_fallback_location(fallback_url)
2249
 
 
2250
 
    def _get_config(self):
2251
 
        return RemoteBranchConfig(self)
 
1841
        # it's relative to this branch...
 
1842
        fallback_url = urlutils.join(self.base, fallback_url)
 
1843
        transports = [self.bzrdir.root_transport]
 
1844
        stacked_on = branch.Branch.open(fallback_url,
 
1845
                                        possible_transports=transports)
 
1846
        self.repository.add_fallback_repository(stacked_on.repository)
2252
1847
 
2253
1848
    def _get_real_transport(self):
2254
1849
        # if we try vfs access, return the real branch's vfs transport
2272
1867
                raise AssertionError('smart server vfs must be enabled '
2273
1868
                    'to use vfs implementation')
2274
1869
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1870
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
1871
            if self.repository._real_repository is None:
2278
1872
                # Give the remote repository the matching real repo.
2279
1873
                real_repo = self._real_branch.repository
2353
1947
            raise errors.UnexpectedSmartServerResponse(response)
2354
1948
        return response[1]
2355
1949
 
2356
 
    def set_stacked_on_url(self, url):
2357
 
        branch.Branch.set_stacked_on_url(self, url)
2358
 
        if not url:
2359
 
            self._is_stacked = False
2360
 
        else:
2361
 
            self._is_stacked = True
2362
 
        
2363
1950
    def _vfs_get_tags_bytes(self):
2364
1951
        self._ensure_real()
2365
1952
        return self._real_branch._get_tags_bytes()
2375
1962
            return self._vfs_get_tags_bytes()
2376
1963
        return response[0]
2377
1964
 
2378
 
    def _vfs_set_tags_bytes(self, bytes):
2379
 
        self._ensure_real()
2380
 
        return self._real_branch._set_tags_bytes(bytes)
2381
 
 
2382
 
    def _set_tags_bytes(self, bytes):
2383
 
        medium = self._client._medium
2384
 
        if medium._is_remote_before((1, 18)):
2385
 
            self._vfs_set_tags_bytes(bytes)
2386
 
            return
2387
 
        try:
2388
 
            args = (
2389
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2390
 
            response = self._call_with_body_bytes(
2391
 
                'Branch.set_tags_bytes', args, bytes)
2392
 
        except errors.UnknownSmartMethod:
2393
 
            medium._remember_remote_is_before((1, 18))
2394
 
            self._vfs_set_tags_bytes(bytes)
2395
 
 
2396
1965
    def lock_read(self):
2397
 
        """Lock the branch for read operations.
2398
 
 
2399
 
        :return: An object with an unlock method which will release the lock
2400
 
            obtained.
2401
 
        """
2402
1966
        self.repository.lock_read()
2403
1967
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
1968
            self._lock_mode = 'r'
2406
1969
            self._lock_count = 1
2407
1970
            if self._real_branch is not None:
2408
1971
                self._real_branch.lock_read()
2409
1972
        else:
2410
1973
            self._lock_count += 1
2411
 
        return self
2412
1974
 
2413
1975
    def _remote_lock_write(self, token):
2414
1976
        if token is None:
2415
1977
            branch_token = repo_token = ''
2416
1978
        else:
2417
1979
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
1980
            repo_token = self.repository.lock_write()
2419
1981
            self.repository.unlock()
2420
1982
        err_context = {'token': token}
2421
1983
        response = self._call(
2428
1990
 
2429
1991
    def lock_write(self, token=None):
2430
1992
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
1993
            # Lock the branch and repo in one remote call.
2433
1994
            remote_tokens = self._remote_lock_write(token)
2434
1995
            self._lock_token, self._repo_lock_token = remote_tokens
2458
2019
            self._lock_count += 1
2459
2020
            # Re-lock the repository too.
2460
2021
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2022
        return self._lock_token or None
 
2023
 
 
2024
    def _set_tags_bytes(self, bytes):
 
2025
        self._ensure_real()
 
2026
        return self._real_branch._set_tags_bytes(bytes)
2462
2027
 
2463
2028
    def _unlock(self, branch_token, repo_token):
2464
2029
        err_context = {'token': str((branch_token, repo_token))}
2469
2034
            return
2470
2035
        raise errors.UnexpectedSmartServerResponse(response)
2471
2036
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
2037
    def unlock(self):
2474
2038
        try:
2475
2039
            self._lock_count -= 1
2488
2052
                    self._real_branch.unlock()
2489
2053
                if mode != 'w':
2490
2054
                    # Only write-locked branched need to make a remote method
2491
 
                    # call to perform the unlock.
 
2055
                    # call to perfom the unlock.
2492
2056
                    return
2493
2057
                if not self._lock_token:
2494
2058
                    raise AssertionError('Locked, but no token!')
2515
2079
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
2080
        self._leave_lock = False
2517
2081
 
2518
 
    @needs_read_lock
2519
 
    def get_rev_id(self, revno, history=None):
2520
 
        if revno == 0:
2521
 
            return _mod_revision.NULL_REVISION
2522
 
        last_revision_info = self.last_revision_info()
2523
 
        ok, result = self.repository.get_rev_id_for_revno(
2524
 
            revno, last_revision_info)
2525
 
        if ok:
2526
 
            return result
2527
 
        missing_parent = result[1]
2528
 
        # Either the revision named by the server is missing, or its parent
2529
 
        # is.  Call get_parent_map to determine which, so that we report a
2530
 
        # useful error.
2531
 
        parent_map = self.repository.get_parent_map([missing_parent])
2532
 
        if missing_parent in parent_map:
2533
 
            missing_parent = parent_map[missing_parent]
2534
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2535
 
 
2536
2082
    def _last_revision_info(self):
2537
2083
        response = self._call('Branch.last_revision_info', self._remote_path())
2538
2084
        if response[0] != 'ok':
2543
2089
 
2544
2090
    def _gen_revision_history(self):
2545
2091
        """See Branch._gen_revision_history()."""
2546
 
        if self._is_stacked:
2547
 
            self._ensure_real()
2548
 
            return self._real_branch._gen_revision_history()
2549
2092
        response_tuple, response_handler = self._call_expecting_body(
2550
2093
            'Branch.revision_history', self._remote_path())
2551
2094
        if response_tuple[0] != 'ok':
2636
2179
        self._ensure_real()
2637
2180
        return self._real_branch._get_parent_location()
2638
2181
 
 
2182
    def set_parent(self, url):
 
2183
        self._ensure_real()
 
2184
        return self._real_branch.set_parent(url)
 
2185
 
2639
2186
    def _set_parent_location(self, url):
2640
 
        medium = self._client._medium
2641
 
        if medium._is_remote_before((1, 15)):
2642
 
            return self._vfs_set_parent_location(url)
2643
 
        try:
2644
 
            call_url = url or ''
2645
 
            if type(call_url) is not str:
2646
 
                raise AssertionError('url must be a str or None (%s)' % url)
2647
 
            response = self._call('Branch.set_parent_location',
2648
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2649
 
                call_url)
2650
 
        except errors.UnknownSmartMethod:
2651
 
            medium._remember_remote_is_before((1, 15))
2652
 
            return self._vfs_set_parent_location(url)
2653
 
        if response != ():
2654
 
            raise errors.UnexpectedSmartServerResponse(response)
2655
 
 
2656
 
    def _vfs_set_parent_location(self, url):
 
2187
        # Used by tests, to poke bad urls into branch configurations
 
2188
        if url is None:
 
2189
            self.set_parent(url)
 
2190
        else:
 
2191
            self._ensure_real()
 
2192
            return self._real_branch._set_parent_location(url)
 
2193
 
 
2194
    def set_stacked_on_url(self, stacked_location):
 
2195
        """Set the URL this branch is stacked against.
 
2196
 
 
2197
        :raises UnstackableBranchFormat: If the branch does not support
 
2198
            stacking.
 
2199
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2200
            stacking.
 
2201
        """
2657
2202
        self._ensure_real()
2658
 
        return self._real_branch._set_parent_location(url)
 
2203
        return self._real_branch.set_stacked_on_url(stacked_location)
2659
2204
 
2660
2205
    @needs_write_lock
2661
2206
    def pull(self, source, overwrite=False, stop_revision=None,
2729
2274
        return self._real_branch.set_push_location(location)
2730
2275
 
2731
2276
 
2732
 
class RemoteConfig(object):
2733
 
    """A Config that reads and writes from smart verbs.
2734
 
 
2735
 
    It is a low-level object that considers config data to be name/value pairs
2736
 
    that may be associated with a section. Assigning meaning to the these
2737
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2738
 
    """
2739
 
 
2740
 
    def get_option(self, name, section=None, default=None):
2741
 
        """Return the value associated with a named option.
2742
 
 
2743
 
        :param name: The name of the value
2744
 
        :param section: The section the option is in (if any)
2745
 
        :param default: The value to return if the value is not set
2746
 
        :return: The value or default value
2747
 
        """
2748
 
        try:
2749
 
            configobj = self._get_configobj()
2750
 
            if section is None:
2751
 
                section_obj = configobj
2752
 
            else:
2753
 
                try:
2754
 
                    section_obj = configobj[section]
2755
 
                except KeyError:
2756
 
                    return default
2757
 
            return section_obj.get(name, default)
2758
 
        except errors.UnknownSmartMethod:
2759
 
            return self._vfs_get_option(name, section, default)
2760
 
 
2761
 
    def _response_to_configobj(self, response):
2762
 
        if len(response[0]) and response[0][0] != 'ok':
2763
 
            raise errors.UnexpectedSmartServerResponse(response)
2764
 
        lines = response[1].read_body_bytes().splitlines()
2765
 
        return config.ConfigObj(lines, encoding='utf-8')
2766
 
 
2767
 
 
2768
 
class RemoteBranchConfig(RemoteConfig):
2769
 
    """A RemoteConfig for Branches."""
2770
 
 
2771
 
    def __init__(self, branch):
2772
 
        self._branch = branch
2773
 
 
2774
 
    def _get_configobj(self):
2775
 
        path = self._branch._remote_path()
2776
 
        response = self._branch._client.call_expecting_body(
2777
 
            'Branch.get_config_file', path)
2778
 
        return self._response_to_configobj(response)
2779
 
 
2780
 
    def set_option(self, value, name, section=None):
2781
 
        """Set the value associated with a named option.
2782
 
 
2783
 
        :param value: The value to set
2784
 
        :param name: The name of the value to set
2785
 
        :param section: The section the option is in (if any)
2786
 
        """
2787
 
        medium = self._branch._client._medium
2788
 
        if medium._is_remote_before((1, 14)):
2789
 
            return self._vfs_set_option(value, name, section)
2790
 
        try:
2791
 
            path = self._branch._remote_path()
2792
 
            response = self._branch._client.call('Branch.set_config_option',
2793
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2794
 
                value.encode('utf8'), name, section or '')
2795
 
        except errors.UnknownSmartMethod:
2796
 
            medium._remember_remote_is_before((1, 14))
2797
 
            return self._vfs_set_option(value, name, section)
2798
 
        if response != ():
2799
 
            raise errors.UnexpectedSmartServerResponse(response)
2800
 
 
2801
 
    def _real_object(self):
2802
 
        self._branch._ensure_real()
2803
 
        return self._branch._real_branch
2804
 
 
2805
 
    def _vfs_set_option(self, value, name, section=None):
2806
 
        return self._real_object()._get_config().set_option(
2807
 
            value, name, section)
2808
 
 
2809
 
 
2810
 
class RemoteBzrDirConfig(RemoteConfig):
2811
 
    """A RemoteConfig for BzrDirs."""
2812
 
 
2813
 
    def __init__(self, bzrdir):
2814
 
        self._bzrdir = bzrdir
2815
 
 
2816
 
    def _get_configobj(self):
2817
 
        medium = self._bzrdir._client._medium
2818
 
        verb = 'BzrDir.get_config_file'
2819
 
        if medium._is_remote_before((1, 15)):
2820
 
            raise errors.UnknownSmartMethod(verb)
2821
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2822
 
        response = self._bzrdir._call_expecting_body(
2823
 
            verb, path)
2824
 
        return self._response_to_configobj(response)
2825
 
 
2826
 
    def _vfs_get_option(self, name, section, default):
2827
 
        return self._real_object()._get_config().get_option(
2828
 
            name, section, default)
2829
 
 
2830
 
    def set_option(self, value, name, section=None):
2831
 
        """Set the value associated with a named option.
2832
 
 
2833
 
        :param value: The value to set
2834
 
        :param name: The name of the value to set
2835
 
        :param section: The section the option is in (if any)
2836
 
        """
2837
 
        return self._real_object()._get_config().set_option(
2838
 
            value, name, section)
2839
 
 
2840
 
    def _real_object(self):
2841
 
        self._bzrdir._ensure_real()
2842
 
        return self._bzrdir._real_bzrdir
2843
 
 
2844
 
 
2845
 
 
2846
2277
def _extract_tar(tar, to_dir):
2847
2278
    """Extract all the contents of a tarfile object.
2848
2279
 
2886
2317
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2318
                raise err
2888
2319
 
2889
 
    if err.error_verb == 'IncompatibleRepositories':
2890
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2891
 
            err.error_args[1], err.error_args[2])
2892
 
    elif err.error_verb == 'NoSuchRevision':
 
2320
    if err.error_verb == 'NoSuchRevision':
2893
2321
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2322
    elif err.error_verb == 'nosuchrevision':
2895
2323
        raise NoSuchRevision(find('repository'), err.error_args[0])
2896
 
    elif err.error_verb == 'nobranch':
2897
 
        if len(err.error_args) >= 1:
2898
 
            extra = err.error_args[0]
2899
 
        else:
2900
 
            extra = None
2901
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2902
 
            detail=extra)
 
2324
    elif err.error_tuple == ('nobranch',):
 
2325
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2326
    elif err.error_verb == 'norepository':
2904
2327
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2328
    elif err.error_verb == 'LockContention':