← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-25 18:43:31 UTC
  • mfrom: (4147.1.3 bzr.bug-338261)
  • Revision ID: pqm@pqm.ubuntu.com-20090325184331-1up3t0gh14ttr5zm
(James Henstridge) Insure that byte strings are passed to SMTP.login()

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
 
    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
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,
44
43
from bzrlib.smart import client, vfs, repository as smart_repo
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
47
47
 
48
48
 
49
49
class _RpcHelper(object):
61
61
        except errors.ErrorFromSmartServer, err:
62
62
            self._translate_error(err, **err_context)
63
63
 
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
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
71
65
                                             **err_context):
72
66
        try:
91
85
class RemoteBzrDir(BzrDir, _RpcHelper):
92
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
87
 
94
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
95
89
        """Construct a RemoteBzrDir.
96
90
 
97
91
        :param _client: Private parameter for testing. Disables probing and the
101
95
        # this object holds a delegated bzrdir that uses file-level operations
102
96
        # to talk to the other side
103
97
        self._real_bzrdir = None
104
 
        self._has_working_tree = None
105
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
106
99
        # create_branch for details.
107
100
        self._next_open_branch_result = None
111
104
            self._client = client._SmartClient(medium)
112
105
        else:
113
106
            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
 
107
            return
 
108
 
124
109
        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
110
        response = self._call('BzrDir.open', path)
151
111
        if response not in [('yes',), ('no',)]:
152
112
            raise errors.UnexpectedSmartServerResponse(response)
153
113
        if response == ('no',):
154
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
155
115
 
156
116
    def _ensure_real(self):
157
117
        """Ensure that there is a _real_bzrdir set.
159
119
        Used before calls to self._real_bzrdir.
160
120
        """
161
121
        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
122
            self._real_bzrdir = BzrDir.open_from_transport(
167
123
                self.root_transport, _server_formats=False)
168
124
            self._format._network_name = \
244
200
        self._ensure_real()
245
201
        self._real_bzrdir.destroy_repository()
246
202
 
247
 
    def create_branch(self, name=None):
 
203
    def create_branch(self):
248
204
        # as per meta1 formats - just delegate to the format object which may
249
205
        # be parameterised.
250
 
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
206
        real_branch = self._format.get_branch_format().initialize(self)
252
207
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
208
            result = RemoteBranch(self, self.find_repository(), real_branch)
255
209
        else:
256
210
            result = real_branch
257
211
        # BzrDir.clone_on_transport() uses the result of create_branch but does
263
217
        self._next_open_branch_result = result
264
218
        return result
265
219
 
266
 
    def destroy_branch(self, name=None):
 
220
    def destroy_branch(self):
267
221
        """See BzrDir.destroy_branch"""
268
222
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
223
        self._real_bzrdir.destroy_branch()
270
224
        self._next_open_branch_result = None
271
225
 
272
226
    def create_workingtree(self, revision_id=None, from_branch=None):
291
245
    def _get_branch_reference(self):
292
246
        path = self._path_for_remote_call(self._client)
293
247
        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
 
248
        if not medium._is_remote_before((1, 13)):
302
249
            try:
303
 
                response = self._call(verb, path)
 
250
                response = self._call('BzrDir.open_branchV2', path)
 
251
                if response[0] not in ('ref', 'branch'):
 
252
                    raise errors.UnexpectedSmartServerResponse(response)
 
253
                return response
304
254
            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'):
 
255
                medium._remember_remote_is_before((1, 13))
 
256
        response = self._call('BzrDir.open_branch', path)
 
257
        if response[0] != 'ok':
318
258
            raise errors.UnexpectedSmartServerResponse(response)
319
 
        return response
 
259
        if response[1] != '':
 
260
            return ('ref', response[1])
 
261
        else:
 
262
            return ('branch', '')
320
263
 
321
264
    def _get_tree_branch(self):
322
265
        """See BzrDir._get_tree_branch()."""
323
266
        return None, self.open_branch()
324
267
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
 
268
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
269
        if _unsupported:
328
270
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
271
        if self._next_open_branch_result is not None:
330
272
            # See create_branch for details.
335
277
        if response[0] == 'ref':
336
278
            # a branch reference, use the existing BranchReference logic.
337
279
            format = BranchReferenceFormat()
338
 
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
280
            return format.open(self, _found=True, location=response[1],
 
281
                ignore_fallbacks=ignore_fallbacks)
340
282
        branch_format_name = response[1]
341
283
        if not branch_format_name:
342
284
            branch_format_name = None
343
285
        format = RemoteBranchFormat(network_name=branch_format_name)
344
286
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
287
            setup_stacking=not ignore_fallbacks)
346
288
 
347
289
    def _open_repo_v1(self, path):
348
290
        verb = 'BzrDir.find_repository'
409
351
        else:
410
352
            raise errors.NoRepositoryPresent(self)
411
353
 
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
354
    def open_workingtree(self, recommend_upgrade=True):
419
 
        if self.has_workingtree():
 
355
        self._ensure_real()
 
356
        if self._real_bzrdir.has_workingtree():
420
357
            raise errors.NotLocalUrl(self.root_transport)
421
358
        else:
422
359
            raise errors.NoWorkingTree(self.root_transport.base)
425
362
        """Return the path to be used for this bzrdir in a remote call."""
426
363
        return client.remote_path_from_transport(self.root_transport)
427
364
 
428
 
    def get_branch_transport(self, branch_format, name=None):
 
365
    def get_branch_transport(self, branch_format):
429
366
        self._ensure_real()
430
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
367
        return self._real_bzrdir.get_branch_transport(branch_format)
431
368
 
432
369
    def get_repository_transport(self, repository_format):
433
370
        self._ensure_real()
454
391
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
392
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
393
 
457
 
    def _get_config(self):
458
 
        return RemoteBzrDirConfig(self)
 
394
    def get_config(self):
 
395
        self._ensure_real()
 
396
        return self._real_bzrdir.get_config()
459
397
 
460
398
 
461
399
class RemoteRepositoryFormat(repository.RepositoryFormat):
485
423
        self._custom_format = None
486
424
        self._network_name = None
487
425
        self._creating_bzrdir = None
488
 
        self._supports_chks = None
489
426
        self._supports_external_lookups = None
490
427
        self._supports_tree_reference = None
491
428
        self._rich_root_data = None
492
429
 
493
 
    def __repr__(self):
494
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
495
 
            self._network_name)
496
 
 
497
430
    @property
498
431
    def fast_deltas(self):
499
432
        self._ensure_real()
507
440
        return self._rich_root_data
508
441
 
509
442
    @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
443
    def supports_external_lookups(self):
518
444
        if self._supports_external_lookups is None:
519
445
            self._ensure_real()
565
491
        # 1) get the network name to use.
566
492
        if self._custom_format:
567
493
            network_name = self._custom_format.network_name()
568
 
        elif self._network_name:
569
 
            network_name = self._network_name
570
494
        else:
571
495
            # Select the current bzrlib default and ask for that.
572
496
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
620
544
        return self._custom_format._fetch_reconcile
621
545
 
622
546
    def get_format_description(self):
623
 
        self._ensure_real()
624
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
547
        return 'bzr remote repository'
625
548
 
626
549
    def __eq__(self, other):
627
550
        return self.__class__ is other.__class__
628
551
 
 
552
    def check_conversion_target(self, target_format):
 
553
        if self.rich_root_data and not target_format.rich_root_data:
 
554
            raise errors.BadConversionTarget(
 
555
                'Does not support rich root data.', target_format)
 
556
        if (self.supports_tree_reference and
 
557
            not getattr(target_format, 'supports_tree_reference', False)):
 
558
            raise errors.BadConversionTarget(
 
559
                'Does not support nested trees', target_format)
 
560
 
629
561
    def network_name(self):
630
562
        if self._network_name:
631
563
            return self._network_name
633
565
        return self._creating_repo._real_repository._format.network_name()
634
566
 
635
567
    @property
636
 
    def pack_compresses(self):
637
 
        self._ensure_real()
638
 
        return self._custom_format.pack_compresses
639
 
 
640
 
    @property
641
568
    def _serializer(self):
642
569
        self._ensure_real()
643
570
        return self._custom_format._serializer
644
571
 
645
572
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
573
class RemoteRepository(_RpcHelper):
648
574
    """Repository accessed over rpc.
649
575
 
650
576
    For the moment most operations are performed using local transport-backed
676
602
        self._lock_token = None
677
603
        self._lock_count = 0
678
604
        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
605
        self._unstacked_provider = graph.CachingParentsProvider(
682
606
            get_parent_map=self._get_parent_map_rpc)
683
607
        self._unstacked_provider.disable_cache()
693
617
        # Additional places to query for data.
694
618
        self._fallback_repositories = []
695
619
 
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
620
    def __str__(self):
708
621
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
622
 
712
625
    def abort_write_group(self, suppress_errors=False):
713
626
        """Complete a write group on the decorated repository.
714
627
 
715
 
        Smart methods perform operations in a single step so this API
 
628
        Smart methods peform operations in a single step so this api
716
629
        is not really applicable except as a compatibility thunk
717
630
        for older plugins that don't use e.g. the CommitBuilder
718
631
        facility.
723
636
        return self._real_repository.abort_write_group(
724
637
            suppress_errors=suppress_errors)
725
638
 
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
639
    def commit_write_group(self):
737
640
        """Complete a write group on the decorated repository.
738
641
 
739
 
        Smart methods perform operations in a single step so this API
 
642
        Smart methods peform operations in a single step so this api
740
643
        is not really applicable except as a compatibility thunk
741
644
        for older plugins that don't use e.g. the CommitBuilder
742
645
        facility.
752
655
        self._ensure_real()
753
656
        return self._real_repository.suspend_write_group()
754
657
 
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
658
    def _ensure_real(self):
792
659
        """Ensure that there is a _real_repository set.
793
660
 
802
669
        invocation. If in doubt chat to the bzr network team.
803
670
        """
804
671
        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
672
            self.bzrdir._ensure_real()
811
673
            self._set_real_repository(
812
674
                self.bzrdir._real_bzrdir.open_repository())
872
734
        """Return a source for streaming from this repository."""
873
735
        return RemoteStreamSource(self, to_format)
874
736
 
875
 
    @needs_read_lock
876
737
    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,))
 
738
        """See Repository.has_revision()."""
 
739
        if revision_id == NULL_REVISION:
 
740
            # The null revision is always present.
 
741
            return True
 
742
        path = self.bzrdir._path_for_remote_call(self._client)
 
743
        response = self._call('Repository.has_revision', path, revision_id)
 
744
        if response[0] not in ('yes', 'no'):
 
745
            raise errors.UnexpectedSmartServerResponse(response)
 
746
        if response[0] == 'yes':
 
747
            return True
 
748
        for fallback_repo in self._fallback_repositories:
 
749
            if fallback_repo.has_revision(revision_id):
 
750
                return True
 
751
        return False
880
752
 
881
 
    @needs_read_lock
882
753
    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)
 
754
        """See Repository.has_revisions()."""
 
755
        # FIXME: This does many roundtrips, particularly when there are
 
756
        # fallback repositories.  -- mbp 20080905
 
757
        result = set()
 
758
        for revision_id in revision_ids:
 
759
            if self.has_revision(revision_id):
 
760
                result.add(revision_id)
893
761
        return result
894
762
 
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
763
    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
764
        return (self.__class__ is other.__class__ and
913
765
                self.bzrdir.transport.base == other.bzrdir.transport.base)
914
766
 
917
769
        parents_provider = self._make_parents_provider(other_repository)
918
770
        return graph.Graph(parents_provider)
919
771
 
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
772
    def gather_stats(self, revid=None, committers=None):
930
773
        """See Repository.gather_stats()."""
931
774
        path = self.bzrdir._path_for_remote_call(self._client)
991
834
    def is_write_locked(self):
992
835
        return self._lock_mode == 'w'
993
836
 
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
837
    def lock_read(self):
1000
838
        # wrong eventually - want a local lock cache context
1001
839
        if not self._lock_mode:
1002
 
            self._note_lock('r')
1003
840
            self._lock_mode = 'r'
1004
841
            self._lock_count = 1
1005
842
            self._unstacked_provider.enable_cache(cache_misses=True)
1006
843
            if self._real_repository is not None:
1007
844
                self._real_repository.lock_read()
1008
 
            for repo in self._fallback_repositories:
1009
 
                repo.lock_read()
1010
845
        else:
1011
846
            self._lock_count += 1
1012
847
 
1025
860
 
1026
861
    def lock_write(self, token=None, _skip_rpc=False):
1027
862
        if not self._lock_mode:
1028
 
            self._note_lock('w')
1029
863
            if _skip_rpc:
1030
864
                if self._lock_token is not None:
1031
865
                    if token != self._lock_token:
1045
879
                self._leave_lock = False
1046
880
            self._lock_mode = 'w'
1047
881
            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()
 
882
            self._unstacked_provider.enable_cache(cache_misses=False)
1053
883
        elif self._lock_mode == 'r':
1054
884
            raise errors.ReadOnlyError(self)
1055
885
        else:
1081
911
        if isinstance(repository, RemoteRepository):
1082
912
            raise AssertionError()
1083
913
        self._real_repository = repository
1084
 
        # three code paths happen here:
1085
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1086
 
        # up stacking. In this case self._fallback_repositories is [], and the
1087
 
        # real repo is already setup. Preserve the real repo and
1088
 
        # RemoteRepository.add_fallback_repository will avoid adding
1089
 
        # duplicates.
1090
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1091
 
        # ensure_real is triggered from a branch, the real repository to
1092
 
        # set already has a matching list with separate instances, but
1093
 
        # as they are also RemoteRepositories we don't worry about making the
1094
 
        # lists be identical.
1095
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1096
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1097
 
        # and need to populate it.
1098
 
        if (self._fallback_repositories and
1099
 
            len(self._real_repository._fallback_repositories) !=
1100
 
            len(self._fallback_repositories)):
1101
 
            if len(self._real_repository._fallback_repositories):
1102
 
                raise AssertionError(
1103
 
                    "cannot cleanly remove existing _fallback_repositories")
 
914
        # If the _real_repository has _fallback_repositories, clear them out,
 
915
        # because we want it to have the same set as this repository.  This is
 
916
        # reasonable to do because the fallbacks we clear here are from a
 
917
        # "real" branch, and we're about to replace them with the equivalents
 
918
        # from a RemoteBranch.
 
919
        self._real_repository._fallback_repositories = []
1104
920
        for fb in self._fallback_repositories:
1105
921
            self._real_repository.add_fallback_repository(fb)
1106
922
        if self._lock_mode == 'w':
1113
929
    def start_write_group(self):
1114
930
        """Start a write group on the decorated repository.
1115
931
 
1116
 
        Smart methods perform operations in a single step so this API
 
932
        Smart methods peform operations in a single step so this api
1117
933
        is not really applicable except as a compatibility thunk
1118
934
        for older plugins that don't use e.g. the CommitBuilder
1119
935
        facility.
1134
950
        else:
1135
951
            raise errors.UnexpectedSmartServerResponse(response)
1136
952
 
1137
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1138
953
    def unlock(self):
1139
954
        if not self._lock_count:
1140
 
            return lock.cant_unlock_not_held(self)
 
955
            raise errors.LockNotHeld(self)
1141
956
        self._lock_count -= 1
1142
957
        if self._lock_count > 0:
1143
958
            return
1157
972
            # problem releasing the vfs-based lock.
1158
973
            if old_mode == 'w':
1159
974
                # Only write-locked repositories need to make a remote method
1160
 
                # call to perform the unlock.
 
975
                # call to perfom the unlock.
1161
976
                old_token = self._lock_token
1162
977
                self._lock_token = None
1163
978
                if not self._leave_lock:
1164
979
                    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
980
 
1170
981
    def break_lock(self):
1171
982
        # should hand off to the network
1235
1046
        # We need to accumulate additional repositories here, to pass them in
1236
1047
        # on various RPC's.
1237
1048
        #
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
1049
        self._fallback_repositories.append(repository)
1245
1050
        # If self._real_repository was parameterised already (e.g. because a
1246
1051
        # _real_branch had its get_stacked_on_url method called), then the
1247
1052
        # repository to be added may already be in the _real_repositories list.
1248
1053
        if self._real_repository is not None:
1249
 
            fallback_locations = [repo.user_url for repo in
1250
 
                self._real_repository._fallback_repositories]
1251
 
            if repository.user_url not in fallback_locations:
 
1054
            if repository not in self._real_repository._fallback_repositories:
1252
1055
                self._real_repository.add_fallback_repository(repository)
1253
 
 
1254
 
    def _check_fallback_repository(self, repository):
1255
 
        """Check that this repository can fallback to repository safely.
1256
 
 
1257
 
        Raise an error if not.
1258
 
 
1259
 
        :param repository: A repository to fallback to.
1260
 
        """
1261
 
        return _mod_repository.InterRepository._assert_same_model(
1262
 
            self, repository)
 
1056
        else:
 
1057
            # They are also seen by the fallback repository.  If it doesn't
 
1058
            # exist yet they'll be added then.  This implicitly copies them.
 
1059
            self._ensure_real()
1263
1060
 
1264
1061
    def add_inventory(self, revid, inv, parents):
1265
1062
        self._ensure_real()
1266
1063
        return self._real_repository.add_inventory(revid, inv, parents)
1267
1064
 
1268
1065
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1269
 
            parents, basis_inv=None, propagate_caches=False):
 
1066
                               parents):
1270
1067
        self._ensure_real()
1271
1068
        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)
 
1069
            delta, new_revision_id, parents)
1274
1070
 
1275
1071
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
1072
        self._ensure_real()
1282
1078
        self._ensure_real()
1283
1079
        return self._real_repository.get_inventory(revision_id)
1284
1080
 
1285
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1081
    def iter_inventories(self, revision_ids):
1286
1082
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1083
        return self._real_repository.iter_inventories(revision_ids)
1288
1084
 
1289
1085
    @needs_read_lock
1290
1086
    def get_revision(self, revision_id):
1354
1150
            raise errors.InternalBzrError(
1355
1151
                "May not fetch while in a write group.")
1356
1152
        # 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)):
 
1153
        if self.has_same_location(source) and fetch_spec is None:
1360
1154
            # check that last_revision is in 'from' and then return a
1361
1155
            # no-operation.
1362
1156
            if (revision_id is not None and
1411
1205
            # in one go, and the user probably will have seen a warning about
1412
1206
            # the server being old anyhow.
1413
1207
            rg = self._get_revision_graph(None)
1414
 
            # There is an API discrepancy between get_parent_map and
 
1208
            # There is an api discrepency between get_parent_map and
1415
1209
            # get_revision_graph. Specifically, a "key:()" pair in
1416
1210
            # get_revision_graph just means a node has no parents. For
1417
1211
            # "get_parent_map" it means the node is a ghost. So fix up the
1467
1261
        # We don't need to send ghosts back to the server as a position to
1468
1262
        # stop either.
1469
1263
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1470
 
        key_count = len(parents_map)
1471
 
        if (NULL_REVISION in result_parents
1472
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1473
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1474
 
            # in our cache of "missing" keys we need to increment our key count
1475
 
            # by 1, because the reconsitituted SearchResult on the server will
1476
 
            # still consider NULL_REVISION to be an included key.
1477
 
            key_count += 1
1478
1264
        included_keys = start_set.intersection(result_parents)
1479
1265
        start_set.difference_update(included_keys)
1480
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1266
        recipe = ('manual', start_set, stop_keys, len(parents_map))
1481
1267
        body = self._serialise_search_recipe(recipe)
1482
1268
        path = self.bzrdir._path_for_remote_call(self._client)
1483
1269
        for key in keys:
1535
1321
        return self._real_repository.get_signature_text(revision_id)
1536
1322
 
1537
1323
    @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)
 
1324
    def get_inventory_xml(self, revision_id):
 
1325
        self._ensure_real()
 
1326
        return self._real_repository.get_inventory_xml(revision_id)
 
1327
 
 
1328
    def deserialise_inventory(self, revision_id, xml):
 
1329
        self._ensure_real()
 
1330
        return self._real_repository.deserialise_inventory(revision_id, xml)
1541
1331
 
1542
1332
    def reconcile(self, other=None, thorough=False):
1543
1333
        self._ensure_real()
1570
1360
        return self._real_repository.get_revision_reconcile(revision_id)
1571
1361
 
1572
1362
    @needs_read_lock
1573
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1363
    def check(self, revision_ids=None):
1574
1364
        self._ensure_real()
1575
 
        return self._real_repository.check(revision_ids=revision_ids,
1576
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1365
        return self._real_repository.check(revision_ids=revision_ids)
1577
1366
 
1578
1367
    def copy_content_into(self, destination, revision_id=None):
1579
1368
        self._ensure_real()
1619
1408
        return self._real_repository.inventories
1620
1409
 
1621
1410
    @needs_write_lock
1622
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1411
    def pack(self):
1623
1412
        """Compress the data within the repository.
1624
1413
 
1625
1414
        This is not currently implemented within the smart server.
1626
1415
        """
1627
1416
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1417
        return self._real_repository.pack()
1629
1418
 
1630
1419
    @property
1631
1420
    def revisions(self):
1719
1508
        self._ensure_real()
1720
1509
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
1510
 
1722
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1511
    def _find_inconsistent_revision_parents(self):
1723
1512
        self._ensure_real()
1724
 
        return self._real_repository._find_inconsistent_revision_parents(
1725
 
            revisions_iterator)
 
1513
        return self._real_repository._find_inconsistent_revision_parents()
1726
1514
 
1727
1515
    def _check_for_inconsistent_revision_parents(self):
1728
1516
        self._ensure_real()
1734
1522
            providers.insert(0, other)
1735
1523
        providers.extend(r._make_parents_provider() for r in
1736
1524
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
1525
        return graph._StackedParentsProvider(providers)
1738
1526
 
1739
1527
    def _serialise_search_recipe(self, recipe):
1740
1528
        """Serialise a graph search recipe.
1781
1569
 
1782
1570
    def insert_stream(self, stream, src_format, resume_tokens):
1783
1571
        target = self.target_repo
1784
 
        target._unstacked_provider.missing_keys.clear()
1785
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1786
1572
        if target._lock_token:
1787
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1788
 
            lock_args = (target._lock_token or '',)
 
1573
            verb = 'Repository.insert_stream_locked'
 
1574
            extra_args = (target._lock_token or '',)
 
1575
            required_version = (1, 14)
1789
1576
        else:
1790
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1791
 
            lock_args = ()
 
1577
            verb = 'Repository.insert_stream'
 
1578
            extra_args = ()
 
1579
            required_version = (1, 13)
1792
1580
        client = target._client
1793
1581
        medium = client._medium
 
1582
        if medium._is_remote_before(required_version):
 
1583
            # No possible way this can work.
 
1584
            return self._insert_real(stream, src_format, resume_tokens)
1794
1585
        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
 
1586
        if not resume_tokens:
 
1587
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1588
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1589
            # fallback to the _real_repositories sink *with a partial stream*.
 
1590
            # Thats bad because we insert less data than bzr expected. To avoid
 
1591
            # this we do a trial push to make sure the verb is accessible, and
 
1592
            # do not fallback when actually pushing the stream. A cleanup patch
 
1593
            # is going to look at rewinding/restarting the stream/partial
 
1594
            # buffering etc.
1808
1595
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1809
1596
            try:
1810
1597
                response = client.call_with_body_stream(
1811
 
                    (verb, path, '') + lock_args, byte_stream)
 
1598
                    (verb, path, '') + extra_args, byte_stream)
1812
1599
            except errors.UnknownSmartMethod:
1813
1600
                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)
 
1601
                return self._insert_real(stream, src_format, resume_tokens)
1828
1602
        byte_stream = smart_repo._stream_to_byte_stream(
1829
1603
            stream, src_format)
1830
1604
        resume_tokens = ' '.join(resume_tokens)
1831
1605
        response = client.call_with_body_stream(
1832
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1606
            (verb, path, resume_tokens) + extra_args, byte_stream)
1833
1607
        if response[0][0] not in ('ok', 'missing-basis'):
1834
1608
            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
1609
        if response[0][0] == 'missing-basis':
1842
1610
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1843
1611
            resume_tokens = tokens
1844
 
            return resume_tokens, set(missing_keys)
 
1612
            return resume_tokens, missing_keys
1845
1613
        else:
1846
1614
            self.target_repo.refresh_data()
1847
1615
            return [], set()
1848
1616
 
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
1617
 
1890
1618
class RemoteStreamSource(repository.StreamSource):
1891
1619
    """Stream data from a remote server."""
1894
1622
        if (self.from_repository._fallback_repositories and
1895
1623
            self.to_format._fetch_order == 'topological'):
1896
1624
            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)
 
1625
        return self.missing_parents_chain(search, [self.from_repository] +
 
1626
            self.from_repository._fallback_repositories)
1914
1627
 
1915
1628
    def _real_stream(self, repo, search):
1916
1629
        """Get a stream for search from repo.
1923
1636
        """
1924
1637
        source = repo._get_source(self.to_format)
1925
1638
        if isinstance(source, RemoteStreamSource):
1926
 
            repo._ensure_real()
1927
 
            source = repo._real_repository._get_source(self.to_format)
 
1639
            return repository.StreamSource.get_stream(source, search)
1928
1640
        return source.get_stream(search)
1929
1641
 
1930
1642
    def _get_stream(self, repo, search):
1947
1659
            return self._real_stream(repo, search)
1948
1660
        client = repo._client
1949
1661
        medium = client._medium
 
1662
        if medium._is_remote_before((1, 13)):
 
1663
            # streaming was added in 1.13
 
1664
            return self._real_stream(repo, search)
1950
1665
        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:
 
1666
        try:
 
1667
            search_bytes = repo._serialise_search_result(search)
 
1668
            response = repo._call_with_body_bytes_expecting_body(
 
1669
                'Repository.get_stream',
 
1670
                (path, self.to_format.network_name()), search_bytes)
 
1671
            response_tuple, response_handler = response
 
1672
        except errors.UnknownSmartMethod:
 
1673
            medium._remember_remote_is_before((1,13))
1970
1674
            return self._real_stream(repo, search)
1971
1675
        if response_tuple[0] != 'ok':
1972
1676
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1984
1688
        :param search: The overall search to satisfy with streams.
1985
1689
        :param sources: A list of Repository objects to query.
1986
1690
        """
1987
 
        self.from_serialiser = self.from_repository._format._serializer
 
1691
        self.serialiser = self.to_format._serializer
1988
1692
        self.seen_revs = set()
1989
1693
        self.referenced_revs = set()
1990
1694
        # If there are heads in the search, or the key count is > 0, we are not
2007
1711
    def missing_parents_rev_handler(self, substream):
2008
1712
        for content in substream:
2009
1713
            revision_bytes = content.get_bytes_as('fulltext')
2010
 
            revision = self.from_serialiser.read_revision_from_string(
2011
 
                revision_bytes)
 
1714
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2012
1715
            self.seen_revs.add(content.key[-1])
2013
1716
            self.referenced_revs.update(revision.parent_ids)
2014
1717
            yield content
2053
1756
                self._network_name)
2054
1757
 
2055
1758
    def get_format_description(self):
2056
 
        self._ensure_real()
2057
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1759
        return 'Remote BZR Branch'
2058
1760
 
2059
1761
    def network_name(self):
2060
1762
        return self._network_name
2061
1763
 
2062
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2063
 
        return a_bzrdir.open_branch(name=name, 
2064
 
            ignore_fallbacks=ignore_fallbacks)
 
1764
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1765
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2065
1766
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1767
    def _vfs_initialize(self, a_bzrdir):
2067
1768
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
1769
        # method is not available on the server.
2069
1770
        # self._custom_format is always set - the start of initialize ensures
2070
1771
        # that.
2071
1772
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
1773
            a_bzrdir._ensure_real()
2073
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
1774
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2075
1775
        else:
2076
1776
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1777
            result = self._custom_format.initialize(a_bzrdir)
2078
1778
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
1779
            not isinstance(result, RemoteBranch)):
2080
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
 
                                  name=name)
 
1780
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2082
1781
        return result
2083
1782
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
1783
    def initialize(self, a_bzrdir):
2085
1784
        # 1) get the network name to use.
2086
1785
        if self._custom_format:
2087
1786
            network_name = self._custom_format.network_name()
2093
1792
            network_name = reference_format.network_name()
2094
1793
        # Being asked to create on a non RemoteBzrDir:
2095
1794
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1795
            return self._vfs_initialize(a_bzrdir)
2097
1796
        medium = a_bzrdir._client._medium
2098
1797
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1798
            return self._vfs_initialize(a_bzrdir)
2100
1799
        # Creating on a remote bzr dir.
2101
1800
        # 2) try direct creation via RPC
2102
1801
        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
1802
        verb = 'BzrDir.create_branch'
2107
1803
        try:
2108
1804
            response = a_bzrdir._call(verb, path, network_name)
2109
1805
        except errors.UnknownSmartMethod:
2110
1806
            # Fallback - use vfs methods
2111
1807
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1808
            return self._vfs_initialize(a_bzrdir)
2113
1809
        if response[0] != 'ok':
2114
1810
            raise errors.UnexpectedSmartServerResponse(response)
2115
1811
        # Turn the response into a RemoteRepository object.
2123
1819
                a_bzrdir._client)
2124
1820
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
1821
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
 
            format=format, setup_stacking=False, name=name)
 
1822
            format=format, setup_stacking=False)
2127
1823
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
1824
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
1825
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2144
1840
        self._ensure_real()
2145
1841
        return self._custom_format.supports_stacking()
2146
1842
 
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):
 
1843
 
 
1844
class RemoteBranch(branch.Branch, _RpcHelper):
2153
1845
    """Branch stored on a server accessed by HPSS RPC.
2154
1846
 
2155
1847
    At the moment most operations are mapped down to simple file operations.
2156
1848
    """
2157
1849
 
2158
1850
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1851
        _client=None, format=None, setup_stacking=True):
2160
1852
        """Create a RemoteBranch instance.
2161
1853
 
2162
1854
        :param real_branch: An optional local implementation of the branch
2168
1860
        :param setup_stacking: If True make an RPC call to determine the
2169
1861
            stacked (or not) status of the branch. If False assume the branch
2170
1862
            is not stacked.
2171
 
        :param name: Colocated branch name
2172
1863
        """
2173
1864
        # We intentionally don't call the parent class's __init__, because it
2174
1865
        # will try to assign to self.tags, which is a property in this subclass.
2175
1866
        # And the parent's __init__ doesn't do much anyway.
 
1867
        self._revision_id_to_revno_cache = None
 
1868
        self._partial_revision_id_to_revno_cache = {}
 
1869
        self._revision_history_cache = None
 
1870
        self._last_revision_info_cache = None
 
1871
        self._merge_sorted_revisions_cache = None
2176
1872
        self.bzrdir = remote_bzrdir
2177
1873
        if _client is not None:
2178
1874
            self._client = _client
2191
1887
            self._real_branch.repository = self.repository
2192
1888
        else:
2193
1889
            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
 
1890
        # Fill out expected attributes of branch for bzrlib api users.
 
1891
        self.base = self.bzrdir.root_transport.base
2199
1892
        self._control_files = None
2200
1893
        self._lock_mode = None
2201
1894
        self._lock_token = None
2212
1905
                    self._real_branch._format.network_name()
2213
1906
        else:
2214
1907
            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
1908
        if not self._format._network_name:
2219
1909
            # Did not get from open_branchV2 - old server.
2220
1910
            self._ensure_real()
2225
1915
        hooks = branch.Branch.hooks['open']
2226
1916
        for hook in hooks:
2227
1917
            hook(self)
2228
 
        self._is_stacked = False
2229
1918
        if setup_stacking:
2230
1919
            self._setup_stacking()
2231
1920
 
2237
1926
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2238
1927
            errors.UnstackableRepositoryFormat), e:
2239
1928
            return
2240
 
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
2242
 
 
2243
 
    def _get_config(self):
2244
 
        return RemoteBranchConfig(self)
 
1929
        # it's relative to this branch...
 
1930
        fallback_url = urlutils.join(self.base, fallback_url)
 
1931
        transports = [self.bzrdir.root_transport]
 
1932
        stacked_on = branch.Branch.open(fallback_url,
 
1933
                                        possible_transports=transports)
 
1934
        self.repository.add_fallback_repository(stacked_on.repository)
2245
1935
 
2246
1936
    def _get_real_transport(self):
2247
1937
        # if we try vfs access, return the real branch's vfs transport
2265
1955
                raise AssertionError('smart server vfs must be enabled '
2266
1956
                    'to use vfs implementation')
2267
1957
            self.bzrdir._ensure_real()
2268
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2269
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1958
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2270
1959
            if self.repository._real_repository is None:
2271
1960
                # Give the remote repository the matching real repo.
2272
1961
                real_repo = self._real_branch.repository
2346
2035
            raise errors.UnexpectedSmartServerResponse(response)
2347
2036
        return response[1]
2348
2037
 
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
2038
    def _vfs_get_tags_bytes(self):
2357
2039
        self._ensure_real()
2358
2040
        return self._real_branch._get_tags_bytes()
2368
2050
            return self._vfs_get_tags_bytes()
2369
2051
        return response[0]
2370
2052
 
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
2053
    def lock_read(self):
2390
2054
        self.repository.lock_read()
2391
2055
        if not self._lock_mode:
2392
 
            self._note_lock('r')
2393
2056
            self._lock_mode = 'r'
2394
2057
            self._lock_count = 1
2395
2058
            if self._real_branch is not None:
2415
2078
 
2416
2079
    def lock_write(self, token=None):
2417
2080
        if not self._lock_mode:
2418
 
            self._note_lock('w')
2419
2081
            # Lock the branch and repo in one remote call.
2420
2082
            remote_tokens = self._remote_lock_write(token)
2421
2083
            self._lock_token, self._repo_lock_token = remote_tokens
2447
2109
            self.repository.lock_write(self._repo_lock_token)
2448
2110
        return self._lock_token or None
2449
2111
 
 
2112
    def _set_tags_bytes(self, bytes):
 
2113
        self._ensure_real()
 
2114
        return self._real_branch._set_tags_bytes(bytes)
 
2115
 
2450
2116
    def _unlock(self, branch_token, repo_token):
2451
2117
        err_context = {'token': str((branch_token, repo_token))}
2452
2118
        response = self._call(
2456
2122
            return
2457
2123
        raise errors.UnexpectedSmartServerResponse(response)
2458
2124
 
2459
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2460
2125
    def unlock(self):
2461
2126
        try:
2462
2127
            self._lock_count -= 1
2475
2140
                    self._real_branch.unlock()
2476
2141
                if mode != 'w':
2477
2142
                    # Only write-locked branched need to make a remote method
2478
 
                    # call to perform the unlock.
 
2143
                    # call to perfom the unlock.
2479
2144
                    return
2480
2145
                if not self._lock_token:
2481
2146
                    raise AssertionError('Locked, but no token!')
2502
2167
            raise NotImplementedError(self.dont_leave_lock_in_place)
2503
2168
        self._leave_lock = False
2504
2169
 
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
2170
    def _last_revision_info(self):
2524
2171
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2172
        if response[0] != 'ok':
2530
2177
 
2531
2178
    def _gen_revision_history(self):
2532
2179
        """See Branch._gen_revision_history()."""
2533
 
        if self._is_stacked:
2534
 
            self._ensure_real()
2535
 
            return self._real_branch._gen_revision_history()
2536
2180
        response_tuple, response_handler = self._call_expecting_body(
2537
2181
            'Branch.revision_history', self._remote_path())
2538
2182
        if response_tuple[0] != 'ok':
2623
2267
        self._ensure_real()
2624
2268
        return self._real_branch._get_parent_location()
2625
2269
 
 
2270
    def set_parent(self, url):
 
2271
        self._ensure_real()
 
2272
        return self._real_branch.set_parent(url)
 
2273
 
2626
2274
    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):
 
2275
        # Used by tests, to poke bad urls into branch configurations
 
2276
        if url is None:
 
2277
            self.set_parent(url)
 
2278
        else:
 
2279
            self._ensure_real()
 
2280
            return self._real_branch._set_parent_location(url)
 
2281
 
 
2282
    def set_stacked_on_url(self, stacked_location):
 
2283
        """Set the URL this branch is stacked against.
 
2284
 
 
2285
        :raises UnstackableBranchFormat: If the branch does not support
 
2286
            stacking.
 
2287
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2288
            stacking.
 
2289
        """
2644
2290
        self._ensure_real()
2645
 
        return self._real_branch._set_parent_location(url)
 
2291
        return self._real_branch.set_stacked_on_url(stacked_location)
2646
2292
 
2647
2293
    @needs_write_lock
2648
2294
    def pull(self, source, overwrite=False, stop_revision=None,
2716
2362
        return self._real_branch.set_push_location(location)
2717
2363
 
2718
2364
 
2719
 
class RemoteConfig(object):
2720
 
    """A Config that reads and writes from smart verbs.
2721
 
 
2722
 
    It is a low-level object that considers config data to be name/value pairs
2723
 
    that may be associated with a section. Assigning meaning to the these
2724
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2725
 
    """
2726
 
 
2727
 
    def get_option(self, name, section=None, default=None):
2728
 
        """Return the value associated with a named option.
2729
 
 
2730
 
        :param name: The name of the value
2731
 
        :param section: The section the option is in (if any)
2732
 
        :param default: The value to return if the value is not set
2733
 
        :return: The value or default value
2734
 
        """
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
2760
 
 
2761
 
    def _get_configobj(self):
2762
 
        path = self._branch._remote_path()
2763
 
        response = self._branch._client.call_expecting_body(
2764
 
            'Branch.get_config_file', path)
2765
 
        return self._response_to_configobj(response)
2766
 
 
2767
 
    def set_option(self, value, name, section=None):
2768
 
        """Set the value associated with a named option.
2769
 
 
2770
 
        :param value: The value to set
2771
 
        :param name: The name of the value to set
2772
 
        :param section: The section the option is in (if any)
2773
 
        """
2774
 
        medium = self._branch._client._medium
2775
 
        if medium._is_remote_before((1, 14)):
2776
 
            return self._vfs_set_option(value, name, section)
2777
 
        try:
2778
 
            path = self._branch._remote_path()
2779
 
            response = self._branch._client.call('Branch.set_config_option',
2780
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
 
                value.encode('utf8'), name, section or '')
2782
 
        except errors.UnknownSmartMethod:
2783
 
            medium._remember_remote_is_before((1, 14))
2784
 
            return self._vfs_set_option(value, name, section)
2785
 
        if response != ():
2786
 
            raise errors.UnexpectedSmartServerResponse(response)
2787
 
 
2788
 
    def _real_object(self):
2789
 
        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
 
 
2831
 
 
2832
 
 
2833
2365
def _extract_tar(tar, to_dir):
2834
2366
    """Extract all the contents of a tarfile object.
2835
2367
 
2873
2405
                    'Missing key %r in context %r', key_err.args[0], context)
2874
2406
                raise err
2875
2407
 
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':
 
2408
    if err.error_verb == 'NoSuchRevision':
2880
2409
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
2410
    elif err.error_verb == 'nosuchrevision':
2882
2411
        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)
 
2412
    elif err.error_tuple == ('nobranch',):
 
2413
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2890
2414
    elif err.error_verb == 'norepository':
2891
2415
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
2416
    elif err.error_verb == 'LockContention':