/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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,
30
31
    revision,
31
32
    revision as _mod_revision,
 
33
    static_tuple,
32
34
    symbol_versioning,
33
35
)
34
36
from bzrlib.branch import BranchReferenceFormat
35
37
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
36
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
37
39
from bzrlib.errors import (
38
40
    NoSuchRevision,
39
41
    SmartProtocolError,
89
91
class RemoteBzrDir(BzrDir, _RpcHelper):
90
92
    """Control directory on a remote server, accessed via bzr:// or similar."""
91
93
 
92
 
    def __init__(self, transport, format, _client=None):
 
94
    def __init__(self, transport, format, _client=None, _force_probe=False):
93
95
        """Construct a RemoteBzrDir.
94
96
 
95
97
        :param _client: Private parameter for testing. Disables probing and the
99
101
        # this object holds a delegated bzrdir that uses file-level operations
100
102
        # to talk to the other side
101
103
        self._real_bzrdir = None
 
104
        self._has_working_tree = None
102
105
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
103
106
        # create_branch for details.
104
107
        self._next_open_branch_result = None
108
111
            self._client = client._SmartClient(medium)
109
112
        else:
110
113
            self._client = _client
111
 
            return
112
 
 
 
114
            if not _force_probe:
 
115
                return
 
116
 
 
117
        self._probe_bzrdir()
 
118
 
 
119
    def __repr__(self):
 
120
        return '%s(%r)' % (self.__class__.__name__, self._client)
 
121
 
 
122
    def _probe_bzrdir(self):
 
123
        medium = self._client._medium
113
124
        path = self._path_for_remote_call(self._client)
 
125
        if medium._is_remote_before((2, 1)):
 
126
            self._rpc_open(path)
 
127
            return
 
128
        try:
 
129
            self._rpc_open_2_1(path)
 
130
            return
 
131
        except errors.UnknownSmartMethod:
 
132
            medium._remember_remote_is_before((2, 1))
 
133
            self._rpc_open(path)
 
134
 
 
135
    def _rpc_open_2_1(self, path):
 
136
        response = self._call('BzrDir.open_2.1', path)
 
137
        if response == ('no',):
 
138
            raise errors.NotBranchError(path=self.root_transport.base)
 
139
        elif response[0] == 'yes':
 
140
            if response[1] == 'yes':
 
141
                self._has_working_tree = True
 
142
            elif response[1] == 'no':
 
143
                self._has_working_tree = False
 
144
            else:
 
145
                raise errors.UnexpectedSmartServerResponse(response)
 
146
        else:
 
147
            raise errors.UnexpectedSmartServerResponse(response)
 
148
 
 
149
    def _rpc_open(self, path):
114
150
        response = self._call('BzrDir.open', path)
115
151
        if response not in [('yes',), ('no',)]:
116
152
            raise errors.UnexpectedSmartServerResponse(response)
117
153
        if response == ('no',):
118
 
            raise errors.NotBranchError(path=transport.base)
 
154
            raise errors.NotBranchError(path=self.root_transport.base)
119
155
 
120
156
    def _ensure_real(self):
121
157
        """Ensure that there is a _real_bzrdir set.
123
159
        Used before calls to self._real_bzrdir.
124
160
        """
125
161
        if not self._real_bzrdir:
 
162
            if 'hpssvfs' in debug.debug_flags:
 
163
                import traceback
 
164
                warning('VFS BzrDir access triggered\n%s',
 
165
                    ''.join(traceback.format_stack()))
126
166
            self._real_bzrdir = BzrDir.open_from_transport(
127
167
                self.root_transport, _server_formats=False)
128
168
            self._format._network_name = \
204
244
        self._ensure_real()
205
245
        self._real_bzrdir.destroy_repository()
206
246
 
207
 
    def create_branch(self):
 
247
    def create_branch(self, name=None):
208
248
        # as per meta1 formats - just delegate to the format object which may
209
249
        # be parameterised.
210
 
        real_branch = self._format.get_branch_format().initialize(self)
 
250
        real_branch = self._format.get_branch_format().initialize(self,
 
251
            name=name)
211
252
        if not isinstance(real_branch, RemoteBranch):
212
 
            result = RemoteBranch(self, self.find_repository(), real_branch)
 
253
            result = RemoteBranch(self, self.find_repository(), real_branch,
 
254
                                  name=name)
213
255
        else:
214
256
            result = real_branch
215
257
        # BzrDir.clone_on_transport() uses the result of create_branch but does
221
263
        self._next_open_branch_result = result
222
264
        return result
223
265
 
224
 
    def destroy_branch(self):
 
266
    def destroy_branch(self, name=None):
225
267
        """See BzrDir.destroy_branch"""
226
268
        self._ensure_real()
227
 
        self._real_bzrdir.destroy_branch()
 
269
        self._real_bzrdir.destroy_branch(name=name)
228
270
        self._next_open_branch_result = None
229
271
 
230
272
    def create_workingtree(self, revision_id=None, from_branch=None):
249
291
    def _get_branch_reference(self):
250
292
        path = self._path_for_remote_call(self._client)
251
293
        medium = self._client._medium
252
 
        if not medium._is_remote_before((1, 13)):
 
294
        candidate_calls = [
 
295
            ('BzrDir.open_branchV3', (2, 1)),
 
296
            ('BzrDir.open_branchV2', (1, 13)),
 
297
            ('BzrDir.open_branch', None),
 
298
            ]
 
299
        for verb, required_version in candidate_calls:
 
300
            if required_version and medium._is_remote_before(required_version):
 
301
                continue
253
302
            try:
254
 
                response = self._call('BzrDir.open_branchV2', path)
255
 
                if response[0] not in ('ref', 'branch'):
256
 
                    raise errors.UnexpectedSmartServerResponse(response)
257
 
                return response
 
303
                response = self._call(verb, path)
258
304
            except errors.UnknownSmartMethod:
259
 
                medium._remember_remote_is_before((1, 13))
260
 
        response = self._call('BzrDir.open_branch', path)
261
 
        if response[0] != 'ok':
 
305
                if required_version is None:
 
306
                    raise
 
307
                medium._remember_remote_is_before(required_version)
 
308
            else:
 
309
                break
 
310
        if verb == 'BzrDir.open_branch':
 
311
            if response[0] != 'ok':
 
312
                raise errors.UnexpectedSmartServerResponse(response)
 
313
            if response[1] != '':
 
314
                return ('ref', response[1])
 
315
            else:
 
316
                return ('branch', '')
 
317
        if response[0] not in ('ref', 'branch'):
262
318
            raise errors.UnexpectedSmartServerResponse(response)
263
 
        if response[1] != '':
264
 
            return ('ref', response[1])
265
 
        else:
266
 
            return ('branch', '')
 
319
        return response
267
320
 
268
321
    def _get_tree_branch(self):
269
322
        """See BzrDir._get_tree_branch()."""
270
323
        return None, self.open_branch()
271
324
 
272
 
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
273
 
        if _unsupported:
 
325
    def open_branch(self, name=None, unsupported=False,
 
326
                    ignore_fallbacks=False):
 
327
        if unsupported:
274
328
            raise NotImplementedError('unsupported flag support not implemented yet.')
275
329
        if self._next_open_branch_result is not None:
276
330
            # See create_branch for details.
281
335
        if response[0] == 'ref':
282
336
            # a branch reference, use the existing BranchReference logic.
283
337
            format = BranchReferenceFormat()
284
 
            return format.open(self, _found=True, location=response[1],
285
 
                ignore_fallbacks=ignore_fallbacks)
 
338
            return format.open(self, name=name, _found=True,
 
339
                location=response[1], ignore_fallbacks=ignore_fallbacks)
286
340
        branch_format_name = response[1]
287
341
        if not branch_format_name:
288
342
            branch_format_name = None
289
343
        format = RemoteBranchFormat(network_name=branch_format_name)
290
344
        return RemoteBranch(self, self.find_repository(), format=format,
291
 
            setup_stacking=not ignore_fallbacks)
 
345
            setup_stacking=not ignore_fallbacks, name=name)
292
346
 
293
347
    def _open_repo_v1(self, path):
294
348
        verb = 'BzrDir.find_repository'
355
409
        else:
356
410
            raise errors.NoRepositoryPresent(self)
357
411
 
 
412
    def has_workingtree(self):
 
413
        if self._has_working_tree is None:
 
414
            self._ensure_real()
 
415
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
416
        return self._has_working_tree
 
417
 
358
418
    def open_workingtree(self, recommend_upgrade=True):
359
 
        self._ensure_real()
360
 
        if self._real_bzrdir.has_workingtree():
 
419
        if self.has_workingtree():
361
420
            raise errors.NotLocalUrl(self.root_transport)
362
421
        else:
363
422
            raise errors.NoWorkingTree(self.root_transport.base)
366
425
        """Return the path to be used for this bzrdir in a remote call."""
367
426
        return client.remote_path_from_transport(self.root_transport)
368
427
 
369
 
    def get_branch_transport(self, branch_format):
 
428
    def get_branch_transport(self, branch_format, name=None):
370
429
        self._ensure_real()
371
 
        return self._real_bzrdir.get_branch_transport(branch_format)
 
430
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
372
431
 
373
432
    def get_repository_transport(self, repository_format):
374
433
        self._ensure_real()
426
485
        self._custom_format = None
427
486
        self._network_name = None
428
487
        self._creating_bzrdir = None
 
488
        self._supports_chks = None
429
489
        self._supports_external_lookups = None
430
490
        self._supports_tree_reference = None
431
491
        self._rich_root_data = None
432
492
 
 
493
    def __repr__(self):
 
494
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
495
            self._network_name)
 
496
 
433
497
    @property
434
498
    def fast_deltas(self):
435
499
        self._ensure_real()
443
507
        return self._rich_root_data
444
508
 
445
509
    @property
 
510
    def supports_chks(self):
 
511
        if self._supports_chks is None:
 
512
            self._ensure_real()
 
513
            self._supports_chks = self._custom_format.supports_chks
 
514
        return self._supports_chks
 
515
 
 
516
    @property
446
517
    def supports_external_lookups(self):
447
518
        if self._supports_external_lookups is None:
448
519
            self._ensure_real()
549
620
        return self._custom_format._fetch_reconcile
550
621
 
551
622
    def get_format_description(self):
552
 
        return 'bzr remote repository'
 
623
        self._ensure_real()
 
624
        return 'Remote: ' + self._custom_format.get_format_description()
553
625
 
554
626
    def __eq__(self, other):
555
627
        return self.__class__ is other.__class__
556
628
 
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
 
 
566
629
    def network_name(self):
567
630
        if self._network_name:
568
631
            return self._network_name
580
643
        return self._custom_format._serializer
581
644
 
582
645
 
583
 
class RemoteRepository(_RpcHelper):
 
646
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
 
647
    bzrdir.ControlComponent):
584
648
    """Repository accessed over rpc.
585
649
 
586
650
    For the moment most operations are performed using local transport-backed
629
693
        # Additional places to query for data.
630
694
        self._fallback_repositories = []
631
695
 
 
696
    @property
 
697
    def user_transport(self):
 
698
        return self.bzrdir.user_transport
 
699
 
 
700
    @property
 
701
    def control_transport(self):
 
702
        # XXX: Normally you shouldn't directly get at the remote repository
 
703
        # transport, but I'm not sure it's worth making this method
 
704
        # optional -- mbp 2010-04-21
 
705
        return self.bzrdir.get_repository_transport(None)
 
706
        
632
707
    def __str__(self):
633
708
        return "%s(%s)" % (self.__class__.__name__, self.base)
634
709
 
842
917
        parents_provider = self._make_parents_provider(other_repository)
843
918
        return graph.Graph(parents_provider)
844
919
 
 
920
    @needs_read_lock
 
921
    def get_known_graph_ancestry(self, revision_ids):
 
922
        """Return the known graph for a set of revision ids and their ancestors.
 
923
        """
 
924
        st = static_tuple.StaticTuple
 
925
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
 
926
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
 
927
        return graph.GraphThunkIdsToKeys(known_graph)
 
928
 
845
929
    def gather_stats(self, revid=None, committers=None):
846
930
        """See Repository.gather_stats()."""
847
931
        path = self.bzrdir._path_for_remote_call(self._client)
907
991
    def is_write_locked(self):
908
992
        return self._lock_mode == 'w'
909
993
 
 
994
    def _warn_if_deprecated(self, branch=None):
 
995
        # If we have a real repository, the check will be done there, if we
 
996
        # don't the check will be done remotely.
 
997
        pass
 
998
 
910
999
    def lock_read(self):
911
1000
        # wrong eventually - want a local lock cache context
912
1001
        if not self._lock_mode:
 
1002
            self._note_lock('r')
913
1003
            self._lock_mode = 'r'
914
1004
            self._lock_count = 1
915
1005
            self._unstacked_provider.enable_cache(cache_misses=True)
935
1025
 
936
1026
    def lock_write(self, token=None, _skip_rpc=False):
937
1027
        if not self._lock_mode:
 
1028
            self._note_lock('w')
938
1029
            if _skip_rpc:
939
1030
                if self._lock_token is not None:
940
1031
                    if token != self._lock_token:
1043
1134
        else:
1044
1135
            raise errors.UnexpectedSmartServerResponse(response)
1045
1136
 
 
1137
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1046
1138
    def unlock(self):
1047
1139
        if not self._lock_count:
1048
1140
            return lock.cant_unlock_not_held(self)
1148
1240
            # state, so always add a lock here. If a caller passes us a locked
1149
1241
            # repository, they are responsible for unlocking it later.
1150
1242
            repository.lock_read()
 
1243
        self._check_fallback_repository(repository)
1151
1244
        self._fallback_repositories.append(repository)
1152
1245
        # If self._real_repository was parameterised already (e.g. because a
1153
1246
        # _real_branch had its get_stacked_on_url method called), then the
1154
1247
        # repository to be added may already be in the _real_repositories list.
1155
1248
        if self._real_repository is not None:
1156
 
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
 
1249
            fallback_locations = [repo.user_url for repo in
1157
1250
                self._real_repository._fallback_repositories]
1158
 
            if repository.bzrdir.root_transport.base not in fallback_locations:
 
1251
            if repository.user_url not in fallback_locations:
1159
1252
                self._real_repository.add_fallback_repository(repository)
1160
1253
 
 
1254
    def _check_fallback_repository(self, repository):
 
1255
        """Check that this repository can fallback to repository safely.
 
1256
 
 
1257
        Raise an error if not.
 
1258
 
 
1259
        :param repository: A repository to fallback to.
 
1260
        """
 
1261
        return _mod_repository.InterRepository._assert_same_model(
 
1262
            self, repository)
 
1263
 
1161
1264
    def add_inventory(self, revid, inv, parents):
1162
1265
        self._ensure_real()
1163
1266
        return self._real_repository.add_inventory(revid, inv, parents)
1164
1267
 
1165
1268
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1166
 
                               parents):
 
1269
            parents, basis_inv=None, propagate_caches=False):
1167
1270
        self._ensure_real()
1168
1271
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1169
 
            delta, new_revision_id, parents)
 
1272
            delta, new_revision_id, parents, basis_inv=basis_inv,
 
1273
            propagate_caches=propagate_caches)
1170
1274
 
1171
1275
    def add_revision(self, rev_id, rev, inv=None, config=None):
1172
1276
        self._ensure_real()
1178
1282
        self._ensure_real()
1179
1283
        return self._real_repository.get_inventory(revision_id)
1180
1284
 
1181
 
    def iter_inventories(self, revision_ids):
 
1285
    def iter_inventories(self, revision_ids, ordering=None):
1182
1286
        self._ensure_real()
1183
 
        return self._real_repository.iter_inventories(revision_ids)
 
1287
        return self._real_repository.iter_inventories(revision_ids, ordering)
1184
1288
 
1185
1289
    @needs_read_lock
1186
1290
    def get_revision(self, revision_id):
1431
1535
        return self._real_repository.get_signature_text(revision_id)
1432
1536
 
1433
1537
    @needs_read_lock
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)
 
1538
    def _get_inventory_xml(self, revision_id):
 
1539
        self._ensure_real()
 
1540
        return self._real_repository._get_inventory_xml(revision_id)
1441
1541
 
1442
1542
    def reconcile(self, other=None, thorough=False):
1443
1543
        self._ensure_real()
1470
1570
        return self._real_repository.get_revision_reconcile(revision_id)
1471
1571
 
1472
1572
    @needs_read_lock
1473
 
    def check(self, revision_ids=None):
 
1573
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1474
1574
        self._ensure_real()
1475
 
        return self._real_repository.check(revision_ids=revision_ids)
 
1575
        return self._real_repository.check(revision_ids=revision_ids,
 
1576
            callback_refs=callback_refs, check_repo=check_repo)
1476
1577
 
1477
1578
    def copy_content_into(self, destination, revision_id=None):
1478
1579
        self._ensure_real()
1518
1619
        return self._real_repository.inventories
1519
1620
 
1520
1621
    @needs_write_lock
1521
 
    def pack(self, hint=None):
 
1622
    def pack(self, hint=None, clean_obsolete_packs=False):
1522
1623
        """Compress the data within the repository.
1523
1624
 
1524
1625
        This is not currently implemented within the smart server.
1525
1626
        """
1526
1627
        self._ensure_real()
1527
 
        return self._real_repository.pack(hint=hint)
 
1628
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1528
1629
 
1529
1630
    @property
1530
1631
    def revisions(self):
1618
1719
        self._ensure_real()
1619
1720
        return self._real_repository.revision_graph_can_have_wrong_parents()
1620
1721
 
1621
 
    def _find_inconsistent_revision_parents(self):
 
1722
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1622
1723
        self._ensure_real()
1623
 
        return self._real_repository._find_inconsistent_revision_parents()
 
1724
        return self._real_repository._find_inconsistent_revision_parents(
 
1725
            revisions_iterator)
1624
1726
 
1625
1727
    def _check_for_inconsistent_revision_parents(self):
1626
1728
        self._ensure_real()
1680
1782
    def insert_stream(self, stream, src_format, resume_tokens):
1681
1783
        target = self.target_repo
1682
1784
        target._unstacked_provider.missing_keys.clear()
 
1785
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1683
1786
        if target._lock_token:
1684
 
            verb = 'Repository.insert_stream_locked'
1685
 
            extra_args = (target._lock_token or '',)
1686
 
            required_version = (1, 14)
 
1787
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
 
1788
            lock_args = (target._lock_token or '',)
1687
1789
        else:
1688
 
            verb = 'Repository.insert_stream'
1689
 
            extra_args = ()
1690
 
            required_version = (1, 13)
 
1790
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
 
1791
            lock_args = ()
1691
1792
        client = target._client
1692
1793
        medium = client._medium
1693
 
        if medium._is_remote_before(required_version):
1694
 
            # No possible way this can work.
1695
 
            return self._insert_real(stream, src_format, resume_tokens)
1696
1794
        path = target.bzrdir._path_for_remote_call(client)
1697
 
        if not resume_tokens:
1698
 
            # XXX: Ugly but important for correctness, *will* be fixed during
1699
 
            # 1.13 cycle. Pushing a stream that is interrupted results in a
1700
 
            # fallback to the _real_repositories sink *with a partial stream*.
1701
 
            # Thats bad because we insert less data than bzr expected. To avoid
1702
 
            # this we do a trial push to make sure the verb is accessible, and
1703
 
            # do not fallback when actually pushing the stream. A cleanup patch
1704
 
            # is going to look at rewinding/restarting the stream/partial
1705
 
            # buffering etc.
 
1795
        # Probe for the verb to use with an empty stream before sending the
 
1796
        # real stream to it.  We do this both to avoid the risk of sending a
 
1797
        # large request that is then rejected, and because we don't want to
 
1798
        # implement a way to buffer, rewind, or restart the stream.
 
1799
        found_verb = False
 
1800
        for verb, required_version in candidate_calls:
 
1801
            if medium._is_remote_before(required_version):
 
1802
                continue
 
1803
            if resume_tokens:
 
1804
                # We've already done the probing (and set _is_remote_before) on
 
1805
                # a previous insert.
 
1806
                found_verb = True
 
1807
                break
1706
1808
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1707
1809
            try:
1708
1810
                response = client.call_with_body_stream(
1709
 
                    (verb, path, '') + extra_args, byte_stream)
 
1811
                    (verb, path, '') + lock_args, byte_stream)
1710
1812
            except errors.UnknownSmartMethod:
1711
1813
                medium._remember_remote_is_before(required_version)
1712
 
                return self._insert_real(stream, src_format, resume_tokens)
 
1814
            else:
 
1815
                found_verb = True
 
1816
                break
 
1817
        if not found_verb:
 
1818
            # Have to use VFS.
 
1819
            return self._insert_real(stream, src_format, resume_tokens)
 
1820
        self._last_inv_record = None
 
1821
        self._last_substream = None
 
1822
        if required_version < (1, 19):
 
1823
            # Remote side doesn't support inventory deltas.  Wrap the stream to
 
1824
            # make sure we don't send any.  If the stream contains inventory
 
1825
            # deltas we'll interrupt the smart insert_stream request and
 
1826
            # fallback to VFS.
 
1827
            stream = self._stop_stream_if_inventory_delta(stream)
1713
1828
        byte_stream = smart_repo._stream_to_byte_stream(
1714
1829
            stream, src_format)
1715
1830
        resume_tokens = ' '.join(resume_tokens)
1716
1831
        response = client.call_with_body_stream(
1717
 
            (verb, path, resume_tokens) + extra_args, byte_stream)
 
1832
            (verb, path, resume_tokens) + lock_args, byte_stream)
1718
1833
        if response[0][0] not in ('ok', 'missing-basis'):
1719
1834
            raise errors.UnexpectedSmartServerResponse(response)
 
1835
        if self._last_substream is not None:
 
1836
            # The stream included an inventory-delta record, but the remote
 
1837
            # side isn't new enough to support them.  So we need to send the
 
1838
            # rest of the stream via VFS.
 
1839
            self.target_repo.refresh_data()
 
1840
            return self._resume_stream_with_vfs(response, src_format)
1720
1841
        if response[0][0] == 'missing-basis':
1721
1842
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1722
1843
            resume_tokens = tokens
1725
1846
            self.target_repo.refresh_data()
1726
1847
            return [], set()
1727
1848
 
 
1849
    def _resume_stream_with_vfs(self, response, src_format):
 
1850
        """Resume sending a stream via VFS, first resending the record and
 
1851
        substream that couldn't be sent via an insert_stream verb.
 
1852
        """
 
1853
        if response[0][0] == 'missing-basis':
 
1854
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1855
            # Ignore missing_keys, we haven't finished inserting yet
 
1856
        else:
 
1857
            tokens = []
 
1858
        def resume_substream():
 
1859
            # Yield the substream that was interrupted.
 
1860
            for record in self._last_substream:
 
1861
                yield record
 
1862
            self._last_substream = None
 
1863
        def resume_stream():
 
1864
            # Finish sending the interrupted substream
 
1865
            yield ('inventory-deltas', resume_substream())
 
1866
            # Then simply continue sending the rest of the stream.
 
1867
            for substream_kind, substream in self._last_stream:
 
1868
                yield substream_kind, substream
 
1869
        return self._insert_real(resume_stream(), src_format, tokens)
 
1870
 
 
1871
    def _stop_stream_if_inventory_delta(self, stream):
 
1872
        """Normally this just lets the original stream pass-through unchanged.
 
1873
 
 
1874
        However if any 'inventory-deltas' substream occurs it will stop
 
1875
        streaming, and store the interrupted substream and stream in
 
1876
        self._last_substream and self._last_stream so that the stream can be
 
1877
        resumed by _resume_stream_with_vfs.
 
1878
        """
 
1879
                    
 
1880
        stream_iter = iter(stream)
 
1881
        for substream_kind, substream in stream_iter:
 
1882
            if substream_kind == 'inventory-deltas':
 
1883
                self._last_substream = substream
 
1884
                self._last_stream = stream_iter
 
1885
                return
 
1886
            else:
 
1887
                yield substream_kind, substream
 
1888
            
1728
1889
 
1729
1890
class RemoteStreamSource(repository.StreamSource):
1730
1891
    """Stream data from a remote server."""
1733
1894
        if (self.from_repository._fallback_repositories and
1734
1895
            self.to_format._fetch_order == 'topological'):
1735
1896
            return self._real_stream(self.from_repository, search)
1736
 
        return self.missing_parents_chain(search, [self.from_repository] +
1737
 
            self.from_repository._fallback_repositories)
 
1897
        sources = []
 
1898
        seen = set()
 
1899
        repos = [self.from_repository]
 
1900
        while repos:
 
1901
            repo = repos.pop(0)
 
1902
            if repo in seen:
 
1903
                continue
 
1904
            seen.add(repo)
 
1905
            repos.extend(repo._fallback_repositories)
 
1906
            sources.append(repo)
 
1907
        return self.missing_parents_chain(search, sources)
 
1908
 
 
1909
    def get_stream_for_missing_keys(self, missing_keys):
 
1910
        self.from_repository._ensure_real()
 
1911
        real_repo = self.from_repository._real_repository
 
1912
        real_source = real_repo._get_source(self.to_format)
 
1913
        return real_source.get_stream_for_missing_keys(missing_keys)
1738
1914
 
1739
1915
    def _real_stream(self, repo, search):
1740
1916
        """Get a stream for search from repo.
1747
1923
        """
1748
1924
        source = repo._get_source(self.to_format)
1749
1925
        if isinstance(source, RemoteStreamSource):
1750
 
            return repository.StreamSource.get_stream(source, search)
 
1926
            repo._ensure_real()
 
1927
            source = repo._real_repository._get_source(self.to_format)
1751
1928
        return source.get_stream(search)
1752
1929
 
1753
1930
    def _get_stream(self, repo, search):
1770
1947
            return self._real_stream(repo, search)
1771
1948
        client = repo._client
1772
1949
        medium = client._medium
1773
 
        if medium._is_remote_before((1, 13)):
1774
 
            # streaming was added in 1.13
1775
 
            return self._real_stream(repo, search)
1776
1950
        path = repo.bzrdir._path_for_remote_call(client)
1777
 
        try:
1778
 
            search_bytes = repo._serialise_search_result(search)
1779
 
            response = repo._call_with_body_bytes_expecting_body(
1780
 
                'Repository.get_stream',
1781
 
                (path, self.to_format.network_name()), search_bytes)
1782
 
            response_tuple, response_handler = response
1783
 
        except errors.UnknownSmartMethod:
1784
 
            medium._remember_remote_is_before((1,13))
 
1951
        search_bytes = repo._serialise_search_result(search)
 
1952
        args = (path, self.to_format.network_name())
 
1953
        candidate_verbs = [
 
1954
            ('Repository.get_stream_1.19', (1, 19)),
 
1955
            ('Repository.get_stream', (1, 13))]
 
1956
        found_verb = False
 
1957
        for verb, version in candidate_verbs:
 
1958
            if medium._is_remote_before(version):
 
1959
                continue
 
1960
            try:
 
1961
                response = repo._call_with_body_bytes_expecting_body(
 
1962
                    verb, args, search_bytes)
 
1963
            except errors.UnknownSmartMethod:
 
1964
                medium._remember_remote_is_before(version)
 
1965
            else:
 
1966
                response_tuple, response_handler = response
 
1967
                found_verb = True
 
1968
                break
 
1969
        if not found_verb:
1785
1970
            return self._real_stream(repo, search)
1786
1971
        if response_tuple[0] != 'ok':
1787
1972
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1799
1984
        :param search: The overall search to satisfy with streams.
1800
1985
        :param sources: A list of Repository objects to query.
1801
1986
        """
1802
 
        self.serialiser = self.to_format._serializer
 
1987
        self.from_serialiser = self.from_repository._format._serializer
1803
1988
        self.seen_revs = set()
1804
1989
        self.referenced_revs = set()
1805
1990
        # If there are heads in the search, or the key count is > 0, we are not
1822
2007
    def missing_parents_rev_handler(self, substream):
1823
2008
        for content in substream:
1824
2009
            revision_bytes = content.get_bytes_as('fulltext')
1825
 
            revision = self.serialiser.read_revision_from_string(revision_bytes)
 
2010
            revision = self.from_serialiser.read_revision_from_string(
 
2011
                revision_bytes)
1826
2012
            self.seen_revs.add(content.key[-1])
1827
2013
            self.referenced_revs.update(revision.parent_ids)
1828
2014
            yield content
1867
2053
                self._network_name)
1868
2054
 
1869
2055
    def get_format_description(self):
1870
 
        return 'Remote BZR Branch'
 
2056
        self._ensure_real()
 
2057
        return 'Remote: ' + self._custom_format.get_format_description()
1871
2058
 
1872
2059
    def network_name(self):
1873
2060
        return self._network_name
1874
2061
 
1875
 
    def open(self, a_bzrdir, ignore_fallbacks=False):
1876
 
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2062
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
 
2063
        return a_bzrdir.open_branch(name=name, 
 
2064
            ignore_fallbacks=ignore_fallbacks)
1877
2065
 
1878
 
    def _vfs_initialize(self, a_bzrdir):
 
2066
    def _vfs_initialize(self, a_bzrdir, name):
1879
2067
        # Initialisation when using a local bzrdir object, or a non-vfs init
1880
2068
        # method is not available on the server.
1881
2069
        # self._custom_format is always set - the start of initialize ensures
1882
2070
        # that.
1883
2071
        if isinstance(a_bzrdir, RemoteBzrDir):
1884
2072
            a_bzrdir._ensure_real()
1885
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
2073
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
 
2074
                name)
1886
2075
        else:
1887
2076
            # We assume the bzrdir is parameterised; it may not be.
1888
 
            result = self._custom_format.initialize(a_bzrdir)
 
2077
            result = self._custom_format.initialize(a_bzrdir, name)
1889
2078
        if (isinstance(a_bzrdir, RemoteBzrDir) and
1890
2079
            not isinstance(result, RemoteBranch)):
1891
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
2080
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
 
2081
                                  name=name)
1892
2082
        return result
1893
2083
 
1894
 
    def initialize(self, a_bzrdir):
 
2084
    def initialize(self, a_bzrdir, name=None):
1895
2085
        # 1) get the network name to use.
1896
2086
        if self._custom_format:
1897
2087
            network_name = self._custom_format.network_name()
1903
2093
            network_name = reference_format.network_name()
1904
2094
        # Being asked to create on a non RemoteBzrDir:
1905
2095
        if not isinstance(a_bzrdir, RemoteBzrDir):
1906
 
            return self._vfs_initialize(a_bzrdir)
 
2096
            return self._vfs_initialize(a_bzrdir, name=name)
1907
2097
        medium = a_bzrdir._client._medium
1908
2098
        if medium._is_remote_before((1, 13)):
1909
 
            return self._vfs_initialize(a_bzrdir)
 
2099
            return self._vfs_initialize(a_bzrdir, name=name)
1910
2100
        # Creating on a remote bzr dir.
1911
2101
        # 2) try direct creation via RPC
1912
2102
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
2103
        if name is not None:
 
2104
            # XXX JRV20100304: Support creating colocated branches
 
2105
            raise errors.NoColocatedBranchSupport(self)
1913
2106
        verb = 'BzrDir.create_branch'
1914
2107
        try:
1915
2108
            response = a_bzrdir._call(verb, path, network_name)
1916
2109
        except errors.UnknownSmartMethod:
1917
2110
            # Fallback - use vfs methods
1918
2111
            medium._remember_remote_is_before((1, 13))
1919
 
            return self._vfs_initialize(a_bzrdir)
 
2112
            return self._vfs_initialize(a_bzrdir, name=name)
1920
2113
        if response[0] != 'ok':
1921
2114
            raise errors.UnexpectedSmartServerResponse(response)
1922
2115
        # Turn the response into a RemoteRepository object.
1930
2123
                a_bzrdir._client)
1931
2124
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1932
2125
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1933
 
            format=format, setup_stacking=False)
 
2126
            format=format, setup_stacking=False, name=name)
1934
2127
        # XXX: We know this is a new branch, so it must have revno 0, revid
1935
2128
        # NULL_REVISION. Creating the branch locked would make this be unable
1936
2129
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1956
2149
        return self._custom_format.supports_set_append_revisions_only()
1957
2150
 
1958
2151
 
1959
 
class RemoteBranch(branch.Branch, _RpcHelper):
 
2152
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1960
2153
    """Branch stored on a server accessed by HPSS RPC.
1961
2154
 
1962
2155
    At the moment most operations are mapped down to simple file operations.
1963
2156
    """
1964
2157
 
1965
2158
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1966
 
        _client=None, format=None, setup_stacking=True):
 
2159
        _client=None, format=None, setup_stacking=True, name=None):
1967
2160
        """Create a RemoteBranch instance.
1968
2161
 
1969
2162
        :param real_branch: An optional local implementation of the branch
1975
2168
        :param setup_stacking: If True make an RPC call to determine the
1976
2169
            stacked (or not) status of the branch. If False assume the branch
1977
2170
            is not stacked.
 
2171
        :param name: Colocated branch name
1978
2172
        """
1979
2173
        # We intentionally don't call the parent class's __init__, because it
1980
2174
        # will try to assign to self.tags, which is a property in this subclass.
1999
2193
            self._real_branch = None
2000
2194
        # Fill out expected attributes of branch for bzrlib API users.
2001
2195
        self._clear_cached_state()
2002
 
        self.base = self.bzrdir.root_transport.base
 
2196
        # TODO: deprecate self.base in favor of user_url
 
2197
        self.base = self.bzrdir.user_url
 
2198
        self._name = name
2003
2199
        self._control_files = None
2004
2200
        self._lock_mode = None
2005
2201
        self._lock_token = None
2016
2212
                    self._real_branch._format.network_name()
2017
2213
        else:
2018
2214
            self._format = format
 
2215
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
 
2216
        # branch.open_branch method.
 
2217
        self._real_ignore_fallbacks = not setup_stacking
2019
2218
        if not self._format._network_name:
2020
2219
            # Did not get from open_branchV2 - old server.
2021
2220
            self._ensure_real()
2066
2265
                raise AssertionError('smart server vfs must be enabled '
2067
2266
                    'to use vfs implementation')
2068
2267
            self.bzrdir._ensure_real()
2069
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
2268
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
 
2269
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2070
2270
            if self.repository._real_repository is None:
2071
2271
                # Give the remote repository the matching real repo.
2072
2272
                real_repo = self._real_branch.repository
2176
2376
        medium = self._client._medium
2177
2377
        if medium._is_remote_before((1, 18)):
2178
2378
            self._vfs_set_tags_bytes(bytes)
 
2379
            return
2179
2380
        try:
2180
2381
            args = (
2181
2382
                self._remote_path(), self._lock_token, self._repo_lock_token)
2188
2389
    def lock_read(self):
2189
2390
        self.repository.lock_read()
2190
2391
        if not self._lock_mode:
 
2392
            self._note_lock('r')
2191
2393
            self._lock_mode = 'r'
2192
2394
            self._lock_count = 1
2193
2395
            if self._real_branch is not None:
2213
2415
 
2214
2416
    def lock_write(self, token=None):
2215
2417
        if not self._lock_mode:
 
2418
            self._note_lock('w')
2216
2419
            # Lock the branch and repo in one remote call.
2217
2420
            remote_tokens = self._remote_lock_write(token)
2218
2421
            self._lock_token, self._repo_lock_token = remote_tokens
2253
2456
            return
2254
2457
        raise errors.UnexpectedSmartServerResponse(response)
2255
2458
 
 
2459
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2256
2460
    def unlock(self):
2257
2461
        try:
2258
2462
            self._lock_count -= 1
2298
2502
            raise NotImplementedError(self.dont_leave_lock_in_place)
2299
2503
        self._leave_lock = False
2300
2504
 
 
2505
    @needs_read_lock
2301
2506
    def get_rev_id(self, revno, history=None):
2302
2507
        if revno == 0:
2303
2508
            return _mod_revision.NULL_REVISION
2668
2873
                    'Missing key %r in context %r', key_err.args[0], context)
2669
2874
                raise err
2670
2875
 
2671
 
    if err.error_verb == 'NoSuchRevision':
 
2876
    if err.error_verb == 'IncompatibleRepositories':
 
2877
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2878
            err.error_args[1], err.error_args[2])
 
2879
    elif err.error_verb == 'NoSuchRevision':
2672
2880
        raise NoSuchRevision(find('branch'), err.error_args[0])
2673
2881
    elif err.error_verb == 'nosuchrevision':
2674
2882
        raise NoSuchRevision(find('repository'), err.error_args[0])
2675
 
    elif err.error_tuple == ('nobranch',):
2676
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
2883
    elif err.error_verb == 'nobranch':
 
2884
        if len(err.error_args) >= 1:
 
2885
            extra = err.error_args[0]
 
2886
        else:
 
2887
            extra = None
 
2888
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
2889
            detail=extra)
2677
2890
    elif err.error_verb == 'norepository':
2678
2891
        raise errors.NoRepositoryPresent(find('bzrdir'))
2679
2892
    elif err.error_verb == 'LockContention':