← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-01-14 00:01:32 UTC
  • mfrom: (4957.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100114000132-3p3rabnonjw3gzqb
(jam) Merge bzr.stable, bringing in bug fixes #175839, #504390

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
# TODO: At some point, handle upgrades by just passing the whole request
18
 
# across to run on the server.
19
 
 
20
17
import bz2
21
18
 
22
19
from bzrlib import (
 
20
    bencode,
23
21
    branch,
24
22
    bzrdir,
25
23
    config,
26
24
    debug,
27
25
    errors,
28
26
    graph,
 
27
    lock,
29
28
    lockdir,
30
 
    pack,
31
29
    repository,
32
30
    revision,
 
31
    revision as _mod_revision,
33
32
    symbol_versioning,
34
 
    urlutils,
35
33
)
36
34
from bzrlib.branch import BranchReferenceFormat
37
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
36
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
37
from bzrlib.errors import (
40
38
    NoSuchRevision,
41
39
    SmartProtocolError,
44
42
from bzrlib.smart import client, vfs, repository as smart_repo
45
43
from bzrlib.revision import ensure_null, NULL_REVISION
46
44
from bzrlib.trace import mutter, note, warning
47
 
from bzrlib.util import bencode
48
45
 
49
46
 
50
47
class _RpcHelper(object):
62
59
        except errors.ErrorFromSmartServer, err:
63
60
            self._translate_error(err, **err_context)
64
61
 
 
62
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
 
63
        try:
 
64
            return self._client.call_with_body_bytes(method, args, body_bytes)
 
65
        except errors.ErrorFromSmartServer, err:
 
66
            self._translate_error(err, **err_context)
 
67
 
65
68
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
66
69
                                             **err_context):
67
70
        try:
86
89
class RemoteBzrDir(BzrDir, _RpcHelper):
87
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
88
91
 
89
 
    def __init__(self, transport, format, _client=None):
 
92
    def __init__(self, transport, format, _client=None, _force_probe=False):
90
93
        """Construct a RemoteBzrDir.
91
94
 
92
95
        :param _client: Private parameter for testing. Disables probing and the
96
99
        # this object holds a delegated bzrdir that uses file-level operations
97
100
        # to talk to the other side
98
101
        self._real_bzrdir = None
 
102
        self._has_working_tree = None
99
103
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
100
104
        # create_branch for details.
101
105
        self._next_open_branch_result = None
105
109
            self._client = client._SmartClient(medium)
106
110
        else:
107
111
            self._client = _client
108
 
            return
109
 
 
 
112
            if not _force_probe:
 
113
                return
 
114
 
 
115
        self._probe_bzrdir()
 
116
 
 
117
    def _probe_bzrdir(self):
 
118
        medium = self._client._medium
110
119
        path = self._path_for_remote_call(self._client)
 
120
        if medium._is_remote_before((2, 1)):
 
121
            self._rpc_open(path)
 
122
            return
 
123
        try:
 
124
            self._rpc_open_2_1(path)
 
125
            return
 
126
        except errors.UnknownSmartMethod:
 
127
            medium._remember_remote_is_before((2, 1))
 
128
            self._rpc_open(path)
 
129
 
 
130
    def _rpc_open_2_1(self, path):
 
131
        response = self._call('BzrDir.open_2.1', path)
 
132
        if response == ('no',):
 
133
            raise errors.NotBranchError(path=self.root_transport.base)
 
134
        elif response[0] == 'yes':
 
135
            if response[1] == 'yes':
 
136
                self._has_working_tree = True
 
137
            elif response[1] == 'no':
 
138
                self._has_working_tree = False
 
139
            else:
 
140
                raise errors.UnexpectedSmartServerResponse(response)
 
141
        else:
 
142
            raise errors.UnexpectedSmartServerResponse(response)
 
143
 
 
144
    def _rpc_open(self, path):
111
145
        response = self._call('BzrDir.open', path)
112
146
        if response not in [('yes',), ('no',)]:
113
147
            raise errors.UnexpectedSmartServerResponse(response)
114
148
        if response == ('no',):
115
 
            raise errors.NotBranchError(path=transport.base)
 
149
            raise errors.NotBranchError(path=self.root_transport.base)
116
150
 
117
151
    def _ensure_real(self):
118
152
        """Ensure that there is a _real_bzrdir set.
120
154
        Used before calls to self._real_bzrdir.
121
155
        """
122
156
        if not self._real_bzrdir:
 
157
            if 'hpssvfs' in debug.debug_flags:
 
158
                import traceback
 
159
                warning('VFS BzrDir access triggered\n%s',
 
160
                    ''.join(traceback.format_stack()))
123
161
            self._real_bzrdir = BzrDir.open_from_transport(
124
162
                self.root_transport, _server_formats=False)
125
163
            self._format._network_name = \
352
390
        else:
353
391
            raise errors.NoRepositoryPresent(self)
354
392
 
 
393
    def has_workingtree(self):
 
394
        if self._has_working_tree is None:
 
395
            self._ensure_real()
 
396
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
397
        return self._has_working_tree
 
398
 
355
399
    def open_workingtree(self, recommend_upgrade=True):
356
 
        self._ensure_real()
357
 
        if self._real_bzrdir.has_workingtree():
 
400
        if self.has_workingtree():
358
401
            raise errors.NotLocalUrl(self.root_transport)
359
402
        else:
360
403
            raise errors.NoWorkingTree(self.root_transport.base)
423
466
        self._custom_format = None
424
467
        self._network_name = None
425
468
        self._creating_bzrdir = None
 
469
        self._supports_chks = None
426
470
        self._supports_external_lookups = None
427
471
        self._supports_tree_reference = None
428
472
        self._rich_root_data = None
429
473
 
 
474
    def __repr__(self):
 
475
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
476
            self._network_name)
 
477
 
430
478
    @property
431
479
    def fast_deltas(self):
432
480
        self._ensure_real()
440
488
        return self._rich_root_data
441
489
 
442
490
    @property
 
491
    def supports_chks(self):
 
492
        if self._supports_chks is None:
 
493
            self._ensure_real()
 
494
            self._supports_chks = self._custom_format.supports_chks
 
495
        return self._supports_chks
 
496
 
 
497
    @property
443
498
    def supports_external_lookups(self):
444
499
        if self._supports_external_lookups is None:
445
500
            self._ensure_real()
491
546
        # 1) get the network name to use.
492
547
        if self._custom_format:
493
548
            network_name = self._custom_format.network_name()
 
549
        elif self._network_name:
 
550
            network_name = self._network_name
494
551
        else:
495
552
            # Select the current bzrlib default and ask for that.
496
553
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
544
601
        return self._custom_format._fetch_reconcile
545
602
 
546
603
    def get_format_description(self):
547
 
        return 'bzr remote repository'
 
604
        self._ensure_real()
 
605
        return 'Remote: ' + self._custom_format.get_format_description()
548
606
 
549
607
    def __eq__(self, other):
550
608
        return self.__class__ is other.__class__
551
609
 
552
 
    def check_conversion_target(self, target_format):
553
 
        if self.rich_root_data and not target_format.rich_root_data:
554
 
            raise errors.BadConversionTarget(
555
 
                'Does not support rich root data.', target_format)
556
 
        if (self.supports_tree_reference and
557
 
            not getattr(target_format, 'supports_tree_reference', False)):
558
 
            raise errors.BadConversionTarget(
559
 
                'Does not support nested trees', target_format)
560
 
 
561
610
    def network_name(self):
562
611
        if self._network_name:
563
612
            return self._network_name
565
614
        return self._creating_repo._real_repository._format.network_name()
566
615
 
567
616
    @property
 
617
    def pack_compresses(self):
 
618
        self._ensure_real()
 
619
        return self._custom_format.pack_compresses
 
620
 
 
621
    @property
568
622
    def _serializer(self):
569
623
        self._ensure_real()
570
624
        return self._custom_format._serializer
571
625
 
572
626
 
573
 
class RemoteRepository(_RpcHelper):
 
627
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin):
574
628
    """Repository accessed over rpc.
575
629
 
576
630
    For the moment most operations are performed using local transport-backed
602
656
        self._lock_token = None
603
657
        self._lock_count = 0
604
658
        self._leave_lock = False
 
659
        # Cache of revision parents; misses are cached during read locks, and
 
660
        # write locks when no _real_repository has been set.
605
661
        self._unstacked_provider = graph.CachingParentsProvider(
606
662
            get_parent_map=self._get_parent_map_rpc)
607
663
        self._unstacked_provider.disable_cache()
665
721
        self._ensure_real()
666
722
        return self._real_repository.suspend_write_group()
667
723
 
 
724
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
725
        self._ensure_real()
 
726
        return self._real_repository.get_missing_parent_inventories(
 
727
            check_for_missing_texts=check_for_missing_texts)
 
728
 
 
729
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
 
730
        self._ensure_real()
 
731
        return self._real_repository.get_rev_id_for_revno(
 
732
            revno, known_pair)
 
733
 
 
734
    def get_rev_id_for_revno(self, revno, known_pair):
 
735
        """See Repository.get_rev_id_for_revno."""
 
736
        path = self.bzrdir._path_for_remote_call(self._client)
 
737
        try:
 
738
            if self._client._medium._is_remote_before((1, 17)):
 
739
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
740
            response = self._call(
 
741
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
 
742
        except errors.UnknownSmartMethod:
 
743
            self._client._medium._remember_remote_is_before((1, 17))
 
744
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
745
        if response[0] == 'ok':
 
746
            return True, response[1]
 
747
        elif response[0] == 'history-incomplete':
 
748
            known_pair = response[1:3]
 
749
            for fallback in self._fallback_repositories:
 
750
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
 
751
                if found:
 
752
                    return True, result
 
753
                else:
 
754
                    known_pair = result
 
755
            # Not found in any fallbacks
 
756
            return False, known_pair
 
757
        else:
 
758
            raise errors.UnexpectedSmartServerResponse(response)
 
759
 
668
760
    def _ensure_real(self):
669
761
        """Ensure that there is a _real_repository set.
670
762
 
679
771
        invocation. If in doubt chat to the bzr network team.
680
772
        """
681
773
        if self._real_repository is None:
 
774
            if 'hpssvfs' in debug.debug_flags:
 
775
                import traceback
 
776
                warning('VFS Repository access triggered\n%s',
 
777
                    ''.join(traceback.format_stack()))
 
778
            self._unstacked_provider.missing_keys.clear()
682
779
            self.bzrdir._ensure_real()
683
780
            self._set_real_repository(
684
781
                self.bzrdir._real_bzrdir.open_repository())
744
841
        """Return a source for streaming from this repository."""
745
842
        return RemoteStreamSource(self, to_format)
746
843
 
 
844
    @needs_read_lock
747
845
    def has_revision(self, revision_id):
748
 
        """See Repository.has_revision()."""
749
 
        if revision_id == NULL_REVISION:
750
 
            # The null revision is always present.
751
 
            return True
752
 
        path = self.bzrdir._path_for_remote_call(self._client)
753
 
        response = self._call('Repository.has_revision', path, revision_id)
754
 
        if response[0] not in ('yes', 'no'):
755
 
            raise errors.UnexpectedSmartServerResponse(response)
756
 
        if response[0] == 'yes':
757
 
            return True
758
 
        for fallback_repo in self._fallback_repositories:
759
 
            if fallback_repo.has_revision(revision_id):
760
 
                return True
761
 
        return False
 
846
        """True if this repository has a copy of the revision."""
 
847
        # Copy of bzrlib.repository.Repository.has_revision
 
848
        return revision_id in self.has_revisions((revision_id,))
762
849
 
 
850
    @needs_read_lock
763
851
    def has_revisions(self, revision_ids):
764
 
        """See Repository.has_revisions()."""
765
 
        # FIXME: This does many roundtrips, particularly when there are
766
 
        # fallback repositories.  -- mbp 20080905
767
 
        result = set()
768
 
        for revision_id in revision_ids:
769
 
            if self.has_revision(revision_id):
770
 
                result.add(revision_id)
 
852
        """Probe to find out the presence of multiple revisions.
 
853
 
 
854
        :param revision_ids: An iterable of revision_ids.
 
855
        :return: A set of the revision_ids that were present.
 
856
        """
 
857
        # Copy of bzrlib.repository.Repository.has_revisions
 
858
        parent_map = self.get_parent_map(revision_ids)
 
859
        result = set(parent_map)
 
860
        if _mod_revision.NULL_REVISION in revision_ids:
 
861
            result.add(_mod_revision.NULL_REVISION)
771
862
        return result
772
863
 
 
864
    def _has_same_fallbacks(self, other_repo):
 
865
        """Returns true if the repositories have the same fallbacks."""
 
866
        # XXX: copied from Repository; it should be unified into a base class
 
867
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
868
        my_fb = self._fallback_repositories
 
869
        other_fb = other_repo._fallback_repositories
 
870
        if len(my_fb) != len(other_fb):
 
871
            return False
 
872
        for f, g in zip(my_fb, other_fb):
 
873
            if not f.has_same_location(g):
 
874
                return False
 
875
        return True
 
876
 
773
877
    def has_same_location(self, other):
 
878
        # TODO: Move to RepositoryBase and unify with the regular Repository
 
879
        # one; unfortunately the tests rely on slightly different behaviour at
 
880
        # present -- mbp 20090710
774
881
        return (self.__class__ is other.__class__ and
775
882
                self.bzrdir.transport.base == other.bzrdir.transport.base)
776
883
 
844
951
    def is_write_locked(self):
845
952
        return self._lock_mode == 'w'
846
953
 
 
954
    def _warn_if_deprecated(self, branch=None):
 
955
        # If we have a real repository, the check will be done there, if we
 
956
        # don't the check will be done remotely.
 
957
        pass
 
958
 
847
959
    def lock_read(self):
848
960
        # wrong eventually - want a local lock cache context
849
961
        if not self._lock_mode:
 
962
            self._note_lock('r')
850
963
            self._lock_mode = 'r'
851
964
            self._lock_count = 1
852
965
            self._unstacked_provider.enable_cache(cache_misses=True)
853
966
            if self._real_repository is not None:
854
967
                self._real_repository.lock_read()
 
968
            for repo in self._fallback_repositories:
 
969
                repo.lock_read()
855
970
        else:
856
971
            self._lock_count += 1
857
 
        for repo in self._fallback_repositories:
858
 
            repo.lock_read()
859
972
 
860
973
    def _remote_lock_write(self, token):
861
974
        path = self.bzrdir._path_for_remote_call(self._client)
872
985
 
873
986
    def lock_write(self, token=None, _skip_rpc=False):
874
987
        if not self._lock_mode:
 
988
            self._note_lock('w')
875
989
            if _skip_rpc:
876
990
                if self._lock_token is not None:
877
991
                    if token != self._lock_token:
891
1005
                self._leave_lock = False
892
1006
            self._lock_mode = 'w'
893
1007
            self._lock_count = 1
894
 
            self._unstacked_provider.enable_cache(cache_misses=False)
 
1008
            cache_misses = self._real_repository is None
 
1009
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
 
1010
            for repo in self._fallback_repositories:
 
1011
                # Writes don't affect fallback repos
 
1012
                repo.lock_read()
895
1013
        elif self._lock_mode == 'r':
896
1014
            raise errors.ReadOnlyError(self)
897
1015
        else:
898
1016
            self._lock_count += 1
899
 
        for repo in self._fallback_repositories:
900
 
            # Writes don't affect fallback repos
901
 
            repo.lock_read()
902
1017
        return self._lock_token or None
903
1018
 
904
1019
    def leave_lock_in_place(self):
979
1094
        else:
980
1095
            raise errors.UnexpectedSmartServerResponse(response)
981
1096
 
 
1097
    @only_raises(errors.LockNotHeld, errors.LockBroken)
982
1098
    def unlock(self):
983
1099
        if not self._lock_count:
984
 
            raise errors.LockNotHeld(self)
 
1100
            return lock.cant_unlock_not_held(self)
985
1101
        self._lock_count -= 1
986
1102
        if self._lock_count > 0:
987
1103
            return
1006
1122
                self._lock_token = None
1007
1123
                if not self._leave_lock:
1008
1124
                    self._unlock(old_token)
 
1125
        # Fallbacks are always 'lock_read()' so we don't pay attention to
 
1126
        # self._leave_lock
 
1127
        for repo in self._fallback_repositories:
 
1128
            repo.unlock()
1009
1129
 
1010
1130
    def break_lock(self):
1011
1131
        # should hand off to the network
1075
1195
        # We need to accumulate additional repositories here, to pass them in
1076
1196
        # on various RPC's.
1077
1197
        #
 
1198
        if self.is_locked():
 
1199
            # We will call fallback.unlock() when we transition to the unlocked
 
1200
            # state, so always add a lock here. If a caller passes us a locked
 
1201
            # repository, they are responsible for unlocking it later.
 
1202
            repository.lock_read()
1078
1203
        self._fallback_repositories.append(repository)
1079
1204
        # If self._real_repository was parameterised already (e.g. because a
1080
1205
        # _real_branch had its get_stacked_on_url method called), then the
1105
1230
        self._ensure_real()
1106
1231
        return self._real_repository.get_inventory(revision_id)
1107
1232
 
1108
 
    def iter_inventories(self, revision_ids):
 
1233
    def iter_inventories(self, revision_ids, ordering=None):
1109
1234
        self._ensure_real()
1110
 
        return self._real_repository.iter_inventories(revision_ids)
 
1235
        return self._real_repository.iter_inventories(revision_ids, ordering)
1111
1236
 
1112
1237
    @needs_read_lock
1113
1238
    def get_revision(self, revision_id):
1177
1302
            raise errors.InternalBzrError(
1178
1303
                "May not fetch while in a write group.")
1179
1304
        # fast path same-url fetch operations
1180
 
        if self.has_same_location(source) and fetch_spec is None:
 
1305
        if (self.has_same_location(source)
 
1306
            and fetch_spec is None
 
1307
            and self._has_same_fallbacks(source)):
1181
1308
            # check that last_revision is in 'from' and then return a
1182
1309
            # no-operation.
1183
1310
            if (revision_id is not None and
1395
1522
        return self._real_repository.get_revision_reconcile(revision_id)
1396
1523
 
1397
1524
    @needs_read_lock
1398
 
    def check(self, revision_ids=None):
 
1525
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1399
1526
        self._ensure_real()
1400
 
        return self._real_repository.check(revision_ids=revision_ids)
 
1527
        return self._real_repository.check(revision_ids=revision_ids,
 
1528
            callback_refs=callback_refs, check_repo=check_repo)
1401
1529
 
1402
1530
    def copy_content_into(self, destination, revision_id=None):
1403
1531
        self._ensure_real()
1443
1571
        return self._real_repository.inventories
1444
1572
 
1445
1573
    @needs_write_lock
1446
 
    def pack(self):
 
1574
    def pack(self, hint=None):
1447
1575
        """Compress the data within the repository.
1448
1576
 
1449
1577
        This is not currently implemented within the smart server.
1450
1578
        """
1451
1579
        self._ensure_real()
1452
 
        return self._real_repository.pack()
 
1580
        return self._real_repository.pack(hint=hint)
1453
1581
 
1454
1582
    @property
1455
1583
    def revisions(self):
1543
1671
        self._ensure_real()
1544
1672
        return self._real_repository.revision_graph_can_have_wrong_parents()
1545
1673
 
1546
 
    def _find_inconsistent_revision_parents(self):
 
1674
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1547
1675
        self._ensure_real()
1548
 
        return self._real_repository._find_inconsistent_revision_parents()
 
1676
        return self._real_repository._find_inconsistent_revision_parents(
 
1677
            revisions_iterator)
1549
1678
 
1550
1679
    def _check_for_inconsistent_revision_parents(self):
1551
1680
        self._ensure_real()
1557
1686
            providers.insert(0, other)
1558
1687
        providers.extend(r._make_parents_provider() for r in
1559
1688
                         self._fallback_repositories)
1560
 
        return graph._StackedParentsProvider(providers)
 
1689
        return graph.StackedParentsProvider(providers)
1561
1690
 
1562
1691
    def _serialise_search_recipe(self, recipe):
1563
1692
        """Serialise a graph search recipe.
1604
1733
 
1605
1734
    def insert_stream(self, stream, src_format, resume_tokens):
1606
1735
        target = self.target_repo
 
1736
        target._unstacked_provider.missing_keys.clear()
 
1737
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1607
1738
        if target._lock_token:
1608
 
            verb = 'Repository.insert_stream_locked'
1609
 
            extra_args = (target._lock_token or '',)
1610
 
            required_version = (1, 14)
 
1739
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
 
1740
            lock_args = (target._lock_token or '',)
1611
1741
        else:
1612
 
            verb = 'Repository.insert_stream'
1613
 
            extra_args = ()
1614
 
            required_version = (1, 13)
 
1742
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
 
1743
            lock_args = ()
1615
1744
        client = target._client
1616
1745
        medium = client._medium
1617
 
        if medium._is_remote_before(required_version):
1618
 
            # No possible way this can work.
1619
 
            return self._insert_real(stream, src_format, resume_tokens)
1620
1746
        path = target.bzrdir._path_for_remote_call(client)
1621
 
        if not resume_tokens:
1622
 
            # XXX: Ugly but important for correctness, *will* be fixed during
1623
 
            # 1.13 cycle. Pushing a stream that is interrupted results in a
1624
 
            # fallback to the _real_repositories sink *with a partial stream*.
1625
 
            # Thats bad because we insert less data than bzr expected. To avoid
1626
 
            # this we do a trial push to make sure the verb is accessible, and
1627
 
            # do not fallback when actually pushing the stream. A cleanup patch
1628
 
            # is going to look at rewinding/restarting the stream/partial
1629
 
            # buffering etc.
 
1747
        # Probe for the verb to use with an empty stream before sending the
 
1748
        # real stream to it.  We do this both to avoid the risk of sending a
 
1749
        # large request that is then rejected, and because we don't want to
 
1750
        # implement a way to buffer, rewind, or restart the stream.
 
1751
        found_verb = False
 
1752
        for verb, required_version in candidate_calls:
 
1753
            if medium._is_remote_before(required_version):
 
1754
                continue
 
1755
            if resume_tokens:
 
1756
                # We've already done the probing (and set _is_remote_before) on
 
1757
                # a previous insert.
 
1758
                found_verb = True
 
1759
                break
1630
1760
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1631
1761
            try:
1632
1762
                response = client.call_with_body_stream(
1633
 
                    (verb, path, '') + extra_args, byte_stream)
 
1763
                    (verb, path, '') + lock_args, byte_stream)
1634
1764
            except errors.UnknownSmartMethod:
1635
1765
                medium._remember_remote_is_before(required_version)
1636
 
                return self._insert_real(stream, src_format, resume_tokens)
 
1766
            else:
 
1767
                found_verb = True
 
1768
                break
 
1769
        if not found_verb:
 
1770
            # Have to use VFS.
 
1771
            return self._insert_real(stream, src_format, resume_tokens)
 
1772
        self._last_inv_record = None
 
1773
        self._last_substream = None
 
1774
        if required_version < (1, 19):
 
1775
            # Remote side doesn't support inventory deltas.  Wrap the stream to
 
1776
            # make sure we don't send any.  If the stream contains inventory
 
1777
            # deltas we'll interrupt the smart insert_stream request and
 
1778
            # fallback to VFS.
 
1779
            stream = self._stop_stream_if_inventory_delta(stream)
1637
1780
        byte_stream = smart_repo._stream_to_byte_stream(
1638
1781
            stream, src_format)
1639
1782
        resume_tokens = ' '.join(resume_tokens)
1640
1783
        response = client.call_with_body_stream(
1641
 
            (verb, path, resume_tokens) + extra_args, byte_stream)
 
1784
            (verb, path, resume_tokens) + lock_args, byte_stream)
1642
1785
        if response[0][0] not in ('ok', 'missing-basis'):
1643
1786
            raise errors.UnexpectedSmartServerResponse(response)
 
1787
        if self._last_substream is not None:
 
1788
            # The stream included an inventory-delta record, but the remote
 
1789
            # side isn't new enough to support them.  So we need to send the
 
1790
            # rest of the stream via VFS.
 
1791
            self.target_repo.refresh_data()
 
1792
            return self._resume_stream_with_vfs(response, src_format)
1644
1793
        if response[0][0] == 'missing-basis':
1645
1794
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1646
1795
            resume_tokens = tokens
1649
1798
            self.target_repo.refresh_data()
1650
1799
            return [], set()
1651
1800
 
 
1801
    def _resume_stream_with_vfs(self, response, src_format):
 
1802
        """Resume sending a stream via VFS, first resending the record and
 
1803
        substream that couldn't be sent via an insert_stream verb.
 
1804
        """
 
1805
        if response[0][0] == 'missing-basis':
 
1806
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1807
            # Ignore missing_keys, we haven't finished inserting yet
 
1808
        else:
 
1809
            tokens = []
 
1810
        def resume_substream():
 
1811
            # Yield the substream that was interrupted.
 
1812
            for record in self._last_substream:
 
1813
                yield record
 
1814
            self._last_substream = None
 
1815
        def resume_stream():
 
1816
            # Finish sending the interrupted substream
 
1817
            yield ('inventory-deltas', resume_substream())
 
1818
            # Then simply continue sending the rest of the stream.
 
1819
            for substream_kind, substream in self._last_stream:
 
1820
                yield substream_kind, substream
 
1821
        return self._insert_real(resume_stream(), src_format, tokens)
 
1822
 
 
1823
    def _stop_stream_if_inventory_delta(self, stream):
 
1824
        """Normally this just lets the original stream pass-through unchanged.
 
1825
 
 
1826
        However if any 'inventory-deltas' substream occurs it will stop
 
1827
        streaming, and store the interrupted substream and stream in
 
1828
        self._last_substream and self._last_stream so that the stream can be
 
1829
        resumed by _resume_stream_with_vfs.
 
1830
        """
 
1831
                    
 
1832
        stream_iter = iter(stream)
 
1833
        for substream_kind, substream in stream_iter:
 
1834
            if substream_kind == 'inventory-deltas':
 
1835
                self._last_substream = substream
 
1836
                self._last_stream = stream_iter
 
1837
                return
 
1838
            else:
 
1839
                yield substream_kind, substream
 
1840
            
1652
1841
 
1653
1842
class RemoteStreamSource(repository.StreamSource):
1654
1843
    """Stream data from a remote server."""
1657
1846
        if (self.from_repository._fallback_repositories and
1658
1847
            self.to_format._fetch_order == 'topological'):
1659
1848
            return self._real_stream(self.from_repository, search)
1660
 
        return self.missing_parents_chain(search, [self.from_repository] +
1661
 
            self.from_repository._fallback_repositories)
 
1849
        sources = []
 
1850
        seen = set()
 
1851
        repos = [self.from_repository]
 
1852
        while repos:
 
1853
            repo = repos.pop(0)
 
1854
            if repo in seen:
 
1855
                continue
 
1856
            seen.add(repo)
 
1857
            repos.extend(repo._fallback_repositories)
 
1858
            sources.append(repo)
 
1859
        return self.missing_parents_chain(search, sources)
 
1860
 
 
1861
    def get_stream_for_missing_keys(self, missing_keys):
 
1862
        self.from_repository._ensure_real()
 
1863
        real_repo = self.from_repository._real_repository
 
1864
        real_source = real_repo._get_source(self.to_format)
 
1865
        return real_source.get_stream_for_missing_keys(missing_keys)
1662
1866
 
1663
1867
    def _real_stream(self, repo, search):
1664
1868
        """Get a stream for search from repo.
1671
1875
        """
1672
1876
        source = repo._get_source(self.to_format)
1673
1877
        if isinstance(source, RemoteStreamSource):
1674
 
            return repository.StreamSource.get_stream(source, search)
 
1878
            repo._ensure_real()
 
1879
            source = repo._real_repository._get_source(self.to_format)
1675
1880
        return source.get_stream(search)
1676
1881
 
1677
1882
    def _get_stream(self, repo, search):
1694
1899
            return self._real_stream(repo, search)
1695
1900
        client = repo._client
1696
1901
        medium = client._medium
1697
 
        if medium._is_remote_before((1, 13)):
1698
 
            # streaming was added in 1.13
1699
 
            return self._real_stream(repo, search)
1700
1902
        path = repo.bzrdir._path_for_remote_call(client)
1701
 
        try:
1702
 
            search_bytes = repo._serialise_search_result(search)
1703
 
            response = repo._call_with_body_bytes_expecting_body(
1704
 
                'Repository.get_stream',
1705
 
                (path, self.to_format.network_name()), search_bytes)
1706
 
            response_tuple, response_handler = response
1707
 
        except errors.UnknownSmartMethod:
1708
 
            medium._remember_remote_is_before((1,13))
 
1903
        search_bytes = repo._serialise_search_result(search)
 
1904
        args = (path, self.to_format.network_name())
 
1905
        candidate_verbs = [
 
1906
            ('Repository.get_stream_1.19', (1, 19)),
 
1907
            ('Repository.get_stream', (1, 13))]
 
1908
        found_verb = False
 
1909
        for verb, version in candidate_verbs:
 
1910
            if medium._is_remote_before(version):
 
1911
                continue
 
1912
            try:
 
1913
                response = repo._call_with_body_bytes_expecting_body(
 
1914
                    verb, args, search_bytes)
 
1915
            except errors.UnknownSmartMethod:
 
1916
                medium._remember_remote_is_before(version)
 
1917
            else:
 
1918
                response_tuple, response_handler = response
 
1919
                found_verb = True
 
1920
                break
 
1921
        if not found_verb:
1709
1922
            return self._real_stream(repo, search)
1710
1923
        if response_tuple[0] != 'ok':
1711
1924
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1723
1936
        :param search: The overall search to satisfy with streams.
1724
1937
        :param sources: A list of Repository objects to query.
1725
1938
        """
1726
 
        self.serialiser = self.to_format._serializer
 
1939
        self.from_serialiser = self.from_repository._format._serializer
1727
1940
        self.seen_revs = set()
1728
1941
        self.referenced_revs = set()
1729
1942
        # If there are heads in the search, or the key count is > 0, we are not
1746
1959
    def missing_parents_rev_handler(self, substream):
1747
1960
        for content in substream:
1748
1961
            revision_bytes = content.get_bytes_as('fulltext')
1749
 
            revision = self.serialiser.read_revision_from_string(revision_bytes)
 
1962
            revision = self.from_serialiser.read_revision_from_string(
 
1963
                revision_bytes)
1750
1964
            self.seen_revs.add(content.key[-1])
1751
1965
            self.referenced_revs.update(revision.parent_ids)
1752
1966
            yield content
1791
2005
                self._network_name)
1792
2006
 
1793
2007
    def get_format_description(self):
1794
 
        return 'Remote BZR Branch'
 
2008
        self._ensure_real()
 
2009
        return 'Remote: ' + self._custom_format.get_format_description()
1795
2010
 
1796
2011
    def network_name(self):
1797
2012
        return self._network_name
1875
2090
        self._ensure_real()
1876
2091
        return self._custom_format.supports_stacking()
1877
2092
 
1878
 
 
1879
 
class RemoteBranch(branch.Branch, _RpcHelper):
 
2093
    def supports_set_append_revisions_only(self):
 
2094
        self._ensure_real()
 
2095
        return self._custom_format.supports_set_append_revisions_only()
 
2096
 
 
2097
 
 
2098
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1880
2099
    """Branch stored on a server accessed by HPSS RPC.
1881
2100
 
1882
2101
    At the moment most operations are mapped down to simple file operations.
1899
2118
        # We intentionally don't call the parent class's __init__, because it
1900
2119
        # will try to assign to self.tags, which is a property in this subclass.
1901
2120
        # And the parent's __init__ doesn't do much anyway.
1902
 
        self._revision_id_to_revno_cache = None
1903
 
        self._partial_revision_id_to_revno_cache = {}
1904
 
        self._revision_history_cache = None
1905
 
        self._last_revision_info_cache = None
1906
 
        self._merge_sorted_revisions_cache = None
1907
2121
        self.bzrdir = remote_bzrdir
1908
2122
        if _client is not None:
1909
2123
            self._client = _client
1923
2137
        else:
1924
2138
            self._real_branch = None
1925
2139
        # Fill out expected attributes of branch for bzrlib API users.
 
2140
        self._clear_cached_state()
1926
2141
        self.base = self.bzrdir.root_transport.base
1927
2142
        self._control_files = None
1928
2143
        self._lock_mode = None
1940
2155
                    self._real_branch._format.network_name()
1941
2156
        else:
1942
2157
            self._format = format
 
2158
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
 
2159
        # branch.open_branch method.
 
2160
        self._real_ignore_fallbacks = not setup_stacking
1943
2161
        if not self._format._network_name:
1944
2162
            # Did not get from open_branchV2 - old server.
1945
2163
            self._ensure_real()
1950
2168
        hooks = branch.Branch.hooks['open']
1951
2169
        for hook in hooks:
1952
2170
            hook(self)
 
2171
        self._is_stacked = False
1953
2172
        if setup_stacking:
1954
2173
            self._setup_stacking()
1955
2174
 
1961
2180
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1962
2181
            errors.UnstackableRepositoryFormat), e:
1963
2182
            return
1964
 
        self._activate_fallback_location(fallback_url, None)
 
2183
        self._is_stacked = True
 
2184
        self._activate_fallback_location(fallback_url)
1965
2185
 
1966
2186
    def _get_config(self):
1967
2187
        return RemoteBranchConfig(self)
1988
2208
                raise AssertionError('smart server vfs must be enabled '
1989
2209
                    'to use vfs implementation')
1990
2210
            self.bzrdir._ensure_real()
1991
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
2211
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
 
2212
                ignore_fallbacks=self._real_ignore_fallbacks)
1992
2213
            if self.repository._real_repository is None:
1993
2214
                # Give the remote repository the matching real repo.
1994
2215
                real_repo = self._real_branch.repository
2068
2289
            raise errors.UnexpectedSmartServerResponse(response)
2069
2290
        return response[1]
2070
2291
 
 
2292
    def set_stacked_on_url(self, url):
 
2293
        branch.Branch.set_stacked_on_url(self, url)
 
2294
        if not url:
 
2295
            self._is_stacked = False
 
2296
        else:
 
2297
            self._is_stacked = True
 
2298
        
2071
2299
    def _vfs_get_tags_bytes(self):
2072
2300
        self._ensure_real()
2073
2301
        return self._real_branch._get_tags_bytes()
2083
2311
            return self._vfs_get_tags_bytes()
2084
2312
        return response[0]
2085
2313
 
 
2314
    def _vfs_set_tags_bytes(self, bytes):
 
2315
        self._ensure_real()
 
2316
        return self._real_branch._set_tags_bytes(bytes)
 
2317
 
 
2318
    def _set_tags_bytes(self, bytes):
 
2319
        medium = self._client._medium
 
2320
        if medium._is_remote_before((1, 18)):
 
2321
            self._vfs_set_tags_bytes(bytes)
 
2322
            return
 
2323
        try:
 
2324
            args = (
 
2325
                self._remote_path(), self._lock_token, self._repo_lock_token)
 
2326
            response = self._call_with_body_bytes(
 
2327
                'Branch.set_tags_bytes', args, bytes)
 
2328
        except errors.UnknownSmartMethod:
 
2329
            medium._remember_remote_is_before((1, 18))
 
2330
            self._vfs_set_tags_bytes(bytes)
 
2331
 
2086
2332
    def lock_read(self):
2087
2333
        self.repository.lock_read()
2088
2334
        if not self._lock_mode:
 
2335
            self._note_lock('r')
2089
2336
            self._lock_mode = 'r'
2090
2337
            self._lock_count = 1
2091
2338
            if self._real_branch is not None:
2111
2358
 
2112
2359
    def lock_write(self, token=None):
2113
2360
        if not self._lock_mode:
 
2361
            self._note_lock('w')
2114
2362
            # Lock the branch and repo in one remote call.
2115
2363
            remote_tokens = self._remote_lock_write(token)
2116
2364
            self._lock_token, self._repo_lock_token = remote_tokens
2142
2390
            self.repository.lock_write(self._repo_lock_token)
2143
2391
        return self._lock_token or None
2144
2392
 
2145
 
    def _set_tags_bytes(self, bytes):
2146
 
        self._ensure_real()
2147
 
        return self._real_branch._set_tags_bytes(bytes)
2148
 
 
2149
2393
    def _unlock(self, branch_token, repo_token):
2150
2394
        err_context = {'token': str((branch_token, repo_token))}
2151
2395
        response = self._call(
2155
2399
            return
2156
2400
        raise errors.UnexpectedSmartServerResponse(response)
2157
2401
 
 
2402
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2158
2403
    def unlock(self):
2159
2404
        try:
2160
2405
            self._lock_count -= 1
2200
2445
            raise NotImplementedError(self.dont_leave_lock_in_place)
2201
2446
        self._leave_lock = False
2202
2447
 
 
2448
    @needs_read_lock
 
2449
    def get_rev_id(self, revno, history=None):
 
2450
        if revno == 0:
 
2451
            return _mod_revision.NULL_REVISION
 
2452
        last_revision_info = self.last_revision_info()
 
2453
        ok, result = self.repository.get_rev_id_for_revno(
 
2454
            revno, last_revision_info)
 
2455
        if ok:
 
2456
            return result
 
2457
        missing_parent = result[1]
 
2458
        # Either the revision named by the server is missing, or its parent
 
2459
        # is.  Call get_parent_map to determine which, so that we report a
 
2460
        # useful error.
 
2461
        parent_map = self.repository.get_parent_map([missing_parent])
 
2462
        if missing_parent in parent_map:
 
2463
            missing_parent = parent_map[missing_parent]
 
2464
        raise errors.RevisionNotPresent(missing_parent, self.repository)
 
2465
 
2203
2466
    def _last_revision_info(self):
2204
2467
        response = self._call('Branch.last_revision_info', self._remote_path())
2205
2468
        if response[0] != 'ok':
2210
2473
 
2211
2474
    def _gen_revision_history(self):
2212
2475
        """See Branch._gen_revision_history()."""
 
2476
        if self._is_stacked:
 
2477
            self._ensure_real()
 
2478
            return self._real_branch._gen_revision_history()
2213
2479
        response_tuple, response_handler = self._call_expecting_body(
2214
2480
            'Branch.revision_history', self._remote_path())
2215
2481
        if response_tuple[0] != 'ok':
2550
2816
                    'Missing key %r in context %r', key_err.args[0], context)
2551
2817
                raise err
2552
2818
 
2553
 
    if err.error_verb == 'NoSuchRevision':
 
2819
    if err.error_verb == 'IncompatibleRepositories':
 
2820
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2821
            err.error_args[1], err.error_args[2])
 
2822
    elif err.error_verb == 'NoSuchRevision':
2554
2823
        raise NoSuchRevision(find('branch'), err.error_args[0])
2555
2824
    elif err.error_verb == 'nosuchrevision':
2556
2825
        raise NoSuchRevision(find('repository'), err.error_args[0])