← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-27 02:11:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4573.
  • Revision ID: andrew.bennetts@canonical.com-20090727021125-ohf358magl25s786
Update test.

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 (
24
27
    debug,
25
28
    errors,
26
29
    graph,
27
 
    lock,
28
30
    lockdir,
29
31
    repository,
30
 
    repository as _mod_repository,
31
32
    revision,
32
33
    revision as _mod_revision,
33
 
    static_tuple,
34
34
    symbol_versioning,
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
48
47
 
49
48
 
92
91
class RemoteBzrDir(BzrDir, _RpcHelper):
93
92
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
93
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
94
    def __init__(self, transport, format, _client=None):
96
95
        """Construct a RemoteBzrDir.
97
96
 
98
97
        :param _client: Private parameter for testing. Disables probing and the
102
101
        # this object holds a delegated bzrdir that uses file-level operations
103
102
        # to talk to the other side
104
103
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
104
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
105
        # create_branch for details.
108
106
        self._next_open_branch_result = None
112
110
            self._client = client._SmartClient(medium)
113
111
        else:
114
112
            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
 
113
            return
 
114
 
125
115
        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
116
        response = self._call('BzrDir.open', path)
152
117
        if response not in [('yes',), ('no',)]:
153
118
            raise errors.UnexpectedSmartServerResponse(response)
154
119
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
120
            raise errors.NotBranchError(path=transport.base)
156
121
 
157
122
    def _ensure_real(self):
158
123
        """Ensure that there is a _real_bzrdir set.
160
125
        Used before calls to self._real_bzrdir.
161
126
        """
162
127
        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
128
            self._real_bzrdir = BzrDir.open_from_transport(
168
129
                self.root_transport, _server_formats=False)
169
130
            self._format._network_name = \
245
206
        self._ensure_real()
246
207
        self._real_bzrdir.destroy_repository()
247
208
 
248
 
    def create_branch(self, name=None):
 
209
    def create_branch(self):
249
210
        # as per meta1 formats - just delegate to the format object which may
250
211
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
212
        real_branch = self._format.get_branch_format().initialize(self)
253
213
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
214
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
215
        else:
257
216
            result = real_branch
258
217
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
223
        self._next_open_branch_result = result
265
224
        return result
266
225
 
267
 
    def destroy_branch(self, name=None):
 
226
    def destroy_branch(self):
268
227
        """See BzrDir.destroy_branch"""
269
228
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
229
        self._real_bzrdir.destroy_branch()
271
230
        self._next_open_branch_result = None
272
231
 
273
232
    def create_workingtree(self, revision_id=None, from_branch=None):
292
251
    def _get_branch_reference(self):
293
252
        path = self._path_for_remote_call(self._client)
294
253
        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
 
254
        if not medium._is_remote_before((1, 13)):
303
255
            try:
304
 
                response = self._call(verb, path)
 
256
                response = self._call('BzrDir.open_branchV2', path)
 
257
                if response[0] not in ('ref', 'branch'):
 
258
                    raise errors.UnexpectedSmartServerResponse(response)
 
259
                return response
305
260
            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'):
 
261
                medium._remember_remote_is_before((1, 13))
 
262
        response = self._call('BzrDir.open_branch', path)
 
263
        if response[0] != 'ok':
319
264
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
 
265
        if response[1] != '':
 
266
            return ('ref', response[1])
 
267
        else:
 
268
            return ('branch', '')
321
269
 
322
270
    def _get_tree_branch(self):
323
271
        """See BzrDir._get_tree_branch()."""
324
272
        return None, self.open_branch()
325
273
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
274
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
275
        if _unsupported:
329
276
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
277
        if self._next_open_branch_result is not None:
331
278
            # See create_branch for details.
336
283
        if response[0] == 'ref':
337
284
            # a branch reference, use the existing BranchReference logic.
338
285
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
286
            return format.open(self, _found=True, location=response[1],
 
287
                ignore_fallbacks=ignore_fallbacks)
341
288
        branch_format_name = response[1]
342
289
        if not branch_format_name:
343
290
            branch_format_name = None
344
291
        format = RemoteBranchFormat(network_name=branch_format_name)
345
292
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
 
293
            setup_stacking=not ignore_fallbacks)
347
294
 
348
295
    def _open_repo_v1(self, path):
349
296
        verb = 'BzrDir.find_repository'
410
357
        else:
411
358
            raise errors.NoRepositoryPresent(self)
412
359
 
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
360
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
361
        self._ensure_real()
 
362
        if self._real_bzrdir.has_workingtree():
421
363
            raise errors.NotLocalUrl(self.root_transport)
422
364
        else:
423
365
            raise errors.NoWorkingTree(self.root_transport.base)
426
368
        """Return the path to be used for this bzrdir in a remote call."""
427
369
        return client.remote_path_from_transport(self.root_transport)
428
370
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
371
    def get_branch_transport(self, branch_format):
430
372
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
373
        return self._real_bzrdir.get_branch_transport(branch_format)
432
374
 
433
375
    def get_repository_transport(self, repository_format):
434
376
        self._ensure_real()
486
428
        self._custom_format = None
487
429
        self._network_name = None
488
430
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
431
        self._supports_external_lookups = None
491
432
        self._supports_tree_reference = None
492
433
        self._rich_root_data = None
493
434
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
435
    @property
499
436
    def fast_deltas(self):
500
437
        self._ensure_real()
508
445
        return self._rich_root_data
509
446
 
510
447
    @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
448
    def supports_external_lookups(self):
519
449
        if self._supports_external_lookups is None:
520
450
            self._ensure_real()
621
551
        return self._custom_format._fetch_reconcile
622
552
 
623
553
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
554
        return 'bzr remote repository'
626
555
 
627
556
    def __eq__(self, other):
628
557
        return self.__class__ is other.__class__
629
558
 
 
559
    def check_conversion_target(self, target_format):
 
560
        if self.rich_root_data and not target_format.rich_root_data:
 
561
            raise errors.BadConversionTarget(
 
562
                'Does not support rich root data.', target_format)
 
563
        if (self.supports_tree_reference and
 
564
            not getattr(target_format, 'supports_tree_reference', False)):
 
565
            raise errors.BadConversionTarget(
 
566
                'Does not support nested trees', target_format)
 
567
 
630
568
    def network_name(self):
631
569
        if self._network_name:
632
570
            return self._network_name
644
582
        return self._custom_format._serializer
645
583
 
646
584
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
585
class RemoteRepository(_RpcHelper):
649
586
    """Repository accessed over rpc.
650
587
 
651
588
    For the moment most operations are performed using local transport-backed
694
631
        # Additional places to query for data.
695
632
        self._fallback_repositories = []
696
633
 
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
634
    def __str__(self):
709
635
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
636
 
893
819
            result.add(_mod_revision.NULL_REVISION)
894
820
        return result
895
821
 
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
822
    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
823
        return (self.__class__ is other.__class__ and
914
824
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
825
 
918
828
        parents_provider = self._make_parents_provider(other_repository)
919
829
        return graph.Graph(parents_provider)
920
830
 
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
831
    def gather_stats(self, revid=None, committers=None):
931
832
        """See Repository.gather_stats()."""
932
833
        path = self.bzrdir._path_for_remote_call(self._client)
992
893
    def is_write_locked(self):
993
894
        return self._lock_mode == 'w'
994
895
 
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
896
    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
897
        # wrong eventually - want a local lock cache context
1007
898
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
899
            self._lock_mode = 'r'
1010
900
            self._lock_count = 1
1011
901
            self._unstacked_provider.enable_cache(cache_misses=True)
1015
905
                repo.lock_read()
1016
906
        else:
1017
907
            self._lock_count += 1
1018
 
        return self
1019
908
 
1020
909
    def _remote_lock_write(self, token):
1021
910
        path = self.bzrdir._path_for_remote_call(self._client)
1032
921
 
1033
922
    def lock_write(self, token=None, _skip_rpc=False):
1034
923
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
924
            if _skip_rpc:
1037
925
                if self._lock_token is not None:
1038
926
                    if token != self._lock_token:
1061
949
            raise errors.ReadOnlyError(self)
1062
950
        else:
1063
951
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
952
        return self._lock_token or None
1065
953
 
1066
954
    def leave_lock_in_place(self):
1067
955
        if not self._lock_token:
1141
1029
        else:
1142
1030
            raise errors.UnexpectedSmartServerResponse(response)
1143
1031
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
1032
    def unlock(self):
1146
1033
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
1034
            raise errors.LockNotHeld(self)
1148
1035
        self._lock_count -= 1
1149
1036
        if self._lock_count > 0:
1150
1037
            return
1247
1134
            # state, so always add a lock here. If a caller passes us a locked
1248
1135
            # repository, they are responsible for unlocking it later.
1249
1136
            repository.lock_read()
1250
 
        self._check_fallback_repository(repository)
1251
1137
        self._fallback_repositories.append(repository)
1252
1138
        # If self._real_repository was parameterised already (e.g. because a
1253
1139
        # _real_branch had its get_stacked_on_url method called), then the
1254
1140
        # repository to be added may already be in the _real_repositories list.
1255
1141
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
 
1142
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1257
1143
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
1144
            if repository.bzrdir.root_transport.base not in fallback_locations:
1259
1145
                self._real_repository.add_fallback_repository(repository)
1260
1146
 
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
1147
    def add_inventory(self, revid, inv, parents):
1272
1148
        self._ensure_real()
1273
1149
        return self._real_repository.add_inventory(revid, inv, parents)
1274
1150
 
1275
1151
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
1152
                               parents):
1277
1153
        self._ensure_real()
1278
1154
        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)
 
1155
            delta, new_revision_id, parents)
1281
1156
 
1282
1157
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1158
        self._ensure_real()
1289
1164
        self._ensure_real()
1290
1165
        return self._real_repository.get_inventory(revision_id)
1291
1166
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1167
    def iter_inventories(self, revision_ids):
1293
1168
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1169
        return self._real_repository.iter_inventories(revision_ids)
1295
1170
 
1296
1171
    @needs_read_lock
1297
1172
    def get_revision(self, revision_id):
1361
1236
            raise errors.InternalBzrError(
1362
1237
                "May not fetch while in a write group.")
1363
1238
        # 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)):
 
1239
        if self.has_same_location(source) and fetch_spec is None:
1367
1240
            # check that last_revision is in 'from' and then return a
1368
1241
            # no-operation.
1369
1242
            if (revision_id is not None and
1542
1415
        return self._real_repository.get_signature_text(revision_id)
1543
1416
 
1544
1417
    @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)
 
1418
    def get_inventory_xml(self, revision_id):
 
1419
        self._ensure_real()
 
1420
        return self._real_repository.get_inventory_xml(revision_id)
 
1421
 
 
1422
    def deserialise_inventory(self, revision_id, xml):
 
1423
        self._ensure_real()
 
1424
        return self._real_repository.deserialise_inventory(revision_id, xml)
1548
1425
 
1549
1426
    def reconcile(self, other=None, thorough=False):
1550
1427
        self._ensure_real()
1577
1454
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1455
 
1579
1456
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1457
    def check(self, revision_ids=None):
1581
1458
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1459
        return self._real_repository.check(revision_ids=revision_ids)
1584
1460
 
1585
1461
    def copy_content_into(self, destination, revision_id=None):
1586
1462
        self._ensure_real()
1626
1502
        return self._real_repository.inventories
1627
1503
 
1628
1504
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1505
    def pack(self, hint=None):
1630
1506
        """Compress the data within the repository.
1631
1507
 
1632
1508
        This is not currently implemented within the smart server.
1633
1509
        """
1634
1510
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1511
        return self._real_repository.pack(hint=hint)
1636
1512
 
1637
1513
    @property
1638
1514
    def revisions(self):
1726
1602
        self._ensure_real()
1727
1603
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1604
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1605
    def _find_inconsistent_revision_parents(self):
1730
1606
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1607
        return self._real_repository._find_inconsistent_revision_parents()
1733
1608
 
1734
1609
    def _check_for_inconsistent_revision_parents(self):
1735
1610
        self._ensure_real()
1789
1664
    def insert_stream(self, stream, src_format, resume_tokens):
1790
1665
        target = self.target_repo
1791
1666
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
1667
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
 
1668
            verb = 'Repository.insert_stream_locked'
 
1669
            extra_args = (target._lock_token or '',)
 
1670
            required_version = (1, 14)
1796
1671
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
 
1672
            verb = 'Repository.insert_stream'
 
1673
            extra_args = ()
 
1674
            required_version = (1, 13)
1799
1675
        client = target._client
1800
1676
        medium = client._medium
 
1677
        if medium._is_remote_before(required_version):
 
1678
            # No possible way this can work.
 
1679
            return self._insert_real(stream, src_format, resume_tokens)
1801
1680
        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
 
1681
        if not resume_tokens:
 
1682
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1683
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1684
            # fallback to the _real_repositories sink *with a partial stream*.
 
1685
            # Thats bad because we insert less data than bzr expected. To avoid
 
1686
            # this we do a trial push to make sure the verb is accessible, and
 
1687
            # do not fallback when actually pushing the stream. A cleanup patch
 
1688
            # is going to look at rewinding/restarting the stream/partial
 
1689
            # buffering etc.
1815
1690
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
1691
            try:
1817
1692
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1693
                    (verb, path, '') + extra_args, byte_stream)
1819
1694
            except errors.UnknownSmartMethod:
1820
1695
                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)
 
1696
                return self._insert_real(stream, src_format, resume_tokens)
1835
1697
        byte_stream = smart_repo._stream_to_byte_stream(
1836
1698
            stream, src_format)
1837
1699
        resume_tokens = ' '.join(resume_tokens)
1838
1700
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1701
            (verb, path, resume_tokens) + extra_args, byte_stream)
1840
1702
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1703
            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
1704
        if response[0][0] == 'missing-basis':
1849
1705
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1706
            resume_tokens = tokens
1853
1709
            self.target_repo.refresh_data()
1854
1710
            return [], set()
1855
1711
 
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
1712
 
1897
1713
class RemoteStreamSource(repository.StreamSource):
1898
1714
    """Stream data from a remote server."""
1901
1717
        if (self.from_repository._fallback_repositories and
1902
1718
            self.to_format._fetch_order == 'topological'):
1903
1719
            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)
 
1720
        return self.missing_parents_chain(search, [self.from_repository] +
 
1721
            self.from_repository._fallback_repositories)
1921
1722
 
1922
1723
    def _real_stream(self, repo, search):
1923
1724
        """Get a stream for search from repo.
1930
1731
        """
1931
1732
        source = repo._get_source(self.to_format)
1932
1733
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
 
1734
            return repository.StreamSource.get_stream(source, search)
1935
1735
        return source.get_stream(search)
1936
1736
 
1937
1737
    def _get_stream(self, repo, search):
1954
1754
            return self._real_stream(repo, search)
1955
1755
        client = repo._client
1956
1756
        medium = client._medium
 
1757
        if medium._is_remote_before((1, 13)):
 
1758
            # streaming was added in 1.13
 
1759
            return self._real_stream(repo, search)
1957
1760
        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:
 
1761
        try:
 
1762
            search_bytes = repo._serialise_search_result(search)
 
1763
            response = repo._call_with_body_bytes_expecting_body(
 
1764
                'Repository.get_stream',
 
1765
                (path, self.to_format.network_name()), search_bytes)
 
1766
            response_tuple, response_handler = response
 
1767
        except errors.UnknownSmartMethod:
 
1768
            medium._remember_remote_is_before((1,13))
1977
1769
            return self._real_stream(repo, search)
1978
1770
        if response_tuple[0] != 'ok':
1979
1771
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1991
1783
        :param search: The overall search to satisfy with streams.
1992
1784
        :param sources: A list of Repository objects to query.
1993
1785
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
 
1786
        self.serialiser = self.to_format._serializer
1995
1787
        self.seen_revs = set()
1996
1788
        self.referenced_revs = set()
1997
1789
        # If there are heads in the search, or the key count is > 0, we are not
2014
1806
    def missing_parents_rev_handler(self, substream):
2015
1807
        for content in substream:
2016
1808
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
 
1809
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2019
1810
            self.seen_revs.add(content.key[-1])
2020
1811
            self.referenced_revs.update(revision.parent_ids)
2021
1812
            yield content
2060
1851
                self._network_name)
2061
1852
 
2062
1853
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1854
        return 'Remote BZR Branch'
2065
1855
 
2066
1856
    def network_name(self):
2067
1857
        return self._network_name
2068
1858
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1859
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1860
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2072
1861
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1862
    def _vfs_initialize(self, a_bzrdir):
2074
1863
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1864
        # method is not available on the server.
2076
1865
        # self._custom_format is always set - the start of initialize ensures
2077
1866
        # that.
2078
1867
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1868
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1869
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1870
        else:
2083
1871
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1872
            result = self._custom_format.initialize(a_bzrdir)
2085
1873
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1874
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1875
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1876
        return result
2090
1877
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1878
    def initialize(self, a_bzrdir):
2092
1879
        # 1) get the network name to use.
2093
1880
        if self._custom_format:
2094
1881
            network_name = self._custom_format.network_name()
2100
1887
            network_name = reference_format.network_name()
2101
1888
        # Being asked to create on a non RemoteBzrDir:
2102
1889
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1890
            return self._vfs_initialize(a_bzrdir)
2104
1891
        medium = a_bzrdir._client._medium
2105
1892
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1893
            return self._vfs_initialize(a_bzrdir)
2107
1894
        # Creating on a remote bzr dir.
2108
1895
        # 2) try direct creation via RPC
2109
1896
        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
1897
        verb = 'BzrDir.create_branch'
2114
1898
        try:
2115
1899
            response = a_bzrdir._call(verb, path, network_name)
2116
1900
        except errors.UnknownSmartMethod:
2117
1901
            # Fallback - use vfs methods
2118
1902
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1903
            return self._vfs_initialize(a_bzrdir)
2120
1904
        if response[0] != 'ok':
2121
1905
            raise errors.UnexpectedSmartServerResponse(response)
2122
1906
        # Turn the response into a RemoteRepository object.
2130
1914
                a_bzrdir._client)
2131
1915
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1916
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1917
            format=format, setup_stacking=False)
2134
1918
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1919
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1920
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2156
1940
        return self._custom_format.supports_set_append_revisions_only()
2157
1941
 
2158
1942
 
2159
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1943
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1944
    """Branch stored on a server accessed by HPSS RPC.
2161
1945
 
2162
1946
    At the moment most operations are mapped down to simple file operations.
2163
1947
    """
2164
1948
 
2165
1949
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1950
        _client=None, format=None, setup_stacking=True):
2167
1951
        """Create a RemoteBranch instance.
2168
1952
 
2169
1953
        :param real_branch: An optional local implementation of the branch
2175
1959
        :param setup_stacking: If True make an RPC call to determine the
2176
1960
            stacked (or not) status of the branch. If False assume the branch
2177
1961
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1962
        """
2180
1963
        # We intentionally don't call the parent class's __init__, because it
2181
1964
        # will try to assign to self.tags, which is a property in this subclass.
2200
1983
            self._real_branch = None
2201
1984
        # Fill out expected attributes of branch for bzrlib API users.
2202
1985
        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
 
1986
        self.base = self.bzrdir.root_transport.base
2206
1987
        self._control_files = None
2207
1988
        self._lock_mode = None
2208
1989
        self._lock_token = None
2219
2000
                    self._real_branch._format.network_name()
2220
2001
        else:
2221
2002
            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
2003
        if not self._format._network_name:
2226
2004
            # Did not get from open_branchV2 - old server.
2227
2005
            self._ensure_real()
2272
2050
                raise AssertionError('smart server vfs must be enabled '
2273
2051
                    'to use vfs implementation')
2274
2052
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
2053
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
2054
            if self.repository._real_repository is None:
2278
2055
                # Give the remote repository the matching real repo.
2279
2056
                real_repo = self._real_branch.repository
2375
2152
            return self._vfs_get_tags_bytes()
2376
2153
        return response[0]
2377
2154
 
2378
 
    def _vfs_set_tags_bytes(self, bytes):
 
2155
    def _vfs_set_tags_bytes(self):
2379
2156
        self._ensure_real()
2380
 
        return self._real_branch._set_tags_bytes(bytes)
 
2157
        return self._real_branch._set_tags_bytes()
2381
2158
 
2382
2159
    def _set_tags_bytes(self, bytes):
2383
2160
        medium = self._client._medium
2384
2161
        if medium._is_remote_before((1, 18)):
2385
2162
            self._vfs_set_tags_bytes(bytes)
2386
 
            return
2387
2163
        try:
2388
2164
            args = (
2389
2165
                self._remote_path(), self._lock_token, self._repo_lock_token)
2394
2170
            self._vfs_set_tags_bytes(bytes)
2395
2171
 
2396
2172
    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
2173
        self.repository.lock_read()
2403
2174
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
2175
            self._lock_mode = 'r'
2406
2176
            self._lock_count = 1
2407
2177
            if self._real_branch is not None:
2408
2178
                self._real_branch.lock_read()
2409
2179
        else:
2410
2180
            self._lock_count += 1
2411
 
        return self
2412
2181
 
2413
2182
    def _remote_lock_write(self, token):
2414
2183
        if token is None:
2415
2184
            branch_token = repo_token = ''
2416
2185
        else:
2417
2186
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
2187
            repo_token = self.repository.lock_write()
2419
2188
            self.repository.unlock()
2420
2189
        err_context = {'token': token}
2421
2190
        response = self._call(
2428
2197
 
2429
2198
    def lock_write(self, token=None):
2430
2199
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
2200
            # Lock the branch and repo in one remote call.
2433
2201
            remote_tokens = self._remote_lock_write(token)
2434
2202
            self._lock_token, self._repo_lock_token = remote_tokens
2458
2226
            self._lock_count += 1
2459
2227
            # Re-lock the repository too.
2460
2228
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2229
        return self._lock_token or None
2462
2230
 
2463
2231
    def _unlock(self, branch_token, repo_token):
2464
2232
        err_context = {'token': str((branch_token, repo_token))}
2469
2237
            return
2470
2238
        raise errors.UnexpectedSmartServerResponse(response)
2471
2239
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
2240
    def unlock(self):
2474
2241
        try:
2475
2242
            self._lock_count -= 1
2515
2282
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
2283
        self._leave_lock = False
2517
2284
 
2518
 
    @needs_read_lock
2519
2285
    def get_rev_id(self, revno, history=None):
2520
2286
        if revno == 0:
2521
2287
            return _mod_revision.NULL_REVISION
2886
2652
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2653
                raise err
2888
2654
 
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':
 
2655
    if err.error_verb == 'NoSuchRevision':
2893
2656
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2657
    elif err.error_verb == 'nosuchrevision':
2895
2658
        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)
 
2659
    elif err.error_tuple == ('nobranch',):
 
2660
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2661
    elif err.error_verb == 'norepository':
2904
2662
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2663
    elif err.error_verb == 'LockContention':