← 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 04:20:12 UTC
  • mfrom: (3468.3.4 controlfiles)
  • Revision ID: pqm@pqm.ubuntu.com-20090325042012-23a6pm0mraw7g2kg
(mbp) better CountedLock handling of tokens,
        and bzrdir takes more responsibility for default file modes

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
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
35
from bzrlib.branch import BranchReferenceFormat
37
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
38
from bzrlib.errors import (
40
39
    NoSuchRevision,
41
40
    SmartProtocolError,
43
42
from bzrlib.lockable_files import LockableFiles
44
43
from bzrlib.smart import client, vfs, repository as smart_repo
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
48
47
 
49
48
 
50
49
class _RpcHelper(object):
62
61
        except errors.ErrorFromSmartServer, err:
63
62
            self._translate_error(err, **err_context)
64
63
 
65
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
66
 
        try:
67
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
68
 
        except errors.ErrorFromSmartServer, err:
69
 
            self._translate_error(err, **err_context)
70
 
 
71
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
65
                                             **err_context):
73
66
        try:
92
85
class RemoteBzrDir(BzrDir, _RpcHelper):
93
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
87
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
96
89
        """Construct a RemoteBzrDir.
97
90
 
98
91
        :param _client: Private parameter for testing. Disables probing and the
102
95
        # this object holds a delegated bzrdir that uses file-level operations
103
96
        # to talk to the other side
104
97
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
99
        # create_branch for details.
108
100
        self._next_open_branch_result = None
112
104
            self._client = client._SmartClient(medium)
113
105
        else:
114
106
            self._client = _client
115
 
            if not _force_probe:
116
 
                return
117
 
 
118
 
        self._probe_bzrdir()
119
 
 
120
 
    def __repr__(self):
121
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
122
 
 
123
 
    def _probe_bzrdir(self):
124
 
        medium = self._client._medium
 
107
            return
 
108
 
125
109
        path = self._path_for_remote_call(self._client)
126
 
        if medium._is_remote_before((2, 1)):
127
 
            self._rpc_open(path)
128
 
            return
129
 
        try:
130
 
            self._rpc_open_2_1(path)
131
 
            return
132
 
        except errors.UnknownSmartMethod:
133
 
            medium._remember_remote_is_before((2, 1))
134
 
            self._rpc_open(path)
135
 
 
136
 
    def _rpc_open_2_1(self, path):
137
 
        response = self._call('BzrDir.open_2.1', path)
138
 
        if response == ('no',):
139
 
            raise errors.NotBranchError(path=self.root_transport.base)
140
 
        elif response[0] == 'yes':
141
 
            if response[1] == 'yes':
142
 
                self._has_working_tree = True
143
 
            elif response[1] == 'no':
144
 
                self._has_working_tree = False
145
 
            else:
146
 
                raise errors.UnexpectedSmartServerResponse(response)
147
 
        else:
148
 
            raise errors.UnexpectedSmartServerResponse(response)
149
 
 
150
 
    def _rpc_open(self, path):
151
110
        response = self._call('BzrDir.open', path)
152
111
        if response not in [('yes',), ('no',)]:
153
112
            raise errors.UnexpectedSmartServerResponse(response)
154
113
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
156
115
 
157
116
    def _ensure_real(self):
158
117
        """Ensure that there is a _real_bzrdir set.
160
119
        Used before calls to self._real_bzrdir.
161
120
        """
162
121
        if not self._real_bzrdir:
163
 
            if 'hpssvfs' in debug.debug_flags:
164
 
                import traceback
165
 
                warning('VFS BzrDir access triggered\n%s',
166
 
                    ''.join(traceback.format_stack()))
167
122
            self._real_bzrdir = BzrDir.open_from_transport(
168
123
                self.root_transport, _server_formats=False)
169
124
            self._format._network_name = \
245
200
        self._ensure_real()
246
201
        self._real_bzrdir.destroy_repository()
247
202
 
248
 
    def create_branch(self, name=None):
 
203
    def create_branch(self):
249
204
        # as per meta1 formats - just delegate to the format object which may
250
205
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
206
        real_branch = self._format.get_branch_format().initialize(self)
253
207
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
208
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
209
        else:
257
210
            result = real_branch
258
211
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
217
        self._next_open_branch_result = result
265
218
        return result
266
219
 
267
 
    def destroy_branch(self, name=None):
 
220
    def destroy_branch(self):
268
221
        """See BzrDir.destroy_branch"""
269
222
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
223
        self._real_bzrdir.destroy_branch()
271
224
        self._next_open_branch_result = None
272
225
 
273
226
    def create_workingtree(self, revision_id=None, from_branch=None):
292
245
    def _get_branch_reference(self):
293
246
        path = self._path_for_remote_call(self._client)
294
247
        medium = self._client._medium
295
 
        candidate_calls = [
296
 
            ('BzrDir.open_branchV3', (2, 1)),
297
 
            ('BzrDir.open_branchV2', (1, 13)),
298
 
            ('BzrDir.open_branch', None),
299
 
            ]
300
 
        for verb, required_version in candidate_calls:
301
 
            if required_version and medium._is_remote_before(required_version):
302
 
                continue
 
248
        if not medium._is_remote_before((1, 13)):
303
249
            try:
304
 
                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
305
254
            except errors.UnknownSmartMethod:
306
 
                if required_version is None:
307
 
                    raise
308
 
                medium._remember_remote_is_before(required_version)
309
 
            else:
310
 
                break
311
 
        if verb == 'BzrDir.open_branch':
312
 
            if response[0] != 'ok':
313
 
                raise errors.UnexpectedSmartServerResponse(response)
314
 
            if response[1] != '':
315
 
                return ('ref', response[1])
316
 
            else:
317
 
                return ('branch', '')
318
 
        if response[0] not in ('ref', 'branch'):
 
255
                medium._remember_remote_is_before((1, 13))
 
256
        response = self._call('BzrDir.open_branch', path)
 
257
        if response[0] != 'ok':
319
258
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
 
259
        if response[1] != '':
 
260
            return ('ref', response[1])
 
261
        else:
 
262
            return ('branch', '')
321
263
 
322
264
    def _get_tree_branch(self):
323
265
        """See BzrDir._get_tree_branch()."""
324
266
        return None, self.open_branch()
325
267
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
268
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
269
        if _unsupported:
329
270
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
271
        if self._next_open_branch_result is not None:
331
272
            # See create_branch for details.
336
277
        if response[0] == 'ref':
337
278
            # a branch reference, use the existing BranchReference logic.
338
279
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
280
            return format.open(self, _found=True, location=response[1],
 
281
                ignore_fallbacks=ignore_fallbacks)
341
282
        branch_format_name = response[1]
342
283
        if not branch_format_name:
343
284
            branch_format_name = None
344
285
        format = RemoteBranchFormat(network_name=branch_format_name)
345
286
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
 
287
            setup_stacking=not ignore_fallbacks)
347
288
 
348
289
    def _open_repo_v1(self, path):
349
290
        verb = 'BzrDir.find_repository'
410
351
        else:
411
352
            raise errors.NoRepositoryPresent(self)
412
353
 
413
 
    def has_workingtree(self):
414
 
        if self._has_working_tree is None:
415
 
            self._ensure_real()
416
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
417
 
        return self._has_working_tree
418
 
 
419
354
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
355
        self._ensure_real()
 
356
        if self._real_bzrdir.has_workingtree():
421
357
            raise errors.NotLocalUrl(self.root_transport)
422
358
        else:
423
359
            raise errors.NoWorkingTree(self.root_transport.base)
426
362
        """Return the path to be used for this bzrdir in a remote call."""
427
363
        return client.remote_path_from_transport(self.root_transport)
428
364
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
365
    def get_branch_transport(self, branch_format):
430
366
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
367
        return self._real_bzrdir.get_branch_transport(branch_format)
432
368
 
433
369
    def get_repository_transport(self, repository_format):
434
370
        self._ensure_real()
455
391
        return self._real_bzrdir.clone(url, revision_id=revision_id,
456
392
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
457
393
 
458
 
    def _get_config(self):
459
 
        return RemoteBzrDirConfig(self)
 
394
    def get_config(self):
 
395
        self._ensure_real()
 
396
        return self._real_bzrdir.get_config()
460
397
 
461
398
 
462
399
class RemoteRepositoryFormat(repository.RepositoryFormat):
486
423
        self._custom_format = None
487
424
        self._network_name = None
488
425
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
426
        self._supports_external_lookups = None
491
427
        self._supports_tree_reference = None
492
428
        self._rich_root_data = None
493
429
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
430
    @property
499
431
    def fast_deltas(self):
500
432
        self._ensure_real()
508
440
        return self._rich_root_data
509
441
 
510
442
    @property
511
 
    def supports_chks(self):
512
 
        if self._supports_chks is None:
513
 
            self._ensure_real()
514
 
            self._supports_chks = self._custom_format.supports_chks
515
 
        return self._supports_chks
516
 
 
517
 
    @property
518
443
    def supports_external_lookups(self):
519
444
        if self._supports_external_lookups is None:
520
445
            self._ensure_real()
566
491
        # 1) get the network name to use.
567
492
        if self._custom_format:
568
493
            network_name = self._custom_format.network_name()
569
 
        elif self._network_name:
570
 
            network_name = self._network_name
571
494
        else:
572
495
            # Select the current bzrlib default and ask for that.
573
496
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
621
544
        return self._custom_format._fetch_reconcile
622
545
 
623
546
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
547
        return 'bzr remote repository'
626
548
 
627
549
    def __eq__(self, other):
628
550
        return self.__class__ is other.__class__
629
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
 
630
561
    def network_name(self):
631
562
        if self._network_name:
632
563
            return self._network_name
634
565
        return self._creating_repo._real_repository._format.network_name()
635
566
 
636
567
    @property
637
 
    def pack_compresses(self):
638
 
        self._ensure_real()
639
 
        return self._custom_format.pack_compresses
640
 
 
641
 
    @property
642
568
    def _serializer(self):
643
569
        self._ensure_real()
644
570
        return self._custom_format._serializer
645
571
 
646
572
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
573
class RemoteRepository(_RpcHelper):
649
574
    """Repository accessed over rpc.
650
575
 
651
576
    For the moment most operations are performed using local transport-backed
677
602
        self._lock_token = None
678
603
        self._lock_count = 0
679
604
        self._leave_lock = False
680
 
        # Cache of revision parents; misses are cached during read locks, and
681
 
        # write locks when no _real_repository has been set.
682
605
        self._unstacked_provider = graph.CachingParentsProvider(
683
606
            get_parent_map=self._get_parent_map_rpc)
684
607
        self._unstacked_provider.disable_cache()
694
617
        # Additional places to query for data.
695
618
        self._fallback_repositories = []
696
619
 
697
 
    @property
698
 
    def user_transport(self):
699
 
        return self.bzrdir.user_transport
700
 
 
701
 
    @property
702
 
    def control_transport(self):
703
 
        # XXX: Normally you shouldn't directly get at the remote repository
704
 
        # transport, but I'm not sure it's worth making this method
705
 
        # optional -- mbp 2010-04-21
706
 
        return self.bzrdir.get_repository_transport(None)
707
 
        
708
620
    def __str__(self):
709
621
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
622
 
713
625
    def abort_write_group(self, suppress_errors=False):
714
626
        """Complete a write group on the decorated repository.
715
627
 
716
 
        Smart methods perform operations in a single step so this API
 
628
        Smart methods peform operations in a single step so this api
717
629
        is not really applicable except as a compatibility thunk
718
630
        for older plugins that don't use e.g. the CommitBuilder
719
631
        facility.
724
636
        return self._real_repository.abort_write_group(
725
637
            suppress_errors=suppress_errors)
726
638
 
727
 
    @property
728
 
    def chk_bytes(self):
729
 
        """Decorate the real repository for now.
730
 
 
731
 
        In the long term a full blown network facility is needed to avoid
732
 
        creating a real repository object locally.
733
 
        """
734
 
        self._ensure_real()
735
 
        return self._real_repository.chk_bytes
736
 
 
737
639
    def commit_write_group(self):
738
640
        """Complete a write group on the decorated repository.
739
641
 
740
 
        Smart methods perform operations in a single step so this API
 
642
        Smart methods peform operations in a single step so this api
741
643
        is not really applicable except as a compatibility thunk
742
644
        for older plugins that don't use e.g. the CommitBuilder
743
645
        facility.
753
655
        self._ensure_real()
754
656
        return self._real_repository.suspend_write_group()
755
657
 
756
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
757
 
        self._ensure_real()
758
 
        return self._real_repository.get_missing_parent_inventories(
759
 
            check_for_missing_texts=check_for_missing_texts)
760
 
 
761
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
762
 
        self._ensure_real()
763
 
        return self._real_repository.get_rev_id_for_revno(
764
 
            revno, known_pair)
765
 
 
766
 
    def get_rev_id_for_revno(self, revno, known_pair):
767
 
        """See Repository.get_rev_id_for_revno."""
768
 
        path = self.bzrdir._path_for_remote_call(self._client)
769
 
        try:
770
 
            if self._client._medium._is_remote_before((1, 17)):
771
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
772
 
            response = self._call(
773
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
774
 
        except errors.UnknownSmartMethod:
775
 
            self._client._medium._remember_remote_is_before((1, 17))
776
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
777
 
        if response[0] == 'ok':
778
 
            return True, response[1]
779
 
        elif response[0] == 'history-incomplete':
780
 
            known_pair = response[1:3]
781
 
            for fallback in self._fallback_repositories:
782
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
783
 
                if found:
784
 
                    return True, result
785
 
                else:
786
 
                    known_pair = result
787
 
            # Not found in any fallbacks
788
 
            return False, known_pair
789
 
        else:
790
 
            raise errors.UnexpectedSmartServerResponse(response)
791
 
 
792
658
    def _ensure_real(self):
793
659
        """Ensure that there is a _real_repository set.
794
660
 
803
669
        invocation. If in doubt chat to the bzr network team.
804
670
        """
805
671
        if self._real_repository is None:
806
 
            if 'hpssvfs' in debug.debug_flags:
807
 
                import traceback
808
 
                warning('VFS Repository access triggered\n%s',
809
 
                    ''.join(traceback.format_stack()))
810
 
            self._unstacked_provider.missing_keys.clear()
811
672
            self.bzrdir._ensure_real()
812
673
            self._set_real_repository(
813
674
                self.bzrdir._real_bzrdir.open_repository())
873
734
        """Return a source for streaming from this repository."""
874
735
        return RemoteStreamSource(self, to_format)
875
736
 
876
 
    @needs_read_lock
877
737
    def has_revision(self, revision_id):
878
 
        """True if this repository has a copy of the revision."""
879
 
        # Copy of bzrlib.repository.Repository.has_revision
880
 
        return revision_id in self.has_revisions((revision_id,))
 
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
881
752
 
882
 
    @needs_read_lock
883
753
    def has_revisions(self, revision_ids):
884
 
        """Probe to find out the presence of multiple revisions.
885
 
 
886
 
        :param revision_ids: An iterable of revision_ids.
887
 
        :return: A set of the revision_ids that were present.
888
 
        """
889
 
        # Copy of bzrlib.repository.Repository.has_revisions
890
 
        parent_map = self.get_parent_map(revision_ids)
891
 
        result = set(parent_map)
892
 
        if _mod_revision.NULL_REVISION in revision_ids:
893
 
            result.add(_mod_revision.NULL_REVISION)
 
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)
894
761
        return result
895
762
 
896
 
    def _has_same_fallbacks(self, other_repo):
897
 
        """Returns true if the repositories have the same fallbacks."""
898
 
        # XXX: copied from Repository; it should be unified into a base class
899
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
900
 
        my_fb = self._fallback_repositories
901
 
        other_fb = other_repo._fallback_repositories
902
 
        if len(my_fb) != len(other_fb):
903
 
            return False
904
 
        for f, g in zip(my_fb, other_fb):
905
 
            if not f.has_same_location(g):
906
 
                return False
907
 
        return True
908
 
 
909
763
    def has_same_location(self, other):
910
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
911
 
        # one; unfortunately the tests rely on slightly different behaviour at
912
 
        # present -- mbp 20090710
913
764
        return (self.__class__ is other.__class__ and
914
765
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
766
 
918
769
        parents_provider = self._make_parents_provider(other_repository)
919
770
        return graph.Graph(parents_provider)
920
771
 
921
 
    @needs_read_lock
922
 
    def get_known_graph_ancestry(self, revision_ids):
923
 
        """Return the known graph for a set of revision ids and their ancestors.
924
 
        """
925
 
        st = static_tuple.StaticTuple
926
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
927
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
928
 
        return graph.GraphThunkIdsToKeys(known_graph)
929
 
 
930
772
    def gather_stats(self, revid=None, committers=None):
931
773
        """See Repository.gather_stats()."""
932
774
        path = self.bzrdir._path_for_remote_call(self._client)
992
834
    def is_write_locked(self):
993
835
        return self._lock_mode == 'w'
994
836
 
995
 
    def _warn_if_deprecated(self, branch=None):
996
 
        # If we have a real repository, the check will be done there, if we
997
 
        # don't the check will be done remotely.
998
 
        pass
999
 
 
1000
837
    def lock_read(self):
1001
 
        """Lock the repository for read operations.
1002
 
 
1003
 
        :return: An object with an unlock method which will release the lock
1004
 
            obtained.
1005
 
        """
1006
838
        # wrong eventually - want a local lock cache context
1007
839
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
840
            self._lock_mode = 'r'
1010
841
            self._lock_count = 1
1011
842
            self._unstacked_provider.enable_cache(cache_misses=True)
1012
843
            if self._real_repository is not None:
1013
844
                self._real_repository.lock_read()
1014
 
            for repo in self._fallback_repositories:
1015
 
                repo.lock_read()
1016
845
        else:
1017
846
            self._lock_count += 1
1018
 
        return self
1019
847
 
1020
848
    def _remote_lock_write(self, token):
1021
849
        path = self.bzrdir._path_for_remote_call(self._client)
1032
860
 
1033
861
    def lock_write(self, token=None, _skip_rpc=False):
1034
862
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
863
            if _skip_rpc:
1037
864
                if self._lock_token is not None:
1038
865
                    if token != self._lock_token:
1052
879
                self._leave_lock = False
1053
880
            self._lock_mode = 'w'
1054
881
            self._lock_count = 1
1055
 
            cache_misses = self._real_repository is None
1056
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1057
 
            for repo in self._fallback_repositories:
1058
 
                # Writes don't affect fallback repos
1059
 
                repo.lock_read()
 
882
            self._unstacked_provider.enable_cache(cache_misses=False)
1060
883
        elif self._lock_mode == 'r':
1061
884
            raise errors.ReadOnlyError(self)
1062
885
        else:
1063
886
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
887
        return self._lock_token or None
1065
888
 
1066
889
    def leave_lock_in_place(self):
1067
890
        if not self._lock_token:
1088
911
        if isinstance(repository, RemoteRepository):
1089
912
            raise AssertionError()
1090
913
        self._real_repository = repository
1091
 
        # three code paths happen here:
1092
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1093
 
        # up stacking. In this case self._fallback_repositories is [], and the
1094
 
        # real repo is already setup. Preserve the real repo and
1095
 
        # RemoteRepository.add_fallback_repository will avoid adding
1096
 
        # duplicates.
1097
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1098
 
        # ensure_real is triggered from a branch, the real repository to
1099
 
        # set already has a matching list with separate instances, but
1100
 
        # as they are also RemoteRepositories we don't worry about making the
1101
 
        # lists be identical.
1102
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1103
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1104
 
        # and need to populate it.
1105
 
        if (self._fallback_repositories and
1106
 
            len(self._real_repository._fallback_repositories) !=
1107
 
            len(self._fallback_repositories)):
1108
 
            if len(self._real_repository._fallback_repositories):
1109
 
                raise AssertionError(
1110
 
                    "cannot cleanly remove existing _fallback_repositories")
 
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 = []
1111
920
        for fb in self._fallback_repositories:
1112
921
            self._real_repository.add_fallback_repository(fb)
1113
922
        if self._lock_mode == 'w':
1120
929
    def start_write_group(self):
1121
930
        """Start a write group on the decorated repository.
1122
931
 
1123
 
        Smart methods perform operations in a single step so this API
 
932
        Smart methods peform operations in a single step so this api
1124
933
        is not really applicable except as a compatibility thunk
1125
934
        for older plugins that don't use e.g. the CommitBuilder
1126
935
        facility.
1141
950
        else:
1142
951
            raise errors.UnexpectedSmartServerResponse(response)
1143
952
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
953
    def unlock(self):
1146
954
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
955
            raise errors.LockNotHeld(self)
1148
956
        self._lock_count -= 1
1149
957
        if self._lock_count > 0:
1150
958
            return
1164
972
            # problem releasing the vfs-based lock.
1165
973
            if old_mode == 'w':
1166
974
                # Only write-locked repositories need to make a remote method
1167
 
                # call to perform the unlock.
 
975
                # call to perfom the unlock.
1168
976
                old_token = self._lock_token
1169
977
                self._lock_token = None
1170
978
                if not self._leave_lock:
1171
979
                    self._unlock(old_token)
1172
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1173
 
        # self._leave_lock
1174
 
        for repo in self._fallback_repositories:
1175
 
            repo.unlock()
1176
980
 
1177
981
    def break_lock(self):
1178
982
        # should hand off to the network
1242
1046
        # We need to accumulate additional repositories here, to pass them in
1243
1047
        # on various RPC's.
1244
1048
        #
1245
 
        if self.is_locked():
1246
 
            # We will call fallback.unlock() when we transition to the unlocked
1247
 
            # state, so always add a lock here. If a caller passes us a locked
1248
 
            # repository, they are responsible for unlocking it later.
1249
 
            repository.lock_read()
1250
 
        self._check_fallback_repository(repository)
1251
1049
        self._fallback_repositories.append(repository)
1252
1050
        # If self._real_repository was parameterised already (e.g. because a
1253
1051
        # _real_branch had its get_stacked_on_url method called), then the
1254
1052
        # repository to be added may already be in the _real_repositories list.
1255
1053
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
1257
 
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
1054
            if repository not in self._real_repository._fallback_repositories:
1259
1055
                self._real_repository.add_fallback_repository(repository)
1260
 
 
1261
 
    def _check_fallback_repository(self, repository):
1262
 
        """Check that this repository can fallback to repository safely.
1263
 
 
1264
 
        Raise an error if not.
1265
 
 
1266
 
        :param repository: A repository to fallback to.
1267
 
        """
1268
 
        return _mod_repository.InterRepository._assert_same_model(
1269
 
            self, repository)
 
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()
1270
1060
 
1271
1061
    def add_inventory(self, revid, inv, parents):
1272
1062
        self._ensure_real()
1273
1063
        return self._real_repository.add_inventory(revid, inv, parents)
1274
1064
 
1275
1065
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
1066
                               parents):
1277
1067
        self._ensure_real()
1278
1068
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1279
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1280
 
            propagate_caches=propagate_caches)
 
1069
            delta, new_revision_id, parents)
1281
1070
 
1282
1071
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1072
        self._ensure_real()
1289
1078
        self._ensure_real()
1290
1079
        return self._real_repository.get_inventory(revision_id)
1291
1080
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1081
    def iter_inventories(self, revision_ids):
1293
1082
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1083
        return self._real_repository.iter_inventories(revision_ids)
1295
1084
 
1296
1085
    @needs_read_lock
1297
1086
    def get_revision(self, revision_id):
1361
1150
            raise errors.InternalBzrError(
1362
1151
                "May not fetch while in a write group.")
1363
1152
        # fast path same-url fetch operations
1364
 
        if (self.has_same_location(source)
1365
 
            and fetch_spec is None
1366
 
            and self._has_same_fallbacks(source)):
 
1153
        if self.has_same_location(source) and fetch_spec is None:
1367
1154
            # check that last_revision is in 'from' and then return a
1368
1155
            # no-operation.
1369
1156
            if (revision_id is not None and
1418
1205
            # in one go, and the user probably will have seen a warning about
1419
1206
            # the server being old anyhow.
1420
1207
            rg = self._get_revision_graph(None)
1421
 
            # There is an API discrepancy between get_parent_map and
 
1208
            # There is an api discrepency between get_parent_map and
1422
1209
            # get_revision_graph. Specifically, a "key:()" pair in
1423
1210
            # get_revision_graph just means a node has no parents. For
1424
1211
            # "get_parent_map" it means the node is a ghost. So fix up the
1474
1261
        # We don't need to send ghosts back to the server as a position to
1475
1262
        # stop either.
1476
1263
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1477
 
        key_count = len(parents_map)
1478
 
        if (NULL_REVISION in result_parents
1479
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1480
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1481
 
            # in our cache of "missing" keys we need to increment our key count
1482
 
            # by 1, because the reconsitituted SearchResult on the server will
1483
 
            # still consider NULL_REVISION to be an included key.
1484
 
            key_count += 1
1485
1264
        included_keys = start_set.intersection(result_parents)
1486
1265
        start_set.difference_update(included_keys)
1487
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1266
        recipe = ('manual', start_set, stop_keys, len(parents_map))
1488
1267
        body = self._serialise_search_recipe(recipe)
1489
1268
        path = self.bzrdir._path_for_remote_call(self._client)
1490
1269
        for key in keys:
1542
1321
        return self._real_repository.get_signature_text(revision_id)
1543
1322
 
1544
1323
    @needs_read_lock
1545
 
    def _get_inventory_xml(self, revision_id):
1546
 
        self._ensure_real()
1547
 
        return self._real_repository._get_inventory_xml(revision_id)
 
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)
1548
1331
 
1549
1332
    def reconcile(self, other=None, thorough=False):
1550
1333
        self._ensure_real()
1577
1360
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1361
 
1579
1362
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1363
    def check(self, revision_ids=None):
1581
1364
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1365
        return self._real_repository.check(revision_ids=revision_ids)
1584
1366
 
1585
1367
    def copy_content_into(self, destination, revision_id=None):
1586
1368
        self._ensure_real()
1626
1408
        return self._real_repository.inventories
1627
1409
 
1628
1410
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1411
    def pack(self):
1630
1412
        """Compress the data within the repository.
1631
1413
 
1632
1414
        This is not currently implemented within the smart server.
1633
1415
        """
1634
1416
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1417
        return self._real_repository.pack()
1636
1418
 
1637
1419
    @property
1638
1420
    def revisions(self):
1726
1508
        self._ensure_real()
1727
1509
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1510
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1511
    def _find_inconsistent_revision_parents(self):
1730
1512
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1513
        return self._real_repository._find_inconsistent_revision_parents()
1733
1514
 
1734
1515
    def _check_for_inconsistent_revision_parents(self):
1735
1516
        self._ensure_real()
1741
1522
            providers.insert(0, other)
1742
1523
        providers.extend(r._make_parents_provider() for r in
1743
1524
                         self._fallback_repositories)
1744
 
        return graph.StackedParentsProvider(providers)
 
1525
        return graph._StackedParentsProvider(providers)
1745
1526
 
1746
1527
    def _serialise_search_recipe(self, recipe):
1747
1528
        """Serialise a graph search recipe.
1788
1569
 
1789
1570
    def insert_stream(self, stream, src_format, resume_tokens):
1790
1571
        target = self.target_repo
1791
 
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
1572
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
 
1573
            verb = 'Repository.insert_stream_locked'
 
1574
            extra_args = (target._lock_token or '',)
 
1575
            required_version = (1, 14)
1796
1576
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
 
1577
            verb = 'Repository.insert_stream'
 
1578
            extra_args = ()
 
1579
            required_version = (1, 13)
1799
1580
        client = target._client
1800
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)
1801
1585
        path = target.bzrdir._path_for_remote_call(client)
1802
 
        # Probe for the verb to use with an empty stream before sending the
1803
 
        # real stream to it.  We do this both to avoid the risk of sending a
1804
 
        # large request that is then rejected, and because we don't want to
1805
 
        # implement a way to buffer, rewind, or restart the stream.
1806
 
        found_verb = False
1807
 
        for verb, required_version in candidate_calls:
1808
 
            if medium._is_remote_before(required_version):
1809
 
                continue
1810
 
            if resume_tokens:
1811
 
                # We've already done the probing (and set _is_remote_before) on
1812
 
                # a previous insert.
1813
 
                found_verb = True
1814
 
                break
 
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.
1815
1595
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
1596
            try:
1817
1597
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1598
                    (verb, path, '') + extra_args, byte_stream)
1819
1599
            except errors.UnknownSmartMethod:
1820
1600
                medium._remember_remote_is_before(required_version)
1821
 
            else:
1822
 
                found_verb = True
1823
 
                break
1824
 
        if not found_verb:
1825
 
            # Have to use VFS.
1826
 
            return self._insert_real(stream, src_format, resume_tokens)
1827
 
        self._last_inv_record = None
1828
 
        self._last_substream = None
1829
 
        if required_version < (1, 19):
1830
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1831
 
            # make sure we don't send any.  If the stream contains inventory
1832
 
            # deltas we'll interrupt the smart insert_stream request and
1833
 
            # fallback to VFS.
1834
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1601
                return self._insert_real(stream, src_format, resume_tokens)
1835
1602
        byte_stream = smart_repo._stream_to_byte_stream(
1836
1603
            stream, src_format)
1837
1604
        resume_tokens = ' '.join(resume_tokens)
1838
1605
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1606
            (verb, path, resume_tokens) + extra_args, byte_stream)
1840
1607
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1608
            raise errors.UnexpectedSmartServerResponse(response)
1842
 
        if self._last_substream is not None:
1843
 
            # The stream included an inventory-delta record, but the remote
1844
 
            # side isn't new enough to support them.  So we need to send the
1845
 
            # rest of the stream via VFS.
1846
 
            self.target_repo.refresh_data()
1847
 
            return self._resume_stream_with_vfs(response, src_format)
1848
1609
        if response[0][0] == 'missing-basis':
1849
1610
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1611
            resume_tokens = tokens
1851
 
            return resume_tokens, set(missing_keys)
 
1612
            return resume_tokens, missing_keys
1852
1613
        else:
1853
1614
            self.target_repo.refresh_data()
1854
1615
            return [], set()
1855
1616
 
1856
 
    def _resume_stream_with_vfs(self, response, src_format):
1857
 
        """Resume sending a stream via VFS, first resending the record and
1858
 
        substream that couldn't be sent via an insert_stream verb.
1859
 
        """
1860
 
        if response[0][0] == 'missing-basis':
1861
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1862
 
            # Ignore missing_keys, we haven't finished inserting yet
1863
 
        else:
1864
 
            tokens = []
1865
 
        def resume_substream():
1866
 
            # Yield the substream that was interrupted.
1867
 
            for record in self._last_substream:
1868
 
                yield record
1869
 
            self._last_substream = None
1870
 
        def resume_stream():
1871
 
            # Finish sending the interrupted substream
1872
 
            yield ('inventory-deltas', resume_substream())
1873
 
            # Then simply continue sending the rest of the stream.
1874
 
            for substream_kind, substream in self._last_stream:
1875
 
                yield substream_kind, substream
1876
 
        return self._insert_real(resume_stream(), src_format, tokens)
1877
 
 
1878
 
    def _stop_stream_if_inventory_delta(self, stream):
1879
 
        """Normally this just lets the original stream pass-through unchanged.
1880
 
 
1881
 
        However if any 'inventory-deltas' substream occurs it will stop
1882
 
        streaming, and store the interrupted substream and stream in
1883
 
        self._last_substream and self._last_stream so that the stream can be
1884
 
        resumed by _resume_stream_with_vfs.
1885
 
        """
1886
 
                    
1887
 
        stream_iter = iter(stream)
1888
 
        for substream_kind, substream in stream_iter:
1889
 
            if substream_kind == 'inventory-deltas':
1890
 
                self._last_substream = substream
1891
 
                self._last_stream = stream_iter
1892
 
                return
1893
 
            else:
1894
 
                yield substream_kind, substream
1895
 
            
1896
1617
 
1897
1618
class RemoteStreamSource(repository.StreamSource):
1898
1619
    """Stream data from a remote server."""
1901
1622
        if (self.from_repository._fallback_repositories and
1902
1623
            self.to_format._fetch_order == 'topological'):
1903
1624
            return self._real_stream(self.from_repository, search)
1904
 
        sources = []
1905
 
        seen = set()
1906
 
        repos = [self.from_repository]
1907
 
        while repos:
1908
 
            repo = repos.pop(0)
1909
 
            if repo in seen:
1910
 
                continue
1911
 
            seen.add(repo)
1912
 
            repos.extend(repo._fallback_repositories)
1913
 
            sources.append(repo)
1914
 
        return self.missing_parents_chain(search, sources)
1915
 
 
1916
 
    def get_stream_for_missing_keys(self, missing_keys):
1917
 
        self.from_repository._ensure_real()
1918
 
        real_repo = self.from_repository._real_repository
1919
 
        real_source = real_repo._get_source(self.to_format)
1920
 
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1625
        return self.missing_parents_chain(search, [self.from_repository] +
 
1626
            self.from_repository._fallback_repositories)
1921
1627
 
1922
1628
    def _real_stream(self, repo, search):
1923
1629
        """Get a stream for search from repo.
1930
1636
        """
1931
1637
        source = repo._get_source(self.to_format)
1932
1638
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
 
1639
            return repository.StreamSource.get_stream(source, search)
1935
1640
        return source.get_stream(search)
1936
1641
 
1937
1642
    def _get_stream(self, repo, search):
1954
1659
            return self._real_stream(repo, search)
1955
1660
        client = repo._client
1956
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)
1957
1665
        path = repo.bzrdir._path_for_remote_call(client)
1958
 
        search_bytes = repo._serialise_search_result(search)
1959
 
        args = (path, self.to_format.network_name())
1960
 
        candidate_verbs = [
1961
 
            ('Repository.get_stream_1.19', (1, 19)),
1962
 
            ('Repository.get_stream', (1, 13))]
1963
 
        found_verb = False
1964
 
        for verb, version in candidate_verbs:
1965
 
            if medium._is_remote_before(version):
1966
 
                continue
1967
 
            try:
1968
 
                response = repo._call_with_body_bytes_expecting_body(
1969
 
                    verb, args, search_bytes)
1970
 
            except errors.UnknownSmartMethod:
1971
 
                medium._remember_remote_is_before(version)
1972
 
            else:
1973
 
                response_tuple, response_handler = response
1974
 
                found_verb = True
1975
 
                break
1976
 
        if not found_verb:
 
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))
1977
1674
            return self._real_stream(repo, search)
1978
1675
        if response_tuple[0] != 'ok':
1979
1676
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1991
1688
        :param search: The overall search to satisfy with streams.
1992
1689
        :param sources: A list of Repository objects to query.
1993
1690
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
 
1691
        self.serialiser = self.to_format._serializer
1995
1692
        self.seen_revs = set()
1996
1693
        self.referenced_revs = set()
1997
1694
        # If there are heads in the search, or the key count is > 0, we are not
2014
1711
    def missing_parents_rev_handler(self, substream):
2015
1712
        for content in substream:
2016
1713
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
 
1714
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2019
1715
            self.seen_revs.add(content.key[-1])
2020
1716
            self.referenced_revs.update(revision.parent_ids)
2021
1717
            yield content
2060
1756
                self._network_name)
2061
1757
 
2062
1758
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1759
        return 'Remote BZR Branch'
2065
1760
 
2066
1761
    def network_name(self):
2067
1762
        return self._network_name
2068
1763
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1764
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1765
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2072
1766
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1767
    def _vfs_initialize(self, a_bzrdir):
2074
1768
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1769
        # method is not available on the server.
2076
1770
        # self._custom_format is always set - the start of initialize ensures
2077
1771
        # that.
2078
1772
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1773
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1774
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1775
        else:
2083
1776
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1777
            result = self._custom_format.initialize(a_bzrdir)
2085
1778
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1779
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1780
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1781
        return result
2090
1782
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1783
    def initialize(self, a_bzrdir):
2092
1784
        # 1) get the network name to use.
2093
1785
        if self._custom_format:
2094
1786
            network_name = self._custom_format.network_name()
2100
1792
            network_name = reference_format.network_name()
2101
1793
        # Being asked to create on a non RemoteBzrDir:
2102
1794
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1795
            return self._vfs_initialize(a_bzrdir)
2104
1796
        medium = a_bzrdir._client._medium
2105
1797
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1798
            return self._vfs_initialize(a_bzrdir)
2107
1799
        # Creating on a remote bzr dir.
2108
1800
        # 2) try direct creation via RPC
2109
1801
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2110
 
        if name is not None:
2111
 
            # XXX JRV20100304: Support creating colocated branches
2112
 
            raise errors.NoColocatedBranchSupport(self)
2113
1802
        verb = 'BzrDir.create_branch'
2114
1803
        try:
2115
1804
            response = a_bzrdir._call(verb, path, network_name)
2116
1805
        except errors.UnknownSmartMethod:
2117
1806
            # Fallback - use vfs methods
2118
1807
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1808
            return self._vfs_initialize(a_bzrdir)
2120
1809
        if response[0] != 'ok':
2121
1810
            raise errors.UnexpectedSmartServerResponse(response)
2122
1811
        # Turn the response into a RemoteRepository object.
2130
1819
                a_bzrdir._client)
2131
1820
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1821
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1822
            format=format, setup_stacking=False)
2134
1823
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1824
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1825
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2151
1840
        self._ensure_real()
2152
1841
        return self._custom_format.supports_stacking()
2153
1842
 
2154
 
    def supports_set_append_revisions_only(self):
2155
 
        self._ensure_real()
2156
 
        return self._custom_format.supports_set_append_revisions_only()
2157
 
 
2158
 
 
2159
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1843
 
 
1844
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1845
    """Branch stored on a server accessed by HPSS RPC.
2161
1846
 
2162
1847
    At the moment most operations are mapped down to simple file operations.
2163
1848
    """
2164
1849
 
2165
1850
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1851
        _client=None, format=None, setup_stacking=True):
2167
1852
        """Create a RemoteBranch instance.
2168
1853
 
2169
1854
        :param real_branch: An optional local implementation of the branch
2175
1860
        :param setup_stacking: If True make an RPC call to determine the
2176
1861
            stacked (or not) status of the branch. If False assume the branch
2177
1862
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1863
        """
2180
1864
        # We intentionally don't call the parent class's __init__, because it
2181
1865
        # will try to assign to self.tags, which is a property in this subclass.
2182
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
2183
1872
        self.bzrdir = remote_bzrdir
2184
1873
        if _client is not None:
2185
1874
            self._client = _client
2198
1887
            self._real_branch.repository = self.repository
2199
1888
        else:
2200
1889
            self._real_branch = None
2201
 
        # Fill out expected attributes of branch for bzrlib API users.
2202
 
        self._clear_cached_state()
2203
 
        # TODO: deprecate self.base in favor of user_url
2204
 
        self.base = self.bzrdir.user_url
2205
 
        self._name = name
 
1890
        # Fill out expected attributes of branch for bzrlib api users.
 
1891
        self.base = self.bzrdir.root_transport.base
2206
1892
        self._control_files = None
2207
1893
        self._lock_mode = None
2208
1894
        self._lock_token = None
2219
1905
                    self._real_branch._format.network_name()
2220
1906
        else:
2221
1907
            self._format = format
2222
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2223
 
        # branch.open_branch method.
2224
 
        self._real_ignore_fallbacks = not setup_stacking
2225
1908
        if not self._format._network_name:
2226
1909
            # Did not get from open_branchV2 - old server.
2227
1910
            self._ensure_real()
2232
1915
        hooks = branch.Branch.hooks['open']
2233
1916
        for hook in hooks:
2234
1917
            hook(self)
2235
 
        self._is_stacked = False
2236
1918
        if setup_stacking:
2237
1919
            self._setup_stacking()
2238
1920
 
2244
1926
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2245
1927
            errors.UnstackableRepositoryFormat), e:
2246
1928
            return
2247
 
        self._is_stacked = True
2248
 
        self._activate_fallback_location(fallback_url)
2249
 
 
2250
 
    def _get_config(self):
2251
 
        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)
2252
1935
 
2253
1936
    def _get_real_transport(self):
2254
1937
        # if we try vfs access, return the real branch's vfs transport
2272
1955
                raise AssertionError('smart server vfs must be enabled '
2273
1956
                    'to use vfs implementation')
2274
1957
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1958
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
1959
            if self.repository._real_repository is None:
2278
1960
                # Give the remote repository the matching real repo.
2279
1961
                real_repo = self._real_branch.repository
2353
2035
            raise errors.UnexpectedSmartServerResponse(response)
2354
2036
        return response[1]
2355
2037
 
2356
 
    def set_stacked_on_url(self, url):
2357
 
        branch.Branch.set_stacked_on_url(self, url)
2358
 
        if not url:
2359
 
            self._is_stacked = False
2360
 
        else:
2361
 
            self._is_stacked = True
2362
 
        
2363
2038
    def _vfs_get_tags_bytes(self):
2364
2039
        self._ensure_real()
2365
2040
        return self._real_branch._get_tags_bytes()
2375
2050
            return self._vfs_get_tags_bytes()
2376
2051
        return response[0]
2377
2052
 
2378
 
    def _vfs_set_tags_bytes(self, bytes):
2379
 
        self._ensure_real()
2380
 
        return self._real_branch._set_tags_bytes(bytes)
2381
 
 
2382
 
    def _set_tags_bytes(self, bytes):
2383
 
        medium = self._client._medium
2384
 
        if medium._is_remote_before((1, 18)):
2385
 
            self._vfs_set_tags_bytes(bytes)
2386
 
            return
2387
 
        try:
2388
 
            args = (
2389
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2390
 
            response = self._call_with_body_bytes(
2391
 
                'Branch.set_tags_bytes', args, bytes)
2392
 
        except errors.UnknownSmartMethod:
2393
 
            medium._remember_remote_is_before((1, 18))
2394
 
            self._vfs_set_tags_bytes(bytes)
2395
 
 
2396
2053
    def lock_read(self):
2397
 
        """Lock the branch for read operations.
2398
 
 
2399
 
        :return: An object with an unlock method which will release the lock
2400
 
            obtained.
2401
 
        """
2402
2054
        self.repository.lock_read()
2403
2055
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
2056
            self._lock_mode = 'r'
2406
2057
            self._lock_count = 1
2407
2058
            if self._real_branch is not None:
2408
2059
                self._real_branch.lock_read()
2409
2060
        else:
2410
2061
            self._lock_count += 1
2411
 
        return self
2412
2062
 
2413
2063
    def _remote_lock_write(self, token):
2414
2064
        if token is None:
2415
2065
            branch_token = repo_token = ''
2416
2066
        else:
2417
2067
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
2068
            repo_token = self.repository.lock_write()
2419
2069
            self.repository.unlock()
2420
2070
        err_context = {'token': token}
2421
2071
        response = self._call(
2428
2078
 
2429
2079
    def lock_write(self, token=None):
2430
2080
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
2081
            # Lock the branch and repo in one remote call.
2433
2082
            remote_tokens = self._remote_lock_write(token)
2434
2083
            self._lock_token, self._repo_lock_token = remote_tokens
2458
2107
            self._lock_count += 1
2459
2108
            # Re-lock the repository too.
2460
2109
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2110
        return self._lock_token or None
 
2111
 
 
2112
    def _set_tags_bytes(self, bytes):
 
2113
        self._ensure_real()
 
2114
        return self._real_branch._set_tags_bytes(bytes)
2462
2115
 
2463
2116
    def _unlock(self, branch_token, repo_token):
2464
2117
        err_context = {'token': str((branch_token, repo_token))}
2469
2122
            return
2470
2123
        raise errors.UnexpectedSmartServerResponse(response)
2471
2124
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
2125
    def unlock(self):
2474
2126
        try:
2475
2127
            self._lock_count -= 1
2488
2140
                    self._real_branch.unlock()
2489
2141
                if mode != 'w':
2490
2142
                    # Only write-locked branched need to make a remote method
2491
 
                    # call to perform the unlock.
 
2143
                    # call to perfom the unlock.
2492
2144
                    return
2493
2145
                if not self._lock_token:
2494
2146
                    raise AssertionError('Locked, but no token!')
2515
2167
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
2168
        self._leave_lock = False
2517
2169
 
2518
 
    @needs_read_lock
2519
 
    def get_rev_id(self, revno, history=None):
2520
 
        if revno == 0:
2521
 
            return _mod_revision.NULL_REVISION
2522
 
        last_revision_info = self.last_revision_info()
2523
 
        ok, result = self.repository.get_rev_id_for_revno(
2524
 
            revno, last_revision_info)
2525
 
        if ok:
2526
 
            return result
2527
 
        missing_parent = result[1]
2528
 
        # Either the revision named by the server is missing, or its parent
2529
 
        # is.  Call get_parent_map to determine which, so that we report a
2530
 
        # useful error.
2531
 
        parent_map = self.repository.get_parent_map([missing_parent])
2532
 
        if missing_parent in parent_map:
2533
 
            missing_parent = parent_map[missing_parent]
2534
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2535
 
 
2536
2170
    def _last_revision_info(self):
2537
2171
        response = self._call('Branch.last_revision_info', self._remote_path())
2538
2172
        if response[0] != 'ok':
2543
2177
 
2544
2178
    def _gen_revision_history(self):
2545
2179
        """See Branch._gen_revision_history()."""
2546
 
        if self._is_stacked:
2547
 
            self._ensure_real()
2548
 
            return self._real_branch._gen_revision_history()
2549
2180
        response_tuple, response_handler = self._call_expecting_body(
2550
2181
            'Branch.revision_history', self._remote_path())
2551
2182
        if response_tuple[0] != 'ok':
2636
2267
        self._ensure_real()
2637
2268
        return self._real_branch._get_parent_location()
2638
2269
 
 
2270
    def set_parent(self, url):
 
2271
        self._ensure_real()
 
2272
        return self._real_branch.set_parent(url)
 
2273
 
2639
2274
    def _set_parent_location(self, url):
2640
 
        medium = self._client._medium
2641
 
        if medium._is_remote_before((1, 15)):
2642
 
            return self._vfs_set_parent_location(url)
2643
 
        try:
2644
 
            call_url = url or ''
2645
 
            if type(call_url) is not str:
2646
 
                raise AssertionError('url must be a str or None (%s)' % url)
2647
 
            response = self._call('Branch.set_parent_location',
2648
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2649
 
                call_url)
2650
 
        except errors.UnknownSmartMethod:
2651
 
            medium._remember_remote_is_before((1, 15))
2652
 
            return self._vfs_set_parent_location(url)
2653
 
        if response != ():
2654
 
            raise errors.UnexpectedSmartServerResponse(response)
2655
 
 
2656
 
    def _vfs_set_parent_location(self, url):
 
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
        """
2657
2290
        self._ensure_real()
2658
 
        return self._real_branch._set_parent_location(url)
 
2291
        return self._real_branch.set_stacked_on_url(stacked_location)
2659
2292
 
2660
2293
    @needs_write_lock
2661
2294
    def pull(self, source, overwrite=False, stop_revision=None,
2729
2362
        return self._real_branch.set_push_location(location)
2730
2363
 
2731
2364
 
2732
 
class RemoteConfig(object):
2733
 
    """A Config that reads and writes from smart verbs.
2734
 
 
2735
 
    It is a low-level object that considers config data to be name/value pairs
2736
 
    that may be associated with a section. Assigning meaning to the these
2737
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2738
 
    """
2739
 
 
2740
 
    def get_option(self, name, section=None, default=None):
2741
 
        """Return the value associated with a named option.
2742
 
 
2743
 
        :param name: The name of the value
2744
 
        :param section: The section the option is in (if any)
2745
 
        :param default: The value to return if the value is not set
2746
 
        :return: The value or default value
2747
 
        """
2748
 
        try:
2749
 
            configobj = self._get_configobj()
2750
 
            if section is None:
2751
 
                section_obj = configobj
2752
 
            else:
2753
 
                try:
2754
 
                    section_obj = configobj[section]
2755
 
                except KeyError:
2756
 
                    return default
2757
 
            return section_obj.get(name, default)
2758
 
        except errors.UnknownSmartMethod:
2759
 
            return self._vfs_get_option(name, section, default)
2760
 
 
2761
 
    def _response_to_configobj(self, response):
2762
 
        if len(response[0]) and response[0][0] != 'ok':
2763
 
            raise errors.UnexpectedSmartServerResponse(response)
2764
 
        lines = response[1].read_body_bytes().splitlines()
2765
 
        return config.ConfigObj(lines, encoding='utf-8')
2766
 
 
2767
 
 
2768
 
class RemoteBranchConfig(RemoteConfig):
2769
 
    """A RemoteConfig for Branches."""
2770
 
 
2771
 
    def __init__(self, branch):
2772
 
        self._branch = branch
2773
 
 
2774
 
    def _get_configobj(self):
2775
 
        path = self._branch._remote_path()
2776
 
        response = self._branch._client.call_expecting_body(
2777
 
            'Branch.get_config_file', path)
2778
 
        return self._response_to_configobj(response)
2779
 
 
2780
 
    def set_option(self, value, name, section=None):
2781
 
        """Set the value associated with a named option.
2782
 
 
2783
 
        :param value: The value to set
2784
 
        :param name: The name of the value to set
2785
 
        :param section: The section the option is in (if any)
2786
 
        """
2787
 
        medium = self._branch._client._medium
2788
 
        if medium._is_remote_before((1, 14)):
2789
 
            return self._vfs_set_option(value, name, section)
2790
 
        try:
2791
 
            path = self._branch._remote_path()
2792
 
            response = self._branch._client.call('Branch.set_config_option',
2793
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2794
 
                value.encode('utf8'), name, section or '')
2795
 
        except errors.UnknownSmartMethod:
2796
 
            medium._remember_remote_is_before((1, 14))
2797
 
            return self._vfs_set_option(value, name, section)
2798
 
        if response != ():
2799
 
            raise errors.UnexpectedSmartServerResponse(response)
2800
 
 
2801
 
    def _real_object(self):
2802
 
        self._branch._ensure_real()
2803
 
        return self._branch._real_branch
2804
 
 
2805
 
    def _vfs_set_option(self, value, name, section=None):
2806
 
        return self._real_object()._get_config().set_option(
2807
 
            value, name, section)
2808
 
 
2809
 
 
2810
 
class RemoteBzrDirConfig(RemoteConfig):
2811
 
    """A RemoteConfig for BzrDirs."""
2812
 
 
2813
 
    def __init__(self, bzrdir):
2814
 
        self._bzrdir = bzrdir
2815
 
 
2816
 
    def _get_configobj(self):
2817
 
        medium = self._bzrdir._client._medium
2818
 
        verb = 'BzrDir.get_config_file'
2819
 
        if medium._is_remote_before((1, 15)):
2820
 
            raise errors.UnknownSmartMethod(verb)
2821
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2822
 
        response = self._bzrdir._call_expecting_body(
2823
 
            verb, path)
2824
 
        return self._response_to_configobj(response)
2825
 
 
2826
 
    def _vfs_get_option(self, name, section, default):
2827
 
        return self._real_object()._get_config().get_option(
2828
 
            name, section, default)
2829
 
 
2830
 
    def set_option(self, value, name, section=None):
2831
 
        """Set the value associated with a named option.
2832
 
 
2833
 
        :param value: The value to set
2834
 
        :param name: The name of the value to set
2835
 
        :param section: The section the option is in (if any)
2836
 
        """
2837
 
        return self._real_object()._get_config().set_option(
2838
 
            value, name, section)
2839
 
 
2840
 
    def _real_object(self):
2841
 
        self._bzrdir._ensure_real()
2842
 
        return self._bzrdir._real_bzrdir
2843
 
 
2844
 
 
2845
 
 
2846
2365
def _extract_tar(tar, to_dir):
2847
2366
    """Extract all the contents of a tarfile object.
2848
2367
 
2886
2405
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2406
                raise err
2888
2407
 
2889
 
    if err.error_verb == 'IncompatibleRepositories':
2890
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2891
 
            err.error_args[1], err.error_args[2])
2892
 
    elif err.error_verb == 'NoSuchRevision':
 
2408
    if err.error_verb == 'NoSuchRevision':
2893
2409
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2410
    elif err.error_verb == 'nosuchrevision':
2895
2411
        raise NoSuchRevision(find('repository'), err.error_args[0])
2896
 
    elif err.error_verb == 'nobranch':
2897
 
        if len(err.error_args) >= 1:
2898
 
            extra = err.error_args[0]
2899
 
        else:
2900
 
            extra = None
2901
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2902
 
            detail=extra)
 
2412
    elif err.error_tuple == ('nobranch',):
 
2413
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2414
    elif err.error_verb == 'norepository':
2904
2415
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2416
    elif err.error_verb == 'LockContention':