← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Aaron Bentley
  • Date: 2009-04-03 20:05:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4266.
  • Revision ID: aaron@aaronbentley.com-20090403200525-5vcdyhnjrlsqd6dr
Support hidden options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
 
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
24
    bzrdir,
23
25
    config,
24
26
    debug,
25
27
    errors,
26
28
    graph,
27
 
    lock,
28
29
    lockdir,
 
30
    pack,
29
31
    repository,
30
 
    repository as _mod_repository,
31
32
    revision,
32
 
    revision as _mod_revision,
33
 
    static_tuple,
34
33
    symbol_versioning,
 
34
    urlutils,
35
35
)
36
36
from bzrlib.branch import BranchReferenceFormat
37
37
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
39
from bzrlib.errors import (
40
40
    NoSuchRevision,
41
41
    SmartProtocolError,
44
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
45
from bzrlib.revision import ensure_null, NULL_REVISION
46
46
from bzrlib.trace import mutter, note, warning
 
47
from bzrlib.util import bencode
47
48
 
48
49
 
49
50
class _RpcHelper(object):
61
62
        except errors.ErrorFromSmartServer, err:
62
63
            self._translate_error(err, **err_context)
63
64
 
64
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
65
 
        try:
66
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
67
 
        except errors.ErrorFromSmartServer, err:
68
 
            self._translate_error(err, **err_context)
69
 
 
70
65
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
71
66
                                             **err_context):
72
67
        try:
91
86
class RemoteBzrDir(BzrDir, _RpcHelper):
92
87
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
88
 
94
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
89
    def __init__(self, transport, format, _client=None):
95
90
        """Construct a RemoteBzrDir.
96
91
 
97
92
        :param _client: Private parameter for testing. Disables probing and the
101
96
        # this object holds a delegated bzrdir that uses file-level operations
102
97
        # to talk to the other side
103
98
        self._real_bzrdir = None
104
 
        self._has_working_tree = None
105
99
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
106
100
        # create_branch for details.
107
101
        self._next_open_branch_result = None
111
105
            self._client = client._SmartClient(medium)
112
106
        else:
113
107
            self._client = _client
114
 
            if not _force_probe:
115
 
                return
116
 
 
117
 
        self._probe_bzrdir()
118
 
 
119
 
    def __repr__(self):
120
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
121
 
 
122
 
    def _probe_bzrdir(self):
123
 
        medium = self._client._medium
 
108
            return
 
109
 
124
110
        path = self._path_for_remote_call(self._client)
125
 
        if medium._is_remote_before((2, 1)):
126
 
            self._rpc_open(path)
127
 
            return
128
 
        try:
129
 
            self._rpc_open_2_1(path)
130
 
            return
131
 
        except errors.UnknownSmartMethod:
132
 
            medium._remember_remote_is_before((2, 1))
133
 
            self._rpc_open(path)
134
 
 
135
 
    def _rpc_open_2_1(self, path):
136
 
        response = self._call('BzrDir.open_2.1', path)
137
 
        if response == ('no',):
138
 
            raise errors.NotBranchError(path=self.root_transport.base)
139
 
        elif response[0] == 'yes':
140
 
            if response[1] == 'yes':
141
 
                self._has_working_tree = True
142
 
            elif response[1] == 'no':
143
 
                self._has_working_tree = False
144
 
            else:
145
 
                raise errors.UnexpectedSmartServerResponse(response)
146
 
        else:
147
 
            raise errors.UnexpectedSmartServerResponse(response)
148
 
 
149
 
    def _rpc_open(self, path):
150
111
        response = self._call('BzrDir.open', path)
151
112
        if response not in [('yes',), ('no',)]:
152
113
            raise errors.UnexpectedSmartServerResponse(response)
153
114
        if response == ('no',):
154
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
115
            raise errors.NotBranchError(path=transport.base)
155
116
 
156
117
    def _ensure_real(self):
157
118
        """Ensure that there is a _real_bzrdir set.
159
120
        Used before calls to self._real_bzrdir.
160
121
        """
161
122
        if not self._real_bzrdir:
162
 
            if 'hpssvfs' in debug.debug_flags:
163
 
                import traceback
164
 
                warning('VFS BzrDir access triggered\n%s',
165
 
                    ''.join(traceback.format_stack()))
166
123
            self._real_bzrdir = BzrDir.open_from_transport(
167
124
                self.root_transport, _server_formats=False)
168
125
            self._format._network_name = \
244
201
        self._ensure_real()
245
202
        self._real_bzrdir.destroy_repository()
246
203
 
247
 
    def create_branch(self, name=None):
 
204
    def create_branch(self):
248
205
        # as per meta1 formats - just delegate to the format object which may
249
206
        # be parameterised.
250
 
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
207
        real_branch = self._format.get_branch_format().initialize(self)
252
208
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
209
            result = RemoteBranch(self, self.find_repository(), real_branch)
255
210
        else:
256
211
            result = real_branch
257
212
        # BzrDir.clone_on_transport() uses the result of create_branch but does
263
218
        self._next_open_branch_result = result
264
219
        return result
265
220
 
266
 
    def destroy_branch(self, name=None):
 
221
    def destroy_branch(self):
267
222
        """See BzrDir.destroy_branch"""
268
223
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
224
        self._real_bzrdir.destroy_branch()
270
225
        self._next_open_branch_result = None
271
226
 
272
227
    def create_workingtree(self, revision_id=None, from_branch=None):
291
246
    def _get_branch_reference(self):
292
247
        path = self._path_for_remote_call(self._client)
293
248
        medium = self._client._medium
294
 
        candidate_calls = [
295
 
            ('BzrDir.open_branchV3', (2, 1)),
296
 
            ('BzrDir.open_branchV2', (1, 13)),
297
 
            ('BzrDir.open_branch', None),
298
 
            ]
299
 
        for verb, required_version in candidate_calls:
300
 
            if required_version and medium._is_remote_before(required_version):
301
 
                continue
 
249
        if not medium._is_remote_before((1, 13)):
302
250
            try:
303
 
                response = self._call(verb, path)
 
251
                response = self._call('BzrDir.open_branchV2', path)
 
252
                if response[0] not in ('ref', 'branch'):
 
253
                    raise errors.UnexpectedSmartServerResponse(response)
 
254
                return response
304
255
            except errors.UnknownSmartMethod:
305
 
                if required_version is None:
306
 
                    raise
307
 
                medium._remember_remote_is_before(required_version)
308
 
            else:
309
 
                break
310
 
        if verb == 'BzrDir.open_branch':
311
 
            if response[0] != 'ok':
312
 
                raise errors.UnexpectedSmartServerResponse(response)
313
 
            if response[1] != '':
314
 
                return ('ref', response[1])
315
 
            else:
316
 
                return ('branch', '')
317
 
        if response[0] not in ('ref', 'branch'):
 
256
                medium._remember_remote_is_before((1, 13))
 
257
        response = self._call('BzrDir.open_branch', path)
 
258
        if response[0] != 'ok':
318
259
            raise errors.UnexpectedSmartServerResponse(response)
319
 
        return response
 
260
        if response[1] != '':
 
261
            return ('ref', response[1])
 
262
        else:
 
263
            return ('branch', '')
320
264
 
321
265
    def _get_tree_branch(self):
322
266
        """See BzrDir._get_tree_branch()."""
323
267
        return None, self.open_branch()
324
268
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
 
269
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
270
        if _unsupported:
328
271
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
272
        if self._next_open_branch_result is not None:
330
273
            # See create_branch for details.
335
278
        if response[0] == 'ref':
336
279
            # a branch reference, use the existing BranchReference logic.
337
280
            format = BranchReferenceFormat()
338
 
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
281
            return format.open(self, _found=True, location=response[1],
 
282
                ignore_fallbacks=ignore_fallbacks)
340
283
        branch_format_name = response[1]
341
284
        if not branch_format_name:
342
285
            branch_format_name = None
343
286
        format = RemoteBranchFormat(network_name=branch_format_name)
344
287
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
288
            setup_stacking=not ignore_fallbacks)
346
289
 
347
290
    def _open_repo_v1(self, path):
348
291
        verb = 'BzrDir.find_repository'
409
352
        else:
410
353
            raise errors.NoRepositoryPresent(self)
411
354
 
412
 
    def has_workingtree(self):
413
 
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
416
 
        return self._has_working_tree
417
 
 
418
355
    def open_workingtree(self, recommend_upgrade=True):
419
 
        if self.has_workingtree():
 
356
        self._ensure_real()
 
357
        if self._real_bzrdir.has_workingtree():
420
358
            raise errors.NotLocalUrl(self.root_transport)
421
359
        else:
422
360
            raise errors.NoWorkingTree(self.root_transport.base)
425
363
        """Return the path to be used for this bzrdir in a remote call."""
426
364
        return client.remote_path_from_transport(self.root_transport)
427
365
 
428
 
    def get_branch_transport(self, branch_format, name=None):
 
366
    def get_branch_transport(self, branch_format):
429
367
        self._ensure_real()
430
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
368
        return self._real_bzrdir.get_branch_transport(branch_format)
431
369
 
432
370
    def get_repository_transport(self, repository_format):
433
371
        self._ensure_real()
454
392
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
393
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
394
 
457
 
    def _get_config(self):
458
 
        return RemoteBzrDirConfig(self)
 
395
    def get_config(self):
 
396
        self._ensure_real()
 
397
        return self._real_bzrdir.get_config()
459
398
 
460
399
 
461
400
class RemoteRepositoryFormat(repository.RepositoryFormat):
485
424
        self._custom_format = None
486
425
        self._network_name = None
487
426
        self._creating_bzrdir = None
488
 
        self._supports_chks = None
489
427
        self._supports_external_lookups = None
490
428
        self._supports_tree_reference = None
491
429
        self._rich_root_data = None
492
430
 
493
 
    def __repr__(self):
494
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
495
 
            self._network_name)
496
 
 
497
431
    @property
498
432
    def fast_deltas(self):
499
433
        self._ensure_real()
507
441
        return self._rich_root_data
508
442
 
509
443
    @property
510
 
    def supports_chks(self):
511
 
        if self._supports_chks is None:
512
 
            self._ensure_real()
513
 
            self._supports_chks = self._custom_format.supports_chks
514
 
        return self._supports_chks
515
 
 
516
 
    @property
517
444
    def supports_external_lookups(self):
518
445
        if self._supports_external_lookups is None:
519
446
            self._ensure_real()
565
492
        # 1) get the network name to use.
566
493
        if self._custom_format:
567
494
            network_name = self._custom_format.network_name()
568
 
        elif self._network_name:
569
 
            network_name = self._network_name
570
495
        else:
571
496
            # Select the current bzrlib default and ask for that.
572
497
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
620
545
        return self._custom_format._fetch_reconcile
621
546
 
622
547
    def get_format_description(self):
623
 
        self._ensure_real()
624
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
548
        return 'bzr remote repository'
625
549
 
626
550
    def __eq__(self, other):
627
551
        return self.__class__ is other.__class__
628
552
 
 
553
    def check_conversion_target(self, target_format):
 
554
        if self.rich_root_data and not target_format.rich_root_data:
 
555
            raise errors.BadConversionTarget(
 
556
                'Does not support rich root data.', target_format)
 
557
        if (self.supports_tree_reference and
 
558
            not getattr(target_format, 'supports_tree_reference', False)):
 
559
            raise errors.BadConversionTarget(
 
560
                'Does not support nested trees', target_format)
 
561
 
629
562
    def network_name(self):
630
563
        if self._network_name:
631
564
            return self._network_name
633
566
        return self._creating_repo._real_repository._format.network_name()
634
567
 
635
568
    @property
636
 
    def pack_compresses(self):
637
 
        self._ensure_real()
638
 
        return self._custom_format.pack_compresses
639
 
 
640
 
    @property
641
569
    def _serializer(self):
642
570
        self._ensure_real()
643
571
        return self._custom_format._serializer
644
572
 
645
573
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
574
class RemoteRepository(_RpcHelper):
648
575
    """Repository accessed over rpc.
649
576
 
650
577
    For the moment most operations are performed using local transport-backed
676
603
        self._lock_token = None
677
604
        self._lock_count = 0
678
605
        self._leave_lock = False
679
 
        # Cache of revision parents; misses are cached during read locks, and
680
 
        # write locks when no _real_repository has been set.
681
606
        self._unstacked_provider = graph.CachingParentsProvider(
682
607
            get_parent_map=self._get_parent_map_rpc)
683
608
        self._unstacked_provider.disable_cache()
693
618
        # Additional places to query for data.
694
619
        self._fallback_repositories = []
695
620
 
696
 
    @property
697
 
    def user_transport(self):
698
 
        return self.bzrdir.user_transport
699
 
 
700
 
    @property
701
 
    def control_transport(self):
702
 
        # XXX: Normally you shouldn't directly get at the remote repository
703
 
        # transport, but I'm not sure it's worth making this method
704
 
        # optional -- mbp 2010-04-21
705
 
        return self.bzrdir.get_repository_transport(None)
706
 
        
707
621
    def __str__(self):
708
622
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
623
 
712
626
    def abort_write_group(self, suppress_errors=False):
713
627
        """Complete a write group on the decorated repository.
714
628
 
715
 
        Smart methods perform operations in a single step so this API
 
629
        Smart methods peform operations in a single step so this api
716
630
        is not really applicable except as a compatibility thunk
717
631
        for older plugins that don't use e.g. the CommitBuilder
718
632
        facility.
723
637
        return self._real_repository.abort_write_group(
724
638
            suppress_errors=suppress_errors)
725
639
 
726
 
    @property
727
 
    def chk_bytes(self):
728
 
        """Decorate the real repository for now.
729
 
 
730
 
        In the long term a full blown network facility is needed to avoid
731
 
        creating a real repository object locally.
732
 
        """
733
 
        self._ensure_real()
734
 
        return self._real_repository.chk_bytes
735
 
 
736
640
    def commit_write_group(self):
737
641
        """Complete a write group on the decorated repository.
738
642
 
739
 
        Smart methods perform operations in a single step so this API
 
643
        Smart methods peform operations in a single step so this api
740
644
        is not really applicable except as a compatibility thunk
741
645
        for older plugins that don't use e.g. the CommitBuilder
742
646
        facility.
752
656
        self._ensure_real()
753
657
        return self._real_repository.suspend_write_group()
754
658
 
755
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
 
        self._ensure_real()
757
 
        return self._real_repository.get_missing_parent_inventories(
758
 
            check_for_missing_texts=check_for_missing_texts)
759
 
 
760
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
761
 
        self._ensure_real()
762
 
        return self._real_repository.get_rev_id_for_revno(
763
 
            revno, known_pair)
764
 
 
765
 
    def get_rev_id_for_revno(self, revno, known_pair):
766
 
        """See Repository.get_rev_id_for_revno."""
767
 
        path = self.bzrdir._path_for_remote_call(self._client)
768
 
        try:
769
 
            if self._client._medium._is_remote_before((1, 17)):
770
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
771
 
            response = self._call(
772
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
773
 
        except errors.UnknownSmartMethod:
774
 
            self._client._medium._remember_remote_is_before((1, 17))
775
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
776
 
        if response[0] == 'ok':
777
 
            return True, response[1]
778
 
        elif response[0] == 'history-incomplete':
779
 
            known_pair = response[1:3]
780
 
            for fallback in self._fallback_repositories:
781
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
782
 
                if found:
783
 
                    return True, result
784
 
                else:
785
 
                    known_pair = result
786
 
            # Not found in any fallbacks
787
 
            return False, known_pair
788
 
        else:
789
 
            raise errors.UnexpectedSmartServerResponse(response)
790
 
 
791
659
    def _ensure_real(self):
792
660
        """Ensure that there is a _real_repository set.
793
661
 
802
670
        invocation. If in doubt chat to the bzr network team.
803
671
        """
804
672
        if self._real_repository is None:
805
 
            if 'hpssvfs' in debug.debug_flags:
806
 
                import traceback
807
 
                warning('VFS Repository access triggered\n%s',
808
 
                    ''.join(traceback.format_stack()))
809
 
            self._unstacked_provider.missing_keys.clear()
810
673
            self.bzrdir._ensure_real()
811
674
            self._set_real_repository(
812
675
                self.bzrdir._real_bzrdir.open_repository())
872
735
        """Return a source for streaming from this repository."""
873
736
        return RemoteStreamSource(self, to_format)
874
737
 
875
 
    @needs_read_lock
876
738
    def has_revision(self, revision_id):
877
 
        """True if this repository has a copy of the revision."""
878
 
        # Copy of bzrlib.repository.Repository.has_revision
879
 
        return revision_id in self.has_revisions((revision_id,))
 
739
        """See Repository.has_revision()."""
 
740
        if revision_id == NULL_REVISION:
 
741
            # The null revision is always present.
 
742
            return True
 
743
        path = self.bzrdir._path_for_remote_call(self._client)
 
744
        response = self._call('Repository.has_revision', path, revision_id)
 
745
        if response[0] not in ('yes', 'no'):
 
746
            raise errors.UnexpectedSmartServerResponse(response)
 
747
        if response[0] == 'yes':
 
748
            return True
 
749
        for fallback_repo in self._fallback_repositories:
 
750
            if fallback_repo.has_revision(revision_id):
 
751
                return True
 
752
        return False
880
753
 
881
 
    @needs_read_lock
882
754
    def has_revisions(self, revision_ids):
883
 
        """Probe to find out the presence of multiple revisions.
884
 
 
885
 
        :param revision_ids: An iterable of revision_ids.
886
 
        :return: A set of the revision_ids that were present.
887
 
        """
888
 
        # Copy of bzrlib.repository.Repository.has_revisions
889
 
        parent_map = self.get_parent_map(revision_ids)
890
 
        result = set(parent_map)
891
 
        if _mod_revision.NULL_REVISION in revision_ids:
892
 
            result.add(_mod_revision.NULL_REVISION)
 
755
        """See Repository.has_revisions()."""
 
756
        # FIXME: This does many roundtrips, particularly when there are
 
757
        # fallback repositories.  -- mbp 20080905
 
758
        result = set()
 
759
        for revision_id in revision_ids:
 
760
            if self.has_revision(revision_id):
 
761
                result.add(revision_id)
893
762
        return result
894
763
 
895
 
    def _has_same_fallbacks(self, other_repo):
896
 
        """Returns true if the repositories have the same fallbacks."""
897
 
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
899
 
        my_fb = self._fallback_repositories
900
 
        other_fb = other_repo._fallback_repositories
901
 
        if len(my_fb) != len(other_fb):
902
 
            return False
903
 
        for f, g in zip(my_fb, other_fb):
904
 
            if not f.has_same_location(g):
905
 
                return False
906
 
        return True
907
 
 
908
764
    def has_same_location(self, other):
909
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
910
 
        # one; unfortunately the tests rely on slightly different behaviour at
911
 
        # present -- mbp 20090710
912
765
        return (self.__class__ is other.__class__ and
913
766
                self.bzrdir.transport.base == other.bzrdir.transport.base)
914
767
 
917
770
        parents_provider = self._make_parents_provider(other_repository)
918
771
        return graph.Graph(parents_provider)
919
772
 
920
 
    @needs_read_lock
921
 
    def get_known_graph_ancestry(self, revision_ids):
922
 
        """Return the known graph for a set of revision ids and their ancestors.
923
 
        """
924
 
        st = static_tuple.StaticTuple
925
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
926
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
927
 
        return graph.GraphThunkIdsToKeys(known_graph)
928
 
 
929
773
    def gather_stats(self, revid=None, committers=None):
930
774
        """See Repository.gather_stats()."""
931
775
        path = self.bzrdir._path_for_remote_call(self._client)
991
835
    def is_write_locked(self):
992
836
        return self._lock_mode == 'w'
993
837
 
994
 
    def _warn_if_deprecated(self, branch=None):
995
 
        # If we have a real repository, the check will be done there, if we
996
 
        # don't the check will be done remotely.
997
 
        pass
998
 
 
999
838
    def lock_read(self):
1000
839
        # wrong eventually - want a local lock cache context
1001
840
        if not self._lock_mode:
1002
 
            self._note_lock('r')
1003
841
            self._lock_mode = 'r'
1004
842
            self._lock_count = 1
1005
843
            self._unstacked_provider.enable_cache(cache_misses=True)
1006
844
            if self._real_repository is not None:
1007
845
                self._real_repository.lock_read()
1008
 
            for repo in self._fallback_repositories:
1009
 
                repo.lock_read()
1010
846
        else:
1011
847
            self._lock_count += 1
 
848
        for repo in self._fallback_repositories:
 
849
            repo.lock_read()
1012
850
 
1013
851
    def _remote_lock_write(self, token):
1014
852
        path = self.bzrdir._path_for_remote_call(self._client)
1025
863
 
1026
864
    def lock_write(self, token=None, _skip_rpc=False):
1027
865
        if not self._lock_mode:
1028
 
            self._note_lock('w')
1029
866
            if _skip_rpc:
1030
867
                if self._lock_token is not None:
1031
868
                    if token != self._lock_token:
1045
882
                self._leave_lock = False
1046
883
            self._lock_mode = 'w'
1047
884
            self._lock_count = 1
1048
 
            cache_misses = self._real_repository is None
1049
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1050
 
            for repo in self._fallback_repositories:
1051
 
                # Writes don't affect fallback repos
1052
 
                repo.lock_read()
 
885
            self._unstacked_provider.enable_cache(cache_misses=False)
1053
886
        elif self._lock_mode == 'r':
1054
887
            raise errors.ReadOnlyError(self)
1055
888
        else:
1056
889
            self._lock_count += 1
 
890
        for repo in self._fallback_repositories:
 
891
            # Writes don't affect fallback repos
 
892
            repo.lock_read()
1057
893
        return self._lock_token or None
1058
894
 
1059
895
    def leave_lock_in_place(self):
1113
949
    def start_write_group(self):
1114
950
        """Start a write group on the decorated repository.
1115
951
 
1116
 
        Smart methods perform operations in a single step so this API
 
952
        Smart methods peform operations in a single step so this api
1117
953
        is not really applicable except as a compatibility thunk
1118
954
        for older plugins that don't use e.g. the CommitBuilder
1119
955
        facility.
1134
970
        else:
1135
971
            raise errors.UnexpectedSmartServerResponse(response)
1136
972
 
1137
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1138
973
    def unlock(self):
1139
974
        if not self._lock_count:
1140
 
            return lock.cant_unlock_not_held(self)
 
975
            raise errors.LockNotHeld(self)
1141
976
        self._lock_count -= 1
1142
977
        if self._lock_count > 0:
1143
978
            return
1157
992
            # problem releasing the vfs-based lock.
1158
993
            if old_mode == 'w':
1159
994
                # Only write-locked repositories need to make a remote method
1160
 
                # call to perform the unlock.
 
995
                # call to perfom the unlock.
1161
996
                old_token = self._lock_token
1162
997
                self._lock_token = None
1163
998
                if not self._leave_lock:
1164
999
                    self._unlock(old_token)
1165
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1166
 
        # self._leave_lock
1167
 
        for repo in self._fallback_repositories:
1168
 
            repo.unlock()
1169
1000
 
1170
1001
    def break_lock(self):
1171
1002
        # should hand off to the network
1235
1066
        # We need to accumulate additional repositories here, to pass them in
1236
1067
        # on various RPC's.
1237
1068
        #
1238
 
        if self.is_locked():
1239
 
            # We will call fallback.unlock() when we transition to the unlocked
1240
 
            # state, so always add a lock here. If a caller passes us a locked
1241
 
            # repository, they are responsible for unlocking it later.
1242
 
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1069
        self._fallback_repositories.append(repository)
1245
1070
        # If self._real_repository was parameterised already (e.g. because a
1246
1071
        # _real_branch had its get_stacked_on_url method called), then the
1247
1072
        # repository to be added may already be in the _real_repositories list.
1248
1073
        if self._real_repository is not None:
1249
 
            fallback_locations = [repo.user_url for repo in
 
1074
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1250
1075
                self._real_repository._fallback_repositories]
1251
 
            if repository.user_url not in fallback_locations:
 
1076
            if repository.bzrdir.root_transport.base not in fallback_locations:
1252
1077
                self._real_repository.add_fallback_repository(repository)
1253
1078
 
1254
 
    def _check_fallback_repository(self, repository):
1255
 
        """Check that this repository can fallback to repository safely.
1256
 
 
1257
 
        Raise an error if not.
1258
 
 
1259
 
        :param repository: A repository to fallback to.
1260
 
        """
1261
 
        return _mod_repository.InterRepository._assert_same_model(
1262
 
            self, repository)
1263
 
 
1264
1079
    def add_inventory(self, revid, inv, parents):
1265
1080
        self._ensure_real()
1266
1081
        return self._real_repository.add_inventory(revid, inv, parents)
1267
1082
 
1268
1083
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1269
 
            parents, basis_inv=None, propagate_caches=False):
 
1084
                               parents):
1270
1085
        self._ensure_real()
1271
1086
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1272
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
 
            propagate_caches=propagate_caches)
 
1087
            delta, new_revision_id, parents)
1274
1088
 
1275
1089
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
1090
        self._ensure_real()
1282
1096
        self._ensure_real()
1283
1097
        return self._real_repository.get_inventory(revision_id)
1284
1098
 
1285
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1099
    def iter_inventories(self, revision_ids):
1286
1100
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1101
        return self._real_repository.iter_inventories(revision_ids)
1288
1102
 
1289
1103
    @needs_read_lock
1290
1104
    def get_revision(self, revision_id):
1354
1168
            raise errors.InternalBzrError(
1355
1169
                "May not fetch while in a write group.")
1356
1170
        # fast path same-url fetch operations
1357
 
        if (self.has_same_location(source)
1358
 
            and fetch_spec is None
1359
 
            and self._has_same_fallbacks(source)):
 
1171
        if self.has_same_location(source) and fetch_spec is None:
1360
1172
            # check that last_revision is in 'from' and then return a
1361
1173
            # no-operation.
1362
1174
            if (revision_id is not None and
1411
1223
            # in one go, and the user probably will have seen a warning about
1412
1224
            # the server being old anyhow.
1413
1225
            rg = self._get_revision_graph(None)
1414
 
            # There is an API discrepancy between get_parent_map and
 
1226
            # There is an api discrepency between get_parent_map and
1415
1227
            # get_revision_graph. Specifically, a "key:()" pair in
1416
1228
            # get_revision_graph just means a node has no parents. For
1417
1229
            # "get_parent_map" it means the node is a ghost. So fix up the
1535
1347
        return self._real_repository.get_signature_text(revision_id)
1536
1348
 
1537
1349
    @needs_read_lock
1538
 
    def _get_inventory_xml(self, revision_id):
1539
 
        self._ensure_real()
1540
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1350
    def get_inventory_xml(self, revision_id):
 
1351
        self._ensure_real()
 
1352
        return self._real_repository.get_inventory_xml(revision_id)
 
1353
 
 
1354
    def deserialise_inventory(self, revision_id, xml):
 
1355
        self._ensure_real()
 
1356
        return self._real_repository.deserialise_inventory(revision_id, xml)
1541
1357
 
1542
1358
    def reconcile(self, other=None, thorough=False):
1543
1359
        self._ensure_real()
1570
1386
        return self._real_repository.get_revision_reconcile(revision_id)
1571
1387
 
1572
1388
    @needs_read_lock
1573
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1389
    def check(self, revision_ids=None):
1574
1390
        self._ensure_real()
1575
 
        return self._real_repository.check(revision_ids=revision_ids,
1576
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1391
        return self._real_repository.check(revision_ids=revision_ids)
1577
1392
 
1578
1393
    def copy_content_into(self, destination, revision_id=None):
1579
1394
        self._ensure_real()
1619
1434
        return self._real_repository.inventories
1620
1435
 
1621
1436
    @needs_write_lock
1622
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1437
    def pack(self):
1623
1438
        """Compress the data within the repository.
1624
1439
 
1625
1440
        This is not currently implemented within the smart server.
1626
1441
        """
1627
1442
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1443
        return self._real_repository.pack()
1629
1444
 
1630
1445
    @property
1631
1446
    def revisions(self):
1719
1534
        self._ensure_real()
1720
1535
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
1536
 
1722
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1537
    def _find_inconsistent_revision_parents(self):
1723
1538
        self._ensure_real()
1724
 
        return self._real_repository._find_inconsistent_revision_parents(
1725
 
            revisions_iterator)
 
1539
        return self._real_repository._find_inconsistent_revision_parents()
1726
1540
 
1727
1541
    def _check_for_inconsistent_revision_parents(self):
1728
1542
        self._ensure_real()
1734
1548
            providers.insert(0, other)
1735
1549
        providers.extend(r._make_parents_provider() for r in
1736
1550
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
1551
        return graph._StackedParentsProvider(providers)
1738
1552
 
1739
1553
    def _serialise_search_recipe(self, recipe):
1740
1554
        """Serialise a graph search recipe.
1781
1595
 
1782
1596
    def insert_stream(self, stream, src_format, resume_tokens):
1783
1597
        target = self.target_repo
1784
 
        target._unstacked_provider.missing_keys.clear()
1785
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1786
1598
        if target._lock_token:
1787
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1788
 
            lock_args = (target._lock_token or '',)
 
1599
            verb = 'Repository.insert_stream_locked'
 
1600
            extra_args = (target._lock_token or '',)
 
1601
            required_version = (1, 14)
1789
1602
        else:
1790
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1791
 
            lock_args = ()
 
1603
            verb = 'Repository.insert_stream'
 
1604
            extra_args = ()
 
1605
            required_version = (1, 13)
1792
1606
        client = target._client
1793
1607
        medium = client._medium
 
1608
        if medium._is_remote_before(required_version):
 
1609
            # No possible way this can work.
 
1610
            return self._insert_real(stream, src_format, resume_tokens)
1794
1611
        path = target.bzrdir._path_for_remote_call(client)
1795
 
        # Probe for the verb to use with an empty stream before sending the
1796
 
        # real stream to it.  We do this both to avoid the risk of sending a
1797
 
        # large request that is then rejected, and because we don't want to
1798
 
        # implement a way to buffer, rewind, or restart the stream.
1799
 
        found_verb = False
1800
 
        for verb, required_version in candidate_calls:
1801
 
            if medium._is_remote_before(required_version):
1802
 
                continue
1803
 
            if resume_tokens:
1804
 
                # We've already done the probing (and set _is_remote_before) on
1805
 
                # a previous insert.
1806
 
                found_verb = True
1807
 
                break
 
1612
        if not resume_tokens:
 
1613
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1614
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1615
            # fallback to the _real_repositories sink *with a partial stream*.
 
1616
            # Thats bad because we insert less data than bzr expected. To avoid
 
1617
            # this we do a trial push to make sure the verb is accessible, and
 
1618
            # do not fallback when actually pushing the stream. A cleanup patch
 
1619
            # is going to look at rewinding/restarting the stream/partial
 
1620
            # buffering etc.
1808
1621
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1809
1622
            try:
1810
1623
                response = client.call_with_body_stream(
1811
 
                    (verb, path, '') + lock_args, byte_stream)
 
1624
                    (verb, path, '') + extra_args, byte_stream)
1812
1625
            except errors.UnknownSmartMethod:
1813
1626
                medium._remember_remote_is_before(required_version)
1814
 
            else:
1815
 
                found_verb = True
1816
 
                break
1817
 
        if not found_verb:
1818
 
            # Have to use VFS.
1819
 
            return self._insert_real(stream, src_format, resume_tokens)
1820
 
        self._last_inv_record = None
1821
 
        self._last_substream = None
1822
 
        if required_version < (1, 19):
1823
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1824
 
            # make sure we don't send any.  If the stream contains inventory
1825
 
            # deltas we'll interrupt the smart insert_stream request and
1826
 
            # fallback to VFS.
1827
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1627
                return self._insert_real(stream, src_format, resume_tokens)
1828
1628
        byte_stream = smart_repo._stream_to_byte_stream(
1829
1629
            stream, src_format)
1830
1630
        resume_tokens = ' '.join(resume_tokens)
1831
1631
        response = client.call_with_body_stream(
1832
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1632
            (verb, path, resume_tokens) + extra_args, byte_stream)
1833
1633
        if response[0][0] not in ('ok', 'missing-basis'):
1834
1634
            raise errors.UnexpectedSmartServerResponse(response)
1835
 
        if self._last_substream is not None:
1836
 
            # The stream included an inventory-delta record, but the remote
1837
 
            # side isn't new enough to support them.  So we need to send the
1838
 
            # rest of the stream via VFS.
1839
 
            self.target_repo.refresh_data()
1840
 
            return self._resume_stream_with_vfs(response, src_format)
1841
1635
        if response[0][0] == 'missing-basis':
1842
1636
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1843
1637
            resume_tokens = tokens
1844
 
            return resume_tokens, set(missing_keys)
 
1638
            return resume_tokens, missing_keys
1845
1639
        else:
1846
1640
            self.target_repo.refresh_data()
1847
1641
            return [], set()
1848
1642
 
1849
 
    def _resume_stream_with_vfs(self, response, src_format):
1850
 
        """Resume sending a stream via VFS, first resending the record and
1851
 
        substream that couldn't be sent via an insert_stream verb.
1852
 
        """
1853
 
        if response[0][0] == 'missing-basis':
1854
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1855
 
            # Ignore missing_keys, we haven't finished inserting yet
1856
 
        else:
1857
 
            tokens = []
1858
 
        def resume_substream():
1859
 
            # Yield the substream that was interrupted.
1860
 
            for record in self._last_substream:
1861
 
                yield record
1862
 
            self._last_substream = None
1863
 
        def resume_stream():
1864
 
            # Finish sending the interrupted substream
1865
 
            yield ('inventory-deltas', resume_substream())
1866
 
            # Then simply continue sending the rest of the stream.
1867
 
            for substream_kind, substream in self._last_stream:
1868
 
                yield substream_kind, substream
1869
 
        return self._insert_real(resume_stream(), src_format, tokens)
1870
 
 
1871
 
    def _stop_stream_if_inventory_delta(self, stream):
1872
 
        """Normally this just lets the original stream pass-through unchanged.
1873
 
 
1874
 
        However if any 'inventory-deltas' substream occurs it will stop
1875
 
        streaming, and store the interrupted substream and stream in
1876
 
        self._last_substream and self._last_stream so that the stream can be
1877
 
        resumed by _resume_stream_with_vfs.
1878
 
        """
1879
 
                    
1880
 
        stream_iter = iter(stream)
1881
 
        for substream_kind, substream in stream_iter:
1882
 
            if substream_kind == 'inventory-deltas':
1883
 
                self._last_substream = substream
1884
 
                self._last_stream = stream_iter
1885
 
                return
1886
 
            else:
1887
 
                yield substream_kind, substream
1888
 
            
1889
1643
 
1890
1644
class RemoteStreamSource(repository.StreamSource):
1891
1645
    """Stream data from a remote server."""
1894
1648
        if (self.from_repository._fallback_repositories and
1895
1649
            self.to_format._fetch_order == 'topological'):
1896
1650
            return self._real_stream(self.from_repository, search)
1897
 
        sources = []
1898
 
        seen = set()
1899
 
        repos = [self.from_repository]
1900
 
        while repos:
1901
 
            repo = repos.pop(0)
1902
 
            if repo in seen:
1903
 
                continue
1904
 
            seen.add(repo)
1905
 
            repos.extend(repo._fallback_repositories)
1906
 
            sources.append(repo)
1907
 
        return self.missing_parents_chain(search, sources)
1908
 
 
1909
 
    def get_stream_for_missing_keys(self, missing_keys):
1910
 
        self.from_repository._ensure_real()
1911
 
        real_repo = self.from_repository._real_repository
1912
 
        real_source = real_repo._get_source(self.to_format)
1913
 
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1651
        return self.missing_parents_chain(search, [self.from_repository] +
 
1652
            self.from_repository._fallback_repositories)
1914
1653
 
1915
1654
    def _real_stream(self, repo, search):
1916
1655
        """Get a stream for search from repo.
1923
1662
        """
1924
1663
        source = repo._get_source(self.to_format)
1925
1664
        if isinstance(source, RemoteStreamSource):
1926
 
            repo._ensure_real()
1927
 
            source = repo._real_repository._get_source(self.to_format)
 
1665
            return repository.StreamSource.get_stream(source, search)
1928
1666
        return source.get_stream(search)
1929
1667
 
1930
1668
    def _get_stream(self, repo, search):
1947
1685
            return self._real_stream(repo, search)
1948
1686
        client = repo._client
1949
1687
        medium = client._medium
 
1688
        if medium._is_remote_before((1, 13)):
 
1689
            # streaming was added in 1.13
 
1690
            return self._real_stream(repo, search)
1950
1691
        path = repo.bzrdir._path_for_remote_call(client)
1951
 
        search_bytes = repo._serialise_search_result(search)
1952
 
        args = (path, self.to_format.network_name())
1953
 
        candidate_verbs = [
1954
 
            ('Repository.get_stream_1.19', (1, 19)),
1955
 
            ('Repository.get_stream', (1, 13))]
1956
 
        found_verb = False
1957
 
        for verb, version in candidate_verbs:
1958
 
            if medium._is_remote_before(version):
1959
 
                continue
1960
 
            try:
1961
 
                response = repo._call_with_body_bytes_expecting_body(
1962
 
                    verb, args, search_bytes)
1963
 
            except errors.UnknownSmartMethod:
1964
 
                medium._remember_remote_is_before(version)
1965
 
            else:
1966
 
                response_tuple, response_handler = response
1967
 
                found_verb = True
1968
 
                break
1969
 
        if not found_verb:
 
1692
        try:
 
1693
            search_bytes = repo._serialise_search_result(search)
 
1694
            response = repo._call_with_body_bytes_expecting_body(
 
1695
                'Repository.get_stream',
 
1696
                (path, self.to_format.network_name()), search_bytes)
 
1697
            response_tuple, response_handler = response
 
1698
        except errors.UnknownSmartMethod:
 
1699
            medium._remember_remote_is_before((1,13))
1970
1700
            return self._real_stream(repo, search)
1971
1701
        if response_tuple[0] != 'ok':
1972
1702
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1984
1714
        :param search: The overall search to satisfy with streams.
1985
1715
        :param sources: A list of Repository objects to query.
1986
1716
        """
1987
 
        self.from_serialiser = self.from_repository._format._serializer
 
1717
        self.serialiser = self.to_format._serializer
1988
1718
        self.seen_revs = set()
1989
1719
        self.referenced_revs = set()
1990
1720
        # If there are heads in the search, or the key count is > 0, we are not
2007
1737
    def missing_parents_rev_handler(self, substream):
2008
1738
        for content in substream:
2009
1739
            revision_bytes = content.get_bytes_as('fulltext')
2010
 
            revision = self.from_serialiser.read_revision_from_string(
2011
 
                revision_bytes)
 
1740
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2012
1741
            self.seen_revs.add(content.key[-1])
2013
1742
            self.referenced_revs.update(revision.parent_ids)
2014
1743
            yield content
2053
1782
                self._network_name)
2054
1783
 
2055
1784
    def get_format_description(self):
2056
 
        self._ensure_real()
2057
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1785
        return 'Remote BZR Branch'
2058
1786
 
2059
1787
    def network_name(self):
2060
1788
        return self._network_name
2061
1789
 
2062
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2063
 
        return a_bzrdir.open_branch(name=name, 
2064
 
            ignore_fallbacks=ignore_fallbacks)
 
1790
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1791
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2065
1792
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1793
    def _vfs_initialize(self, a_bzrdir):
2067
1794
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
1795
        # method is not available on the server.
2069
1796
        # self._custom_format is always set - the start of initialize ensures
2070
1797
        # that.
2071
1798
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
1799
            a_bzrdir._ensure_real()
2073
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
1800
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2075
1801
        else:
2076
1802
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1803
            result = self._custom_format.initialize(a_bzrdir)
2078
1804
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
1805
            not isinstance(result, RemoteBranch)):
2080
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
 
                                  name=name)
 
1806
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2082
1807
        return result
2083
1808
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
1809
    def initialize(self, a_bzrdir):
2085
1810
        # 1) get the network name to use.
2086
1811
        if self._custom_format:
2087
1812
            network_name = self._custom_format.network_name()
2093
1818
            network_name = reference_format.network_name()
2094
1819
        # Being asked to create on a non RemoteBzrDir:
2095
1820
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1821
            return self._vfs_initialize(a_bzrdir)
2097
1822
        medium = a_bzrdir._client._medium
2098
1823
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1824
            return self._vfs_initialize(a_bzrdir)
2100
1825
        # Creating on a remote bzr dir.
2101
1826
        # 2) try direct creation via RPC
2102
1827
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
 
        if name is not None:
2104
 
            # XXX JRV20100304: Support creating colocated branches
2105
 
            raise errors.NoColocatedBranchSupport(self)
2106
1828
        verb = 'BzrDir.create_branch'
2107
1829
        try:
2108
1830
            response = a_bzrdir._call(verb, path, network_name)
2109
1831
        except errors.UnknownSmartMethod:
2110
1832
            # Fallback - use vfs methods
2111
1833
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1834
            return self._vfs_initialize(a_bzrdir)
2113
1835
        if response[0] != 'ok':
2114
1836
            raise errors.UnexpectedSmartServerResponse(response)
2115
1837
        # Turn the response into a RemoteRepository object.
2123
1845
                a_bzrdir._client)
2124
1846
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
1847
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
 
            format=format, setup_stacking=False, name=name)
 
1848
            format=format, setup_stacking=False)
2127
1849
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
1850
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
1851
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2144
1866
        self._ensure_real()
2145
1867
        return self._custom_format.supports_stacking()
2146
1868
 
2147
 
    def supports_set_append_revisions_only(self):
2148
 
        self._ensure_real()
2149
 
        return self._custom_format.supports_set_append_revisions_only()
2150
 
 
2151
 
 
2152
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1869
 
 
1870
class RemoteBranch(branch.Branch, _RpcHelper):
2153
1871
    """Branch stored on a server accessed by HPSS RPC.
2154
1872
 
2155
1873
    At the moment most operations are mapped down to simple file operations.
2156
1874
    """
2157
1875
 
2158
1876
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1877
        _client=None, format=None, setup_stacking=True):
2160
1878
        """Create a RemoteBranch instance.
2161
1879
 
2162
1880
        :param real_branch: An optional local implementation of the branch
2168
1886
        :param setup_stacking: If True make an RPC call to determine the
2169
1887
            stacked (or not) status of the branch. If False assume the branch
2170
1888
            is not stacked.
2171
 
        :param name: Colocated branch name
2172
1889
        """
2173
1890
        # We intentionally don't call the parent class's __init__, because it
2174
1891
        # will try to assign to self.tags, which is a property in this subclass.
2175
1892
        # And the parent's __init__ doesn't do much anyway.
 
1893
        self._revision_id_to_revno_cache = None
 
1894
        self._partial_revision_id_to_revno_cache = {}
 
1895
        self._revision_history_cache = None
 
1896
        self._last_revision_info_cache = None
 
1897
        self._merge_sorted_revisions_cache = None
2176
1898
        self.bzrdir = remote_bzrdir
2177
1899
        if _client is not None:
2178
1900
            self._client = _client
2191
1913
            self._real_branch.repository = self.repository
2192
1914
        else:
2193
1915
            self._real_branch = None
2194
 
        # Fill out expected attributes of branch for bzrlib API users.
2195
 
        self._clear_cached_state()
2196
 
        # TODO: deprecate self.base in favor of user_url
2197
 
        self.base = self.bzrdir.user_url
2198
 
        self._name = name
 
1916
        # Fill out expected attributes of branch for bzrlib api users.
 
1917
        self.base = self.bzrdir.root_transport.base
2199
1918
        self._control_files = None
2200
1919
        self._lock_mode = None
2201
1920
        self._lock_token = None
2212
1931
                    self._real_branch._format.network_name()
2213
1932
        else:
2214
1933
            self._format = format
2215
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2216
 
        # branch.open_branch method.
2217
 
        self._real_ignore_fallbacks = not setup_stacking
2218
1934
        if not self._format._network_name:
2219
1935
            # Did not get from open_branchV2 - old server.
2220
1936
            self._ensure_real()
2225
1941
        hooks = branch.Branch.hooks['open']
2226
1942
        for hook in hooks:
2227
1943
            hook(self)
2228
 
        self._is_stacked = False
2229
1944
        if setup_stacking:
2230
1945
            self._setup_stacking()
2231
1946
 
2237
1952
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2238
1953
            errors.UnstackableRepositoryFormat), e:
2239
1954
            return
2240
 
        self._is_stacked = True
2241
1955
        self._activate_fallback_location(fallback_url)
2242
1956
 
2243
1957
    def _get_config(self):
2265
1979
                raise AssertionError('smart server vfs must be enabled '
2266
1980
                    'to use vfs implementation')
2267
1981
            self.bzrdir._ensure_real()
2268
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2269
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1982
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2270
1983
            if self.repository._real_repository is None:
2271
1984
                # Give the remote repository the matching real repo.
2272
1985
                real_repo = self._real_branch.repository
2346
2059
            raise errors.UnexpectedSmartServerResponse(response)
2347
2060
        return response[1]
2348
2061
 
2349
 
    def set_stacked_on_url(self, url):
2350
 
        branch.Branch.set_stacked_on_url(self, url)
2351
 
        if not url:
2352
 
            self._is_stacked = False
2353
 
        else:
2354
 
            self._is_stacked = True
2355
 
        
2356
2062
    def _vfs_get_tags_bytes(self):
2357
2063
        self._ensure_real()
2358
2064
        return self._real_branch._get_tags_bytes()
2368
2074
            return self._vfs_get_tags_bytes()
2369
2075
        return response[0]
2370
2076
 
2371
 
    def _vfs_set_tags_bytes(self, bytes):
2372
 
        self._ensure_real()
2373
 
        return self._real_branch._set_tags_bytes(bytes)
2374
 
 
2375
 
    def _set_tags_bytes(self, bytes):
2376
 
        medium = self._client._medium
2377
 
        if medium._is_remote_before((1, 18)):
2378
 
            self._vfs_set_tags_bytes(bytes)
2379
 
            return
2380
 
        try:
2381
 
            args = (
2382
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2383
 
            response = self._call_with_body_bytes(
2384
 
                'Branch.set_tags_bytes', args, bytes)
2385
 
        except errors.UnknownSmartMethod:
2386
 
            medium._remember_remote_is_before((1, 18))
2387
 
            self._vfs_set_tags_bytes(bytes)
2388
 
 
2389
2077
    def lock_read(self):
2390
2078
        self.repository.lock_read()
2391
2079
        if not self._lock_mode:
2392
 
            self._note_lock('r')
2393
2080
            self._lock_mode = 'r'
2394
2081
            self._lock_count = 1
2395
2082
            if self._real_branch is not None:
2415
2102
 
2416
2103
    def lock_write(self, token=None):
2417
2104
        if not self._lock_mode:
2418
 
            self._note_lock('w')
2419
2105
            # Lock the branch and repo in one remote call.
2420
2106
            remote_tokens = self._remote_lock_write(token)
2421
2107
            self._lock_token, self._repo_lock_token = remote_tokens
2447
2133
            self.repository.lock_write(self._repo_lock_token)
2448
2134
        return self._lock_token or None
2449
2135
 
 
2136
    def _set_tags_bytes(self, bytes):
 
2137
        self._ensure_real()
 
2138
        return self._real_branch._set_tags_bytes(bytes)
 
2139
 
2450
2140
    def _unlock(self, branch_token, repo_token):
2451
2141
        err_context = {'token': str((branch_token, repo_token))}
2452
2142
        response = self._call(
2456
2146
            return
2457
2147
        raise errors.UnexpectedSmartServerResponse(response)
2458
2148
 
2459
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2460
2149
    def unlock(self):
2461
2150
        try:
2462
2151
            self._lock_count -= 1
2475
2164
                    self._real_branch.unlock()
2476
2165
                if mode != 'w':
2477
2166
                    # Only write-locked branched need to make a remote method
2478
 
                    # call to perform the unlock.
 
2167
                    # call to perfom the unlock.
2479
2168
                    return
2480
2169
                if not self._lock_token:
2481
2170
                    raise AssertionError('Locked, but no token!')
2502
2191
            raise NotImplementedError(self.dont_leave_lock_in_place)
2503
2192
        self._leave_lock = False
2504
2193
 
2505
 
    @needs_read_lock
2506
 
    def get_rev_id(self, revno, history=None):
2507
 
        if revno == 0:
2508
 
            return _mod_revision.NULL_REVISION
2509
 
        last_revision_info = self.last_revision_info()
2510
 
        ok, result = self.repository.get_rev_id_for_revno(
2511
 
            revno, last_revision_info)
2512
 
        if ok:
2513
 
            return result
2514
 
        missing_parent = result[1]
2515
 
        # Either the revision named by the server is missing, or its parent
2516
 
        # is.  Call get_parent_map to determine which, so that we report a
2517
 
        # useful error.
2518
 
        parent_map = self.repository.get_parent_map([missing_parent])
2519
 
        if missing_parent in parent_map:
2520
 
            missing_parent = parent_map[missing_parent]
2521
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
 
 
2523
2194
    def _last_revision_info(self):
2524
2195
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2196
        if response[0] != 'ok':
2530
2201
 
2531
2202
    def _gen_revision_history(self):
2532
2203
        """See Branch._gen_revision_history()."""
2533
 
        if self._is_stacked:
2534
 
            self._ensure_real()
2535
 
            return self._real_branch._gen_revision_history()
2536
2204
        response_tuple, response_handler = self._call_expecting_body(
2537
2205
            'Branch.revision_history', self._remote_path())
2538
2206
        if response_tuple[0] != 'ok':
2623
2291
        self._ensure_real()
2624
2292
        return self._real_branch._get_parent_location()
2625
2293
 
 
2294
    def set_parent(self, url):
 
2295
        self._ensure_real()
 
2296
        return self._real_branch.set_parent(url)
 
2297
 
2626
2298
    def _set_parent_location(self, url):
2627
 
        medium = self._client._medium
2628
 
        if medium._is_remote_before((1, 15)):
2629
 
            return self._vfs_set_parent_location(url)
2630
 
        try:
2631
 
            call_url = url or ''
2632
 
            if type(call_url) is not str:
2633
 
                raise AssertionError('url must be a str or None (%s)' % url)
2634
 
            response = self._call('Branch.set_parent_location',
2635
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2636
 
                call_url)
2637
 
        except errors.UnknownSmartMethod:
2638
 
            medium._remember_remote_is_before((1, 15))
2639
 
            return self._vfs_set_parent_location(url)
2640
 
        if response != ():
2641
 
            raise errors.UnexpectedSmartServerResponse(response)
2642
 
 
2643
 
    def _vfs_set_parent_location(self, url):
2644
 
        self._ensure_real()
2645
 
        return self._real_branch._set_parent_location(url)
 
2299
        # Used by tests, to poke bad urls into branch configurations
 
2300
        if url is None:
 
2301
            self.set_parent(url)
 
2302
        else:
 
2303
            self._ensure_real()
 
2304
            return self._real_branch._set_parent_location(url)
2646
2305
 
2647
2306
    @needs_write_lock
2648
2307
    def pull(self, source, overwrite=False, stop_revision=None,
2716
2375
        return self._real_branch.set_push_location(location)
2717
2376
 
2718
2377
 
2719
 
class RemoteConfig(object):
2720
 
    """A Config that reads and writes from smart verbs.
 
2378
class RemoteBranchConfig(object):
 
2379
    """A Config that reads from a smart branch and writes via smart methods.
2721
2380
 
2722
2381
    It is a low-level object that considers config data to be name/value pairs
2723
2382
    that may be associated with a section. Assigning meaning to the these
2724
2383
    values is done at higher levels like bzrlib.config.TreeConfig.
2725
2384
    """
2726
2385
 
 
2386
    def __init__(self, branch):
 
2387
        self._branch = branch
 
2388
 
2727
2389
    def get_option(self, name, section=None, default=None):
2728
2390
        """Return the value associated with a named option.
2729
2391
 
2732
2394
        :param default: The value to return if the value is not set
2733
2395
        :return: The value or default value
2734
2396
        """
2735
 
        try:
2736
 
            configobj = self._get_configobj()
2737
 
            if section is None:
2738
 
                section_obj = configobj
2739
 
            else:
2740
 
                try:
2741
 
                    section_obj = configobj[section]
2742
 
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
2745
 
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
2747
 
 
2748
 
    def _response_to_configobj(self, response):
2749
 
        if len(response[0]) and response[0][0] != 'ok':
2750
 
            raise errors.UnexpectedSmartServerResponse(response)
2751
 
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
2753
 
 
2754
 
 
2755
 
class RemoteBranchConfig(RemoteConfig):
2756
 
    """A RemoteConfig for Branches."""
2757
 
 
2758
 
    def __init__(self, branch):
2759
 
        self._branch = branch
 
2397
        configobj = self._get_configobj()
 
2398
        if section is None:
 
2399
            section_obj = configobj
 
2400
        else:
 
2401
            try:
 
2402
                section_obj = configobj[section]
 
2403
            except KeyError:
 
2404
                return default
 
2405
        return section_obj.get(name, default)
2760
2406
 
2761
2407
    def _get_configobj(self):
2762
2408
        path = self._branch._remote_path()
2763
2409
        response = self._branch._client.call_expecting_body(
2764
2410
            'Branch.get_config_file', path)
2765
 
        return self._response_to_configobj(response)
 
2411
        if response[0][0] != 'ok':
 
2412
            raise UnexpectedSmartServerResponse(response)
 
2413
        lines = response[1].read_body_bytes().splitlines()
 
2414
        return config.ConfigObj(lines, encoding='utf-8')
2766
2415
 
2767
2416
    def set_option(self, value, name, section=None):
2768
2417
        """Set the value associated with a named option.
2785
2434
        if response != ():
2786
2435
            raise errors.UnexpectedSmartServerResponse(response)
2787
2436
 
2788
 
    def _real_object(self):
 
2437
    def _vfs_set_option(self, value, name, section=None):
2789
2438
        self._branch._ensure_real()
2790
 
        return self._branch._real_branch
2791
 
 
2792
 
    def _vfs_set_option(self, value, name, section=None):
2793
 
        return self._real_object()._get_config().set_option(
2794
 
            value, name, section)
2795
 
 
2796
 
 
2797
 
class RemoteBzrDirConfig(RemoteConfig):
2798
 
    """A RemoteConfig for BzrDirs."""
2799
 
 
2800
 
    def __init__(self, bzrdir):
2801
 
        self._bzrdir = bzrdir
2802
 
 
2803
 
    def _get_configobj(self):
2804
 
        medium = self._bzrdir._client._medium
2805
 
        verb = 'BzrDir.get_config_file'
2806
 
        if medium._is_remote_before((1, 15)):
2807
 
            raise errors.UnknownSmartMethod(verb)
2808
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2809
 
        response = self._bzrdir._call_expecting_body(
2810
 
            verb, path)
2811
 
        return self._response_to_configobj(response)
2812
 
 
2813
 
    def _vfs_get_option(self, name, section, default):
2814
 
        return self._real_object()._get_config().get_option(
2815
 
            name, section, default)
2816
 
 
2817
 
    def set_option(self, value, name, section=None):
2818
 
        """Set the value associated with a named option.
2819
 
 
2820
 
        :param value: The value to set
2821
 
        :param name: The name of the value to set
2822
 
        :param section: The section the option is in (if any)
2823
 
        """
2824
 
        return self._real_object()._get_config().set_option(
2825
 
            value, name, section)
2826
 
 
2827
 
    def _real_object(self):
2828
 
        self._bzrdir._ensure_real()
2829
 
        return self._bzrdir._real_bzrdir
2830
 
 
 
2439
        return self._branch._real_branch._get_config().set_option(
 
2440
            value, name, section)
2831
2441
 
2832
2442
 
2833
2443
def _extract_tar(tar, to_dir):
2873
2483
                    'Missing key %r in context %r', key_err.args[0], context)
2874
2484
                raise err
2875
2485
 
2876
 
    if err.error_verb == 'IncompatibleRepositories':
2877
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2878
 
            err.error_args[1], err.error_args[2])
2879
 
    elif err.error_verb == 'NoSuchRevision':
 
2486
    if err.error_verb == 'NoSuchRevision':
2880
2487
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
2488
    elif err.error_verb == 'nosuchrevision':
2882
2489
        raise NoSuchRevision(find('repository'), err.error_args[0])
2883
 
    elif err.error_verb == 'nobranch':
2884
 
        if len(err.error_args) >= 1:
2885
 
            extra = err.error_args[0]
2886
 
        else:
2887
 
            extra = None
2888
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2889
 
            detail=extra)
 
2490
    elif err.error_tuple == ('nobranch',):
 
2491
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2890
2492
    elif err.error_verb == 'norepository':
2891
2493
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
2494
    elif err.error_verb == 'LockContention':