/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: Aaron Bentley
  • Date: 2009-03-09 04:36:37 UTC
  • mto: This revision was merged to the branch mainline in revision 4100.
  • Revision ID: aaron@aaronbentley.com-20090309043637-5aftkw7f2yyvcn13
Fix some formatting issues.

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
16
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
24
    bzrdir,
23
 
    config,
24
25
    debug,
25
26
    errors,
26
27
    graph,
27
 
    lock,
28
28
    lockdir,
 
29
    pack,
29
30
    repository,
30
 
    repository as _mod_repository,
31
31
    revision,
32
 
    revision as _mod_revision,
33
 
    static_tuple,
34
32
    symbol_versioning,
 
33
    urlutils,
35
34
)
36
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
35
from bzrlib.branch import BranchReferenceFormat
37
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
38
from bzrlib.errors import (
40
39
    NoSuchRevision,
41
40
    SmartProtocolError,
43
42
from bzrlib.lockable_files import LockableFiles
44
43
from bzrlib.smart import client, vfs, repository as smart_repo
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
48
47
 
49
48
 
50
49
class _RpcHelper(object):
62
61
        except errors.ErrorFromSmartServer, err:
63
62
            self._translate_error(err, **err_context)
64
63
 
65
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
66
 
        try:
67
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
68
 
        except errors.ErrorFromSmartServer, err:
69
 
            self._translate_error(err, **err_context)
70
 
 
71
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
65
                                             **err_context):
73
66
        try:
80
73
def response_tuple_to_repo_format(response):
81
74
    """Convert a response tuple describing a repository format to a format."""
82
75
    format = RemoteRepositoryFormat()
83
 
    format._rich_root_data = (response[0] == 'yes')
84
 
    format._supports_tree_reference = (response[1] == 'yes')
85
 
    format._supports_external_lookups = (response[2] == 'yes')
 
76
    format.rich_root_data = (response[0] == 'yes')
 
77
    format.supports_tree_reference = (response[1] == 'yes')
 
78
    format.supports_external_lookups = (response[2] == 'yes')
86
79
    format._network_name = response[3]
87
80
    return format
88
81
 
92
85
class RemoteBzrDir(BzrDir, _RpcHelper):
93
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
87
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
96
89
        """Construct a RemoteBzrDir.
97
90
 
98
91
        :param _client: Private parameter for testing. Disables probing and the
102
95
        # this object holds a delegated bzrdir that uses file-level operations
103
96
        # to talk to the other side
104
97
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
99
        # create_branch for details.
108
100
        self._next_open_branch_result = None
112
104
            self._client = client._SmartClient(medium)
113
105
        else:
114
106
            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
 
107
            return
 
108
 
125
109
        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
110
        response = self._call('BzrDir.open', path)
152
111
        if response not in [('yes',), ('no',)]:
153
112
            raise errors.UnexpectedSmartServerResponse(response)
154
113
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
156
115
 
157
116
    def _ensure_real(self):
158
117
        """Ensure that there is a _real_bzrdir set.
160
119
        Used before calls to self._real_bzrdir.
161
120
        """
162
121
        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
122
            self._real_bzrdir = BzrDir.open_from_transport(
168
123
                self.root_transport, _server_formats=False)
169
124
            self._format._network_name = \
196
151
        try:
197
152
            response = self._call(verb, path, stacking)
198
153
        except errors.UnknownSmartMethod:
199
 
            medium._remember_remote_is_before((1, 13))
200
154
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
201
 
        except errors.UnknownErrorFromSmartServer, err:
202
 
            if err.error_tuple != ('BranchReference',):
203
 
                raise
204
 
            # We need to resolve the branch reference to determine the
205
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
206
 
            # referenced branch (and bzrdir, etc) but only when the caller
207
 
            # didn't already resolve the branch reference.
208
 
            referenced_branch = self.open_branch()
209
 
            return referenced_branch.bzrdir.cloning_metadir()
210
155
        if len(response) != 3:
211
156
            raise errors.UnexpectedSmartServerResponse(response)
212
157
        control_name, repo_name, branch_info = response
245
190
        self._ensure_real()
246
191
        self._real_bzrdir.destroy_repository()
247
192
 
248
 
    def create_branch(self, name=None):
 
193
    def create_branch(self):
249
194
        # as per meta1 formats - just delegate to the format object which may
250
195
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
196
        real_branch = self._format.get_branch_format().initialize(self)
253
197
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
198
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
199
        else:
257
200
            result = real_branch
258
201
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
207
        self._next_open_branch_result = result
265
208
        return result
266
209
 
267
 
    def destroy_branch(self, name=None):
 
210
    def destroy_branch(self):
268
211
        """See BzrDir.destroy_branch"""
269
212
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
213
        self._real_bzrdir.destroy_branch()
271
214
        self._next_open_branch_result = None
272
215
 
273
216
    def create_workingtree(self, revision_id=None, from_branch=None):
292
235
    def _get_branch_reference(self):
293
236
        path = self._path_for_remote_call(self._client)
294
237
        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
 
238
        if not medium._is_remote_before((1, 13)):
303
239
            try:
304
 
                response = self._call(verb, path)
 
240
                response = self._call('BzrDir.open_branchV2', path)
 
241
                if response[0] not in ('ref', 'branch'):
 
242
                    raise errors.UnexpectedSmartServerResponse(response)
 
243
                return response
305
244
            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'):
 
245
                pass
 
246
        response = self._call('BzrDir.open_branch', path)
 
247
        if response[0] != 'ok':
319
248
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
 
249
        if response[1] != '':
 
250
            return ('ref', response[1])
 
251
        else:
 
252
            return ('branch', '')
321
253
 
322
254
    def _get_tree_branch(self):
323
255
        """See BzrDir._get_tree_branch()."""
324
256
        return None, self.open_branch()
325
257
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
258
    def open_branch(self, _unsupported=False):
 
259
        if _unsupported:
329
260
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
261
        if self._next_open_branch_result is not None:
331
262
            # See create_branch for details.
336
267
        if response[0] == 'ref':
337
268
            # a branch reference, use the existing BranchReference logic.
338
269
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
270
            return format.open(self, _found=True, location=response[1])
341
271
        branch_format_name = response[1]
342
272
        if not branch_format_name:
343
273
            branch_format_name = None
344
274
        format = RemoteBranchFormat(network_name=branch_format_name)
345
 
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
 
275
        return RemoteBranch(self, self.find_repository(), format=format)
347
276
 
348
277
    def _open_repo_v1(self, path):
349
278
        verb = 'BzrDir.find_repository'
372
301
        medium = self._client._medium
373
302
        if medium._is_remote_before((1, 13)):
374
303
            raise errors.UnknownSmartMethod(verb)
375
 
        try:
376
 
            response = self._call(verb, path)
377
 
        except errors.UnknownSmartMethod:
378
 
            medium._remember_remote_is_before((1, 13))
379
 
            raise
 
304
        response = self._call(verb, path)
380
305
        if response[0] != 'ok':
381
306
            raise errors.UnexpectedSmartServerResponse(response)
382
307
        return response, None
410
335
        else:
411
336
            raise errors.NoRepositoryPresent(self)
412
337
 
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
338
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
339
        self._ensure_real()
 
340
        if self._real_bzrdir.has_workingtree():
421
341
            raise errors.NotLocalUrl(self.root_transport)
422
342
        else:
423
343
            raise errors.NoWorkingTree(self.root_transport.base)
426
346
        """Return the path to be used for this bzrdir in a remote call."""
427
347
        return client.remote_path_from_transport(self.root_transport)
428
348
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
349
    def get_branch_transport(self, branch_format):
430
350
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
351
        return self._real_bzrdir.get_branch_transport(branch_format)
432
352
 
433
353
    def get_repository_transport(self, repository_format):
434
354
        self._ensure_real()
455
375
        return self._real_bzrdir.clone(url, revision_id=revision_id,
456
376
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
457
377
 
458
 
    def _get_config(self):
459
 
        return RemoteBzrDirConfig(self)
 
378
    def get_config(self):
 
379
        self._ensure_real()
 
380
        return self._real_bzrdir.get_config()
460
381
 
461
382
 
462
383
class RemoteRepositoryFormat(repository.RepositoryFormat):
486
407
        self._custom_format = None
487
408
        self._network_name = None
488
409
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
 
        self._supports_external_lookups = None
491
 
        self._supports_tree_reference = None
492
 
        self._rich_root_data = None
493
 
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
 
    @property
499
 
    def fast_deltas(self):
500
 
        self._ensure_real()
501
 
        return self._custom_format.fast_deltas
502
 
 
503
 
    @property
504
 
    def rich_root_data(self):
505
 
        if self._rich_root_data is None:
506
 
            self._ensure_real()
507
 
            self._rich_root_data = self._custom_format.rich_root_data
508
 
        return self._rich_root_data
509
 
 
510
 
    @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
 
    def supports_external_lookups(self):
519
 
        if self._supports_external_lookups is None:
520
 
            self._ensure_real()
521
 
            self._supports_external_lookups = \
522
 
                self._custom_format.supports_external_lookups
523
 
        return self._supports_external_lookups
524
 
 
525
 
    @property
526
 
    def supports_tree_reference(self):
527
 
        if self._supports_tree_reference is None:
528
 
            self._ensure_real()
529
 
            self._supports_tree_reference = \
530
 
                self._custom_format.supports_tree_reference
531
 
        return self._supports_tree_reference
532
410
 
533
411
    def _vfs_initialize(self, a_bzrdir, shared):
534
412
        """Helper for common code in initialize."""
566
444
        # 1) get the network name to use.
567
445
        if self._custom_format:
568
446
            network_name = self._custom_format.network_name()
569
 
        elif self._network_name:
570
 
            network_name = self._network_name
571
447
        else:
572
448
            # Select the current bzrlib default and ask for that.
573
449
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
584
460
            response = a_bzrdir._call(verb, path, network_name, shared_str)
585
461
        except errors.UnknownSmartMethod:
586
462
            # Fallback - use vfs methods
587
 
            medium._remember_remote_is_before((1, 13))
588
463
            return self._vfs_initialize(a_bzrdir, shared)
589
464
        else:
590
465
            # Turn the response into a RemoteRepository object.
621
496
        return self._custom_format._fetch_reconcile
622
497
 
623
498
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
499
        return 'bzr remote repository'
626
500
 
627
501
    def __eq__(self, other):
628
 
        return self.__class__ is other.__class__
 
502
        return self.__class__ == other.__class__
 
503
 
 
504
    def check_conversion_target(self, target_format):
 
505
        if self.rich_root_data and not target_format.rich_root_data:
 
506
            raise errors.BadConversionTarget(
 
507
                'Does not support rich root data.', target_format)
 
508
        if (self.supports_tree_reference and
 
509
            not getattr(target_format, 'supports_tree_reference', False)):
 
510
            raise errors.BadConversionTarget(
 
511
                'Does not support nested trees', target_format)
629
512
 
630
513
    def network_name(self):
631
514
        if self._network_name:
634
517
        return self._creating_repo._real_repository._format.network_name()
635
518
 
636
519
    @property
637
 
    def pack_compresses(self):
638
 
        self._ensure_real()
639
 
        return self._custom_format.pack_compresses
640
 
 
641
 
    @property
642
520
    def _serializer(self):
643
521
        self._ensure_real()
644
522
        return self._custom_format._serializer
645
523
 
646
524
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
525
class RemoteRepository(_RpcHelper):
649
526
    """Repository accessed over rpc.
650
527
 
651
528
    For the moment most operations are performed using local transport-backed
677
554
        self._lock_token = None
678
555
        self._lock_count = 0
679
556
        self._leave_lock = False
680
 
        # Cache of revision parents; misses are cached during read locks, and
681
 
        # write locks when no _real_repository has been set.
682
557
        self._unstacked_provider = graph.CachingParentsProvider(
683
558
            get_parent_map=self._get_parent_map_rpc)
684
559
        self._unstacked_provider.disable_cache()
694
569
        # Additional places to query for data.
695
570
        self._fallback_repositories = []
696
571
 
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
572
    def __str__(self):
709
573
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
574
 
713
577
    def abort_write_group(self, suppress_errors=False):
714
578
        """Complete a write group on the decorated repository.
715
579
 
716
 
        Smart methods perform operations in a single step so this API
 
580
        Smart methods peform operations in a single step so this api
717
581
        is not really applicable except as a compatibility thunk
718
582
        for older plugins that don't use e.g. the CommitBuilder
719
583
        facility.
724
588
        return self._real_repository.abort_write_group(
725
589
            suppress_errors=suppress_errors)
726
590
 
727
 
    @property
728
 
    def chk_bytes(self):
729
 
        """Decorate the real repository for now.
730
 
 
731
 
        In the long term a full blown network facility is needed to avoid
732
 
        creating a real repository object locally.
733
 
        """
734
 
        self._ensure_real()
735
 
        return self._real_repository.chk_bytes
736
 
 
737
591
    def commit_write_group(self):
738
592
        """Complete a write group on the decorated repository.
739
593
 
740
 
        Smart methods perform operations in a single step so this API
 
594
        Smart methods peform operations in a single step so this api
741
595
        is not really applicable except as a compatibility thunk
742
596
        for older plugins that don't use e.g. the CommitBuilder
743
597
        facility.
753
607
        self._ensure_real()
754
608
        return self._real_repository.suspend_write_group()
755
609
 
756
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
757
 
        self._ensure_real()
758
 
        return self._real_repository.get_missing_parent_inventories(
759
 
            check_for_missing_texts=check_for_missing_texts)
760
 
 
761
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
762
 
        self._ensure_real()
763
 
        return self._real_repository.get_rev_id_for_revno(
764
 
            revno, known_pair)
765
 
 
766
 
    def get_rev_id_for_revno(self, revno, known_pair):
767
 
        """See Repository.get_rev_id_for_revno."""
768
 
        path = self.bzrdir._path_for_remote_call(self._client)
769
 
        try:
770
 
            if self._client._medium._is_remote_before((1, 17)):
771
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
772
 
            response = self._call(
773
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
774
 
        except errors.UnknownSmartMethod:
775
 
            self._client._medium._remember_remote_is_before((1, 17))
776
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
777
 
        if response[0] == 'ok':
778
 
            return True, response[1]
779
 
        elif response[0] == 'history-incomplete':
780
 
            known_pair = response[1:3]
781
 
            for fallback in self._fallback_repositories:
782
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
783
 
                if found:
784
 
                    return True, result
785
 
                else:
786
 
                    known_pair = result
787
 
            # Not found in any fallbacks
788
 
            return False, known_pair
789
 
        else:
790
 
            raise errors.UnexpectedSmartServerResponse(response)
791
 
 
792
610
    def _ensure_real(self):
793
611
        """Ensure that there is a _real_repository set.
794
612
 
795
613
        Used before calls to self._real_repository.
796
 
 
797
 
        Note that _ensure_real causes many roundtrips to the server which are
798
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
799
 
        perform complex operations (such as accessing parent data, streaming
800
 
        revisions etc). Adding calls to _ensure_real should only be done when
801
 
        bringing up new functionality, adding fallbacks for smart methods that
802
 
        require a fallback path, and never to replace an existing smart method
803
 
        invocation. If in doubt chat to the bzr network team.
804
614
        """
805
615
        if self._real_repository is None:
806
 
            if 'hpssvfs' in debug.debug_flags:
807
 
                import traceback
808
 
                warning('VFS Repository access triggered\n%s',
809
 
                    ''.join(traceback.format_stack()))
810
 
            self._unstacked_provider.missing_keys.clear()
811
616
            self.bzrdir._ensure_real()
812
617
            self._set_real_repository(
813
618
                self.bzrdir._real_bzrdir.open_repository())
840
645
        self._ensure_real()
841
646
        return self._real_repository._generate_text_key_index()
842
647
 
 
648
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
649
    def get_revision_graph(self, revision_id=None):
 
650
        """See Repository.get_revision_graph()."""
 
651
        return self._get_revision_graph(revision_id)
 
652
 
843
653
    def _get_revision_graph(self, revision_id):
844
654
        """Private method for using with old (< 1.2) servers to fallback."""
845
655
        if revision_id is None:
873
683
        """Return a source for streaming from this repository."""
874
684
        return RemoteStreamSource(self, to_format)
875
685
 
876
 
    @needs_read_lock
877
686
    def has_revision(self, revision_id):
878
 
        """True if this repository has a copy of the revision."""
879
 
        # Copy of bzrlib.repository.Repository.has_revision
880
 
        return revision_id in self.has_revisions((revision_id,))
 
687
        """See Repository.has_revision()."""
 
688
        if revision_id == NULL_REVISION:
 
689
            # The null revision is always present.
 
690
            return True
 
691
        path = self.bzrdir._path_for_remote_call(self._client)
 
692
        response = self._call('Repository.has_revision', path, revision_id)
 
693
        if response[0] not in ('yes', 'no'):
 
694
            raise errors.UnexpectedSmartServerResponse(response)
 
695
        if response[0] == 'yes':
 
696
            return True
 
697
        for fallback_repo in self._fallback_repositories:
 
698
            if fallback_repo.has_revision(revision_id):
 
699
                return True
 
700
        return False
881
701
 
882
 
    @needs_read_lock
883
702
    def has_revisions(self, revision_ids):
884
 
        """Probe to find out the presence of multiple revisions.
885
 
 
886
 
        :param revision_ids: An iterable of revision_ids.
887
 
        :return: A set of the revision_ids that were present.
888
 
        """
889
 
        # Copy of bzrlib.repository.Repository.has_revisions
890
 
        parent_map = self.get_parent_map(revision_ids)
891
 
        result = set(parent_map)
892
 
        if _mod_revision.NULL_REVISION in revision_ids:
893
 
            result.add(_mod_revision.NULL_REVISION)
 
703
        """See Repository.has_revisions()."""
 
704
        # FIXME: This does many roundtrips, particularly when there are
 
705
        # fallback repositories.  -- mbp 20080905
 
706
        result = set()
 
707
        for revision_id in revision_ids:
 
708
            if self.has_revision(revision_id):
 
709
                result.add(revision_id)
894
710
        return result
895
711
 
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
712
    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
 
        return (self.__class__ is other.__class__ and
 
713
        return (self.__class__ == other.__class__ and
914
714
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
715
 
916
716
    def get_graph(self, other_repository=None):
918
718
        parents_provider = self._make_parents_provider(other_repository)
919
719
        return graph.Graph(parents_provider)
920
720
 
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
721
    def gather_stats(self, revid=None, committers=None):
931
722
        """See Repository.gather_stats()."""
932
723
        path = self.bzrdir._path_for_remote_call(self._client)
992
783
    def is_write_locked(self):
993
784
        return self._lock_mode == 'w'
994
785
 
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
786
    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
787
        # wrong eventually - want a local lock cache context
1007
788
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
789
            self._lock_mode = 'r'
1010
790
            self._lock_count = 1
1011
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
791
            self._unstacked_provider.enable_cache(cache_misses=False)
1012
792
            if self._real_repository is not None:
1013
793
                self._real_repository.lock_read()
1014
 
            for repo in self._fallback_repositories:
1015
 
                repo.lock_read()
1016
794
        else:
1017
795
            self._lock_count += 1
1018
 
        return self
1019
796
 
1020
797
    def _remote_lock_write(self, token):
1021
798
        path = self.bzrdir._path_for_remote_call(self._client)
1032
809
 
1033
810
    def lock_write(self, token=None, _skip_rpc=False):
1034
811
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
812
            if _skip_rpc:
1037
813
                if self._lock_token is not None:
1038
814
                    if token != self._lock_token:
1052
828
                self._leave_lock = False
1053
829
            self._lock_mode = 'w'
1054
830
            self._lock_count = 1
1055
 
            cache_misses = self._real_repository is None
1056
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1057
 
            for repo in self._fallback_repositories:
1058
 
                # Writes don't affect fallback repos
1059
 
                repo.lock_read()
 
831
            self._unstacked_provider.enable_cache(cache_misses=False)
1060
832
        elif self._lock_mode == 'r':
1061
833
            raise errors.ReadOnlyError(self)
1062
834
        else:
1063
835
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
836
        return self._lock_token or None
1065
837
 
1066
838
    def leave_lock_in_place(self):
1067
839
        if not self._lock_token:
1088
860
        if isinstance(repository, RemoteRepository):
1089
861
            raise AssertionError()
1090
862
        self._real_repository = repository
1091
 
        # three code paths happen here:
1092
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1093
 
        # up stacking. In this case self._fallback_repositories is [], and the
1094
 
        # real repo is already setup. Preserve the real repo and
1095
 
        # RemoteRepository.add_fallback_repository will avoid adding
1096
 
        # duplicates.
1097
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1098
 
        # ensure_real is triggered from a branch, the real repository to
1099
 
        # set already has a matching list with separate instances, but
1100
 
        # as they are also RemoteRepositories we don't worry about making the
1101
 
        # lists be identical.
1102
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1103
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1104
 
        # and need to populate it.
1105
 
        if (self._fallback_repositories and
1106
 
            len(self._real_repository._fallback_repositories) !=
1107
 
            len(self._fallback_repositories)):
1108
 
            if len(self._real_repository._fallback_repositories):
1109
 
                raise AssertionError(
1110
 
                    "cannot cleanly remove existing _fallback_repositories")
 
863
        # If the _real_repository has _fallback_repositories, clear them out,
 
864
        # because we want it to have the same set as this repository.  This is
 
865
        # reasonable to do because the fallbacks we clear here are from a
 
866
        # "real" branch, and we're about to replace them with the equivalents
 
867
        # from a RemoteBranch.
 
868
        self._real_repository._fallback_repositories = []
1111
869
        for fb in self._fallback_repositories:
1112
870
            self._real_repository.add_fallback_repository(fb)
1113
871
        if self._lock_mode == 'w':
1120
878
    def start_write_group(self):
1121
879
        """Start a write group on the decorated repository.
1122
880
 
1123
 
        Smart methods perform operations in a single step so this API
 
881
        Smart methods peform operations in a single step so this api
1124
882
        is not really applicable except as a compatibility thunk
1125
883
        for older plugins that don't use e.g. the CommitBuilder
1126
884
        facility.
1141
899
        else:
1142
900
            raise errors.UnexpectedSmartServerResponse(response)
1143
901
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
902
    def unlock(self):
1146
903
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
904
            raise errors.LockNotHeld(self)
1148
905
        self._lock_count -= 1
1149
906
        if self._lock_count > 0:
1150
907
            return
1164
921
            # problem releasing the vfs-based lock.
1165
922
            if old_mode == 'w':
1166
923
                # Only write-locked repositories need to make a remote method
1167
 
                # call to perform the unlock.
 
924
                # call to perfom the unlock.
1168
925
                old_token = self._lock_token
1169
926
                self._lock_token = None
1170
927
                if not self._leave_lock:
1171
928
                    self._unlock(old_token)
1172
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1173
 
        # self._leave_lock
1174
 
        for repo in self._fallback_repositories:
1175
 
            repo.unlock()
1176
929
 
1177
930
    def break_lock(self):
1178
931
        # should hand off to the network
1236
989
 
1237
990
        :param repository: A repository.
1238
991
        """
1239
 
        if not self._format.supports_external_lookups:
1240
 
            raise errors.UnstackableRepositoryFormat(
1241
 
                self._format.network_name(), self.base)
 
992
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
993
        # unconditionally - however, a _real_repository will usually exist,
 
994
        # and may raise an error if it's not accommodated by the underlying
 
995
        # format.  Eventually we should check when opening the repository
 
996
        # whether it's willing to allow them or not.
 
997
        #
1242
998
        # We need to accumulate additional repositories here, to pass them in
1243
999
        # on various RPC's.
1244
1000
        #
1245
 
        if self.is_locked():
1246
 
            # We will call fallback.unlock() when we transition to the unlocked
1247
 
            # state, so always add a lock here. If a caller passes us a locked
1248
 
            # repository, they are responsible for unlocking it later.
1249
 
            repository.lock_read()
1250
 
        self._check_fallback_repository(repository)
1251
1001
        self._fallback_repositories.append(repository)
1252
1002
        # If self._real_repository was parameterised already (e.g. because a
1253
1003
        # _real_branch had its get_stacked_on_url method called), then the
1254
1004
        # repository to be added may already be in the _real_repositories list.
1255
1005
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
1257
 
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
1006
            if repository not in self._real_repository._fallback_repositories:
1259
1007
                self._real_repository.add_fallback_repository(repository)
1260
 
 
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)
 
1008
        else:
 
1009
            # They are also seen by the fallback repository.  If it doesn't
 
1010
            # exist yet they'll be added then.  This implicitly copies them.
 
1011
            self._ensure_real()
1270
1012
 
1271
1013
    def add_inventory(self, revid, inv, parents):
1272
1014
        self._ensure_real()
1273
1015
        return self._real_repository.add_inventory(revid, inv, parents)
1274
1016
 
1275
1017
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
1018
                               parents):
1277
1019
        self._ensure_real()
1278
1020
        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)
 
1021
            delta, new_revision_id, parents)
1281
1022
 
1282
1023
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1024
        self._ensure_real()
1289
1030
        self._ensure_real()
1290
1031
        return self._real_repository.get_inventory(revision_id)
1291
1032
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1033
    def iter_inventories(self, revision_ids):
1293
1034
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1035
        return self._real_repository.iter_inventories(revision_ids)
1295
1036
 
1296
1037
    @needs_read_lock
1297
1038
    def get_revision(self, revision_id):
1312
1053
        self._ensure_real()
1313
1054
        return self._real_repository.make_working_trees()
1314
1055
 
1315
 
    def refresh_data(self):
1316
 
        """Re-read any data needed to to synchronise with disk.
1317
 
 
1318
 
        This method is intended to be called after another repository instance
1319
 
        (such as one used by a smart server) has inserted data into the
1320
 
        repository. It may not be called during a write group, but may be
1321
 
        called at any other time.
1322
 
        """
1323
 
        if self.is_in_write_group():
1324
 
            raise errors.InternalBzrError(
1325
 
                "May not refresh_data while in a write group.")
1326
 
        if self._real_repository is not None:
1327
 
            self._real_repository.refresh_data()
1328
 
 
1329
1056
    def revision_ids_to_search_result(self, result_set):
1330
1057
        """Convert a set of revision ids to a graph SearchResult."""
1331
1058
        result_parents = set()
1352
1079
 
1353
1080
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1354
1081
            fetch_spec=None):
1355
 
        # No base implementation to use as RemoteRepository is not a subclass
1356
 
        # of Repository; so this is a copy of Repository.fetch().
1357
1082
        if fetch_spec is not None and revision_id is not None:
1358
1083
            raise AssertionError(
1359
1084
                "fetch_spec and revision_id are mutually exclusive.")
1360
 
        if self.is_in_write_group():
1361
 
            raise errors.InternalBzrError(
1362
 
                "May not fetch while in a write group.")
1363
 
        # 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)):
 
1085
        # Not delegated to _real_repository so that InterRepository.get has a
 
1086
        # chance to find an InterRepository specialised for RemoteRepository.
 
1087
        if self.has_same_location(source) and fetch_spec is None:
1367
1088
            # check that last_revision is in 'from' and then return a
1368
1089
            # no-operation.
1369
1090
            if (revision_id is not None and
1370
1091
                not revision.is_null(revision_id)):
1371
1092
                self.get_revision(revision_id)
1372
1093
            return 0, []
1373
 
        # if there is no specific appropriate InterRepository, this will get
1374
 
        # the InterRepository base class, which raises an
1375
 
        # IncompatibleRepositories when asked to fetch.
1376
1094
        inter = repository.InterRepository.get(source, self)
1377
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1378
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1095
        try:
 
1096
            return inter.fetch(revision_id=revision_id, pb=pb,
 
1097
                    find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1098
        except NotImplementedError:
 
1099
            raise errors.IncompatibleRepositories(source, self)
1379
1100
 
1380
1101
    def create_bundle(self, target, base, fileobj, format=None):
1381
1102
        self._ensure_real()
1412
1133
            # We already found out that the server can't understand
1413
1134
            # Repository.get_parent_map requests, so just fetch the whole
1414
1135
            # graph.
1415
 
            #
1416
 
            # Note that this reads the whole graph, when only some keys are
1417
 
            # wanted.  On this old server there's no way (?) to get them all
1418
 
            # in one go, and the user probably will have seen a warning about
1419
 
            # the server being old anyhow.
1420
 
            rg = self._get_revision_graph(None)
1421
 
            # There is an API discrepancy between get_parent_map and
 
1136
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1137
            # :- its because we're working with a deprecated server anyway, and
 
1138
            # the user will almost certainly have seen a warning about the
 
1139
            # server version already.
 
1140
            rg = self.get_revision_graph()
 
1141
            # There is an api discrepency between get_parent_map and
1422
1142
            # get_revision_graph. Specifically, a "key:()" pair in
1423
1143
            # get_revision_graph just means a node has no parents. For
1424
1144
            # "get_parent_map" it means the node is a ghost. So fix up the
1454
1174
        # TODO: Manage this incrementally to avoid covering the same path
1455
1175
        # repeatedly. (The server will have to on each request, but the less
1456
1176
        # work done the better).
1457
 
        #
1458
 
        # Negative caching notes:
1459
 
        # new server sends missing when a request including the revid
1460
 
        # 'include-missing:' is present in the request.
1461
 
        # missing keys are serialised as missing:X, and we then call
1462
 
        # provider.note_missing(X) for-all X
1463
1177
        parents_map = self._unstacked_provider.get_cached_map()
1464
1178
        if parents_map is None:
1465
1179
            # Repository is not locked, so there's no cache.
1466
1180
            parents_map = {}
1467
 
        # start_set is all the keys in the cache
1468
1181
        start_set = set(parents_map)
1469
 
        # result set is all the references to keys in the cache
1470
1182
        result_parents = set()
1471
1183
        for parents in parents_map.itervalues():
1472
1184
            result_parents.update(parents)
1473
1185
        stop_keys = result_parents.difference(start_set)
1474
 
        # We don't need to send ghosts back to the server as a position to
1475
 
        # stop either.
1476
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1477
 
        key_count = len(parents_map)
1478
 
        if (NULL_REVISION in result_parents
1479
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1480
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1481
 
            # in our cache of "missing" keys we need to increment our key count
1482
 
            # by 1, because the reconsitituted SearchResult on the server will
1483
 
            # still consider NULL_REVISION to be an included key.
1484
 
            key_count += 1
1485
1186
        included_keys = start_set.intersection(result_parents)
1486
1187
        start_set.difference_update(included_keys)
1487
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1188
        recipe = (start_set, stop_keys, len(parents_map))
1488
1189
        body = self._serialise_search_recipe(recipe)
1489
1190
        path = self.bzrdir._path_for_remote_call(self._client)
1490
1191
        for key in keys:
1492
1193
                raise ValueError(
1493
1194
                    "key %r not a plain string" % (key,))
1494
1195
        verb = 'Repository.get_parent_map'
1495
 
        args = (path, 'include-missing:') + tuple(keys)
 
1196
        args = (path,) + tuple(keys)
1496
1197
        try:
1497
1198
            response = self._call_with_body_bytes_expecting_body(
1498
1199
                verb, args, body)
1508
1209
            # To avoid having to disconnect repeatedly, we keep track of the
1509
1210
            # fact the server doesn't understand remote methods added in 1.2.
1510
1211
            medium._remember_remote_is_before((1, 2))
1511
 
            # Recurse just once and we should use the fallback code.
1512
 
            return self._get_parent_map_rpc(keys)
 
1212
            return self.get_revision_graph(None)
1513
1213
        response_tuple, response_handler = response
1514
1214
        if response_tuple[0] not in ['ok']:
1515
1215
            response_handler.cancel_read_body()
1526
1226
                if len(d) > 1:
1527
1227
                    revision_graph[d[0]] = d[1:]
1528
1228
                else:
1529
 
                    # No parents:
1530
 
                    if d[0].startswith('missing:'):
1531
 
                        revid = d[0][8:]
1532
 
                        self._unstacked_provider.note_missing_key(revid)
1533
 
                    else:
1534
 
                        # no parents - so give the Graph result
1535
 
                        # (NULL_REVISION,).
1536
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
1229
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1230
                    revision_graph[d[0]] = (NULL_REVISION,)
1537
1231
            return revision_graph
1538
1232
 
1539
1233
    @needs_read_lock
1542
1236
        return self._real_repository.get_signature_text(revision_id)
1543
1237
 
1544
1238
    @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)
 
1239
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1240
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1241
        self._ensure_real()
 
1242
        return self._real_repository.get_revision_graph_with_ghosts(
 
1243
            revision_ids=revision_ids)
 
1244
 
 
1245
    @needs_read_lock
 
1246
    def get_inventory_xml(self, revision_id):
 
1247
        self._ensure_real()
 
1248
        return self._real_repository.get_inventory_xml(revision_id)
 
1249
 
 
1250
    def deserialise_inventory(self, revision_id, xml):
 
1251
        self._ensure_real()
 
1252
        return self._real_repository.deserialise_inventory(revision_id, xml)
1548
1253
 
1549
1254
    def reconcile(self, other=None, thorough=False):
1550
1255
        self._ensure_real()
1555
1260
        return self._real_repository.all_revision_ids()
1556
1261
 
1557
1262
    @needs_read_lock
1558
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1263
    def get_deltas_for_revisions(self, revisions):
1559
1264
        self._ensure_real()
1560
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1561
 
            specific_fileids=specific_fileids)
 
1265
        return self._real_repository.get_deltas_for_revisions(revisions)
1562
1266
 
1563
1267
    @needs_read_lock
1564
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1268
    def get_revision_delta(self, revision_id):
1565
1269
        self._ensure_real()
1566
 
        return self._real_repository.get_revision_delta(revision_id,
1567
 
            specific_fileids=specific_fileids)
 
1270
        return self._real_repository.get_revision_delta(revision_id)
1568
1271
 
1569
1272
    @needs_read_lock
1570
1273
    def revision_trees(self, revision_ids):
1577
1280
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1281
 
1579
1282
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1283
    def check(self, revision_ids=None):
1581
1284
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1285
        return self._real_repository.check(revision_ids=revision_ids)
1584
1286
 
1585
1287
    def copy_content_into(self, destination, revision_id=None):
1586
1288
        self._ensure_real()
1626
1328
        return self._real_repository.inventories
1627
1329
 
1628
1330
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1331
    def pack(self):
1630
1332
        """Compress the data within the repository.
1631
1333
 
1632
1334
        This is not currently implemented within the smart server.
1633
1335
        """
1634
1336
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1337
        return self._real_repository.pack()
1636
1338
 
1637
1339
    @property
1638
1340
    def revisions(self):
1726
1428
        self._ensure_real()
1727
1429
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1430
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1431
    def _find_inconsistent_revision_parents(self):
1730
1432
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1433
        return self._real_repository._find_inconsistent_revision_parents()
1733
1434
 
1734
1435
    def _check_for_inconsistent_revision_parents(self):
1735
1436
        self._ensure_real()
1741
1442
            providers.insert(0, other)
1742
1443
        providers.extend(r._make_parents_provider() for r in
1743
1444
                         self._fallback_repositories)
1744
 
        return graph.StackedParentsProvider(providers)
 
1445
        return graph._StackedParentsProvider(providers)
1745
1446
 
1746
1447
    def _serialise_search_recipe(self, recipe):
1747
1448
        """Serialise a graph search recipe.
1749
1450
        :param recipe: A search recipe (start, stop, count).
1750
1451
        :return: Serialised bytes.
1751
1452
        """
1752
 
        start_keys = ' '.join(recipe[1])
1753
 
        stop_keys = ' '.join(recipe[2])
1754
 
        count = str(recipe[3])
 
1453
        start_keys = ' '.join(recipe[0])
 
1454
        stop_keys = ' '.join(recipe[1])
 
1455
        count = str(recipe[2])
1755
1456
        return '\n'.join((start_keys, stop_keys, count))
1756
1457
 
1757
1458
    def _serialise_search_result(self, search_result):
1760
1461
            parts.extend(search_result.heads)
1761
1462
        else:
1762
1463
            recipe = search_result.get_recipe()
1763
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
1464
            parts = ['search', self._serialise_search_recipe(recipe)]
1764
1465
        return '\n'.join(parts)
1765
1466
 
1766
1467
    def autopack(self):
1771
1472
            self._ensure_real()
1772
1473
            self._real_repository._pack_collection.autopack()
1773
1474
            return
1774
 
        self.refresh_data()
 
1475
        if self._real_repository is not None:
 
1476
            # Reset the real repository's cache of pack names.
 
1477
            # XXX: At some point we may be able to skip this and just rely on
 
1478
            # the automatic retry logic to do the right thing, but for now we
 
1479
            # err on the side of being correct rather than being optimal.
 
1480
            self._real_repository._pack_collection.reload_pack_names()
1775
1481
        if response[0] != 'ok':
1776
1482
            raise errors.UnexpectedSmartServerResponse(response)
1777
1483
 
1787
1493
        return result
1788
1494
 
1789
1495
    def insert_stream(self, stream, src_format, resume_tokens):
1790
 
        target = self.target_repo
1791
 
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
 
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
1796
 
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
1799
 
        client = target._client
 
1496
        repo = self.target_repo
 
1497
        client = repo._client
1800
1498
        medium = client._medium
1801
 
        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
 
1499
        if medium._is_remote_before((1, 13)):
 
1500
            # No possible way this can work.
 
1501
            return self._insert_real(stream, src_format, resume_tokens)
 
1502
        path = repo.bzrdir._path_for_remote_call(client)
 
1503
        if not resume_tokens:
 
1504
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1505
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1506
            # fallback to the _real_repositories sink *with a partial stream*.
 
1507
            # Thats bad because we insert less data than bzr expected. To avoid
 
1508
            # this we do a trial push to make sure the verb is accessible, and
 
1509
            # do not fallback when actually pushing the stream. A cleanup patch
 
1510
            # is going to look at rewinding/restarting the stream/partial
 
1511
            # buffering etc.
1815
1512
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
1513
            try:
1817
1514
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1515
                    ('Repository.insert_stream', path, ''), byte_stream)
1819
1516
            except errors.UnknownSmartMethod:
1820
 
                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)
 
1517
                medium._remember_remote_is_before((1,13))
 
1518
                return self._insert_real(stream, src_format, resume_tokens)
1835
1519
        byte_stream = smart_repo._stream_to_byte_stream(
1836
1520
            stream, src_format)
1837
1521
        resume_tokens = ' '.join(resume_tokens)
1838
1522
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1523
            ('Repository.insert_stream', path, resume_tokens), byte_stream)
1840
1524
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1525
            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
1526
        if response[0][0] == 'missing-basis':
1849
1527
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1528
            resume_tokens = tokens
1851
 
            return resume_tokens, set(missing_keys)
 
1529
            return resume_tokens, missing_keys
1852
1530
        else:
1853
 
            self.target_repo.refresh_data()
 
1531
            if self.target_repo._real_repository is not None:
 
1532
                collection = getattr(self.target_repo._real_repository,
 
1533
                    '_pack_collection', None)
 
1534
                if collection is not None:
 
1535
                    collection.reload_pack_names()
1854
1536
            return [], set()
1855
1537
 
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
1538
 
1897
1539
class RemoteStreamSource(repository.StreamSource):
1898
1540
    """Stream data from a remote server."""
1899
1541
 
1900
1542
    def get_stream(self, search):
1901
 
        if (self.from_repository._fallback_repositories and
1902
 
            self.to_format._fetch_order == 'topological'):
1903
 
            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)
1921
 
 
1922
 
    def _real_stream(self, repo, search):
1923
 
        """Get a stream for search from repo.
1924
 
        
1925
 
        This never called RemoteStreamSource.get_stream, and is a heler
1926
 
        for RemoteStreamSource._get_stream to allow getting a stream 
1927
 
        reliably whether fallback back because of old servers or trying
1928
 
        to stream from a non-RemoteRepository (which the stacked support
1929
 
        code will do).
1930
 
        """
1931
 
        source = repo._get_source(self.to_format)
1932
 
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
1935
 
        return source.get_stream(search)
1936
 
 
1937
 
    def _get_stream(self, repo, search):
1938
 
        """Core worker to get a stream from repo for search.
1939
 
 
1940
 
        This is used by both get_stream and the stacking support logic. It
1941
 
        deliberately gets a stream for repo which does not need to be
1942
 
        self.from_repository. In the event that repo is not Remote, or
1943
 
        cannot do a smart stream, a fallback is made to the generic
1944
 
        repository._get_stream() interface, via self._real_stream.
1945
 
 
1946
 
        In the event of stacking, streams from _get_stream will not
1947
 
        contain all the data for search - this is normal (see get_stream).
1948
 
 
1949
 
        :param repo: A repository.
1950
 
        :param search: A search.
1951
 
        """
1952
 
        # Fallbacks may be non-smart
1953
 
        if not isinstance(repo, RemoteRepository):
1954
 
            return self._real_stream(repo, search)
 
1543
        # streaming with fallback repositories is not well defined yet: The
 
1544
        # remote repository cannot see the fallback repositories, and thus
 
1545
        # cannot satisfy the entire search in the general case. Likewise the
 
1546
        # fallback repositories cannot reify the search to determine what they
 
1547
        # should send. It likely needs a return value in the stream listing the
 
1548
        # edge of the search to resume from in fallback repositories.
 
1549
        if self.from_repository._fallback_repositories:
 
1550
            return repository.StreamSource.get_stream(self, search)
 
1551
        repo = self.from_repository
1955
1552
        client = repo._client
1956
1553
        medium = client._medium
 
1554
        if medium._is_remote_before((1, 13)):
 
1555
            # No possible way this can work.
 
1556
            return repository.StreamSource.get_stream(self, search)
1957
1557
        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:
1977
 
            return self._real_stream(repo, search)
 
1558
        try:
 
1559
            search_bytes = repo._serialise_search_result(search)
 
1560
            response = repo._call_with_body_bytes_expecting_body(
 
1561
                'Repository.get_stream',
 
1562
                (path, self.to_format.network_name()), search_bytes)
 
1563
            response_tuple, response_handler = response
 
1564
        except errors.UnknownSmartMethod:
 
1565
            medium._remember_remote_is_before((1,13))
 
1566
            return repository.StreamSource.get_stream(self, search)
1978
1567
        if response_tuple[0] != 'ok':
1979
1568
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1980
1569
        byte_stream = response_handler.read_streamed_body()
1985
1574
                src_format.network_name(), repo._format.network_name()))
1986
1575
        return stream
1987
1576
 
1988
 
    def missing_parents_chain(self, search, sources):
1989
 
        """Chain multiple streams together to handle stacking.
1990
 
 
1991
 
        :param search: The overall search to satisfy with streams.
1992
 
        :param sources: A list of Repository objects to query.
1993
 
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
1995
 
        self.seen_revs = set()
1996
 
        self.referenced_revs = set()
1997
 
        # If there are heads in the search, or the key count is > 0, we are not
1998
 
        # done.
1999
 
        while not search.is_empty() and len(sources) > 1:
2000
 
            source = sources.pop(0)
2001
 
            stream = self._get_stream(source, search)
2002
 
            for kind, substream in stream:
2003
 
                if kind != 'revisions':
2004
 
                    yield kind, substream
2005
 
                else:
2006
 
                    yield kind, self.missing_parents_rev_handler(substream)
2007
 
            search = search.refine(self.seen_revs, self.referenced_revs)
2008
 
            self.seen_revs = set()
2009
 
            self.referenced_revs = set()
2010
 
        if not search.is_empty():
2011
 
            for kind, stream in self._get_stream(sources[0], search):
2012
 
                yield kind, stream
2013
 
 
2014
 
    def missing_parents_rev_handler(self, substream):
2015
 
        for content in substream:
2016
 
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
2019
 
            self.seen_revs.add(content.key[-1])
2020
 
            self.referenced_revs.update(revision.parent_ids)
2021
 
            yield content
2022
 
 
2023
1577
 
2024
1578
class RemoteBranchLockableFiles(LockableFiles):
2025
1579
    """A 'LockableFiles' implementation that talks to a smart server.
2060
1614
                self._network_name)
2061
1615
 
2062
1616
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1617
        return 'Remote BZR Branch'
2065
1618
 
2066
1619
    def network_name(self):
2067
1620
        return self._network_name
2068
1621
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1622
    def open(self, a_bzrdir):
 
1623
        return a_bzrdir.open_branch()
2072
1624
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1625
    def _vfs_initialize(self, a_bzrdir):
2074
1626
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1627
        # method is not available on the server.
2076
1628
        # self._custom_format is always set - the start of initialize ensures
2077
1629
        # that.
2078
1630
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1631
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1632
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1633
        else:
2083
1634
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1635
            result = self._custom_format.initialize(a_bzrdir)
2085
1636
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1637
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1638
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1639
        return result
2090
1640
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1641
    def initialize(self, a_bzrdir):
2092
1642
        # 1) get the network name to use.
2093
1643
        if self._custom_format:
2094
1644
            network_name = self._custom_format.network_name()
2100
1650
            network_name = reference_format.network_name()
2101
1651
        # Being asked to create on a non RemoteBzrDir:
2102
1652
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1653
            return self._vfs_initialize(a_bzrdir)
2104
1654
        medium = a_bzrdir._client._medium
2105
1655
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1656
            return self._vfs_initialize(a_bzrdir)
2107
1657
        # Creating on a remote bzr dir.
2108
1658
        # 2) try direct creation via RPC
2109
1659
        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
1660
        verb = 'BzrDir.create_branch'
2114
1661
        try:
2115
1662
            response = a_bzrdir._call(verb, path, network_name)
2116
1663
        except errors.UnknownSmartMethod:
2117
1664
            # Fallback - use vfs methods
2118
 
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1665
            return self._vfs_initialize(a_bzrdir)
2120
1666
        if response[0] != 'ok':
2121
1667
            raise errors.UnexpectedSmartServerResponse(response)
2122
1668
        # Turn the response into a RemoteRepository object.
2130
1676
                a_bzrdir._client)
2131
1677
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1678
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1679
            format=format, setup_stacking=False)
2134
1680
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1681
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1682
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2147
1693
        self._ensure_real()
2148
1694
        return self._custom_format.supports_tags()
2149
1695
 
2150
 
    def supports_stacking(self):
2151
 
        self._ensure_real()
2152
 
        return self._custom_format.supports_stacking()
2153
 
 
2154
 
    def supports_set_append_revisions_only(self):
2155
 
        self._ensure_real()
2156
 
        return self._custom_format.supports_set_append_revisions_only()
2157
 
 
2158
 
 
2159
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1696
 
 
1697
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1698
    """Branch stored on a server accessed by HPSS RPC.
2161
1699
 
2162
1700
    At the moment most operations are mapped down to simple file operations.
2163
1701
    """
2164
1702
 
2165
1703
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1704
        _client=None, format=None, setup_stacking=True):
2167
1705
        """Create a RemoteBranch instance.
2168
1706
 
2169
1707
        :param real_branch: An optional local implementation of the branch
2175
1713
        :param setup_stacking: If True make an RPC call to determine the
2176
1714
            stacked (or not) status of the branch. If False assume the branch
2177
1715
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1716
        """
2180
1717
        # We intentionally don't call the parent class's __init__, because it
2181
1718
        # will try to assign to self.tags, which is a property in this subclass.
2182
1719
        # And the parent's __init__ doesn't do much anyway.
 
1720
        self._revision_id_to_revno_cache = None
 
1721
        self._partial_revision_id_to_revno_cache = {}
 
1722
        self._revision_history_cache = None
 
1723
        self._last_revision_info_cache = None
 
1724
        self._merge_sorted_revisions_cache = None
2183
1725
        self.bzrdir = remote_bzrdir
2184
1726
        if _client is not None:
2185
1727
            self._client = _client
2198
1740
            self._real_branch.repository = self.repository
2199
1741
        else:
2200
1742
            self._real_branch = None
2201
 
        # Fill out expected attributes of branch for bzrlib API users.
2202
 
        self._clear_cached_state()
2203
 
        # TODO: deprecate self.base in favor of user_url
2204
 
        self.base = self.bzrdir.user_url
2205
 
        self._name = name
 
1743
        # Fill out expected attributes of branch for bzrlib api users.
 
1744
        self.base = self.bzrdir.root_transport.base
2206
1745
        self._control_files = None
2207
1746
        self._lock_mode = None
2208
1747
        self._lock_token = None
2219
1758
                    self._real_branch._format.network_name()
2220
1759
        else:
2221
1760
            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
1761
        if not self._format._network_name:
2226
1762
            # Did not get from open_branchV2 - old server.
2227
1763
            self._ensure_real()
2232
1768
        hooks = branch.Branch.hooks['open']
2233
1769
        for hook in hooks:
2234
1770
            hook(self)
2235
 
        self._is_stacked = False
2236
1771
        if setup_stacking:
2237
1772
            self._setup_stacking()
2238
1773
 
2244
1779
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2245
1780
            errors.UnstackableRepositoryFormat), e:
2246
1781
            return
2247
 
        self._is_stacked = True
2248
 
        self._activate_fallback_location(fallback_url)
2249
 
 
2250
 
    def _get_config(self):
2251
 
        return RemoteBranchConfig(self)
 
1782
        # it's relative to this branch...
 
1783
        fallback_url = urlutils.join(self.base, fallback_url)
 
1784
        transports = [self.bzrdir.root_transport]
 
1785
        stacked_on = branch.Branch.open(fallback_url,
 
1786
                                        possible_transports=transports)
 
1787
        self.repository.add_fallback_repository(stacked_on.repository)
2252
1788
 
2253
1789
    def _get_real_transport(self):
2254
1790
        # if we try vfs access, return the real branch's vfs transport
2272
1808
                raise AssertionError('smart server vfs must be enabled '
2273
1809
                    'to use vfs implementation')
2274
1810
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1811
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
1812
            if self.repository._real_repository is None:
2278
1813
                # Give the remote repository the matching real repo.
2279
1814
                real_repo = self._real_branch.repository
2353
1888
            raise errors.UnexpectedSmartServerResponse(response)
2354
1889
        return response[1]
2355
1890
 
2356
 
    def set_stacked_on_url(self, url):
2357
 
        branch.Branch.set_stacked_on_url(self, url)
2358
 
        if not url:
2359
 
            self._is_stacked = False
2360
 
        else:
2361
 
            self._is_stacked = True
2362
 
        
2363
1891
    def _vfs_get_tags_bytes(self):
2364
1892
        self._ensure_real()
2365
1893
        return self._real_branch._get_tags_bytes()
2371
1899
        try:
2372
1900
            response = self._call('Branch.get_tags_bytes', self._remote_path())
2373
1901
        except errors.UnknownSmartMethod:
2374
 
            medium._remember_remote_is_before((1, 13))
2375
1902
            return self._vfs_get_tags_bytes()
2376
1903
        return response[0]
2377
1904
 
2378
 
    def _vfs_set_tags_bytes(self, bytes):
2379
 
        self._ensure_real()
2380
 
        return self._real_branch._set_tags_bytes(bytes)
2381
 
 
2382
 
    def _set_tags_bytes(self, bytes):
2383
 
        medium = self._client._medium
2384
 
        if medium._is_remote_before((1, 18)):
2385
 
            self._vfs_set_tags_bytes(bytes)
2386
 
            return
2387
 
        try:
2388
 
            args = (
2389
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2390
 
            response = self._call_with_body_bytes(
2391
 
                'Branch.set_tags_bytes', args, bytes)
2392
 
        except errors.UnknownSmartMethod:
2393
 
            medium._remember_remote_is_before((1, 18))
2394
 
            self._vfs_set_tags_bytes(bytes)
2395
 
 
2396
1905
    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
1906
        self.repository.lock_read()
2403
1907
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
1908
            self._lock_mode = 'r'
2406
1909
            self._lock_count = 1
2407
1910
            if self._real_branch is not None:
2408
1911
                self._real_branch.lock_read()
2409
1912
        else:
2410
1913
            self._lock_count += 1
2411
 
        return self
2412
1914
 
2413
1915
    def _remote_lock_write(self, token):
2414
1916
        if token is None:
2415
1917
            branch_token = repo_token = ''
2416
1918
        else:
2417
1919
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
1920
            repo_token = self.repository.lock_write()
2419
1921
            self.repository.unlock()
2420
1922
        err_context = {'token': token}
2421
1923
        response = self._call(
2428
1930
 
2429
1931
    def lock_write(self, token=None):
2430
1932
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
1933
            # Lock the branch and repo in one remote call.
2433
1934
            remote_tokens = self._remote_lock_write(token)
2434
1935
            self._lock_token, self._repo_lock_token = remote_tokens
2458
1959
            self._lock_count += 1
2459
1960
            # Re-lock the repository too.
2460
1961
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
1962
        return self._lock_token or None
 
1963
 
 
1964
    def _set_tags_bytes(self, bytes):
 
1965
        self._ensure_real()
 
1966
        return self._real_branch._set_tags_bytes(bytes)
2462
1967
 
2463
1968
    def _unlock(self, branch_token, repo_token):
2464
1969
        err_context = {'token': str((branch_token, repo_token))}
2469
1974
            return
2470
1975
        raise errors.UnexpectedSmartServerResponse(response)
2471
1976
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
1977
    def unlock(self):
2474
1978
        try:
2475
1979
            self._lock_count -= 1
2488
1992
                    self._real_branch.unlock()
2489
1993
                if mode != 'w':
2490
1994
                    # Only write-locked branched need to make a remote method
2491
 
                    # call to perform the unlock.
 
1995
                    # call to perfom the unlock.
2492
1996
                    return
2493
1997
                if not self._lock_token:
2494
1998
                    raise AssertionError('Locked, but no token!')
2515
2019
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
2020
        self._leave_lock = False
2517
2021
 
2518
 
    @needs_read_lock
2519
 
    def get_rev_id(self, revno, history=None):
2520
 
        if revno == 0:
2521
 
            return _mod_revision.NULL_REVISION
2522
 
        last_revision_info = self.last_revision_info()
2523
 
        ok, result = self.repository.get_rev_id_for_revno(
2524
 
            revno, last_revision_info)
2525
 
        if ok:
2526
 
            return result
2527
 
        missing_parent = result[1]
2528
 
        # Either the revision named by the server is missing, or its parent
2529
 
        # is.  Call get_parent_map to determine which, so that we report a
2530
 
        # useful error.
2531
 
        parent_map = self.repository.get_parent_map([missing_parent])
2532
 
        if missing_parent in parent_map:
2533
 
            missing_parent = parent_map[missing_parent]
2534
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2535
 
 
2536
2022
    def _last_revision_info(self):
2537
2023
        response = self._call('Branch.last_revision_info', self._remote_path())
2538
2024
        if response[0] != 'ok':
2543
2029
 
2544
2030
    def _gen_revision_history(self):
2545
2031
        """See Branch._gen_revision_history()."""
2546
 
        if self._is_stacked:
2547
 
            self._ensure_real()
2548
 
            return self._real_branch._gen_revision_history()
2549
2032
        response_tuple, response_handler = self._call_expecting_body(
2550
2033
            'Branch.revision_history', self._remote_path())
2551
2034
        if response_tuple[0] != 'ok':
2623
2106
        try:
2624
2107
            response = self._call('Branch.get_parent', self._remote_path())
2625
2108
        except errors.UnknownSmartMethod:
2626
 
            medium._remember_remote_is_before((1, 13))
2627
2109
            return self._vfs_get_parent_location()
2628
2110
        if len(response) != 1:
2629
2111
            raise errors.UnexpectedSmartServerResponse(response)
2636
2118
        self._ensure_real()
2637
2119
        return self._real_branch._get_parent_location()
2638
2120
 
 
2121
    def set_parent(self, url):
 
2122
        self._ensure_real()
 
2123
        return self._real_branch.set_parent(url)
 
2124
 
2639
2125
    def _set_parent_location(self, url):
2640
 
        medium = self._client._medium
2641
 
        if medium._is_remote_before((1, 15)):
2642
 
            return self._vfs_set_parent_location(url)
2643
 
        try:
2644
 
            call_url = url or ''
2645
 
            if type(call_url) is not str:
2646
 
                raise AssertionError('url must be a str or None (%s)' % url)
2647
 
            response = self._call('Branch.set_parent_location',
2648
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2649
 
                call_url)
2650
 
        except errors.UnknownSmartMethod:
2651
 
            medium._remember_remote_is_before((1, 15))
2652
 
            return self._vfs_set_parent_location(url)
2653
 
        if response != ():
2654
 
            raise errors.UnexpectedSmartServerResponse(response)
2655
 
 
2656
 
    def _vfs_set_parent_location(self, url):
 
2126
        # Used by tests, to poke bad urls into branch configurations
 
2127
        if url is None:
 
2128
            self.set_parent(url)
 
2129
        else:
 
2130
            self._ensure_real()
 
2131
            return self._real_branch._set_parent_location(url)
 
2132
 
 
2133
    def set_stacked_on_url(self, stacked_location):
 
2134
        """Set the URL this branch is stacked against.
 
2135
 
 
2136
        :raises UnstackableBranchFormat: If the branch does not support
 
2137
            stacking.
 
2138
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2139
            stacking.
 
2140
        """
2657
2141
        self._ensure_real()
2658
 
        return self._real_branch._set_parent_location(url)
 
2142
        return self._real_branch.set_stacked_on_url(stacked_location)
2659
2143
 
2660
2144
    @needs_write_lock
2661
2145
    def pull(self, source, overwrite=False, stop_revision=None,
2729
2213
        return self._real_branch.set_push_location(location)
2730
2214
 
2731
2215
 
2732
 
class RemoteConfig(object):
2733
 
    """A Config that reads and writes from smart verbs.
2734
 
 
2735
 
    It is a low-level object that considers config data to be name/value pairs
2736
 
    that may be associated with a section. Assigning meaning to the these
2737
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2738
 
    """
2739
 
 
2740
 
    def get_option(self, name, section=None, default=None):
2741
 
        """Return the value associated with a named option.
2742
 
 
2743
 
        :param name: The name of the value
2744
 
        :param section: The section the option is in (if any)
2745
 
        :param default: The value to return if the value is not set
2746
 
        :return: The value or default value
2747
 
        """
2748
 
        try:
2749
 
            configobj = self._get_configobj()
2750
 
            if section is None:
2751
 
                section_obj = configobj
2752
 
            else:
2753
 
                try:
2754
 
                    section_obj = configobj[section]
2755
 
                except KeyError:
2756
 
                    return default
2757
 
            return section_obj.get(name, default)
2758
 
        except errors.UnknownSmartMethod:
2759
 
            return self._vfs_get_option(name, section, default)
2760
 
 
2761
 
    def _response_to_configobj(self, response):
2762
 
        if len(response[0]) and response[0][0] != 'ok':
2763
 
            raise errors.UnexpectedSmartServerResponse(response)
2764
 
        lines = response[1].read_body_bytes().splitlines()
2765
 
        return config.ConfigObj(lines, encoding='utf-8')
2766
 
 
2767
 
 
2768
 
class RemoteBranchConfig(RemoteConfig):
2769
 
    """A RemoteConfig for Branches."""
2770
 
 
2771
 
    def __init__(self, branch):
2772
 
        self._branch = branch
2773
 
 
2774
 
    def _get_configobj(self):
2775
 
        path = self._branch._remote_path()
2776
 
        response = self._branch._client.call_expecting_body(
2777
 
            'Branch.get_config_file', path)
2778
 
        return self._response_to_configobj(response)
2779
 
 
2780
 
    def set_option(self, value, name, section=None):
2781
 
        """Set the value associated with a named option.
2782
 
 
2783
 
        :param value: The value to set
2784
 
        :param name: The name of the value to set
2785
 
        :param section: The section the option is in (if any)
2786
 
        """
2787
 
        medium = self._branch._client._medium
2788
 
        if medium._is_remote_before((1, 14)):
2789
 
            return self._vfs_set_option(value, name, section)
2790
 
        try:
2791
 
            path = self._branch._remote_path()
2792
 
            response = self._branch._client.call('Branch.set_config_option',
2793
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2794
 
                value.encode('utf8'), name, section or '')
2795
 
        except errors.UnknownSmartMethod:
2796
 
            medium._remember_remote_is_before((1, 14))
2797
 
            return self._vfs_set_option(value, name, section)
2798
 
        if response != ():
2799
 
            raise errors.UnexpectedSmartServerResponse(response)
2800
 
 
2801
 
    def _real_object(self):
2802
 
        self._branch._ensure_real()
2803
 
        return self._branch._real_branch
2804
 
 
2805
 
    def _vfs_set_option(self, value, name, section=None):
2806
 
        return self._real_object()._get_config().set_option(
2807
 
            value, name, section)
2808
 
 
2809
 
 
2810
 
class RemoteBzrDirConfig(RemoteConfig):
2811
 
    """A RemoteConfig for BzrDirs."""
2812
 
 
2813
 
    def __init__(self, bzrdir):
2814
 
        self._bzrdir = bzrdir
2815
 
 
2816
 
    def _get_configobj(self):
2817
 
        medium = self._bzrdir._client._medium
2818
 
        verb = 'BzrDir.get_config_file'
2819
 
        if medium._is_remote_before((1, 15)):
2820
 
            raise errors.UnknownSmartMethod(verb)
2821
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2822
 
        response = self._bzrdir._call_expecting_body(
2823
 
            verb, path)
2824
 
        return self._response_to_configobj(response)
2825
 
 
2826
 
    def _vfs_get_option(self, name, section, default):
2827
 
        return self._real_object()._get_config().get_option(
2828
 
            name, section, default)
2829
 
 
2830
 
    def set_option(self, value, name, section=None):
2831
 
        """Set the value associated with a named option.
2832
 
 
2833
 
        :param value: The value to set
2834
 
        :param name: The name of the value to set
2835
 
        :param section: The section the option is in (if any)
2836
 
        """
2837
 
        return self._real_object()._get_config().set_option(
2838
 
            value, name, section)
2839
 
 
2840
 
    def _real_object(self):
2841
 
        self._bzrdir._ensure_real()
2842
 
        return self._bzrdir._real_bzrdir
2843
 
 
2844
 
 
2845
 
 
2846
2216
def _extract_tar(tar, to_dir):
2847
2217
    """Extract all the contents of a tarfile object.
2848
2218
 
2886
2256
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2257
                raise err
2888
2258
 
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':
 
2259
    if err.error_verb == 'NoSuchRevision':
2893
2260
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2261
    elif err.error_verb == 'nosuchrevision':
2895
2262
        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)
 
2263
    elif err.error_tuple == ('nobranch',):
 
2264
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2265
    elif err.error_verb == 'norepository':
2904
2266
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2267
    elif err.error_verb == 'LockContention':