← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Robert Collins
  • Date: 2009-03-12 06:24:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4133.
  • Revision ID: robertc@robertcollins.net-20090312062439-gigl7rnor6t2cbcz
Migrate existing hooks over to the new HookPoint infrastructure.

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
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,
44
43
from bzrlib.smart import client, vfs, repository as smart_repo
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
47
47
 
48
48
 
49
49
class _RpcHelper(object):
61
61
        except errors.ErrorFromSmartServer, err:
62
62
            self._translate_error(err, **err_context)
63
63
 
64
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
65
 
        try:
66
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
67
 
        except errors.ErrorFromSmartServer, err:
68
 
            self._translate_error(err, **err_context)
69
 
 
70
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
71
65
                                             **err_context):
72
66
        try:
79
73
def response_tuple_to_repo_format(response):
80
74
    """Convert a response tuple describing a repository format to a format."""
81
75
    format = RemoteRepositoryFormat()
82
 
    format._rich_root_data = (response[0] == 'yes')
83
 
    format._supports_tree_reference = (response[1] == 'yes')
84
 
    format._supports_external_lookups = (response[2] == 'yes')
 
76
    format.rich_root_data = (response[0] == 'yes')
 
77
    format.supports_tree_reference = (response[1] == 'yes')
 
78
    format.supports_external_lookups = (response[2] == 'yes')
85
79
    format._network_name = response[3]
86
80
    return format
87
81
 
91
85
class RemoteBzrDir(BzrDir, _RpcHelper):
92
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
87
 
94
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
95
89
        """Construct a RemoteBzrDir.
96
90
 
97
91
        :param _client: Private parameter for testing. Disables probing and the
101
95
        # this object holds a delegated bzrdir that uses file-level operations
102
96
        # to talk to the other side
103
97
        self._real_bzrdir = None
104
 
        self._has_working_tree = None
105
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
106
99
        # create_branch for details.
107
100
        self._next_open_branch_result = None
111
104
            self._client = client._SmartClient(medium)
112
105
        else:
113
106
            self._client = _client
114
 
            if not _force_probe:
115
 
                return
116
 
 
117
 
        self._probe_bzrdir()
118
 
 
119
 
    def __repr__(self):
120
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
121
 
 
122
 
    def _probe_bzrdir(self):
123
 
        medium = self._client._medium
 
107
            return
 
108
 
124
109
        path = self._path_for_remote_call(self._client)
125
 
        if medium._is_remote_before((2, 1)):
126
 
            self._rpc_open(path)
127
 
            return
128
 
        try:
129
 
            self._rpc_open_2_1(path)
130
 
            return
131
 
        except errors.UnknownSmartMethod:
132
 
            medium._remember_remote_is_before((2, 1))
133
 
            self._rpc_open(path)
134
 
 
135
 
    def _rpc_open_2_1(self, path):
136
 
        response = self._call('BzrDir.open_2.1', path)
137
 
        if response == ('no',):
138
 
            raise errors.NotBranchError(path=self.root_transport.base)
139
 
        elif response[0] == 'yes':
140
 
            if response[1] == 'yes':
141
 
                self._has_working_tree = True
142
 
            elif response[1] == 'no':
143
 
                self._has_working_tree = False
144
 
            else:
145
 
                raise errors.UnexpectedSmartServerResponse(response)
146
 
        else:
147
 
            raise errors.UnexpectedSmartServerResponse(response)
148
 
 
149
 
    def _rpc_open(self, path):
150
110
        response = self._call('BzrDir.open', path)
151
111
        if response not in [('yes',), ('no',)]:
152
112
            raise errors.UnexpectedSmartServerResponse(response)
153
113
        if response == ('no',):
154
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
155
115
 
156
116
    def _ensure_real(self):
157
117
        """Ensure that there is a _real_bzrdir set.
159
119
        Used before calls to self._real_bzrdir.
160
120
        """
161
121
        if not self._real_bzrdir:
162
 
            if 'hpssvfs' in debug.debug_flags:
163
 
                import traceback
164
 
                warning('VFS BzrDir access triggered\n%s',
165
 
                    ''.join(traceback.format_stack()))
166
122
            self._real_bzrdir = BzrDir.open_from_transport(
167
123
                self.root_transport, _server_formats=False)
168
124
            self._format._network_name = \
197
153
        except errors.UnknownSmartMethod:
198
154
            medium._remember_remote_is_before((1, 13))
199
155
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
200
 
        except errors.UnknownErrorFromSmartServer, err:
201
 
            if err.error_tuple != ('BranchReference',):
202
 
                raise
203
 
            # We need to resolve the branch reference to determine the
204
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
205
 
            # referenced branch (and bzrdir, etc) but only when the caller
206
 
            # didn't already resolve the branch reference.
207
 
            referenced_branch = self.open_branch()
208
 
            return referenced_branch.bzrdir.cloning_metadir()
209
156
        if len(response) != 3:
210
157
            raise errors.UnexpectedSmartServerResponse(response)
211
158
        control_name, repo_name, branch_info = response
244
191
        self._ensure_real()
245
192
        self._real_bzrdir.destroy_repository()
246
193
 
247
 
    def create_branch(self, name=None):
 
194
    def create_branch(self):
248
195
        # as per meta1 formats - just delegate to the format object which may
249
196
        # be parameterised.
250
 
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
197
        real_branch = self._format.get_branch_format().initialize(self)
252
198
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
199
            result = RemoteBranch(self, self.find_repository(), real_branch)
255
200
        else:
256
201
            result = real_branch
257
202
        # BzrDir.clone_on_transport() uses the result of create_branch but does
263
208
        self._next_open_branch_result = result
264
209
        return result
265
210
 
266
 
    def destroy_branch(self, name=None):
 
211
    def destroy_branch(self):
267
212
        """See BzrDir.destroy_branch"""
268
213
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
214
        self._real_bzrdir.destroy_branch()
270
215
        self._next_open_branch_result = None
271
216
 
272
217
    def create_workingtree(self, revision_id=None, from_branch=None):
291
236
    def _get_branch_reference(self):
292
237
        path = self._path_for_remote_call(self._client)
293
238
        medium = self._client._medium
294
 
        candidate_calls = [
295
 
            ('BzrDir.open_branchV3', (2, 1)),
296
 
            ('BzrDir.open_branchV2', (1, 13)),
297
 
            ('BzrDir.open_branch', None),
298
 
            ]
299
 
        for verb, required_version in candidate_calls:
300
 
            if required_version and medium._is_remote_before(required_version):
301
 
                continue
 
239
        if not medium._is_remote_before((1, 13)):
302
240
            try:
303
 
                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
304
245
            except errors.UnknownSmartMethod:
305
 
                if required_version is None:
306
 
                    raise
307
 
                medium._remember_remote_is_before(required_version)
308
 
            else:
309
 
                break
310
 
        if verb == 'BzrDir.open_branch':
311
 
            if response[0] != 'ok':
312
 
                raise errors.UnexpectedSmartServerResponse(response)
313
 
            if response[1] != '':
314
 
                return ('ref', response[1])
315
 
            else:
316
 
                return ('branch', '')
317
 
        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':
318
249
            raise errors.UnexpectedSmartServerResponse(response)
319
 
        return response
 
250
        if response[1] != '':
 
251
            return ('ref', response[1])
 
252
        else:
 
253
            return ('branch', '')
320
254
 
321
255
    def _get_tree_branch(self):
322
256
        """See BzrDir._get_tree_branch()."""
323
257
        return None, self.open_branch()
324
258
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
 
259
    def open_branch(self, _unsupported=False):
 
260
        if _unsupported:
328
261
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
262
        if self._next_open_branch_result is not None:
330
263
            # See create_branch for details.
335
268
        if response[0] == 'ref':
336
269
            # a branch reference, use the existing BranchReference logic.
337
270
            format = BranchReferenceFormat()
338
 
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
271
            return format.open(self, _found=True, location=response[1])
340
272
        branch_format_name = response[1]
341
273
        if not branch_format_name:
342
274
            branch_format_name = None
343
275
        format = RemoteBranchFormat(network_name=branch_format_name)
344
 
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
276
        return RemoteBranch(self, self.find_repository(), format=format)
346
277
 
347
278
    def _open_repo_v1(self, path):
348
279
        verb = 'BzrDir.find_repository'
409
340
        else:
410
341
            raise errors.NoRepositoryPresent(self)
411
342
 
412
 
    def has_workingtree(self):
413
 
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
416
 
        return self._has_working_tree
417
 
 
418
343
    def open_workingtree(self, recommend_upgrade=True):
419
 
        if self.has_workingtree():
 
344
        self._ensure_real()
 
345
        if self._real_bzrdir.has_workingtree():
420
346
            raise errors.NotLocalUrl(self.root_transport)
421
347
        else:
422
348
            raise errors.NoWorkingTree(self.root_transport.base)
425
351
        """Return the path to be used for this bzrdir in a remote call."""
426
352
        return client.remote_path_from_transport(self.root_transport)
427
353
 
428
 
    def get_branch_transport(self, branch_format, name=None):
 
354
    def get_branch_transport(self, branch_format):
429
355
        self._ensure_real()
430
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
356
        return self._real_bzrdir.get_branch_transport(branch_format)
431
357
 
432
358
    def get_repository_transport(self, repository_format):
433
359
        self._ensure_real()
454
380
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
381
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
382
 
457
 
    def _get_config(self):
458
 
        return RemoteBzrDirConfig(self)
 
383
    def get_config(self):
 
384
        self._ensure_real()
 
385
        return self._real_bzrdir.get_config()
459
386
 
460
387
 
461
388
class RemoteRepositoryFormat(repository.RepositoryFormat):
485
412
        self._custom_format = None
486
413
        self._network_name = None
487
414
        self._creating_bzrdir = None
488
 
        self._supports_chks = None
489
 
        self._supports_external_lookups = None
490
 
        self._supports_tree_reference = None
491
 
        self._rich_root_data = None
492
 
 
493
 
    def __repr__(self):
494
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
495
 
            self._network_name)
496
 
 
497
 
    @property
498
 
    def fast_deltas(self):
499
 
        self._ensure_real()
500
 
        return self._custom_format.fast_deltas
501
 
 
502
 
    @property
503
 
    def rich_root_data(self):
504
 
        if self._rich_root_data is None:
505
 
            self._ensure_real()
506
 
            self._rich_root_data = self._custom_format.rich_root_data
507
 
        return self._rich_root_data
508
 
 
509
 
    @property
510
 
    def supports_chks(self):
511
 
        if self._supports_chks is None:
512
 
            self._ensure_real()
513
 
            self._supports_chks = self._custom_format.supports_chks
514
 
        return self._supports_chks
515
 
 
516
 
    @property
517
 
    def supports_external_lookups(self):
518
 
        if self._supports_external_lookups is None:
519
 
            self._ensure_real()
520
 
            self._supports_external_lookups = \
521
 
                self._custom_format.supports_external_lookups
522
 
        return self._supports_external_lookups
523
 
 
524
 
    @property
525
 
    def supports_tree_reference(self):
526
 
        if self._supports_tree_reference is None:
527
 
            self._ensure_real()
528
 
            self._supports_tree_reference = \
529
 
                self._custom_format.supports_tree_reference
530
 
        return self._supports_tree_reference
531
415
 
532
416
    def _vfs_initialize(self, a_bzrdir, shared):
533
417
        """Helper for common code in initialize."""
565
449
        # 1) get the network name to use.
566
450
        if self._custom_format:
567
451
            network_name = self._custom_format.network_name()
568
 
        elif self._network_name:
569
 
            network_name = self._network_name
570
452
        else:
571
453
            # Select the current bzrlib default and ask for that.
572
454
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
620
502
        return self._custom_format._fetch_reconcile
621
503
 
622
504
    def get_format_description(self):
623
 
        self._ensure_real()
624
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
505
        return 'bzr remote repository'
625
506
 
626
507
    def __eq__(self, other):
627
508
        return self.__class__ is other.__class__
628
509
 
 
510
    def check_conversion_target(self, target_format):
 
511
        if self.rich_root_data and not target_format.rich_root_data:
 
512
            raise errors.BadConversionTarget(
 
513
                'Does not support rich root data.', target_format)
 
514
        if (self.supports_tree_reference and
 
515
            not getattr(target_format, 'supports_tree_reference', False)):
 
516
            raise errors.BadConversionTarget(
 
517
                'Does not support nested trees', target_format)
 
518
 
629
519
    def network_name(self):
630
520
        if self._network_name:
631
521
            return self._network_name
633
523
        return self._creating_repo._real_repository._format.network_name()
634
524
 
635
525
    @property
636
 
    def pack_compresses(self):
637
 
        self._ensure_real()
638
 
        return self._custom_format.pack_compresses
639
 
 
640
 
    @property
641
526
    def _serializer(self):
642
527
        self._ensure_real()
643
528
        return self._custom_format._serializer
644
529
 
645
530
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
531
class RemoteRepository(_RpcHelper):
648
532
    """Repository accessed over rpc.
649
533
 
650
534
    For the moment most operations are performed using local transport-backed
676
560
        self._lock_token = None
677
561
        self._lock_count = 0
678
562
        self._leave_lock = False
679
 
        # Cache of revision parents; misses are cached during read locks, and
680
 
        # write locks when no _real_repository has been set.
681
563
        self._unstacked_provider = graph.CachingParentsProvider(
682
564
            get_parent_map=self._get_parent_map_rpc)
683
565
        self._unstacked_provider.disable_cache()
693
575
        # Additional places to query for data.
694
576
        self._fallback_repositories = []
695
577
 
696
 
    @property
697
 
    def user_transport(self):
698
 
        return self.bzrdir.user_transport
699
 
 
700
 
    @property
701
 
    def control_transport(self):
702
 
        # XXX: Normally you shouldn't directly get at the remote repository
703
 
        # transport, but I'm not sure it's worth making this method
704
 
        # optional -- mbp 2010-04-21
705
 
        return self.bzrdir.get_repository_transport(None)
706
 
        
707
578
    def __str__(self):
708
579
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
580
 
712
583
    def abort_write_group(self, suppress_errors=False):
713
584
        """Complete a write group on the decorated repository.
714
585
 
715
 
        Smart methods perform operations in a single step so this API
 
586
        Smart methods peform operations in a single step so this api
716
587
        is not really applicable except as a compatibility thunk
717
588
        for older plugins that don't use e.g. the CommitBuilder
718
589
        facility.
723
594
        return self._real_repository.abort_write_group(
724
595
            suppress_errors=suppress_errors)
725
596
 
726
 
    @property
727
 
    def chk_bytes(self):
728
 
        """Decorate the real repository for now.
729
 
 
730
 
        In the long term a full blown network facility is needed to avoid
731
 
        creating a real repository object locally.
732
 
        """
733
 
        self._ensure_real()
734
 
        return self._real_repository.chk_bytes
735
 
 
736
597
    def commit_write_group(self):
737
598
        """Complete a write group on the decorated repository.
738
599
 
739
 
        Smart methods perform operations in a single step so this API
 
600
        Smart methods peform operations in a single step so this api
740
601
        is not really applicable except as a compatibility thunk
741
602
        for older plugins that don't use e.g. the CommitBuilder
742
603
        facility.
752
613
        self._ensure_real()
753
614
        return self._real_repository.suspend_write_group()
754
615
 
755
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
 
        self._ensure_real()
757
 
        return self._real_repository.get_missing_parent_inventories(
758
 
            check_for_missing_texts=check_for_missing_texts)
759
 
 
760
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
761
 
        self._ensure_real()
762
 
        return self._real_repository.get_rev_id_for_revno(
763
 
            revno, known_pair)
764
 
 
765
 
    def get_rev_id_for_revno(self, revno, known_pair):
766
 
        """See Repository.get_rev_id_for_revno."""
767
 
        path = self.bzrdir._path_for_remote_call(self._client)
768
 
        try:
769
 
            if self._client._medium._is_remote_before((1, 17)):
770
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
771
 
            response = self._call(
772
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
773
 
        except errors.UnknownSmartMethod:
774
 
            self._client._medium._remember_remote_is_before((1, 17))
775
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
776
 
        if response[0] == 'ok':
777
 
            return True, response[1]
778
 
        elif response[0] == 'history-incomplete':
779
 
            known_pair = response[1:3]
780
 
            for fallback in self._fallback_repositories:
781
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
782
 
                if found:
783
 
                    return True, result
784
 
                else:
785
 
                    known_pair = result
786
 
            # Not found in any fallbacks
787
 
            return False, known_pair
788
 
        else:
789
 
            raise errors.UnexpectedSmartServerResponse(response)
790
 
 
791
616
    def _ensure_real(self):
792
617
        """Ensure that there is a _real_repository set.
793
618
 
794
619
        Used before calls to self._real_repository.
795
 
 
796
 
        Note that _ensure_real causes many roundtrips to the server which are
797
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
798
 
        perform complex operations (such as accessing parent data, streaming
799
 
        revisions etc). Adding calls to _ensure_real should only be done when
800
 
        bringing up new functionality, adding fallbacks for smart methods that
801
 
        require a fallback path, and never to replace an existing smart method
802
 
        invocation. If in doubt chat to the bzr network team.
803
620
        """
804
621
        if self._real_repository is None:
805
 
            if 'hpssvfs' in debug.debug_flags:
806
 
                import traceback
807
 
                warning('VFS Repository access triggered\n%s',
808
 
                    ''.join(traceback.format_stack()))
809
 
            self._unstacked_provider.missing_keys.clear()
810
622
            self.bzrdir._ensure_real()
811
623
            self._set_real_repository(
812
624
                self.bzrdir._real_bzrdir.open_repository())
839
651
        self._ensure_real()
840
652
        return self._real_repository._generate_text_key_index()
841
653
 
 
654
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
655
    def get_revision_graph(self, revision_id=None):
 
656
        """See Repository.get_revision_graph()."""
 
657
        return self._get_revision_graph(revision_id)
 
658
 
842
659
    def _get_revision_graph(self, revision_id):
843
660
        """Private method for using with old (< 1.2) servers to fallback."""
844
661
        if revision_id is None:
872
689
        """Return a source for streaming from this repository."""
873
690
        return RemoteStreamSource(self, to_format)
874
691
 
875
 
    @needs_read_lock
876
692
    def has_revision(self, revision_id):
877
 
        """True if this repository has a copy of the revision."""
878
 
        # Copy of bzrlib.repository.Repository.has_revision
879
 
        return revision_id in self.has_revisions((revision_id,))
 
693
        """See Repository.has_revision()."""
 
694
        if revision_id == NULL_REVISION:
 
695
            # The null revision is always present.
 
696
            return True
 
697
        path = self.bzrdir._path_for_remote_call(self._client)
 
698
        response = self._call('Repository.has_revision', path, revision_id)
 
699
        if response[0] not in ('yes', 'no'):
 
700
            raise errors.UnexpectedSmartServerResponse(response)
 
701
        if response[0] == 'yes':
 
702
            return True
 
703
        for fallback_repo in self._fallback_repositories:
 
704
            if fallback_repo.has_revision(revision_id):
 
705
                return True
 
706
        return False
880
707
 
881
 
    @needs_read_lock
882
708
    def has_revisions(self, revision_ids):
883
 
        """Probe to find out the presence of multiple revisions.
884
 
 
885
 
        :param revision_ids: An iterable of revision_ids.
886
 
        :return: A set of the revision_ids that were present.
887
 
        """
888
 
        # Copy of bzrlib.repository.Repository.has_revisions
889
 
        parent_map = self.get_parent_map(revision_ids)
890
 
        result = set(parent_map)
891
 
        if _mod_revision.NULL_REVISION in revision_ids:
892
 
            result.add(_mod_revision.NULL_REVISION)
 
709
        """See Repository.has_revisions()."""
 
710
        # FIXME: This does many roundtrips, particularly when there are
 
711
        # fallback repositories.  -- mbp 20080905
 
712
        result = set()
 
713
        for revision_id in revision_ids:
 
714
            if self.has_revision(revision_id):
 
715
                result.add(revision_id)
893
716
        return result
894
717
 
895
 
    def _has_same_fallbacks(self, other_repo):
896
 
        """Returns true if the repositories have the same fallbacks."""
897
 
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
899
 
        my_fb = self._fallback_repositories
900
 
        other_fb = other_repo._fallback_repositories
901
 
        if len(my_fb) != len(other_fb):
902
 
            return False
903
 
        for f, g in zip(my_fb, other_fb):
904
 
            if not f.has_same_location(g):
905
 
                return False
906
 
        return True
907
 
 
908
718
    def has_same_location(self, other):
909
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
910
 
        # one; unfortunately the tests rely on slightly different behaviour at
911
 
        # present -- mbp 20090710
912
719
        return (self.__class__ is other.__class__ and
913
720
                self.bzrdir.transport.base == other.bzrdir.transport.base)
914
721
 
917
724
        parents_provider = self._make_parents_provider(other_repository)
918
725
        return graph.Graph(parents_provider)
919
726
 
920
 
    @needs_read_lock
921
 
    def get_known_graph_ancestry(self, revision_ids):
922
 
        """Return the known graph for a set of revision ids and their ancestors.
923
 
        """
924
 
        st = static_tuple.StaticTuple
925
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
926
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
927
 
        return graph.GraphThunkIdsToKeys(known_graph)
928
 
 
929
727
    def gather_stats(self, revid=None, committers=None):
930
728
        """See Repository.gather_stats()."""
931
729
        path = self.bzrdir._path_for_remote_call(self._client)
991
789
    def is_write_locked(self):
992
790
        return self._lock_mode == 'w'
993
791
 
994
 
    def _warn_if_deprecated(self, branch=None):
995
 
        # If we have a real repository, the check will be done there, if we
996
 
        # don't the check will be done remotely.
997
 
        pass
998
 
 
999
792
    def lock_read(self):
1000
793
        # wrong eventually - want a local lock cache context
1001
794
        if not self._lock_mode:
1002
 
            self._note_lock('r')
1003
795
            self._lock_mode = 'r'
1004
796
            self._lock_count = 1
1005
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
797
            self._unstacked_provider.enable_cache(cache_misses=False)
1006
798
            if self._real_repository is not None:
1007
799
                self._real_repository.lock_read()
1008
 
            for repo in self._fallback_repositories:
1009
 
                repo.lock_read()
1010
800
        else:
1011
801
            self._lock_count += 1
1012
802
 
1025
815
 
1026
816
    def lock_write(self, token=None, _skip_rpc=False):
1027
817
        if not self._lock_mode:
1028
 
            self._note_lock('w')
1029
818
            if _skip_rpc:
1030
819
                if self._lock_token is not None:
1031
820
                    if token != self._lock_token:
1045
834
                self._leave_lock = False
1046
835
            self._lock_mode = 'w'
1047
836
            self._lock_count = 1
1048
 
            cache_misses = self._real_repository is None
1049
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1050
 
            for repo in self._fallback_repositories:
1051
 
                # Writes don't affect fallback repos
1052
 
                repo.lock_read()
 
837
            self._unstacked_provider.enable_cache(cache_misses=False)
1053
838
        elif self._lock_mode == 'r':
1054
839
            raise errors.ReadOnlyError(self)
1055
840
        else:
1081
866
        if isinstance(repository, RemoteRepository):
1082
867
            raise AssertionError()
1083
868
        self._real_repository = repository
1084
 
        # three code paths happen here:
1085
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1086
 
        # up stacking. In this case self._fallback_repositories is [], and the
1087
 
        # real repo is already setup. Preserve the real repo and
1088
 
        # RemoteRepository.add_fallback_repository will avoid adding
1089
 
        # duplicates.
1090
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1091
 
        # ensure_real is triggered from a branch, the real repository to
1092
 
        # set already has a matching list with separate instances, but
1093
 
        # as they are also RemoteRepositories we don't worry about making the
1094
 
        # lists be identical.
1095
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1096
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1097
 
        # and need to populate it.
1098
 
        if (self._fallback_repositories and
1099
 
            len(self._real_repository._fallback_repositories) !=
1100
 
            len(self._fallback_repositories)):
1101
 
            if len(self._real_repository._fallback_repositories):
1102
 
                raise AssertionError(
1103
 
                    "cannot cleanly remove existing _fallback_repositories")
 
869
        # If the _real_repository has _fallback_repositories, clear them out,
 
870
        # because we want it to have the same set as this repository.  This is
 
871
        # reasonable to do because the fallbacks we clear here are from a
 
872
        # "real" branch, and we're about to replace them with the equivalents
 
873
        # from a RemoteBranch.
 
874
        self._real_repository._fallback_repositories = []
1104
875
        for fb in self._fallback_repositories:
1105
876
            self._real_repository.add_fallback_repository(fb)
1106
877
        if self._lock_mode == 'w':
1113
884
    def start_write_group(self):
1114
885
        """Start a write group on the decorated repository.
1115
886
 
1116
 
        Smart methods perform operations in a single step so this API
 
887
        Smart methods peform operations in a single step so this api
1117
888
        is not really applicable except as a compatibility thunk
1118
889
        for older plugins that don't use e.g. the CommitBuilder
1119
890
        facility.
1134
905
        else:
1135
906
            raise errors.UnexpectedSmartServerResponse(response)
1136
907
 
1137
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1138
908
    def unlock(self):
1139
909
        if not self._lock_count:
1140
 
            return lock.cant_unlock_not_held(self)
 
910
            raise errors.LockNotHeld(self)
1141
911
        self._lock_count -= 1
1142
912
        if self._lock_count > 0:
1143
913
            return
1157
927
            # problem releasing the vfs-based lock.
1158
928
            if old_mode == 'w':
1159
929
                # Only write-locked repositories need to make a remote method
1160
 
                # call to perform the unlock.
 
930
                # call to perfom the unlock.
1161
931
                old_token = self._lock_token
1162
932
                self._lock_token = None
1163
933
                if not self._leave_lock:
1164
934
                    self._unlock(old_token)
1165
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1166
 
        # self._leave_lock
1167
 
        for repo in self._fallback_repositories:
1168
 
            repo.unlock()
1169
935
 
1170
936
    def break_lock(self):
1171
937
        # should hand off to the network
1229
995
 
1230
996
        :param repository: A repository.
1231
997
        """
1232
 
        if not self._format.supports_external_lookups:
1233
 
            raise errors.UnstackableRepositoryFormat(
1234
 
                self._format.network_name(), self.base)
 
998
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
999
        # unconditionally - however, a _real_repository will usually exist,
 
1000
        # and may raise an error if it's not accommodated by the underlying
 
1001
        # format.  Eventually we should check when opening the repository
 
1002
        # whether it's willing to allow them or not.
 
1003
        #
1235
1004
        # We need to accumulate additional repositories here, to pass them in
1236
1005
        # on various RPC's.
1237
1006
        #
1238
 
        if self.is_locked():
1239
 
            # We will call fallback.unlock() when we transition to the unlocked
1240
 
            # state, so always add a lock here. If a caller passes us a locked
1241
 
            # repository, they are responsible for unlocking it later.
1242
 
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1007
        self._fallback_repositories.append(repository)
1245
1008
        # If self._real_repository was parameterised already (e.g. because a
1246
1009
        # _real_branch had its get_stacked_on_url method called), then the
1247
1010
        # repository to be added may already be in the _real_repositories list.
1248
1011
        if self._real_repository is not None:
1249
 
            fallback_locations = [repo.user_url for repo in
1250
 
                self._real_repository._fallback_repositories]
1251
 
            if repository.user_url not in fallback_locations:
 
1012
            if repository not in self._real_repository._fallback_repositories:
1252
1013
                self._real_repository.add_fallback_repository(repository)
1253
 
 
1254
 
    def _check_fallback_repository(self, repository):
1255
 
        """Check that this repository can fallback to repository safely.
1256
 
 
1257
 
        Raise an error if not.
1258
 
 
1259
 
        :param repository: A repository to fallback to.
1260
 
        """
1261
 
        return _mod_repository.InterRepository._assert_same_model(
1262
 
            self, repository)
 
1014
        else:
 
1015
            # They are also seen by the fallback repository.  If it doesn't
 
1016
            # exist yet they'll be added then.  This implicitly copies them.
 
1017
            self._ensure_real()
1263
1018
 
1264
1019
    def add_inventory(self, revid, inv, parents):
1265
1020
        self._ensure_real()
1266
1021
        return self._real_repository.add_inventory(revid, inv, parents)
1267
1022
 
1268
1023
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1269
 
            parents, basis_inv=None, propagate_caches=False):
 
1024
                               parents):
1270
1025
        self._ensure_real()
1271
1026
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1272
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
 
            propagate_caches=propagate_caches)
 
1027
            delta, new_revision_id, parents)
1274
1028
 
1275
1029
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
1030
        self._ensure_real()
1282
1036
        self._ensure_real()
1283
1037
        return self._real_repository.get_inventory(revision_id)
1284
1038
 
1285
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1039
    def iter_inventories(self, revision_ids):
1286
1040
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1041
        return self._real_repository.iter_inventories(revision_ids)
1288
1042
 
1289
1043
    @needs_read_lock
1290
1044
    def get_revision(self, revision_id):
1305
1059
        self._ensure_real()
1306
1060
        return self._real_repository.make_working_trees()
1307
1061
 
1308
 
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
1310
 
 
1311
 
        This method is intended to be called after another repository instance
1312
 
        (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.
1315
 
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
 
        if self._real_repository is not None:
1320
 
            self._real_repository.refresh_data()
1321
 
 
1322
1062
    def revision_ids_to_search_result(self, result_set):
1323
1063
        """Convert a set of revision ids to a graph SearchResult."""
1324
1064
        result_parents = set()
1345
1085
 
1346
1086
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1347
1087
            fetch_spec=None):
1348
 
        # No base implementation to use as RemoteRepository is not a subclass
1349
 
        # of Repository; so this is a copy of Repository.fetch().
1350
1088
        if fetch_spec is not None and revision_id is not None:
1351
1089
            raise AssertionError(
1352
1090
                "fetch_spec and revision_id are mutually exclusive.")
1353
 
        if self.is_in_write_group():
1354
 
            raise errors.InternalBzrError(
1355
 
                "May not fetch while in a write group.")
1356
 
        # fast path same-url fetch operations
1357
 
        if (self.has_same_location(source)
1358
 
            and fetch_spec is None
1359
 
            and self._has_same_fallbacks(source)):
 
1091
        # Not delegated to _real_repository so that InterRepository.get has a
 
1092
        # chance to find an InterRepository specialised for RemoteRepository.
 
1093
        if self.has_same_location(source) and fetch_spec is None:
1360
1094
            # check that last_revision is in 'from' and then return a
1361
1095
            # no-operation.
1362
1096
            if (revision_id is not None and
1363
1097
                not revision.is_null(revision_id)):
1364
1098
                self.get_revision(revision_id)
1365
1099
            return 0, []
1366
 
        # if there is no specific appropriate InterRepository, this will get
1367
 
        # the InterRepository base class, which raises an
1368
 
        # IncompatibleRepositories when asked to fetch.
1369
1100
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1371
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1101
        try:
 
1102
            return inter.fetch(revision_id=revision_id, pb=pb,
 
1103
                    find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1104
        except NotImplementedError:
 
1105
            raise errors.IncompatibleRepositories(source, self)
1372
1106
 
1373
1107
    def create_bundle(self, target, base, fileobj, format=None):
1374
1108
        self._ensure_real()
1405
1139
            # We already found out that the server can't understand
1406
1140
            # Repository.get_parent_map requests, so just fetch the whole
1407
1141
            # graph.
1408
 
            #
1409
 
            # Note that this reads the whole graph, when only some keys are
1410
 
            # wanted.  On this old server there's no way (?) to get them all
1411
 
            # in one go, and the user probably will have seen a warning about
1412
 
            # the server being old anyhow.
1413
 
            rg = self._get_revision_graph(None)
1414
 
            # There is an API discrepancy between get_parent_map and
 
1142
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1143
            # :- its because we're working with a deprecated server anyway, and
 
1144
            # the user will almost certainly have seen a warning about the
 
1145
            # server version already.
 
1146
            rg = self.get_revision_graph()
 
1147
            # There is an api discrepency between get_parent_map and
1415
1148
            # get_revision_graph. Specifically, a "key:()" pair in
1416
1149
            # get_revision_graph just means a node has no parents. For
1417
1150
            # "get_parent_map" it means the node is a ghost. So fix up the
1447
1180
        # TODO: Manage this incrementally to avoid covering the same path
1448
1181
        # repeatedly. (The server will have to on each request, but the less
1449
1182
        # work done the better).
1450
 
        #
1451
 
        # Negative caching notes:
1452
 
        # new server sends missing when a request including the revid
1453
 
        # 'include-missing:' is present in the request.
1454
 
        # missing keys are serialised as missing:X, and we then call
1455
 
        # provider.note_missing(X) for-all X
1456
1183
        parents_map = self._unstacked_provider.get_cached_map()
1457
1184
        if parents_map is None:
1458
1185
            # Repository is not locked, so there's no cache.
1459
1186
            parents_map = {}
1460
 
        # start_set is all the keys in the cache
1461
1187
        start_set = set(parents_map)
1462
 
        # result set is all the references to keys in the cache
1463
1188
        result_parents = set()
1464
1189
        for parents in parents_map.itervalues():
1465
1190
            result_parents.update(parents)
1466
1191
        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
1192
        included_keys = start_set.intersection(result_parents)
1479
1193
        start_set.difference_update(included_keys)
1480
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1194
        recipe = (start_set, stop_keys, len(parents_map))
1481
1195
        body = self._serialise_search_recipe(recipe)
1482
1196
        path = self.bzrdir._path_for_remote_call(self._client)
1483
1197
        for key in keys:
1485
1199
                raise ValueError(
1486
1200
                    "key %r not a plain string" % (key,))
1487
1201
        verb = 'Repository.get_parent_map'
1488
 
        args = (path, 'include-missing:') + tuple(keys)
 
1202
        args = (path,) + tuple(keys)
1489
1203
        try:
1490
1204
            response = self._call_with_body_bytes_expecting_body(
1491
1205
                verb, args, body)
1501
1215
            # To avoid having to disconnect repeatedly, we keep track of the
1502
1216
            # fact the server doesn't understand remote methods added in 1.2.
1503
1217
            medium._remember_remote_is_before((1, 2))
1504
 
            # Recurse just once and we should use the fallback code.
1505
 
            return self._get_parent_map_rpc(keys)
 
1218
            return self.get_revision_graph(None)
1506
1219
        response_tuple, response_handler = response
1507
1220
        if response_tuple[0] not in ['ok']:
1508
1221
            response_handler.cancel_read_body()
1519
1232
                if len(d) > 1:
1520
1233
                    revision_graph[d[0]] = d[1:]
1521
1234
                else:
1522
 
                    # No parents:
1523
 
                    if d[0].startswith('missing:'):
1524
 
                        revid = d[0][8:]
1525
 
                        self._unstacked_provider.note_missing_key(revid)
1526
 
                    else:
1527
 
                        # no parents - so give the Graph result
1528
 
                        # (NULL_REVISION,).
1529
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
1235
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1236
                    revision_graph[d[0]] = (NULL_REVISION,)
1530
1237
            return revision_graph
1531
1238
 
1532
1239
    @needs_read_lock
1535
1242
        return self._real_repository.get_signature_text(revision_id)
1536
1243
 
1537
1244
    @needs_read_lock
1538
 
    def _get_inventory_xml(self, revision_id):
1539
 
        self._ensure_real()
1540
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1245
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1246
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1247
        self._ensure_real()
 
1248
        return self._real_repository.get_revision_graph_with_ghosts(
 
1249
            revision_ids=revision_ids)
 
1250
 
 
1251
    @needs_read_lock
 
1252
    def get_inventory_xml(self, revision_id):
 
1253
        self._ensure_real()
 
1254
        return self._real_repository.get_inventory_xml(revision_id)
 
1255
 
 
1256
    def deserialise_inventory(self, revision_id, xml):
 
1257
        self._ensure_real()
 
1258
        return self._real_repository.deserialise_inventory(revision_id, xml)
1541
1259
 
1542
1260
    def reconcile(self, other=None, thorough=False):
1543
1261
        self._ensure_real()
1548
1266
        return self._real_repository.all_revision_ids()
1549
1267
 
1550
1268
    @needs_read_lock
1551
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1269
    def get_deltas_for_revisions(self, revisions):
1552
1270
        self._ensure_real()
1553
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1554
 
            specific_fileids=specific_fileids)
 
1271
        return self._real_repository.get_deltas_for_revisions(revisions)
1555
1272
 
1556
1273
    @needs_read_lock
1557
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1274
    def get_revision_delta(self, revision_id):
1558
1275
        self._ensure_real()
1559
 
        return self._real_repository.get_revision_delta(revision_id,
1560
 
            specific_fileids=specific_fileids)
 
1276
        return self._real_repository.get_revision_delta(revision_id)
1561
1277
 
1562
1278
    @needs_read_lock
1563
1279
    def revision_trees(self, revision_ids):
1570
1286
        return self._real_repository.get_revision_reconcile(revision_id)
1571
1287
 
1572
1288
    @needs_read_lock
1573
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1289
    def check(self, revision_ids=None):
1574
1290
        self._ensure_real()
1575
 
        return self._real_repository.check(revision_ids=revision_ids,
1576
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1291
        return self._real_repository.check(revision_ids=revision_ids)
1577
1292
 
1578
1293
    def copy_content_into(self, destination, revision_id=None):
1579
1294
        self._ensure_real()
1619
1334
        return self._real_repository.inventories
1620
1335
 
1621
1336
    @needs_write_lock
1622
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1337
    def pack(self):
1623
1338
        """Compress the data within the repository.
1624
1339
 
1625
1340
        This is not currently implemented within the smart server.
1626
1341
        """
1627
1342
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1343
        return self._real_repository.pack()
1629
1344
 
1630
1345
    @property
1631
1346
    def revisions(self):
1719
1434
        self._ensure_real()
1720
1435
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
1436
 
1722
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1437
    def _find_inconsistent_revision_parents(self):
1723
1438
        self._ensure_real()
1724
 
        return self._real_repository._find_inconsistent_revision_parents(
1725
 
            revisions_iterator)
 
1439
        return self._real_repository._find_inconsistent_revision_parents()
1726
1440
 
1727
1441
    def _check_for_inconsistent_revision_parents(self):
1728
1442
        self._ensure_real()
1734
1448
            providers.insert(0, other)
1735
1449
        providers.extend(r._make_parents_provider() for r in
1736
1450
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
1451
        return graph._StackedParentsProvider(providers)
1738
1452
 
1739
1453
    def _serialise_search_recipe(self, recipe):
1740
1454
        """Serialise a graph search recipe.
1742
1456
        :param recipe: A search recipe (start, stop, count).
1743
1457
        :return: Serialised bytes.
1744
1458
        """
1745
 
        start_keys = ' '.join(recipe[1])
1746
 
        stop_keys = ' '.join(recipe[2])
1747
 
        count = str(recipe[3])
 
1459
        start_keys = ' '.join(recipe[0])
 
1460
        stop_keys = ' '.join(recipe[1])
 
1461
        count = str(recipe[2])
1748
1462
        return '\n'.join((start_keys, stop_keys, count))
1749
1463
 
1750
1464
    def _serialise_search_result(self, search_result):
1753
1467
            parts.extend(search_result.heads)
1754
1468
        else:
1755
1469
            recipe = search_result.get_recipe()
1756
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
1470
            parts = ['search', self._serialise_search_recipe(recipe)]
1757
1471
        return '\n'.join(parts)
1758
1472
 
1759
1473
    def autopack(self):
1764
1478
            self._ensure_real()
1765
1479
            self._real_repository._pack_collection.autopack()
1766
1480
            return
1767
 
        self.refresh_data()
 
1481
        if self._real_repository is not None:
 
1482
            # Reset the real repository's cache of pack names.
 
1483
            # XXX: At some point we may be able to skip this and just rely on
 
1484
            # the automatic retry logic to do the right thing, but for now we
 
1485
            # err on the side of being correct rather than being optimal.
 
1486
            self._real_repository._pack_collection.reload_pack_names()
1768
1487
        if response[0] != 'ok':
1769
1488
            raise errors.UnexpectedSmartServerResponse(response)
1770
1489
 
1780
1499
        return result
1781
1500
 
1782
1501
    def insert_stream(self, stream, src_format, resume_tokens):
1783
 
        target = self.target_repo
1784
 
        target._unstacked_provider.missing_keys.clear()
1785
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1786
 
        if target._lock_token:
1787
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1788
 
            lock_args = (target._lock_token or '',)
1789
 
        else:
1790
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1791
 
            lock_args = ()
1792
 
        client = target._client
 
1502
        repo = self.target_repo
 
1503
        client = repo._client
1793
1504
        medium = client._medium
1794
 
        path = target.bzrdir._path_for_remote_call(client)
1795
 
        # Probe for the verb to use with an empty stream before sending the
1796
 
        # real stream to it.  We do this both to avoid the risk of sending a
1797
 
        # large request that is then rejected, and because we don't want to
1798
 
        # implement a way to buffer, rewind, or restart the stream.
1799
 
        found_verb = False
1800
 
        for verb, required_version in candidate_calls:
1801
 
            if medium._is_remote_before(required_version):
1802
 
                continue
1803
 
            if resume_tokens:
1804
 
                # We've already done the probing (and set _is_remote_before) on
1805
 
                # a previous insert.
1806
 
                found_verb = True
1807
 
                break
 
1505
        if medium._is_remote_before((1, 13)):
 
1506
            # No possible way this can work.
 
1507
            return self._insert_real(stream, src_format, resume_tokens)
 
1508
        path = repo.bzrdir._path_for_remote_call(client)
 
1509
        if not resume_tokens:
 
1510
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1511
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1512
            # fallback to the _real_repositories sink *with a partial stream*.
 
1513
            # Thats bad because we insert less data than bzr expected. To avoid
 
1514
            # this we do a trial push to make sure the verb is accessible, and
 
1515
            # do not fallback when actually pushing the stream. A cleanup patch
 
1516
            # is going to look at rewinding/restarting the stream/partial
 
1517
            # buffering etc.
1808
1518
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1809
1519
            try:
1810
1520
                response = client.call_with_body_stream(
1811
 
                    (verb, path, '') + lock_args, byte_stream)
 
1521
                    ('Repository.insert_stream', path, ''), byte_stream)
1812
1522
            except errors.UnknownSmartMethod:
1813
 
                medium._remember_remote_is_before(required_version)
1814
 
            else:
1815
 
                found_verb = True
1816
 
                break
1817
 
        if not found_verb:
1818
 
            # Have to use VFS.
1819
 
            return self._insert_real(stream, src_format, resume_tokens)
1820
 
        self._last_inv_record = None
1821
 
        self._last_substream = None
1822
 
        if required_version < (1, 19):
1823
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1824
 
            # make sure we don't send any.  If the stream contains inventory
1825
 
            # deltas we'll interrupt the smart insert_stream request and
1826
 
            # fallback to VFS.
1827
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1523
                medium._remember_remote_is_before((1,13))
 
1524
                return self._insert_real(stream, src_format, resume_tokens)
1828
1525
        byte_stream = smart_repo._stream_to_byte_stream(
1829
1526
            stream, src_format)
1830
1527
        resume_tokens = ' '.join(resume_tokens)
1831
1528
        response = client.call_with_body_stream(
1832
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1529
            ('Repository.insert_stream', path, resume_tokens), byte_stream)
1833
1530
        if response[0][0] not in ('ok', 'missing-basis'):
1834
1531
            raise errors.UnexpectedSmartServerResponse(response)
1835
 
        if self._last_substream is not None:
1836
 
            # The stream included an inventory-delta record, but the remote
1837
 
            # side isn't new enough to support them.  So we need to send the
1838
 
            # rest of the stream via VFS.
1839
 
            self.target_repo.refresh_data()
1840
 
            return self._resume_stream_with_vfs(response, src_format)
1841
1532
        if response[0][0] == 'missing-basis':
1842
1533
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1843
1534
            resume_tokens = tokens
1844
 
            return resume_tokens, set(missing_keys)
 
1535
            return resume_tokens, missing_keys
1845
1536
        else:
1846
 
            self.target_repo.refresh_data()
 
1537
            if self.target_repo._real_repository is not None:
 
1538
                collection = getattr(self.target_repo._real_repository,
 
1539
                    '_pack_collection', None)
 
1540
                if collection is not None:
 
1541
                    collection.reload_pack_names()
1847
1542
            return [], set()
1848
1543
 
1849
 
    def _resume_stream_with_vfs(self, response, src_format):
1850
 
        """Resume sending a stream via VFS, first resending the record and
1851
 
        substream that couldn't be sent via an insert_stream verb.
1852
 
        """
1853
 
        if response[0][0] == 'missing-basis':
1854
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1855
 
            # Ignore missing_keys, we haven't finished inserting yet
1856
 
        else:
1857
 
            tokens = []
1858
 
        def resume_substream():
1859
 
            # Yield the substream that was interrupted.
1860
 
            for record in self._last_substream:
1861
 
                yield record
1862
 
            self._last_substream = None
1863
 
        def resume_stream():
1864
 
            # Finish sending the interrupted substream
1865
 
            yield ('inventory-deltas', resume_substream())
1866
 
            # Then simply continue sending the rest of the stream.
1867
 
            for substream_kind, substream in self._last_stream:
1868
 
                yield substream_kind, substream
1869
 
        return self._insert_real(resume_stream(), src_format, tokens)
1870
 
 
1871
 
    def _stop_stream_if_inventory_delta(self, stream):
1872
 
        """Normally this just lets the original stream pass-through unchanged.
1873
 
 
1874
 
        However if any 'inventory-deltas' substream occurs it will stop
1875
 
        streaming, and store the interrupted substream and stream in
1876
 
        self._last_substream and self._last_stream so that the stream can be
1877
 
        resumed by _resume_stream_with_vfs.
1878
 
        """
1879
 
                    
1880
 
        stream_iter = iter(stream)
1881
 
        for substream_kind, substream in stream_iter:
1882
 
            if substream_kind == 'inventory-deltas':
1883
 
                self._last_substream = substream
1884
 
                self._last_stream = stream_iter
1885
 
                return
1886
 
            else:
1887
 
                yield substream_kind, substream
1888
 
            
1889
1544
 
1890
1545
class RemoteStreamSource(repository.StreamSource):
1891
1546
    """Stream data from a remote server."""
1892
1547
 
1893
1548
    def get_stream(self, search):
1894
 
        if (self.from_repository._fallback_repositories and
1895
 
            self.to_format._fetch_order == 'topological'):
1896
 
            return self._real_stream(self.from_repository, search)
1897
 
        sources = []
1898
 
        seen = set()
1899
 
        repos = [self.from_repository]
1900
 
        while repos:
1901
 
            repo = repos.pop(0)
1902
 
            if repo in seen:
1903
 
                continue
1904
 
            seen.add(repo)
1905
 
            repos.extend(repo._fallback_repositories)
1906
 
            sources.append(repo)
1907
 
        return self.missing_parents_chain(search, sources)
1908
 
 
1909
 
    def get_stream_for_missing_keys(self, missing_keys):
1910
 
        self.from_repository._ensure_real()
1911
 
        real_repo = self.from_repository._real_repository
1912
 
        real_source = real_repo._get_source(self.to_format)
1913
 
        return real_source.get_stream_for_missing_keys(missing_keys)
1914
 
 
1915
 
    def _real_stream(self, repo, search):
1916
 
        """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 
1920
 
        reliably whether fallback back because of old servers or trying
1921
 
        to stream from a non-RemoteRepository (which the stacked support
1922
 
        code will do).
1923
 
        """
1924
 
        source = repo._get_source(self.to_format)
1925
 
        if isinstance(source, RemoteStreamSource):
1926
 
            repo._ensure_real()
1927
 
            source = repo._real_repository._get_source(self.to_format)
1928
 
        return source.get_stream(search)
1929
 
 
1930
 
    def _get_stream(self, repo, search):
1931
 
        """Core worker to get a stream from repo for search.
1932
 
 
1933
 
        This is used by both get_stream and the stacking support logic. It
1934
 
        deliberately gets a stream for repo which does not need to be
1935
 
        self.from_repository. In the event that repo is not Remote, or
1936
 
        cannot do a smart stream, a fallback is made to the generic
1937
 
        repository._get_stream() interface, via self._real_stream.
1938
 
 
1939
 
        In the event of stacking, streams from _get_stream will not
1940
 
        contain all the data for search - this is normal (see get_stream).
1941
 
 
1942
 
        :param repo: A repository.
1943
 
        :param search: A search.
1944
 
        """
1945
 
        # Fallbacks may be non-smart
1946
 
        if not isinstance(repo, RemoteRepository):
1947
 
            return self._real_stream(repo, search)
 
1549
        # streaming with fallback repositories is not well defined yet: The
 
1550
        # remote repository cannot see the fallback repositories, and thus
 
1551
        # cannot satisfy the entire search in the general case. Likewise the
 
1552
        # fallback repositories cannot reify the search to determine what they
 
1553
        # should send. It likely needs a return value in the stream listing the
 
1554
        # edge of the search to resume from in fallback repositories.
 
1555
        if self.from_repository._fallback_repositories:
 
1556
            return repository.StreamSource.get_stream(self, search)
 
1557
        repo = self.from_repository
1948
1558
        client = repo._client
1949
1559
        medium = client._medium
 
1560
        if medium._is_remote_before((1, 13)):
 
1561
            # No possible way this can work.
 
1562
            return repository.StreamSource.get_stream(self, search)
1950
1563
        path = repo.bzrdir._path_for_remote_call(client)
1951
 
        search_bytes = repo._serialise_search_result(search)
1952
 
        args = (path, self.to_format.network_name())
1953
 
        candidate_verbs = [
1954
 
            ('Repository.get_stream_1.19', (1, 19)),
1955
 
            ('Repository.get_stream', (1, 13))]
1956
 
        found_verb = False
1957
 
        for verb, version in candidate_verbs:
1958
 
            if medium._is_remote_before(version):
1959
 
                continue
1960
 
            try:
1961
 
                response = repo._call_with_body_bytes_expecting_body(
1962
 
                    verb, args, search_bytes)
1963
 
            except errors.UnknownSmartMethod:
1964
 
                medium._remember_remote_is_before(version)
1965
 
            else:
1966
 
                response_tuple, response_handler = response
1967
 
                found_verb = True
1968
 
                break
1969
 
        if not found_verb:
1970
 
            return self._real_stream(repo, search)
 
1564
        try:
 
1565
            search_bytes = repo._serialise_search_result(search)
 
1566
            response = repo._call_with_body_bytes_expecting_body(
 
1567
                'Repository.get_stream',
 
1568
                (path, self.to_format.network_name()), search_bytes)
 
1569
            response_tuple, response_handler = response
 
1570
        except errors.UnknownSmartMethod:
 
1571
            medium._remember_remote_is_before((1,13))
 
1572
            return repository.StreamSource.get_stream(self, search)
1971
1573
        if response_tuple[0] != 'ok':
1972
1574
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
1575
        byte_stream = response_handler.read_streamed_body()
1978
1580
                src_format.network_name(), repo._format.network_name()))
1979
1581
        return stream
1980
1582
 
1981
 
    def missing_parents_chain(self, search, sources):
1982
 
        """Chain multiple streams together to handle stacking.
1983
 
 
1984
 
        :param search: The overall search to satisfy with streams.
1985
 
        :param sources: A list of Repository objects to query.
1986
 
        """
1987
 
        self.from_serialiser = self.from_repository._format._serializer
1988
 
        self.seen_revs = set()
1989
 
        self.referenced_revs = set()
1990
 
        # If there are heads in the search, or the key count is > 0, we are not
1991
 
        # done.
1992
 
        while not search.is_empty() and len(sources) > 1:
1993
 
            source = sources.pop(0)
1994
 
            stream = self._get_stream(source, search)
1995
 
            for kind, substream in stream:
1996
 
                if kind != 'revisions':
1997
 
                    yield kind, substream
1998
 
                else:
1999
 
                    yield kind, self.missing_parents_rev_handler(substream)
2000
 
            search = search.refine(self.seen_revs, self.referenced_revs)
2001
 
            self.seen_revs = set()
2002
 
            self.referenced_revs = set()
2003
 
        if not search.is_empty():
2004
 
            for kind, stream in self._get_stream(sources[0], search):
2005
 
                yield kind, stream
2006
 
 
2007
 
    def missing_parents_rev_handler(self, substream):
2008
 
        for content in substream:
2009
 
            revision_bytes = content.get_bytes_as('fulltext')
2010
 
            revision = self.from_serialiser.read_revision_from_string(
2011
 
                revision_bytes)
2012
 
            self.seen_revs.add(content.key[-1])
2013
 
            self.referenced_revs.update(revision.parent_ids)
2014
 
            yield content
2015
 
 
2016
1583
 
2017
1584
class RemoteBranchLockableFiles(LockableFiles):
2018
1585
    """A 'LockableFiles' implementation that talks to a smart server.
2053
1620
                self._network_name)
2054
1621
 
2055
1622
    def get_format_description(self):
2056
 
        self._ensure_real()
2057
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1623
        return 'Remote BZR Branch'
2058
1624
 
2059
1625
    def network_name(self):
2060
1626
        return self._network_name
2061
1627
 
2062
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2063
 
        return a_bzrdir.open_branch(name=name, 
2064
 
            ignore_fallbacks=ignore_fallbacks)
 
1628
    def open(self, a_bzrdir):
 
1629
        return a_bzrdir.open_branch()
2065
1630
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1631
    def _vfs_initialize(self, a_bzrdir):
2067
1632
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
1633
        # method is not available on the server.
2069
1634
        # self._custom_format is always set - the start of initialize ensures
2070
1635
        # that.
2071
1636
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
1637
            a_bzrdir._ensure_real()
2073
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
1638
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2075
1639
        else:
2076
1640
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1641
            result = self._custom_format.initialize(a_bzrdir)
2078
1642
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
1643
            not isinstance(result, RemoteBranch)):
2080
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
 
                                  name=name)
 
1644
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2082
1645
        return result
2083
1646
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
1647
    def initialize(self, a_bzrdir):
2085
1648
        # 1) get the network name to use.
2086
1649
        if self._custom_format:
2087
1650
            network_name = self._custom_format.network_name()
2093
1656
            network_name = reference_format.network_name()
2094
1657
        # Being asked to create on a non RemoteBzrDir:
2095
1658
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1659
            return self._vfs_initialize(a_bzrdir)
2097
1660
        medium = a_bzrdir._client._medium
2098
1661
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1662
            return self._vfs_initialize(a_bzrdir)
2100
1663
        # Creating on a remote bzr dir.
2101
1664
        # 2) try direct creation via RPC
2102
1665
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
 
        if name is not None:
2104
 
            # XXX JRV20100304: Support creating colocated branches
2105
 
            raise errors.NoColocatedBranchSupport(self)
2106
1666
        verb = 'BzrDir.create_branch'
2107
1667
        try:
2108
1668
            response = a_bzrdir._call(verb, path, network_name)
2109
1669
        except errors.UnknownSmartMethod:
2110
1670
            # Fallback - use vfs methods
2111
1671
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1672
            return self._vfs_initialize(a_bzrdir)
2113
1673
        if response[0] != 'ok':
2114
1674
            raise errors.UnexpectedSmartServerResponse(response)
2115
1675
        # Turn the response into a RemoteRepository object.
2123
1683
                a_bzrdir._client)
2124
1684
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
1685
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
 
            format=format, setup_stacking=False, name=name)
 
1686
            format=format, setup_stacking=False)
2127
1687
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
1688
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
1689
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2144
1704
        self._ensure_real()
2145
1705
        return self._custom_format.supports_stacking()
2146
1706
 
2147
 
    def supports_set_append_revisions_only(self):
2148
 
        self._ensure_real()
2149
 
        return self._custom_format.supports_set_append_revisions_only()
2150
 
 
2151
 
 
2152
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1707
 
 
1708
class RemoteBranch(branch.Branch, _RpcHelper):
2153
1709
    """Branch stored on a server accessed by HPSS RPC.
2154
1710
 
2155
1711
    At the moment most operations are mapped down to simple file operations.
2156
1712
    """
2157
1713
 
2158
1714
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1715
        _client=None, format=None, setup_stacking=True):
2160
1716
        """Create a RemoteBranch instance.
2161
1717
 
2162
1718
        :param real_branch: An optional local implementation of the branch
2168
1724
        :param setup_stacking: If True make an RPC call to determine the
2169
1725
            stacked (or not) status of the branch. If False assume the branch
2170
1726
            is not stacked.
2171
 
        :param name: Colocated branch name
2172
1727
        """
2173
1728
        # We intentionally don't call the parent class's __init__, because it
2174
1729
        # will try to assign to self.tags, which is a property in this subclass.
2175
1730
        # And the parent's __init__ doesn't do much anyway.
 
1731
        self._revision_id_to_revno_cache = None
 
1732
        self._partial_revision_id_to_revno_cache = {}
 
1733
        self._revision_history_cache = None
 
1734
        self._last_revision_info_cache = None
 
1735
        self._merge_sorted_revisions_cache = None
2176
1736
        self.bzrdir = remote_bzrdir
2177
1737
        if _client is not None:
2178
1738
            self._client = _client
2191
1751
            self._real_branch.repository = self.repository
2192
1752
        else:
2193
1753
            self._real_branch = None
2194
 
        # Fill out expected attributes of branch for bzrlib API users.
2195
 
        self._clear_cached_state()
2196
 
        # TODO: deprecate self.base in favor of user_url
2197
 
        self.base = self.bzrdir.user_url
2198
 
        self._name = name
 
1754
        # Fill out expected attributes of branch for bzrlib api users.
 
1755
        self.base = self.bzrdir.root_transport.base
2199
1756
        self._control_files = None
2200
1757
        self._lock_mode = None
2201
1758
        self._lock_token = None
2212
1769
                    self._real_branch._format.network_name()
2213
1770
        else:
2214
1771
            self._format = format
2215
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2216
 
        # branch.open_branch method.
2217
 
        self._real_ignore_fallbacks = not setup_stacking
2218
1772
        if not self._format._network_name:
2219
1773
            # Did not get from open_branchV2 - old server.
2220
1774
            self._ensure_real()
2225
1779
        hooks = branch.Branch.hooks['open']
2226
1780
        for hook in hooks:
2227
1781
            hook(self)
2228
 
        self._is_stacked = False
2229
1782
        if setup_stacking:
2230
1783
            self._setup_stacking()
2231
1784
 
2237
1790
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2238
1791
            errors.UnstackableRepositoryFormat), e:
2239
1792
            return
2240
 
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
2242
 
 
2243
 
    def _get_config(self):
2244
 
        return RemoteBranchConfig(self)
 
1793
        # it's relative to this branch...
 
1794
        fallback_url = urlutils.join(self.base, fallback_url)
 
1795
        transports = [self.bzrdir.root_transport]
 
1796
        stacked_on = branch.Branch.open(fallback_url,
 
1797
                                        possible_transports=transports)
 
1798
        self.repository.add_fallback_repository(stacked_on.repository)
2245
1799
 
2246
1800
    def _get_real_transport(self):
2247
1801
        # if we try vfs access, return the real branch's vfs transport
2265
1819
                raise AssertionError('smart server vfs must be enabled '
2266
1820
                    'to use vfs implementation')
2267
1821
            self.bzrdir._ensure_real()
2268
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2269
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1822
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2270
1823
            if self.repository._real_repository is None:
2271
1824
                # Give the remote repository the matching real repo.
2272
1825
                real_repo = self._real_branch.repository
2346
1899
            raise errors.UnexpectedSmartServerResponse(response)
2347
1900
        return response[1]
2348
1901
 
2349
 
    def set_stacked_on_url(self, url):
2350
 
        branch.Branch.set_stacked_on_url(self, url)
2351
 
        if not url:
2352
 
            self._is_stacked = False
2353
 
        else:
2354
 
            self._is_stacked = True
2355
 
        
2356
1902
    def _vfs_get_tags_bytes(self):
2357
1903
        self._ensure_real()
2358
1904
        return self._real_branch._get_tags_bytes()
2368
1914
            return self._vfs_get_tags_bytes()
2369
1915
        return response[0]
2370
1916
 
2371
 
    def _vfs_set_tags_bytes(self, bytes):
2372
 
        self._ensure_real()
2373
 
        return self._real_branch._set_tags_bytes(bytes)
2374
 
 
2375
 
    def _set_tags_bytes(self, bytes):
2376
 
        medium = self._client._medium
2377
 
        if medium._is_remote_before((1, 18)):
2378
 
            self._vfs_set_tags_bytes(bytes)
2379
 
            return
2380
 
        try:
2381
 
            args = (
2382
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2383
 
            response = self._call_with_body_bytes(
2384
 
                'Branch.set_tags_bytes', args, bytes)
2385
 
        except errors.UnknownSmartMethod:
2386
 
            medium._remember_remote_is_before((1, 18))
2387
 
            self._vfs_set_tags_bytes(bytes)
2388
 
 
2389
1917
    def lock_read(self):
2390
1918
        self.repository.lock_read()
2391
1919
        if not self._lock_mode:
2392
 
            self._note_lock('r')
2393
1920
            self._lock_mode = 'r'
2394
1921
            self._lock_count = 1
2395
1922
            if self._real_branch is not None:
2415
1942
 
2416
1943
    def lock_write(self, token=None):
2417
1944
        if not self._lock_mode:
2418
 
            self._note_lock('w')
2419
1945
            # Lock the branch and repo in one remote call.
2420
1946
            remote_tokens = self._remote_lock_write(token)
2421
1947
            self._lock_token, self._repo_lock_token = remote_tokens
2447
1973
            self.repository.lock_write(self._repo_lock_token)
2448
1974
        return self._lock_token or None
2449
1975
 
 
1976
    def _set_tags_bytes(self, bytes):
 
1977
        self._ensure_real()
 
1978
        return self._real_branch._set_tags_bytes(bytes)
 
1979
 
2450
1980
    def _unlock(self, branch_token, repo_token):
2451
1981
        err_context = {'token': str((branch_token, repo_token))}
2452
1982
        response = self._call(
2456
1986
            return
2457
1987
        raise errors.UnexpectedSmartServerResponse(response)
2458
1988
 
2459
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2460
1989
    def unlock(self):
2461
1990
        try:
2462
1991
            self._lock_count -= 1
2475
2004
                    self._real_branch.unlock()
2476
2005
                if mode != 'w':
2477
2006
                    # Only write-locked branched need to make a remote method
2478
 
                    # call to perform the unlock.
 
2007
                    # call to perfom the unlock.
2479
2008
                    return
2480
2009
                if not self._lock_token:
2481
2010
                    raise AssertionError('Locked, but no token!')
2502
2031
            raise NotImplementedError(self.dont_leave_lock_in_place)
2503
2032
        self._leave_lock = False
2504
2033
 
2505
 
    @needs_read_lock
2506
 
    def get_rev_id(self, revno, history=None):
2507
 
        if revno == 0:
2508
 
            return _mod_revision.NULL_REVISION
2509
 
        last_revision_info = self.last_revision_info()
2510
 
        ok, result = self.repository.get_rev_id_for_revno(
2511
 
            revno, last_revision_info)
2512
 
        if ok:
2513
 
            return result
2514
 
        missing_parent = result[1]
2515
 
        # Either the revision named by the server is missing, or its parent
2516
 
        # is.  Call get_parent_map to determine which, so that we report a
2517
 
        # useful error.
2518
 
        parent_map = self.repository.get_parent_map([missing_parent])
2519
 
        if missing_parent in parent_map:
2520
 
            missing_parent = parent_map[missing_parent]
2521
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
 
 
2523
2034
    def _last_revision_info(self):
2524
2035
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2036
        if response[0] != 'ok':
2530
2041
 
2531
2042
    def _gen_revision_history(self):
2532
2043
        """See Branch._gen_revision_history()."""
2533
 
        if self._is_stacked:
2534
 
            self._ensure_real()
2535
 
            return self._real_branch._gen_revision_history()
2536
2044
        response_tuple, response_handler = self._call_expecting_body(
2537
2045
            'Branch.revision_history', self._remote_path())
2538
2046
        if response_tuple[0] != 'ok':
2623
2131
        self._ensure_real()
2624
2132
        return self._real_branch._get_parent_location()
2625
2133
 
 
2134
    def set_parent(self, url):
 
2135
        self._ensure_real()
 
2136
        return self._real_branch.set_parent(url)
 
2137
 
2626
2138
    def _set_parent_location(self, url):
2627
 
        medium = self._client._medium
2628
 
        if medium._is_remote_before((1, 15)):
2629
 
            return self._vfs_set_parent_location(url)
2630
 
        try:
2631
 
            call_url = url or ''
2632
 
            if type(call_url) is not str:
2633
 
                raise AssertionError('url must be a str or None (%s)' % url)
2634
 
            response = self._call('Branch.set_parent_location',
2635
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2636
 
                call_url)
2637
 
        except errors.UnknownSmartMethod:
2638
 
            medium._remember_remote_is_before((1, 15))
2639
 
            return self._vfs_set_parent_location(url)
2640
 
        if response != ():
2641
 
            raise errors.UnexpectedSmartServerResponse(response)
2642
 
 
2643
 
    def _vfs_set_parent_location(self, url):
 
2139
        # Used by tests, to poke bad urls into branch configurations
 
2140
        if url is None:
 
2141
            self.set_parent(url)
 
2142
        else:
 
2143
            self._ensure_real()
 
2144
            return self._real_branch._set_parent_location(url)
 
2145
 
 
2146
    def set_stacked_on_url(self, stacked_location):
 
2147
        """Set the URL this branch is stacked against.
 
2148
 
 
2149
        :raises UnstackableBranchFormat: If the branch does not support
 
2150
            stacking.
 
2151
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2152
            stacking.
 
2153
        """
2644
2154
        self._ensure_real()
2645
 
        return self._real_branch._set_parent_location(url)
 
2155
        return self._real_branch.set_stacked_on_url(stacked_location)
2646
2156
 
2647
2157
    @needs_write_lock
2648
2158
    def pull(self, source, overwrite=False, stop_revision=None,
2716
2226
        return self._real_branch.set_push_location(location)
2717
2227
 
2718
2228
 
2719
 
class RemoteConfig(object):
2720
 
    """A Config that reads and writes from smart verbs.
2721
 
 
2722
 
    It is a low-level object that considers config data to be name/value pairs
2723
 
    that may be associated with a section. Assigning meaning to the these
2724
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2725
 
    """
2726
 
 
2727
 
    def get_option(self, name, section=None, default=None):
2728
 
        """Return the value associated with a named option.
2729
 
 
2730
 
        :param name: The name of the value
2731
 
        :param section: The section the option is in (if any)
2732
 
        :param default: The value to return if the value is not set
2733
 
        :return: The value or default value
2734
 
        """
2735
 
        try:
2736
 
            configobj = self._get_configobj()
2737
 
            if section is None:
2738
 
                section_obj = configobj
2739
 
            else:
2740
 
                try:
2741
 
                    section_obj = configobj[section]
2742
 
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
2745
 
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
2747
 
 
2748
 
    def _response_to_configobj(self, response):
2749
 
        if len(response[0]) and response[0][0] != 'ok':
2750
 
            raise errors.UnexpectedSmartServerResponse(response)
2751
 
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
2753
 
 
2754
 
 
2755
 
class RemoteBranchConfig(RemoteConfig):
2756
 
    """A RemoteConfig for Branches."""
2757
 
 
2758
 
    def __init__(self, branch):
2759
 
        self._branch = branch
2760
 
 
2761
 
    def _get_configobj(self):
2762
 
        path = self._branch._remote_path()
2763
 
        response = self._branch._client.call_expecting_body(
2764
 
            'Branch.get_config_file', path)
2765
 
        return self._response_to_configobj(response)
2766
 
 
2767
 
    def set_option(self, value, name, section=None):
2768
 
        """Set the value associated with a named option.
2769
 
 
2770
 
        :param value: The value to set
2771
 
        :param name: The name of the value to set
2772
 
        :param section: The section the option is in (if any)
2773
 
        """
2774
 
        medium = self._branch._client._medium
2775
 
        if medium._is_remote_before((1, 14)):
2776
 
            return self._vfs_set_option(value, name, section)
2777
 
        try:
2778
 
            path = self._branch._remote_path()
2779
 
            response = self._branch._client.call('Branch.set_config_option',
2780
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
 
                value.encode('utf8'), name, section or '')
2782
 
        except errors.UnknownSmartMethod:
2783
 
            medium._remember_remote_is_before((1, 14))
2784
 
            return self._vfs_set_option(value, name, section)
2785
 
        if response != ():
2786
 
            raise errors.UnexpectedSmartServerResponse(response)
2787
 
 
2788
 
    def _real_object(self):
2789
 
        self._branch._ensure_real()
2790
 
        return self._branch._real_branch
2791
 
 
2792
 
    def _vfs_set_option(self, value, name, section=None):
2793
 
        return self._real_object()._get_config().set_option(
2794
 
            value, name, section)
2795
 
 
2796
 
 
2797
 
class RemoteBzrDirConfig(RemoteConfig):
2798
 
    """A RemoteConfig for BzrDirs."""
2799
 
 
2800
 
    def __init__(self, bzrdir):
2801
 
        self._bzrdir = bzrdir
2802
 
 
2803
 
    def _get_configobj(self):
2804
 
        medium = self._bzrdir._client._medium
2805
 
        verb = 'BzrDir.get_config_file'
2806
 
        if medium._is_remote_before((1, 15)):
2807
 
            raise errors.UnknownSmartMethod(verb)
2808
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2809
 
        response = self._bzrdir._call_expecting_body(
2810
 
            verb, path)
2811
 
        return self._response_to_configobj(response)
2812
 
 
2813
 
    def _vfs_get_option(self, name, section, default):
2814
 
        return self._real_object()._get_config().get_option(
2815
 
            name, section, default)
2816
 
 
2817
 
    def set_option(self, value, name, section=None):
2818
 
        """Set the value associated with a named option.
2819
 
 
2820
 
        :param value: The value to set
2821
 
        :param name: The name of the value to set
2822
 
        :param section: The section the option is in (if any)
2823
 
        """
2824
 
        return self._real_object()._get_config().set_option(
2825
 
            value, name, section)
2826
 
 
2827
 
    def _real_object(self):
2828
 
        self._bzrdir._ensure_real()
2829
 
        return self._bzrdir._real_bzrdir
2830
 
 
2831
 
 
2832
 
 
2833
2229
def _extract_tar(tar, to_dir):
2834
2230
    """Extract all the contents of a tarfile object.
2835
2231
 
2873
2269
                    'Missing key %r in context %r', key_err.args[0], context)
2874
2270
                raise err
2875
2271
 
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':
 
2272
    if err.error_verb == 'NoSuchRevision':
2880
2273
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
2274
    elif err.error_verb == 'nosuchrevision':
2882
2275
        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)
 
2276
    elif err.error_tuple == ('nobranch',):
 
2277
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2890
2278
    elif err.error_verb == 'norepository':
2891
2279
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
2280
    elif err.error_verb == 'LockContention':