/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Martin Pool
  • Date: 2009-08-06 05:20:04 UTC
  • mto: This revision was merged to the branch mainline in revision 4595.
  • Revision ID: mbp@sourcefrog.net-20090806052004-22edm2oradkpm0xk
bundle_info blackbox test passes on rich-root formats

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, 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
27
27
    lock,
28
28
    lockdir,
29
29
    repository,
30
 
    repository as _mod_repository,
31
30
    revision,
32
31
    revision as _mod_revision,
33
 
    static_tuple,
34
32
    symbol_versioning,
35
33
)
36
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
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, only_raises
 
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
37
from bzrlib.errors import (
40
38
    NoSuchRevision,
41
39
    SmartProtocolError,
43
41
from bzrlib.lockable_files import LockableFiles
44
42
from bzrlib.smart import client, vfs, repository as smart_repo
45
43
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
44
from bzrlib.trace import mutter, note, warning
48
45
 
49
46
 
92
89
class RemoteBzrDir(BzrDir, _RpcHelper):
93
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
91
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
92
    def __init__(self, transport, format, _client=None):
96
93
        """Construct a RemoteBzrDir.
97
94
 
98
95
        :param _client: Private parameter for testing. Disables probing and the
102
99
        # this object holds a delegated bzrdir that uses file-level operations
103
100
        # to talk to the other side
104
101
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
102
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
103
        # create_branch for details.
108
104
        self._next_open_branch_result = None
112
108
            self._client = client._SmartClient(medium)
113
109
        else:
114
110
            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
 
111
            return
 
112
 
125
113
        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
114
        response = self._call('BzrDir.open', path)
152
115
        if response not in [('yes',), ('no',)]:
153
116
            raise errors.UnexpectedSmartServerResponse(response)
154
117
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
118
            raise errors.NotBranchError(path=transport.base)
156
119
 
157
120
    def _ensure_real(self):
158
121
        """Ensure that there is a _real_bzrdir set.
160
123
        Used before calls to self._real_bzrdir.
161
124
        """
162
125
        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
126
            self._real_bzrdir = BzrDir.open_from_transport(
168
127
                self.root_transport, _server_formats=False)
169
128
            self._format._network_name = \
245
204
        self._ensure_real()
246
205
        self._real_bzrdir.destroy_repository()
247
206
 
248
 
    def create_branch(self, name=None):
 
207
    def create_branch(self):
249
208
        # as per meta1 formats - just delegate to the format object which may
250
209
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
210
        real_branch = self._format.get_branch_format().initialize(self)
253
211
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
212
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
213
        else:
257
214
            result = real_branch
258
215
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
221
        self._next_open_branch_result = result
265
222
        return result
266
223
 
267
 
    def destroy_branch(self, name=None):
 
224
    def destroy_branch(self):
268
225
        """See BzrDir.destroy_branch"""
269
226
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
227
        self._real_bzrdir.destroy_branch()
271
228
        self._next_open_branch_result = None
272
229
 
273
230
    def create_workingtree(self, revision_id=None, from_branch=None):
274
231
        raise errors.NotLocalUrl(self.transport.base)
275
232
 
276
 
    def find_branch_format(self, name=None):
 
233
    def find_branch_format(self):
277
234
        """Find the branch 'format' for this bzrdir.
278
235
 
279
236
        This might be a synthetic object for e.g. RemoteBranch and SVN.
280
237
        """
281
 
        b = self.open_branch(name=name)
 
238
        b = self.open_branch()
282
239
        return b._format
283
240
 
284
 
    def get_branch_reference(self, name=None):
 
241
    def get_branch_reference(self):
285
242
        """See BzrDir.get_branch_reference()."""
286
 
        if name is not None:
287
 
            # XXX JRV20100304: Support opening colocated branches
288
 
            raise errors.NoColocatedBranchSupport(self)
289
243
        response = self._get_branch_reference()
290
244
        if response[0] == 'ref':
291
245
            return response[1]
295
249
    def _get_branch_reference(self):
296
250
        path = self._path_for_remote_call(self._client)
297
251
        medium = self._client._medium
298
 
        candidate_calls = [
299
 
            ('BzrDir.open_branchV3', (2, 1)),
300
 
            ('BzrDir.open_branchV2', (1, 13)),
301
 
            ('BzrDir.open_branch', None),
302
 
            ]
303
 
        for verb, required_version in candidate_calls:
304
 
            if required_version and medium._is_remote_before(required_version):
305
 
                continue
 
252
        if not medium._is_remote_before((1, 13)):
306
253
            try:
307
 
                response = self._call(verb, path)
 
254
                response = self._call('BzrDir.open_branchV2', path)
 
255
                if response[0] not in ('ref', 'branch'):
 
256
                    raise errors.UnexpectedSmartServerResponse(response)
 
257
                return response
308
258
            except errors.UnknownSmartMethod:
309
 
                if required_version is None:
310
 
                    raise
311
 
                medium._remember_remote_is_before(required_version)
312
 
            else:
313
 
                break
314
 
        if verb == 'BzrDir.open_branch':
315
 
            if response[0] != 'ok':
316
 
                raise errors.UnexpectedSmartServerResponse(response)
317
 
            if response[1] != '':
318
 
                return ('ref', response[1])
319
 
            else:
320
 
                return ('branch', '')
321
 
        if response[0] not in ('ref', 'branch'):
 
259
                medium._remember_remote_is_before((1, 13))
 
260
        response = self._call('BzrDir.open_branch', path)
 
261
        if response[0] != 'ok':
322
262
            raise errors.UnexpectedSmartServerResponse(response)
323
 
        return response
 
263
        if response[1] != '':
 
264
            return ('ref', response[1])
 
265
        else:
 
266
            return ('branch', '')
324
267
 
325
 
    def _get_tree_branch(self, name=None):
 
268
    def _get_tree_branch(self):
326
269
        """See BzrDir._get_tree_branch()."""
327
 
        return None, self.open_branch(name=name)
 
270
        return None, self.open_branch()
328
271
 
329
 
    def open_branch(self, name=None, unsupported=False,
330
 
                    ignore_fallbacks=False):
331
 
        if unsupported:
 
272
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
273
        if _unsupported:
332
274
            raise NotImplementedError('unsupported flag support not implemented yet.')
333
275
        if self._next_open_branch_result is not None:
334
276
            # See create_branch for details.
339
281
        if response[0] == 'ref':
340
282
            # a branch reference, use the existing BranchReference logic.
341
283
            format = BranchReferenceFormat()
342
 
            return format.open(self, name=name, _found=True,
343
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
284
            return format.open(self, _found=True, location=response[1],
 
285
                ignore_fallbacks=ignore_fallbacks)
344
286
        branch_format_name = response[1]
345
287
        if not branch_format_name:
346
288
            branch_format_name = None
347
289
        format = RemoteBranchFormat(network_name=branch_format_name)
348
290
        return RemoteBranch(self, self.find_repository(), format=format,
349
 
            setup_stacking=not ignore_fallbacks, name=name)
 
291
            setup_stacking=not ignore_fallbacks)
350
292
 
351
293
    def _open_repo_v1(self, path):
352
294
        verb = 'BzrDir.find_repository'
413
355
        else:
414
356
            raise errors.NoRepositoryPresent(self)
415
357
 
416
 
    def has_workingtree(self):
417
 
        if self._has_working_tree is None:
418
 
            self._ensure_real()
419
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
420
 
        return self._has_working_tree
421
 
 
422
358
    def open_workingtree(self, recommend_upgrade=True):
423
 
        if self.has_workingtree():
 
359
        self._ensure_real()
 
360
        if self._real_bzrdir.has_workingtree():
424
361
            raise errors.NotLocalUrl(self.root_transport)
425
362
        else:
426
363
            raise errors.NoWorkingTree(self.root_transport.base)
429
366
        """Return the path to be used for this bzrdir in a remote call."""
430
367
        return client.remote_path_from_transport(self.root_transport)
431
368
 
432
 
    def get_branch_transport(self, branch_format, name=None):
 
369
    def get_branch_transport(self, branch_format):
433
370
        self._ensure_real()
434
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
371
        return self._real_bzrdir.get_branch_transport(branch_format)
435
372
 
436
373
    def get_repository_transport(self, repository_format):
437
374
        self._ensure_real()
489
426
        self._custom_format = None
490
427
        self._network_name = None
491
428
        self._creating_bzrdir = None
492
 
        self._supports_chks = None
493
429
        self._supports_external_lookups = None
494
430
        self._supports_tree_reference = None
495
431
        self._rich_root_data = None
496
432
 
497
 
    def __repr__(self):
498
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
499
 
            self._network_name)
500
 
 
501
433
    @property
502
434
    def fast_deltas(self):
503
435
        self._ensure_real()
511
443
        return self._rich_root_data
512
444
 
513
445
    @property
514
 
    def supports_chks(self):
515
 
        if self._supports_chks is None:
516
 
            self._ensure_real()
517
 
            self._supports_chks = self._custom_format.supports_chks
518
 
        return self._supports_chks
519
 
 
520
 
    @property
521
446
    def supports_external_lookups(self):
522
447
        if self._supports_external_lookups is None:
523
448
            self._ensure_real()
624
549
        return self._custom_format._fetch_reconcile
625
550
 
626
551
    def get_format_description(self):
627
 
        self._ensure_real()
628
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
552
        return 'bzr remote repository'
629
553
 
630
554
    def __eq__(self, other):
631
555
        return self.__class__ is other.__class__
632
556
 
 
557
    def check_conversion_target(self, target_format):
 
558
        if self.rich_root_data and not target_format.rich_root_data:
 
559
            raise errors.BadConversionTarget(
 
560
                'Does not support rich root data.', target_format)
 
561
        if (self.supports_tree_reference and
 
562
            not getattr(target_format, 'supports_tree_reference', False)):
 
563
            raise errors.BadConversionTarget(
 
564
                'Does not support nested trees', target_format)
 
565
 
633
566
    def network_name(self):
634
567
        if self._network_name:
635
568
            return self._network_name
647
580
        return self._custom_format._serializer
648
581
 
649
582
 
650
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
651
 
    bzrdir.ControlComponent):
 
583
class RemoteRepository(_RpcHelper):
652
584
    """Repository accessed over rpc.
653
585
 
654
586
    For the moment most operations are performed using local transport-backed
697
629
        # Additional places to query for data.
698
630
        self._fallback_repositories = []
699
631
 
700
 
    @property
701
 
    def user_transport(self):
702
 
        return self.bzrdir.user_transport
703
 
 
704
 
    @property
705
 
    def control_transport(self):
706
 
        # XXX: Normally you shouldn't directly get at the remote repository
707
 
        # transport, but I'm not sure it's worth making this method
708
 
        # optional -- mbp 2010-04-21
709
 
        return self.bzrdir.get_repository_transport(None)
710
 
        
711
632
    def __str__(self):
712
633
        return "%s(%s)" % (self.__class__.__name__, self.base)
713
634
 
921
842
        parents_provider = self._make_parents_provider(other_repository)
922
843
        return graph.Graph(parents_provider)
923
844
 
924
 
    @needs_read_lock
925
 
    def get_known_graph_ancestry(self, revision_ids):
926
 
        """Return the known graph for a set of revision ids and their ancestors.
927
 
        """
928
 
        st = static_tuple.StaticTuple
929
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
930
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
931
 
        return graph.GraphThunkIdsToKeys(known_graph)
932
 
 
933
845
    def gather_stats(self, revid=None, committers=None):
934
846
        """See Repository.gather_stats()."""
935
847
        path = self.bzrdir._path_for_remote_call(self._client)
995
907
    def is_write_locked(self):
996
908
        return self._lock_mode == 'w'
997
909
 
998
 
    def _warn_if_deprecated(self, branch=None):
999
 
        # If we have a real repository, the check will be done there, if we
1000
 
        # don't the check will be done remotely.
1001
 
        pass
1002
 
 
1003
910
    def lock_read(self):
1004
 
        """Lock the repository for read operations.
1005
 
 
1006
 
        :return: A bzrlib.lock.LogicalLockResult.
1007
 
        """
1008
911
        # wrong eventually - want a local lock cache context
1009
912
        if not self._lock_mode:
1010
 
            self._note_lock('r')
1011
913
            self._lock_mode = 'r'
1012
914
            self._lock_count = 1
1013
915
            self._unstacked_provider.enable_cache(cache_misses=True)
1017
919
                repo.lock_read()
1018
920
        else:
1019
921
            self._lock_count += 1
1020
 
        return lock.LogicalLockResult(self.unlock)
1021
922
 
1022
923
    def _remote_lock_write(self, token):
1023
924
        path = self.bzrdir._path_for_remote_call(self._client)
1034
935
 
1035
936
    def lock_write(self, token=None, _skip_rpc=False):
1036
937
        if not self._lock_mode:
1037
 
            self._note_lock('w')
1038
938
            if _skip_rpc:
1039
939
                if self._lock_token is not None:
1040
940
                    if token != self._lock_token:
1063
963
            raise errors.ReadOnlyError(self)
1064
964
        else:
1065
965
            self._lock_count += 1
1066
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
966
        return self._lock_token or None
1067
967
 
1068
968
    def leave_lock_in_place(self):
1069
969
        if not self._lock_token:
1143
1043
        else:
1144
1044
            raise errors.UnexpectedSmartServerResponse(response)
1145
1045
 
1146
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1147
1046
    def unlock(self):
1148
1047
        if not self._lock_count:
1149
1048
            return lock.cant_unlock_not_held(self)
1249
1148
            # state, so always add a lock here. If a caller passes us a locked
1250
1149
            # repository, they are responsible for unlocking it later.
1251
1150
            repository.lock_read()
1252
 
        self._check_fallback_repository(repository)
1253
1151
        self._fallback_repositories.append(repository)
1254
1152
        # If self._real_repository was parameterised already (e.g. because a
1255
1153
        # _real_branch had its get_stacked_on_url method called), then the
1256
1154
        # repository to be added may already be in the _real_repositories list.
1257
1155
        if self._real_repository is not None:
1258
 
            fallback_locations = [repo.user_url for repo in
 
1156
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1259
1157
                self._real_repository._fallback_repositories]
1260
 
            if repository.user_url not in fallback_locations:
 
1158
            if repository.bzrdir.root_transport.base not in fallback_locations:
1261
1159
                self._real_repository.add_fallback_repository(repository)
1262
1160
 
1263
 
    def _check_fallback_repository(self, repository):
1264
 
        """Check that this repository can fallback to repository safely.
1265
 
 
1266
 
        Raise an error if not.
1267
 
 
1268
 
        :param repository: A repository to fallback to.
1269
 
        """
1270
 
        return _mod_repository.InterRepository._assert_same_model(
1271
 
            self, repository)
1272
 
 
1273
1161
    def add_inventory(self, revid, inv, parents):
1274
1162
        self._ensure_real()
1275
1163
        return self._real_repository.add_inventory(revid, inv, parents)
1276
1164
 
1277
1165
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1278
 
            parents, basis_inv=None, propagate_caches=False):
 
1166
                               parents):
1279
1167
        self._ensure_real()
1280
1168
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1281
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1282
 
            propagate_caches=propagate_caches)
 
1169
            delta, new_revision_id, parents)
1283
1170
 
1284
1171
    def add_revision(self, rev_id, rev, inv=None, config=None):
1285
1172
        self._ensure_real()
1291
1178
        self._ensure_real()
1292
1179
        return self._real_repository.get_inventory(revision_id)
1293
1180
 
1294
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1181
    def iter_inventories(self, revision_ids):
1295
1182
        self._ensure_real()
1296
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1183
        return self._real_repository.iter_inventories(revision_ids)
1297
1184
 
1298
1185
    @needs_read_lock
1299
1186
    def get_revision(self, revision_id):
1315
1202
        return self._real_repository.make_working_trees()
1316
1203
 
1317
1204
    def refresh_data(self):
1318
 
        """Re-read any data needed to synchronise with disk.
 
1205
        """Re-read any data needed to to synchronise with disk.
1319
1206
 
1320
1207
        This method is intended to be called after another repository instance
1321
1208
        (such as one used by a smart server) has inserted data into the
1322
 
        repository. On all repositories this will work outside of write groups.
1323
 
        Some repository formats (pack and newer for bzrlib native formats)
1324
 
        support refresh_data inside write groups. If called inside a write
1325
 
        group on a repository that does not support refreshing in a write group
1326
 
        IsInWriteGroupError will be raised.
 
1209
        repository. It may not be called during a write group, but may be
 
1210
        called at any other time.
1327
1211
        """
 
1212
        if self.is_in_write_group():
 
1213
            raise errors.InternalBzrError(
 
1214
                "May not refresh_data while in a write group.")
1328
1215
        if self._real_repository is not None:
1329
1216
            self._real_repository.refresh_data()
1330
1217
 
1544
1431
        return self._real_repository.get_signature_text(revision_id)
1545
1432
 
1546
1433
    @needs_read_lock
1547
 
    def _get_inventory_xml(self, revision_id):
1548
 
        self._ensure_real()
1549
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1434
    def get_inventory_xml(self, revision_id):
 
1435
        self._ensure_real()
 
1436
        return self._real_repository.get_inventory_xml(revision_id)
 
1437
 
 
1438
    def deserialise_inventory(self, revision_id, xml):
 
1439
        self._ensure_real()
 
1440
        return self._real_repository.deserialise_inventory(revision_id, xml)
1550
1441
 
1551
1442
    def reconcile(self, other=None, thorough=False):
1552
1443
        self._ensure_real()
1628
1519
        return self._real_repository.inventories
1629
1520
 
1630
1521
    @needs_write_lock
1631
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1522
    def pack(self, hint=None):
1632
1523
        """Compress the data within the repository.
1633
1524
 
1634
1525
        This is not currently implemented within the smart server.
1635
1526
        """
1636
1527
        self._ensure_real()
1637
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1528
        return self._real_repository.pack(hint=hint)
1638
1529
 
1639
1530
    @property
1640
1531
    def revisions(self):
1791
1682
    def insert_stream(self, stream, src_format, resume_tokens):
1792
1683
        target = self.target_repo
1793
1684
        target._unstacked_provider.missing_keys.clear()
1794
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1795
1685
        if target._lock_token:
1796
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1797
 
            lock_args = (target._lock_token or '',)
 
1686
            verb = 'Repository.insert_stream_locked'
 
1687
            extra_args = (target._lock_token or '',)
 
1688
            required_version = (1, 14)
1798
1689
        else:
1799
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1800
 
            lock_args = ()
 
1690
            verb = 'Repository.insert_stream'
 
1691
            extra_args = ()
 
1692
            required_version = (1, 13)
1801
1693
        client = target._client
1802
1694
        medium = client._medium
 
1695
        if medium._is_remote_before(required_version):
 
1696
            # No possible way this can work.
 
1697
            return self._insert_real(stream, src_format, resume_tokens)
1803
1698
        path = target.bzrdir._path_for_remote_call(client)
1804
 
        # Probe for the verb to use with an empty stream before sending the
1805
 
        # real stream to it.  We do this both to avoid the risk of sending a
1806
 
        # large request that is then rejected, and because we don't want to
1807
 
        # implement a way to buffer, rewind, or restart the stream.
1808
 
        found_verb = False
1809
 
        for verb, required_version in candidate_calls:
1810
 
            if medium._is_remote_before(required_version):
1811
 
                continue
1812
 
            if resume_tokens:
1813
 
                # We've already done the probing (and set _is_remote_before) on
1814
 
                # a previous insert.
1815
 
                found_verb = True
1816
 
                break
 
1699
        if not resume_tokens:
 
1700
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1701
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1702
            # fallback to the _real_repositories sink *with a partial stream*.
 
1703
            # Thats bad because we insert less data than bzr expected. To avoid
 
1704
            # this we do a trial push to make sure the verb is accessible, and
 
1705
            # do not fallback when actually pushing the stream. A cleanup patch
 
1706
            # is going to look at rewinding/restarting the stream/partial
 
1707
            # buffering etc.
1817
1708
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1818
1709
            try:
1819
1710
                response = client.call_with_body_stream(
1820
 
                    (verb, path, '') + lock_args, byte_stream)
 
1711
                    (verb, path, '') + extra_args, byte_stream)
1821
1712
            except errors.UnknownSmartMethod:
1822
1713
                medium._remember_remote_is_before(required_version)
1823
 
            else:
1824
 
                found_verb = True
1825
 
                break
1826
 
        if not found_verb:
1827
 
            # Have to use VFS.
1828
 
            return self._insert_real(stream, src_format, resume_tokens)
1829
 
        self._last_inv_record = None
1830
 
        self._last_substream = None
1831
 
        if required_version < (1, 19):
1832
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1833
 
            # make sure we don't send any.  If the stream contains inventory
1834
 
            # deltas we'll interrupt the smart insert_stream request and
1835
 
            # fallback to VFS.
1836
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1714
                return self._insert_real(stream, src_format, resume_tokens)
1837
1715
        byte_stream = smart_repo._stream_to_byte_stream(
1838
1716
            stream, src_format)
1839
1717
        resume_tokens = ' '.join(resume_tokens)
1840
1718
        response = client.call_with_body_stream(
1841
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1719
            (verb, path, resume_tokens) + extra_args, byte_stream)
1842
1720
        if response[0][0] not in ('ok', 'missing-basis'):
1843
1721
            raise errors.UnexpectedSmartServerResponse(response)
1844
 
        if self._last_substream is not None:
1845
 
            # The stream included an inventory-delta record, but the remote
1846
 
            # side isn't new enough to support them.  So we need to send the
1847
 
            # rest of the stream via VFS.
1848
 
            self.target_repo.refresh_data()
1849
 
            return self._resume_stream_with_vfs(response, src_format)
1850
1722
        if response[0][0] == 'missing-basis':
1851
1723
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1852
1724
            resume_tokens = tokens
1855
1727
            self.target_repo.refresh_data()
1856
1728
            return [], set()
1857
1729
 
1858
 
    def _resume_stream_with_vfs(self, response, src_format):
1859
 
        """Resume sending a stream via VFS, first resending the record and
1860
 
        substream that couldn't be sent via an insert_stream verb.
1861
 
        """
1862
 
        if response[0][0] == 'missing-basis':
1863
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1864
 
            # Ignore missing_keys, we haven't finished inserting yet
1865
 
        else:
1866
 
            tokens = []
1867
 
        def resume_substream():
1868
 
            # Yield the substream that was interrupted.
1869
 
            for record in self._last_substream:
1870
 
                yield record
1871
 
            self._last_substream = None
1872
 
        def resume_stream():
1873
 
            # Finish sending the interrupted substream
1874
 
            yield ('inventory-deltas', resume_substream())
1875
 
            # Then simply continue sending the rest of the stream.
1876
 
            for substream_kind, substream in self._last_stream:
1877
 
                yield substream_kind, substream
1878
 
        return self._insert_real(resume_stream(), src_format, tokens)
1879
 
 
1880
 
    def _stop_stream_if_inventory_delta(self, stream):
1881
 
        """Normally this just lets the original stream pass-through unchanged.
1882
 
 
1883
 
        However if any 'inventory-deltas' substream occurs it will stop
1884
 
        streaming, and store the interrupted substream and stream in
1885
 
        self._last_substream and self._last_stream so that the stream can be
1886
 
        resumed by _resume_stream_with_vfs.
1887
 
        """
1888
 
                    
1889
 
        stream_iter = iter(stream)
1890
 
        for substream_kind, substream in stream_iter:
1891
 
            if substream_kind == 'inventory-deltas':
1892
 
                self._last_substream = substream
1893
 
                self._last_stream = stream_iter
1894
 
                return
1895
 
            else:
1896
 
                yield substream_kind, substream
1897
 
            
1898
1730
 
1899
1731
class RemoteStreamSource(repository.StreamSource):
1900
1732
    """Stream data from a remote server."""
1915
1747
            sources.append(repo)
1916
1748
        return self.missing_parents_chain(search, sources)
1917
1749
 
1918
 
    def get_stream_for_missing_keys(self, missing_keys):
1919
 
        self.from_repository._ensure_real()
1920
 
        real_repo = self.from_repository._real_repository
1921
 
        real_source = real_repo._get_source(self.to_format)
1922
 
        return real_source.get_stream_for_missing_keys(missing_keys)
1923
 
 
1924
1750
    def _real_stream(self, repo, search):
1925
1751
        """Get a stream for search from repo.
1926
1752
        
1932
1758
        """
1933
1759
        source = repo._get_source(self.to_format)
1934
1760
        if isinstance(source, RemoteStreamSource):
1935
 
            repo._ensure_real()
1936
 
            source = repo._real_repository._get_source(self.to_format)
 
1761
            return repository.StreamSource.get_stream(source, search)
1937
1762
        return source.get_stream(search)
1938
1763
 
1939
1764
    def _get_stream(self, repo, search):
1956
1781
            return self._real_stream(repo, search)
1957
1782
        client = repo._client
1958
1783
        medium = client._medium
 
1784
        if medium._is_remote_before((1, 13)):
 
1785
            # streaming was added in 1.13
 
1786
            return self._real_stream(repo, search)
1959
1787
        path = repo.bzrdir._path_for_remote_call(client)
1960
 
        search_bytes = repo._serialise_search_result(search)
1961
 
        args = (path, self.to_format.network_name())
1962
 
        candidate_verbs = [
1963
 
            ('Repository.get_stream_1.19', (1, 19)),
1964
 
            ('Repository.get_stream', (1, 13))]
1965
 
        found_verb = False
1966
 
        for verb, version in candidate_verbs:
1967
 
            if medium._is_remote_before(version):
1968
 
                continue
1969
 
            try:
1970
 
                response = repo._call_with_body_bytes_expecting_body(
1971
 
                    verb, args, search_bytes)
1972
 
            except errors.UnknownSmartMethod:
1973
 
                medium._remember_remote_is_before(version)
1974
 
            else:
1975
 
                response_tuple, response_handler = response
1976
 
                found_verb = True
1977
 
                break
1978
 
        if not found_verb:
 
1788
        try:
 
1789
            search_bytes = repo._serialise_search_result(search)
 
1790
            response = repo._call_with_body_bytes_expecting_body(
 
1791
                'Repository.get_stream',
 
1792
                (path, self.to_format.network_name()), search_bytes)
 
1793
            response_tuple, response_handler = response
 
1794
        except errors.UnknownSmartMethod:
 
1795
            medium._remember_remote_is_before((1,13))
1979
1796
            return self._real_stream(repo, search)
1980
1797
        if response_tuple[0] != 'ok':
1981
1798
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1993
1810
        :param search: The overall search to satisfy with streams.
1994
1811
        :param sources: A list of Repository objects to query.
1995
1812
        """
1996
 
        self.from_serialiser = self.from_repository._format._serializer
 
1813
        self.serialiser = self.to_format._serializer
1997
1814
        self.seen_revs = set()
1998
1815
        self.referenced_revs = set()
1999
1816
        # If there are heads in the search, or the key count is > 0, we are not
2016
1833
    def missing_parents_rev_handler(self, substream):
2017
1834
        for content in substream:
2018
1835
            revision_bytes = content.get_bytes_as('fulltext')
2019
 
            revision = self.from_serialiser.read_revision_from_string(
2020
 
                revision_bytes)
 
1836
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2021
1837
            self.seen_revs.add(content.key[-1])
2022
1838
            self.referenced_revs.update(revision.parent_ids)
2023
1839
            yield content
2062
1878
                self._network_name)
2063
1879
 
2064
1880
    def get_format_description(self):
2065
 
        self._ensure_real()
2066
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1881
        return 'Remote BZR Branch'
2067
1882
 
2068
1883
    def network_name(self):
2069
1884
        return self._network_name
2070
1885
 
2071
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2072
 
        return a_bzrdir.open_branch(name=name, 
2073
 
            ignore_fallbacks=ignore_fallbacks)
 
1886
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1887
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2074
1888
 
2075
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1889
    def _vfs_initialize(self, a_bzrdir):
2076
1890
        # Initialisation when using a local bzrdir object, or a non-vfs init
2077
1891
        # method is not available on the server.
2078
1892
        # self._custom_format is always set - the start of initialize ensures
2079
1893
        # that.
2080
1894
        if isinstance(a_bzrdir, RemoteBzrDir):
2081
1895
            a_bzrdir._ensure_real()
2082
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2083
 
                name)
 
1896
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2084
1897
        else:
2085
1898
            # We assume the bzrdir is parameterised; it may not be.
2086
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1899
            result = self._custom_format.initialize(a_bzrdir)
2087
1900
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2088
1901
            not isinstance(result, RemoteBranch)):
2089
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2090
 
                                  name=name)
 
1902
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2091
1903
        return result
2092
1904
 
2093
 
    def initialize(self, a_bzrdir, name=None):
 
1905
    def initialize(self, a_bzrdir):
2094
1906
        # 1) get the network name to use.
2095
1907
        if self._custom_format:
2096
1908
            network_name = self._custom_format.network_name()
2102
1914
            network_name = reference_format.network_name()
2103
1915
        # Being asked to create on a non RemoteBzrDir:
2104
1916
        if not isinstance(a_bzrdir, RemoteBzrDir):
2105
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1917
            return self._vfs_initialize(a_bzrdir)
2106
1918
        medium = a_bzrdir._client._medium
2107
1919
        if medium._is_remote_before((1, 13)):
2108
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1920
            return self._vfs_initialize(a_bzrdir)
2109
1921
        # Creating on a remote bzr dir.
2110
1922
        # 2) try direct creation via RPC
2111
1923
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2112
 
        if name is not None:
2113
 
            # XXX JRV20100304: Support creating colocated branches
2114
 
            raise errors.NoColocatedBranchSupport(self)
2115
1924
        verb = 'BzrDir.create_branch'
2116
1925
        try:
2117
1926
            response = a_bzrdir._call(verb, path, network_name)
2118
1927
        except errors.UnknownSmartMethod:
2119
1928
            # Fallback - use vfs methods
2120
1929
            medium._remember_remote_is_before((1, 13))
2121
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1930
            return self._vfs_initialize(a_bzrdir)
2122
1931
        if response[0] != 'ok':
2123
1932
            raise errors.UnexpectedSmartServerResponse(response)
2124
1933
        # Turn the response into a RemoteRepository object.
2132
1941
                a_bzrdir._client)
2133
1942
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2134
1943
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2135
 
            format=format, setup_stacking=False, name=name)
 
1944
            format=format, setup_stacking=False)
2136
1945
        # XXX: We know this is a new branch, so it must have revno 0, revid
2137
1946
        # NULL_REVISION. Creating the branch locked would make this be unable
2138
1947
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2158
1967
        return self._custom_format.supports_set_append_revisions_only()
2159
1968
 
2160
1969
 
2161
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1970
class RemoteBranch(branch.Branch, _RpcHelper):
2162
1971
    """Branch stored on a server accessed by HPSS RPC.
2163
1972
 
2164
1973
    At the moment most operations are mapped down to simple file operations.
2165
1974
    """
2166
1975
 
2167
1976
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2168
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1977
        _client=None, format=None, setup_stacking=True):
2169
1978
        """Create a RemoteBranch instance.
2170
1979
 
2171
1980
        :param real_branch: An optional local implementation of the branch
2177
1986
        :param setup_stacking: If True make an RPC call to determine the
2178
1987
            stacked (or not) status of the branch. If False assume the branch
2179
1988
            is not stacked.
2180
 
        :param name: Colocated branch name
2181
1989
        """
2182
1990
        # We intentionally don't call the parent class's __init__, because it
2183
1991
        # will try to assign to self.tags, which is a property in this subclass.
2202
2010
            self._real_branch = None
2203
2011
        # Fill out expected attributes of branch for bzrlib API users.
2204
2012
        self._clear_cached_state()
2205
 
        # TODO: deprecate self.base in favor of user_url
2206
 
        self.base = self.bzrdir.user_url
2207
 
        self._name = name
 
2013
        self.base = self.bzrdir.root_transport.base
2208
2014
        self._control_files = None
2209
2015
        self._lock_mode = None
2210
2016
        self._lock_token = None
2221
2027
                    self._real_branch._format.network_name()
2222
2028
        else:
2223
2029
            self._format = format
2224
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2225
 
        # branch.open_branch method.
2226
 
        self._real_ignore_fallbacks = not setup_stacking
2227
2030
        if not self._format._network_name:
2228
2031
            # Did not get from open_branchV2 - old server.
2229
2032
            self._ensure_real()
2274
2077
                raise AssertionError('smart server vfs must be enabled '
2275
2078
                    'to use vfs implementation')
2276
2079
            self.bzrdir._ensure_real()
2277
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2278
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
2080
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2279
2081
            if self.repository._real_repository is None:
2280
2082
                # Give the remote repository the matching real repo.
2281
2083
                real_repo = self._real_branch.repository
2385
2187
        medium = self._client._medium
2386
2188
        if medium._is_remote_before((1, 18)):
2387
2189
            self._vfs_set_tags_bytes(bytes)
2388
 
            return
2389
2190
        try:
2390
2191
            args = (
2391
2192
                self._remote_path(), self._lock_token, self._repo_lock_token)
2396
2197
            self._vfs_set_tags_bytes(bytes)
2397
2198
 
2398
2199
    def lock_read(self):
2399
 
        """Lock the branch for read operations.
2400
 
 
2401
 
        :return: A bzrlib.lock.LogicalLockResult.
2402
 
        """
2403
2200
        self.repository.lock_read()
2404
2201
        if not self._lock_mode:
2405
 
            self._note_lock('r')
2406
2202
            self._lock_mode = 'r'
2407
2203
            self._lock_count = 1
2408
2204
            if self._real_branch is not None:
2409
2205
                self._real_branch.lock_read()
2410
2206
        else:
2411
2207
            self._lock_count += 1
2412
 
        return lock.LogicalLockResult(self.unlock)
2413
2208
 
2414
2209
    def _remote_lock_write(self, token):
2415
2210
        if token is None:
2416
2211
            branch_token = repo_token = ''
2417
2212
        else:
2418
2213
            branch_token = token
2419
 
            repo_token = self.repository.lock_write().repository_token
 
2214
            repo_token = self.repository.lock_write()
2420
2215
            self.repository.unlock()
2421
2216
        err_context = {'token': token}
2422
2217
        response = self._call(
2429
2224
 
2430
2225
    def lock_write(self, token=None):
2431
2226
        if not self._lock_mode:
2432
 
            self._note_lock('w')
2433
2227
            # Lock the branch and repo in one remote call.
2434
2228
            remote_tokens = self._remote_lock_write(token)
2435
2229
            self._lock_token, self._repo_lock_token = remote_tokens
2459
2253
            self._lock_count += 1
2460
2254
            # Re-lock the repository too.
2461
2255
            self.repository.lock_write(self._repo_lock_token)
2462
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2256
        return self._lock_token or None
2463
2257
 
2464
2258
    def _unlock(self, branch_token, repo_token):
2465
2259
        err_context = {'token': str((branch_token, repo_token))}
2470
2264
            return
2471
2265
        raise errors.UnexpectedSmartServerResponse(response)
2472
2266
 
2473
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2474
2267
    def unlock(self):
2475
2268
        try:
2476
2269
            self._lock_count -= 1
2516
2309
            raise NotImplementedError(self.dont_leave_lock_in_place)
2517
2310
        self._leave_lock = False
2518
2311
 
2519
 
    @needs_read_lock
2520
2312
    def get_rev_id(self, revno, history=None):
2521
2313
        if revno == 0:
2522
2314
            return _mod_revision.NULL_REVISION
2887
2679
                    'Missing key %r in context %r', key_err.args[0], context)
2888
2680
                raise err
2889
2681
 
2890
 
    if err.error_verb == 'IncompatibleRepositories':
2891
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2892
 
            err.error_args[1], err.error_args[2])
2893
 
    elif err.error_verb == 'NoSuchRevision':
 
2682
    if err.error_verb == 'NoSuchRevision':
2894
2683
        raise NoSuchRevision(find('branch'), err.error_args[0])
2895
2684
    elif err.error_verb == 'nosuchrevision':
2896
2685
        raise NoSuchRevision(find('repository'), err.error_args[0])
2897
 
    elif err.error_verb == 'nobranch':
2898
 
        if len(err.error_args) >= 1:
2899
 
            extra = err.error_args[0]
2900
 
        else:
2901
 
            extra = None
2902
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2903
 
            detail=extra)
 
2686
    elif err.error_tuple == ('nobranch',):
 
2687
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2904
2688
    elif err.error_verb == 'norepository':
2905
2689
        raise errors.NoRepositoryPresent(find('bzrdir'))
2906
2690
    elif err.error_verb == 'LockContention':