← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: John Arbash Meinel
  • Date: 2009-04-08 16:33:19 UTC
  • mfrom: (3735.2.187 brisbane-core)
  • mto: This revision was merged to the branch mainline in revision 4280.
  • Revision ID: john@arbash-meinel.com-20090408163319-jzin98xnzklj8vun
Merge the a couple rev older brisbane-core into bzr.dev, most things are resolve in favor of bzr.dev

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
 
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
24
    bzrdir,
23
25
    config,
24
26
    debug,
25
27
    errors,
26
28
    graph,
27
 
    lock,
28
29
    lockdir,
 
30
    pack,
29
31
    repository,
30
 
    repository as _mod_repository,
31
32
    revision,
32
 
    revision as _mod_revision,
33
 
    static_tuple,
34
33
    symbol_versioning,
 
34
    urlutils,
35
35
)
36
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
36
from bzrlib.branch import BranchReferenceFormat
37
37
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
39
from bzrlib.errors import (
40
40
    NoSuchRevision,
41
41
    SmartProtocolError,
43
43
from bzrlib.lockable_files import LockableFiles
44
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
45
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
46
from bzrlib.trace import mutter, note, warning
 
47
from bzrlib.util import bencode
48
48
 
49
49
 
50
50
class _RpcHelper(object):
62
62
        except errors.ErrorFromSmartServer, err:
63
63
            self._translate_error(err, **err_context)
64
64
 
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
65
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
66
                                             **err_context):
73
67
        try:
92
86
class RemoteBzrDir(BzrDir, _RpcHelper):
93
87
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
88
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
89
    def __init__(self, transport, format, _client=None):
96
90
        """Construct a RemoteBzrDir.
97
91
 
98
92
        :param _client: Private parameter for testing. Disables probing and the
102
96
        # this object holds a delegated bzrdir that uses file-level operations
103
97
        # to talk to the other side
104
98
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
99
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
100
        # create_branch for details.
108
101
        self._next_open_branch_result = None
112
105
            self._client = client._SmartClient(medium)
113
106
        else:
114
107
            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
 
108
            return
 
109
 
125
110
        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
111
        response = self._call('BzrDir.open', path)
152
112
        if response not in [('yes',), ('no',)]:
153
113
            raise errors.UnexpectedSmartServerResponse(response)
154
114
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
115
            raise errors.NotBranchError(path=transport.base)
156
116
 
157
117
    def _ensure_real(self):
158
118
        """Ensure that there is a _real_bzrdir set.
160
120
        Used before calls to self._real_bzrdir.
161
121
        """
162
122
        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
123
            self._real_bzrdir = BzrDir.open_from_transport(
168
124
                self.root_transport, _server_formats=False)
169
125
            self._format._network_name = \
245
201
        self._ensure_real()
246
202
        self._real_bzrdir.destroy_repository()
247
203
 
248
 
    def create_branch(self, name=None):
 
204
    def create_branch(self):
249
205
        # as per meta1 formats - just delegate to the format object which may
250
206
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
207
        real_branch = self._format.get_branch_format().initialize(self)
253
208
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
209
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
210
        else:
257
211
            result = real_branch
258
212
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
218
        self._next_open_branch_result = result
265
219
        return result
266
220
 
267
 
    def destroy_branch(self, name=None):
 
221
    def destroy_branch(self):
268
222
        """See BzrDir.destroy_branch"""
269
223
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
224
        self._real_bzrdir.destroy_branch()
271
225
        self._next_open_branch_result = None
272
226
 
273
227
    def create_workingtree(self, revision_id=None, from_branch=None):
292
246
    def _get_branch_reference(self):
293
247
        path = self._path_for_remote_call(self._client)
294
248
        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
 
249
        if not medium._is_remote_before((1, 13)):
303
250
            try:
304
 
                response = self._call(verb, path)
 
251
                response = self._call('BzrDir.open_branchV2', path)
 
252
                if response[0] not in ('ref', 'branch'):
 
253
                    raise errors.UnexpectedSmartServerResponse(response)
 
254
                return response
305
255
            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'):
 
256
                medium._remember_remote_is_before((1, 13))
 
257
        response = self._call('BzrDir.open_branch', path)
 
258
        if response[0] != 'ok':
319
259
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
 
260
        if response[1] != '':
 
261
            return ('ref', response[1])
 
262
        else:
 
263
            return ('branch', '')
321
264
 
322
265
    def _get_tree_branch(self):
323
266
        """See BzrDir._get_tree_branch()."""
324
267
        return None, self.open_branch()
325
268
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
269
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
270
        if _unsupported:
329
271
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
272
        if self._next_open_branch_result is not None:
331
273
            # See create_branch for details.
336
278
        if response[0] == 'ref':
337
279
            # a branch reference, use the existing BranchReference logic.
338
280
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
281
            return format.open(self, _found=True, location=response[1],
 
282
                ignore_fallbacks=ignore_fallbacks)
341
283
        branch_format_name = response[1]
342
284
        if not branch_format_name:
343
285
            branch_format_name = None
344
286
        format = RemoteBranchFormat(network_name=branch_format_name)
345
287
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
 
288
            setup_stacking=not ignore_fallbacks)
347
289
 
348
290
    def _open_repo_v1(self, path):
349
291
        verb = 'BzrDir.find_repository'
410
352
        else:
411
353
            raise errors.NoRepositoryPresent(self)
412
354
 
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
355
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
356
        self._ensure_real()
 
357
        if self._real_bzrdir.has_workingtree():
421
358
            raise errors.NotLocalUrl(self.root_transport)
422
359
        else:
423
360
            raise errors.NoWorkingTree(self.root_transport.base)
426
363
        """Return the path to be used for this bzrdir in a remote call."""
427
364
        return client.remote_path_from_transport(self.root_transport)
428
365
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
366
    def get_branch_transport(self, branch_format):
430
367
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
368
        return self._real_bzrdir.get_branch_transport(branch_format)
432
369
 
433
370
    def get_repository_transport(self, repository_format):
434
371
        self._ensure_real()
455
392
        return self._real_bzrdir.clone(url, revision_id=revision_id,
456
393
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
457
394
 
458
 
    def _get_config(self):
459
 
        return RemoteBzrDirConfig(self)
 
395
    def get_config(self):
 
396
        self._ensure_real()
 
397
        return self._real_bzrdir.get_config()
460
398
 
461
399
 
462
400
class RemoteRepositoryFormat(repository.RepositoryFormat):
486
424
        self._custom_format = None
487
425
        self._network_name = None
488
426
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
427
        self._supports_external_lookups = None
491
428
        self._supports_tree_reference = None
492
429
        self._rich_root_data = None
493
430
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
431
    @property
499
432
    def fast_deltas(self):
500
433
        self._ensure_real()
508
441
        return self._rich_root_data
509
442
 
510
443
    @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
444
    def supports_external_lookups(self):
519
445
        if self._supports_external_lookups is None:
520
446
            self._ensure_real()
566
492
        # 1) get the network name to use.
567
493
        if self._custom_format:
568
494
            network_name = self._custom_format.network_name()
569
 
        elif self._network_name:
570
 
            network_name = self._network_name
571
495
        else:
572
496
            # Select the current bzrlib default and ask for that.
573
497
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
621
545
        return self._custom_format._fetch_reconcile
622
546
 
623
547
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
548
        return 'bzr remote repository'
626
549
 
627
550
    def __eq__(self, other):
628
551
        return self.__class__ is other.__class__
629
552
 
 
553
    def check_conversion_target(self, target_format):
 
554
        if self.rich_root_data and not target_format.rich_root_data:
 
555
            raise errors.BadConversionTarget(
 
556
                'Does not support rich root data.', target_format)
 
557
        if (self.supports_tree_reference and
 
558
            not getattr(target_format, 'supports_tree_reference', False)):
 
559
            raise errors.BadConversionTarget(
 
560
                'Does not support nested trees', target_format)
 
561
 
630
562
    def network_name(self):
631
563
        if self._network_name:
632
564
            return self._network_name
634
566
        return self._creating_repo._real_repository._format.network_name()
635
567
 
636
568
    @property
637
 
    def pack_compresses(self):
638
 
        self._ensure_real()
639
 
        return self._custom_format.pack_compresses
640
 
 
641
 
    @property
642
569
    def _serializer(self):
643
570
        self._ensure_real()
644
571
        return self._custom_format._serializer
645
572
 
646
573
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
574
class RemoteRepository(_RpcHelper):
649
575
    """Repository accessed over rpc.
650
576
 
651
577
    For the moment most operations are performed using local transport-backed
677
603
        self._lock_token = None
678
604
        self._lock_count = 0
679
605
        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
606
        self._unstacked_provider = graph.CachingParentsProvider(
683
607
            get_parent_map=self._get_parent_map_rpc)
684
608
        self._unstacked_provider.disable_cache()
694
618
        # Additional places to query for data.
695
619
        self._fallback_repositories = []
696
620
 
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
621
    def __str__(self):
709
622
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
623
 
753
666
        self._ensure_real()
754
667
        return self._real_repository.suspend_write_group()
755
668
 
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
669
    def _ensure_real(self):
793
670
        """Ensure that there is a _real_repository set.
794
671
 
803
680
        invocation. If in doubt chat to the bzr network team.
804
681
        """
805
682
        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
683
            self.bzrdir._ensure_real()
812
684
            self._set_real_repository(
813
685
                self.bzrdir._real_bzrdir.open_repository())
873
745
        """Return a source for streaming from this repository."""
874
746
        return RemoteStreamSource(self, to_format)
875
747
 
876
 
    @needs_read_lock
877
748
    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,))
 
749
        """See Repository.has_revision()."""
 
750
        if revision_id == NULL_REVISION:
 
751
            # The null revision is always present.
 
752
            return True
 
753
        path = self.bzrdir._path_for_remote_call(self._client)
 
754
        response = self._call('Repository.has_revision', path, revision_id)
 
755
        if response[0] not in ('yes', 'no'):
 
756
            raise errors.UnexpectedSmartServerResponse(response)
 
757
        if response[0] == 'yes':
 
758
            return True
 
759
        for fallback_repo in self._fallback_repositories:
 
760
            if fallback_repo.has_revision(revision_id):
 
761
                return True
 
762
        return False
881
763
 
882
 
    @needs_read_lock
883
764
    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)
 
765
        """See Repository.has_revisions()."""
 
766
        # FIXME: This does many roundtrips, particularly when there are
 
767
        # fallback repositories.  -- mbp 20080905
 
768
        result = set()
 
769
        for revision_id in revision_ids:
 
770
            if self.has_revision(revision_id):
 
771
                result.add(revision_id)
894
772
        return result
895
773
 
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
774
    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
775
        return (self.__class__ is other.__class__ and
914
776
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
777
 
918
780
        parents_provider = self._make_parents_provider(other_repository)
919
781
        return graph.Graph(parents_provider)
920
782
 
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
783
    def gather_stats(self, revid=None, committers=None):
931
784
        """See Repository.gather_stats()."""
932
785
        path = self.bzrdir._path_for_remote_call(self._client)
992
845
    def is_write_locked(self):
993
846
        return self._lock_mode == 'w'
994
847
 
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
848
    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
849
        # wrong eventually - want a local lock cache context
1007
850
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
851
            self._lock_mode = 'r'
1010
852
            self._lock_count = 1
1011
853
            self._unstacked_provider.enable_cache(cache_misses=True)
1012
854
            if self._real_repository is not None:
1013
855
                self._real_repository.lock_read()
1014
 
            for repo in self._fallback_repositories:
1015
 
                repo.lock_read()
1016
856
        else:
1017
857
            self._lock_count += 1
1018
 
        return self
 
858
        for repo in self._fallback_repositories:
 
859
            repo.lock_read()
1019
860
 
1020
861
    def _remote_lock_write(self, token):
1021
862
        path = self.bzrdir._path_for_remote_call(self._client)
1032
873
 
1033
874
    def lock_write(self, token=None, _skip_rpc=False):
1034
875
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
876
            if _skip_rpc:
1037
877
                if self._lock_token is not None:
1038
878
                    if token != self._lock_token:
1052
892
                self._leave_lock = False
1053
893
            self._lock_mode = 'w'
1054
894
            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()
 
895
            self._unstacked_provider.enable_cache(cache_misses=False)
1060
896
        elif self._lock_mode == 'r':
1061
897
            raise errors.ReadOnlyError(self)
1062
898
        else:
1063
899
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
900
        for repo in self._fallback_repositories:
 
901
            # Writes don't affect fallback repos
 
902
            repo.lock_read()
 
903
        return self._lock_token or None
1065
904
 
1066
905
    def leave_lock_in_place(self):
1067
906
        if not self._lock_token:
1141
980
        else:
1142
981
            raise errors.UnexpectedSmartServerResponse(response)
1143
982
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
983
    def unlock(self):
1146
984
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
985
            raise errors.LockNotHeld(self)
1148
986
        self._lock_count -= 1
1149
987
        if self._lock_count > 0:
1150
988
            return
1169
1007
                self._lock_token = None
1170
1008
                if not self._leave_lock:
1171
1009
                    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
1010
 
1177
1011
    def break_lock(self):
1178
1012
        # should hand off to the network
1242
1076
        # We need to accumulate additional repositories here, to pass them in
1243
1077
        # on various RPC's.
1244
1078
        #
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
1079
        self._fallback_repositories.append(repository)
1252
1080
        # If self._real_repository was parameterised already (e.g. because a
1253
1081
        # _real_branch had its get_stacked_on_url method called), then the
1254
1082
        # repository to be added may already be in the _real_repositories list.
1255
1083
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
 
1084
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1257
1085
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
1086
            if repository.bzrdir.root_transport.base not in fallback_locations:
1259
1087
                self._real_repository.add_fallback_repository(repository)
1260
1088
 
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)
1270
 
 
1271
1089
    def add_inventory(self, revid, inv, parents):
1272
1090
        self._ensure_real()
1273
1091
        return self._real_repository.add_inventory(revid, inv, parents)
1274
1092
 
1275
1093
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
1094
                               parents):
1277
1095
        self._ensure_real()
1278
1096
        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)
 
1097
            delta, new_revision_id, parents)
1281
1098
 
1282
1099
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1100
        self._ensure_real()
1289
1106
        self._ensure_real()
1290
1107
        return self._real_repository.get_inventory(revision_id)
1291
1108
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1109
    def iter_inventories(self, revision_ids):
1293
1110
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1111
        return self._real_repository.iter_inventories(revision_ids)
1295
1112
 
1296
1113
    @needs_read_lock
1297
1114
    def get_revision(self, revision_id):
1361
1178
            raise errors.InternalBzrError(
1362
1179
                "May not fetch while in a write group.")
1363
1180
        # 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)):
 
1181
        if self.has_same_location(source) and fetch_spec is None:
1367
1182
            # check that last_revision is in 'from' and then return a
1368
1183
            # no-operation.
1369
1184
            if (revision_id is not None and
1542
1357
        return self._real_repository.get_signature_text(revision_id)
1543
1358
 
1544
1359
    @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)
 
1360
    def get_inventory_xml(self, revision_id):
 
1361
        self._ensure_real()
 
1362
        return self._real_repository.get_inventory_xml(revision_id)
 
1363
 
 
1364
    def deserialise_inventory(self, revision_id, xml):
 
1365
        self._ensure_real()
 
1366
        return self._real_repository.deserialise_inventory(revision_id, xml)
1548
1367
 
1549
1368
    def reconcile(self, other=None, thorough=False):
1550
1369
        self._ensure_real()
1577
1396
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1397
 
1579
1398
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1399
    def check(self, revision_ids=None):
1581
1400
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1401
        return self._real_repository.check(revision_ids=revision_ids)
1584
1402
 
1585
1403
    def copy_content_into(self, destination, revision_id=None):
1586
1404
        self._ensure_real()
1626
1444
        return self._real_repository.inventories
1627
1445
 
1628
1446
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1447
    def pack(self):
1630
1448
        """Compress the data within the repository.
1631
1449
 
1632
1450
        This is not currently implemented within the smart server.
1633
1451
        """
1634
1452
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1453
        return self._real_repository.pack()
1636
1454
 
1637
1455
    @property
1638
1456
    def revisions(self):
1726
1544
        self._ensure_real()
1727
1545
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1546
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1547
    def _find_inconsistent_revision_parents(self):
1730
1548
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1549
        return self._real_repository._find_inconsistent_revision_parents()
1733
1550
 
1734
1551
    def _check_for_inconsistent_revision_parents(self):
1735
1552
        self._ensure_real()
1741
1558
            providers.insert(0, other)
1742
1559
        providers.extend(r._make_parents_provider() for r in
1743
1560
                         self._fallback_repositories)
1744
 
        return graph.StackedParentsProvider(providers)
 
1561
        return graph._StackedParentsProvider(providers)
1745
1562
 
1746
1563
    def _serialise_search_recipe(self, recipe):
1747
1564
        """Serialise a graph search recipe.
1788
1605
 
1789
1606
    def insert_stream(self, stream, src_format, resume_tokens):
1790
1607
        target = self.target_repo
1791
 
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
1608
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
 
1609
            verb = 'Repository.insert_stream_locked'
 
1610
            extra_args = (target._lock_token or '',)
 
1611
            required_version = (1, 14)
1796
1612
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
 
1613
            verb = 'Repository.insert_stream'
 
1614
            extra_args = ()
 
1615
            required_version = (1, 13)
1799
1616
        client = target._client
1800
1617
        medium = client._medium
 
1618
        if medium._is_remote_before(required_version):
 
1619
            # No possible way this can work.
 
1620
            return self._insert_real(stream, src_format, resume_tokens)
1801
1621
        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
 
1622
        if not resume_tokens:
 
1623
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1624
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1625
            # fallback to the _real_repositories sink *with a partial stream*.
 
1626
            # Thats bad because we insert less data than bzr expected. To avoid
 
1627
            # this we do a trial push to make sure the verb is accessible, and
 
1628
            # do not fallback when actually pushing the stream. A cleanup patch
 
1629
            # is going to look at rewinding/restarting the stream/partial
 
1630
            # buffering etc.
1815
1631
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
1632
            try:
1817
1633
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1634
                    (verb, path, '') + extra_args, byte_stream)
1819
1635
            except errors.UnknownSmartMethod:
1820
1636
                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)
 
1637
                return self._insert_real(stream, src_format, resume_tokens)
1835
1638
        byte_stream = smart_repo._stream_to_byte_stream(
1836
1639
            stream, src_format)
1837
1640
        resume_tokens = ' '.join(resume_tokens)
1838
1641
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1642
            (verb, path, resume_tokens) + extra_args, byte_stream)
1840
1643
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1644
            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
1645
        if response[0][0] == 'missing-basis':
1849
1646
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1647
            resume_tokens = tokens
1851
 
            return resume_tokens, set(missing_keys)
 
1648
            return resume_tokens, missing_keys
1852
1649
        else:
1853
1650
            self.target_repo.refresh_data()
1854
1651
            return [], set()
1855
1652
 
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
1653
 
1897
1654
class RemoteStreamSource(repository.StreamSource):
1898
1655
    """Stream data from a remote server."""
1901
1658
        if (self.from_repository._fallback_repositories and
1902
1659
            self.to_format._fetch_order == 'topological'):
1903
1660
            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)
 
1661
        return self.missing_parents_chain(search, [self.from_repository] +
 
1662
            self.from_repository._fallback_repositories)
1921
1663
 
1922
1664
    def _real_stream(self, repo, search):
1923
1665
        """Get a stream for search from repo.
1930
1672
        """
1931
1673
        source = repo._get_source(self.to_format)
1932
1674
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
 
1675
            return repository.StreamSource.get_stream(source, search)
1935
1676
        return source.get_stream(search)
1936
1677
 
1937
1678
    def _get_stream(self, repo, search):
1954
1695
            return self._real_stream(repo, search)
1955
1696
        client = repo._client
1956
1697
        medium = client._medium
 
1698
        if medium._is_remote_before((1, 13)):
 
1699
            # streaming was added in 1.13
 
1700
            return self._real_stream(repo, search)
1957
1701
        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:
 
1702
        try:
 
1703
            search_bytes = repo._serialise_search_result(search)
 
1704
            response = repo._call_with_body_bytes_expecting_body(
 
1705
                'Repository.get_stream',
 
1706
                (path, self.to_format.network_name()), search_bytes)
 
1707
            response_tuple, response_handler = response
 
1708
        except errors.UnknownSmartMethod:
 
1709
            medium._remember_remote_is_before((1,13))
1977
1710
            return self._real_stream(repo, search)
1978
1711
        if response_tuple[0] != 'ok':
1979
1712
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1991
1724
        :param search: The overall search to satisfy with streams.
1992
1725
        :param sources: A list of Repository objects to query.
1993
1726
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
 
1727
        self.serialiser = self.to_format._serializer
1995
1728
        self.seen_revs = set()
1996
1729
        self.referenced_revs = set()
1997
1730
        # If there are heads in the search, or the key count is > 0, we are not
2014
1747
    def missing_parents_rev_handler(self, substream):
2015
1748
        for content in substream:
2016
1749
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
 
1750
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2019
1751
            self.seen_revs.add(content.key[-1])
2020
1752
            self.referenced_revs.update(revision.parent_ids)
2021
1753
            yield content
2060
1792
                self._network_name)
2061
1793
 
2062
1794
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1795
        return 'Remote BZR Branch'
2065
1796
 
2066
1797
    def network_name(self):
2067
1798
        return self._network_name
2068
1799
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1800
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1801
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2072
1802
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1803
    def _vfs_initialize(self, a_bzrdir):
2074
1804
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1805
        # method is not available on the server.
2076
1806
        # self._custom_format is always set - the start of initialize ensures
2077
1807
        # that.
2078
1808
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1809
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1810
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1811
        else:
2083
1812
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1813
            result = self._custom_format.initialize(a_bzrdir)
2085
1814
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1815
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1816
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1817
        return result
2090
1818
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1819
    def initialize(self, a_bzrdir):
2092
1820
        # 1) get the network name to use.
2093
1821
        if self._custom_format:
2094
1822
            network_name = self._custom_format.network_name()
2100
1828
            network_name = reference_format.network_name()
2101
1829
        # Being asked to create on a non RemoteBzrDir:
2102
1830
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1831
            return self._vfs_initialize(a_bzrdir)
2104
1832
        medium = a_bzrdir._client._medium
2105
1833
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1834
            return self._vfs_initialize(a_bzrdir)
2107
1835
        # Creating on a remote bzr dir.
2108
1836
        # 2) try direct creation via RPC
2109
1837
        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
1838
        verb = 'BzrDir.create_branch'
2114
1839
        try:
2115
1840
            response = a_bzrdir._call(verb, path, network_name)
2116
1841
        except errors.UnknownSmartMethod:
2117
1842
            # Fallback - use vfs methods
2118
1843
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1844
            return self._vfs_initialize(a_bzrdir)
2120
1845
        if response[0] != 'ok':
2121
1846
            raise errors.UnexpectedSmartServerResponse(response)
2122
1847
        # Turn the response into a RemoteRepository object.
2130
1855
                a_bzrdir._client)
2131
1856
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1857
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1858
            format=format, setup_stacking=False)
2134
1859
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1860
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1861
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2151
1876
        self._ensure_real()
2152
1877
        return self._custom_format.supports_stacking()
2153
1878
 
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):
 
1879
 
 
1880
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1881
    """Branch stored on a server accessed by HPSS RPC.
2161
1882
 
2162
1883
    At the moment most operations are mapped down to simple file operations.
2163
1884
    """
2164
1885
 
2165
1886
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1887
        _client=None, format=None, setup_stacking=True):
2167
1888
        """Create a RemoteBranch instance.
2168
1889
 
2169
1890
        :param real_branch: An optional local implementation of the branch
2175
1896
        :param setup_stacking: If True make an RPC call to determine the
2176
1897
            stacked (or not) status of the branch. If False assume the branch
2177
1898
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1899
        """
2180
1900
        # We intentionally don't call the parent class's __init__, because it
2181
1901
        # will try to assign to self.tags, which is a property in this subclass.
2182
1902
        # And the parent's __init__ doesn't do much anyway.
 
1903
        self._revision_id_to_revno_cache = None
 
1904
        self._partial_revision_id_to_revno_cache = {}
 
1905
        self._revision_history_cache = None
 
1906
        self._last_revision_info_cache = None
 
1907
        self._merge_sorted_revisions_cache = None
2183
1908
        self.bzrdir = remote_bzrdir
2184
1909
        if _client is not None:
2185
1910
            self._client = _client
2199
1924
        else:
2200
1925
            self._real_branch = None
2201
1926
        # 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
 
1927
        self.base = self.bzrdir.root_transport.base
2206
1928
        self._control_files = None
2207
1929
        self._lock_mode = None
2208
1930
        self._lock_token = None
2219
1941
                    self._real_branch._format.network_name()
2220
1942
        else:
2221
1943
            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
1944
        if not self._format._network_name:
2226
1945
            # Did not get from open_branchV2 - old server.
2227
1946
            self._ensure_real()
2232
1951
        hooks = branch.Branch.hooks['open']
2233
1952
        for hook in hooks:
2234
1953
            hook(self)
2235
 
        self._is_stacked = False
2236
1954
        if setup_stacking:
2237
1955
            self._setup_stacking()
2238
1956
 
2244
1962
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2245
1963
            errors.UnstackableRepositoryFormat), e:
2246
1964
            return
2247
 
        self._is_stacked = True
2248
1965
        self._activate_fallback_location(fallback_url)
2249
1966
 
2250
1967
    def _get_config(self):
2272
1989
                raise AssertionError('smart server vfs must be enabled '
2273
1990
                    'to use vfs implementation')
2274
1991
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1992
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
1993
            if self.repository._real_repository is None:
2278
1994
                # Give the remote repository the matching real repo.
2279
1995
                real_repo = self._real_branch.repository
2353
2069
            raise errors.UnexpectedSmartServerResponse(response)
2354
2070
        return response[1]
2355
2071
 
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
2072
    def _vfs_get_tags_bytes(self):
2364
2073
        self._ensure_real()
2365
2074
        return self._real_branch._get_tags_bytes()
2375
2084
            return self._vfs_get_tags_bytes()
2376
2085
        return response[0]
2377
2086
 
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
2087
    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
2088
        self.repository.lock_read()
2403
2089
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
2090
            self._lock_mode = 'r'
2406
2091
            self._lock_count = 1
2407
2092
            if self._real_branch is not None:
2408
2093
                self._real_branch.lock_read()
2409
2094
        else:
2410
2095
            self._lock_count += 1
2411
 
        return self
2412
2096
 
2413
2097
    def _remote_lock_write(self, token):
2414
2098
        if token is None:
2415
2099
            branch_token = repo_token = ''
2416
2100
        else:
2417
2101
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
2102
            repo_token = self.repository.lock_write()
2419
2103
            self.repository.unlock()
2420
2104
        err_context = {'token': token}
2421
2105
        response = self._call(
2428
2112
 
2429
2113
    def lock_write(self, token=None):
2430
2114
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
2115
            # Lock the branch and repo in one remote call.
2433
2116
            remote_tokens = self._remote_lock_write(token)
2434
2117
            self._lock_token, self._repo_lock_token = remote_tokens
2458
2141
            self._lock_count += 1
2459
2142
            # Re-lock the repository too.
2460
2143
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2144
        return self._lock_token or None
 
2145
 
 
2146
    def _set_tags_bytes(self, bytes):
 
2147
        self._ensure_real()
 
2148
        return self._real_branch._set_tags_bytes(bytes)
2462
2149
 
2463
2150
    def _unlock(self, branch_token, repo_token):
2464
2151
        err_context = {'token': str((branch_token, repo_token))}
2469
2156
            return
2470
2157
        raise errors.UnexpectedSmartServerResponse(response)
2471
2158
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
2159
    def unlock(self):
2474
2160
        try:
2475
2161
            self._lock_count -= 1
2515
2201
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
2202
        self._leave_lock = False
2517
2203
 
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
2204
    def _last_revision_info(self):
2537
2205
        response = self._call('Branch.last_revision_info', self._remote_path())
2538
2206
        if response[0] != 'ok':
2543
2211
 
2544
2212
    def _gen_revision_history(self):
2545
2213
        """See Branch._gen_revision_history()."""
2546
 
        if self._is_stacked:
2547
 
            self._ensure_real()
2548
 
            return self._real_branch._gen_revision_history()
2549
2214
        response_tuple, response_handler = self._call_expecting_body(
2550
2215
            'Branch.revision_history', self._remote_path())
2551
2216
        if response_tuple[0] != 'ok':
2636
2301
        self._ensure_real()
2637
2302
        return self._real_branch._get_parent_location()
2638
2303
 
 
2304
    def set_parent(self, url):
 
2305
        self._ensure_real()
 
2306
        return self._real_branch.set_parent(url)
 
2307
 
2639
2308
    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):
2657
 
        self._ensure_real()
2658
 
        return self._real_branch._set_parent_location(url)
 
2309
        # Used by tests, to poke bad urls into branch configurations
 
2310
        if url is None:
 
2311
            self.set_parent(url)
 
2312
        else:
 
2313
            self._ensure_real()
 
2314
            return self._real_branch._set_parent_location(url)
2659
2315
 
2660
2316
    @needs_write_lock
2661
2317
    def pull(self, source, overwrite=False, stop_revision=None,
2729
2385
        return self._real_branch.set_push_location(location)
2730
2386
 
2731
2387
 
2732
 
class RemoteConfig(object):
2733
 
    """A Config that reads and writes from smart verbs.
 
2388
class RemoteBranchConfig(object):
 
2389
    """A Config that reads from a smart branch and writes via smart methods.
2734
2390
 
2735
2391
    It is a low-level object that considers config data to be name/value pairs
2736
2392
    that may be associated with a section. Assigning meaning to the these
2737
2393
    values is done at higher levels like bzrlib.config.TreeConfig.
2738
2394
    """
2739
2395
 
 
2396
    def __init__(self, branch):
 
2397
        self._branch = branch
 
2398
 
2740
2399
    def get_option(self, name, section=None, default=None):
2741
2400
        """Return the value associated with a named option.
2742
2401
 
2745
2404
        :param default: The value to return if the value is not set
2746
2405
        :return: The value or default value
2747
2406
        """
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
 
2407
        configobj = self._get_configobj()
 
2408
        if section is None:
 
2409
            section_obj = configobj
 
2410
        else:
 
2411
            try:
 
2412
                section_obj = configobj[section]
 
2413
            except KeyError:
 
2414
                return default
 
2415
        return section_obj.get(name, default)
2773
2416
 
2774
2417
    def _get_configobj(self):
2775
2418
        path = self._branch._remote_path()
2776
2419
        response = self._branch._client.call_expecting_body(
2777
2420
            'Branch.get_config_file', path)
2778
 
        return self._response_to_configobj(response)
 
2421
        if response[0][0] != 'ok':
 
2422
            raise UnexpectedSmartServerResponse(response)
 
2423
        lines = response[1].read_body_bytes().splitlines()
 
2424
        return config.ConfigObj(lines, encoding='utf-8')
2779
2425
 
2780
2426
    def set_option(self, value, name, section=None):
2781
2427
        """Set the value associated with a named option.
2798
2444
        if response != ():
2799
2445
            raise errors.UnexpectedSmartServerResponse(response)
2800
2446
 
2801
 
    def _real_object(self):
 
2447
    def _vfs_set_option(self, value, name, section=None):
2802
2448
        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
 
 
 
2449
        return self._branch._real_branch._get_config().set_option(
 
2450
            value, name, section)
2844
2451
 
2845
2452
 
2846
2453
def _extract_tar(tar, to_dir):
2886
2493
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2494
                raise err
2888
2495
 
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':
 
2496
    if err.error_verb == 'NoSuchRevision':
2893
2497
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2498
    elif err.error_verb == 'nosuchrevision':
2895
2499
        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)
 
2500
    elif err.error_tuple == ('nobranch',):
 
2501
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2502
    elif err.error_verb == 'norepository':
2904
2503
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2504
    elif err.error_verb == 'LockContention':