← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 00:26:41 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013002641-9tlh9k89mlj1666m
Keep docs-plain working.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
from bzrlib import (
20
20
    bencode,
21
21
    branch,
22
 
    bzrdir as _mod_bzrdir,
 
22
    bzrdir,
23
23
    config,
24
24
    controldir,
25
25
    debug,
27
27
    graph,
28
28
    lock,
29
29
    lockdir,
 
30
    repository,
30
31
    repository as _mod_repository,
 
32
    revision,
31
33
    revision as _mod_revision,
32
34
    static_tuple,
33
35
    symbol_versioning,
34
 
    urlutils,
35
 
    vf_repository,
36
 
    )
 
36
)
37
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
38
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
39
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
40
from bzrlib.errors import (
40
41
    NoSuchRevision,
42
43
    )
43
44
from bzrlib.lockable_files import LockableFiles
44
45
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.smart.client import _SmartClient
46
 
from bzrlib.revision import NULL_REVISION
47
 
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
 
46
from bzrlib.revision import ensure_null, NULL_REVISION
 
47
from bzrlib.repository import RepositoryWriteLockResult
48
48
from bzrlib.trace import mutter, note, warning
49
49
 
50
50
 
88
88
    return format
89
89
 
90
90
 
91
 
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
92
 
# does not have to be imported unless a remote format is involved.
93
 
 
94
 
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
95
 
    """Format representing bzrdirs accessed via a smart server"""
96
 
 
97
 
    supports_workingtrees = False
98
 
 
99
 
    def __init__(self):
100
 
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
101
 
        # XXX: It's a bit ugly that the network name is here, because we'd
102
 
        # like to believe that format objects are stateless or at least
103
 
        # immutable,  However, we do at least avoid mutating the name after
104
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
105
 
        self._network_name = None
106
 
 
107
 
    def __repr__(self):
108
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
109
 
            self._network_name)
110
 
 
111
 
    def get_format_description(self):
112
 
        if self._network_name:
113
 
            real_format = controldir.network_format_registry.get(self._network_name)
114
 
            return 'Remote: ' + real_format.get_format_description()
115
 
        return 'bzr remote bzrdir'
116
 
 
117
 
    def get_format_string(self):
118
 
        raise NotImplementedError(self.get_format_string)
119
 
 
120
 
    def network_name(self):
121
 
        if self._network_name:
122
 
            return self._network_name
123
 
        else:
124
 
            raise AssertionError("No network name set.")
125
 
 
126
 
    def initialize_on_transport(self, transport):
127
 
        try:
128
 
            # hand off the request to the smart server
129
 
            client_medium = transport.get_smart_medium()
130
 
        except errors.NoSmartMedium:
131
 
            # TODO: lookup the local format from a server hint.
132
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
133
 
            return local_dir_format.initialize_on_transport(transport)
134
 
        client = _SmartClient(client_medium)
135
 
        path = client.remote_path_from_transport(transport)
136
 
        try:
137
 
            response = client.call('BzrDirFormat.initialize', path)
138
 
        except errors.ErrorFromSmartServer, err:
139
 
            _translate_error(err, path=path)
140
 
        if response[0] != 'ok':
141
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
142
 
        format = RemoteBzrDirFormat()
143
 
        self._supply_sub_formats_to(format)
144
 
        return RemoteBzrDir(transport, format)
145
 
 
146
 
    def parse_NoneTrueFalse(self, arg):
147
 
        if not arg:
148
 
            return None
149
 
        if arg == 'False':
150
 
            return False
151
 
        if arg == 'True':
152
 
            return True
153
 
        raise AssertionError("invalid arg %r" % arg)
154
 
 
155
 
    def _serialize_NoneTrueFalse(self, arg):
156
 
        if arg is False:
157
 
            return 'False'
158
 
        if arg:
159
 
            return 'True'
160
 
        return ''
161
 
 
162
 
    def _serialize_NoneString(self, arg):
163
 
        return arg or ''
164
 
 
165
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
166
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
167
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
168
 
        shared_repo=False):
169
 
        try:
170
 
            # hand off the request to the smart server
171
 
            client_medium = transport.get_smart_medium()
172
 
        except errors.NoSmartMedium:
173
 
            do_vfs = True
174
 
        else:
175
 
            # Decline to open it if the server doesn't support our required
176
 
            # version (3) so that the VFS-based transport will do it.
177
 
            if client_medium.should_probe():
178
 
                try:
179
 
                    server_version = client_medium.protocol_version()
180
 
                    if server_version != '2':
181
 
                        do_vfs = True
182
 
                    else:
183
 
                        do_vfs = False
184
 
                except errors.SmartProtocolError:
185
 
                    # Apparently there's no usable smart server there, even though
186
 
                    # the medium supports the smart protocol.
187
 
                    do_vfs = True
188
 
            else:
189
 
                do_vfs = False
190
 
        if not do_vfs:
191
 
            client = _SmartClient(client_medium)
192
 
            path = client.remote_path_from_transport(transport)
193
 
            if client_medium._is_remote_before((1, 16)):
194
 
                do_vfs = True
195
 
        if do_vfs:
196
 
            # TODO: lookup the local format from a server hint.
197
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
198
 
            self._supply_sub_formats_to(local_dir_format)
199
 
            return local_dir_format.initialize_on_transport_ex(transport,
200
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
201
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
202
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
203
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
204
 
                vfs_only=True)
205
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
206
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
207
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
208
 
 
209
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
210
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
211
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
212
 
        args = []
213
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
214
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
215
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
216
 
        args.append(self._serialize_NoneString(stacked_on))
217
 
        # stack_on_pwd is often/usually our transport
218
 
        if stack_on_pwd:
219
 
            try:
220
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
221
 
                if not stack_on_pwd:
222
 
                    stack_on_pwd = '.'
223
 
            except errors.PathNotChild:
224
 
                pass
225
 
        args.append(self._serialize_NoneString(stack_on_pwd))
226
 
        args.append(self._serialize_NoneString(repo_format_name))
227
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
228
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
229
 
        request_network_name = self._network_name or \
230
 
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
231
 
        try:
232
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
233
 
                request_network_name, path, *args)
234
 
        except errors.UnknownSmartMethod:
235
 
            client._medium._remember_remote_is_before((1,16))
236
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
237
 
            self._supply_sub_formats_to(local_dir_format)
238
 
            return local_dir_format.initialize_on_transport_ex(transport,
239
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
240
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
241
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
242
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
243
 
                vfs_only=True)
244
 
        except errors.ErrorFromSmartServer, err:
245
 
            _translate_error(err, path=path)
246
 
        repo_path = response[0]
247
 
        bzrdir_name = response[6]
248
 
        require_stacking = response[7]
249
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
250
 
        format = RemoteBzrDirFormat()
251
 
        format._network_name = bzrdir_name
252
 
        self._supply_sub_formats_to(format)
253
 
        bzrdir = RemoteBzrDir(transport, format, _client=client)
254
 
        if repo_path:
255
 
            repo_format = response_tuple_to_repo_format(response[1:])
256
 
            if repo_path == '.':
257
 
                repo_path = ''
258
 
            if repo_path:
259
 
                repo_bzrdir_format = RemoteBzrDirFormat()
260
 
                repo_bzrdir_format._network_name = response[5]
261
 
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
262
 
                    repo_bzrdir_format)
263
 
            else:
264
 
                repo_bzr = bzrdir
265
 
            final_stack = response[8] or None
266
 
            final_stack_pwd = response[9] or None
267
 
            if final_stack_pwd:
268
 
                final_stack_pwd = urlutils.join(
269
 
                    transport.base, final_stack_pwd)
270
 
            remote_repo = RemoteRepository(repo_bzr, repo_format)
271
 
            if len(response) > 10:
272
 
                # Updated server verb that locks remotely.
273
 
                repo_lock_token = response[10] or None
274
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
275
 
                if repo_lock_token:
276
 
                    remote_repo.dont_leave_lock_in_place()
277
 
            else:
278
 
                remote_repo.lock_write()
279
 
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
280
 
                final_stack_pwd, require_stacking)
281
 
            policy.acquire_repository()
282
 
        else:
283
 
            remote_repo = None
284
 
            policy = None
285
 
        bzrdir._format.set_branch_format(self.get_branch_format())
286
 
        if require_stacking:
287
 
            # The repo has already been created, but we need to make sure that
288
 
            # we'll make a stackable branch.
289
 
            bzrdir._format.require_stacking(_skip_repo=True)
290
 
        return remote_repo, bzrdir, require_stacking, policy
291
 
 
292
 
    def _open(self, transport):
293
 
        return RemoteBzrDir(transport, self)
294
 
 
295
 
    def __eq__(self, other):
296
 
        if not isinstance(other, RemoteBzrDirFormat):
297
 
            return False
298
 
        return self.get_format_description() == other.get_format_description()
299
 
 
300
 
    def __return_repository_format(self):
301
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
302
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
303
 
        # that it should use that for init() etc.
304
 
        result = RemoteRepositoryFormat()
305
 
        custom_format = getattr(self, '_repository_format', None)
306
 
        if custom_format:
307
 
            if isinstance(custom_format, RemoteRepositoryFormat):
308
 
                return custom_format
309
 
            else:
310
 
                # We will use the custom format to create repositories over the
311
 
                # wire; expose its details like rich_root_data for code to
312
 
                # query
313
 
                result._custom_format = custom_format
314
 
        return result
315
 
 
316
 
    def get_branch_format(self):
317
 
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
318
 
        if not isinstance(result, RemoteBranchFormat):
319
 
            new_result = RemoteBranchFormat()
320
 
            new_result._custom_format = result
321
 
            # cache the result
322
 
            self.set_branch_format(new_result)
323
 
            result = new_result
324
 
        return result
325
 
 
326
 
    repository_format = property(__return_repository_format,
327
 
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
328
 
 
329
 
 
330
 
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
 
91
# Note: RemoteBzrDirFormat is in bzrdir.py
 
92
 
 
93
class RemoteBzrDir(BzrDir, _RpcHelper):
331
94
    """Control directory on a remote server, accessed via bzr:// or similar."""
332
95
 
333
96
    def __init__(self, transport, format, _client=None, _force_probe=False):
336
99
        :param _client: Private parameter for testing. Disables probing and the
337
100
            use of a real bzrdir.
338
101
        """
339
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
102
        BzrDir.__init__(self, transport, format)
340
103
        # this object holds a delegated bzrdir that uses file-level operations
341
104
        # to talk to the other side
342
105
        self._real_bzrdir = None
402
165
                import traceback
403
166
                warning('VFS BzrDir access triggered\n%s',
404
167
                    ''.join(traceback.format_stack()))
405
 
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
168
            self._real_bzrdir = BzrDir.open_from_transport(
406
169
                self.root_transport, _server_formats=False)
407
170
            self._format._network_name = \
408
171
                self._real_bzrdir._format.network_name()
414
177
        # Prevent aliasing problems in the next_open_branch_result cache.
415
178
        # See create_branch for rationale.
416
179
        self._next_open_branch_result = None
417
 
        return _mod_bzrdir.BzrDir.break_lock(self)
 
180
        return BzrDir.break_lock(self)
418
181
 
419
182
    def _vfs_cloning_metadir(self, require_stacking=False):
420
183
        self._ensure_real()
453
216
        branch_ref, branch_name = branch_info
454
217
        format = controldir.network_format_registry.get(control_name)
455
218
        if repo_name:
456
 
            format.repository_format = _mod_repository.network_format_registry.get(
 
219
            format.repository_format = repository.network_format_registry.get(
457
220
                repo_name)
458
221
        if branch_ref == 'ref':
459
222
            # XXX: we need possible_transports here to avoid reopening the
460
223
            # connection to the referenced location
461
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
 
224
            ref_bzrdir = BzrDir.open(branch_name)
462
225
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
226
            format.set_branch_format(branch_format)
464
227
        elif branch_ref == 'branch':
483
246
        self._ensure_real()
484
247
        self._real_bzrdir.destroy_repository()
485
248
 
486
 
    def create_branch(self, name=None, repository=None):
 
249
    def create_branch(self, name=None):
487
250
        # as per meta1 formats - just delegate to the format object which may
488
251
        # be parameterised.
489
252
        real_branch = self._format.get_branch_format().initialize(self,
490
 
            name=name, repository=repository)
 
253
            name=name)
491
254
        if not isinstance(real_branch, RemoteBranch):
492
 
            if not isinstance(repository, RemoteRepository):
493
 
                raise AssertionError(
494
 
                    'need a RemoteRepository to use with RemoteBranch, got %r'
495
 
                    % (repository,))
496
 
            result = RemoteBranch(self, repository, real_branch, name=name)
 
255
            result = RemoteBranch(self, self.find_repository(), real_branch,
 
256
                                  name=name)
497
257
        else:
498
258
            result = real_branch
499
259
        # BzrDir.clone_on_transport() uses the result of create_branch but does
687
447
        """Upgrading of remote bzrdirs is not supported yet."""
688
448
        return False
689
449
 
690
 
    def needs_format_conversion(self, format):
 
450
    def needs_format_conversion(self, format=None):
691
451
        """Upgrading of remote bzrdirs is not supported yet."""
 
452
        if format is None:
 
453
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
454
                % 'needs_format_conversion(format=None)')
692
455
        return False
693
456
 
694
457
    def clone(self, url, revision_id=None, force_new_repo=False,
701
464
        return RemoteBzrDirConfig(self)
702
465
 
703
466
 
704
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
467
class RemoteRepositoryFormat(repository.RepositoryFormat):
705
468
    """Format for repositories accessed over a _SmartClient.
706
469
 
707
470
    Instances of this repository are represented by RemoteRepository
722
485
    """
723
486
 
724
487
    _matchingbzrdir = RemoteBzrDirFormat()
725
 
    supports_full_versioned_files = True
726
 
    supports_leaving_lock = True
727
488
 
728
489
    def __init__(self):
729
 
        _mod_repository.RepositoryFormat.__init__(self)
 
490
        repository.RepositoryFormat.__init__(self)
730
491
        self._custom_format = None
731
492
        self._network_name = None
732
493
        self._creating_bzrdir = None
733
 
        self._revision_graph_can_have_wrong_parents = None
734
494
        self._supports_chks = None
735
495
        self._supports_external_lookups = None
736
496
        self._supports_tree_reference = None
737
 
        self._supports_funky_characters = None
738
497
        self._rich_root_data = None
739
498
 
740
499
    def __repr__(self):
769
528
        return self._supports_external_lookups
770
529
 
771
530
    @property
772
 
    def supports_funky_characters(self):
773
 
        if self._supports_funky_characters is None:
774
 
            self._ensure_real()
775
 
            self._supports_funky_characters = \
776
 
                self._custom_format.supports_funky_characters
777
 
        return self._supports_funky_characters
778
 
 
779
 
    @property
780
531
    def supports_tree_reference(self):
781
532
        if self._supports_tree_reference is None:
782
533
            self._ensure_real()
784
535
                self._custom_format.supports_tree_reference
785
536
        return self._supports_tree_reference
786
537
 
787
 
    @property
788
 
    def revision_graph_can_have_wrong_parents(self):
789
 
        if self._revision_graph_can_have_wrong_parents is None:
790
 
            self._ensure_real()
791
 
            self._revision_graph_can_have_wrong_parents = \
792
 
                self._custom_format.revision_graph_can_have_wrong_parents
793
 
        return self._revision_graph_can_have_wrong_parents
794
 
 
795
538
    def _vfs_initialize(self, a_bzrdir, shared):
796
539
        """Helper for common code in initialize."""
797
540
        if self._custom_format:
832
575
            network_name = self._network_name
833
576
        else:
834
577
            # Select the current bzrlib default and ask for that.
835
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
578
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
836
579
            reference_format = reference_bzrdir_format.repository_format
837
580
            network_name = reference_format.network_name()
838
581
        # 2) try direct creation via RPC
864
607
 
865
608
    def _ensure_real(self):
866
609
        if self._custom_format is None:
867
 
            self._custom_format = _mod_repository.network_format_registry.get(
 
610
            self._custom_format = repository.network_format_registry.get(
868
611
                self._network_name)
869
612
 
870
613
    @property
966
709
        # transport, but I'm not sure it's worth making this method
967
710
        # optional -- mbp 2010-04-21
968
711
        return self.bzrdir.get_repository_transport(None)
969
 
 
 
712
        
970
713
    def __str__(self):
971
714
        return "%s(%s)" % (self.__class__.__name__, self.base)
972
715
 
1080
823
    def find_text_key_references(self):
1081
824
        """Find the text key references within the repository.
1082
825
 
 
826
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
827
        revision_ids. Each altered file-ids has the exact revision_ids that
 
828
        altered it listed explicitly.
1083
829
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1084
830
            to whether they were referred to by the inventory of the
1085
831
            revision_id that they contain. The inventory texts from all present
1103
849
        """Private method for using with old (< 1.2) servers to fallback."""
1104
850
        if revision_id is None:
1105
851
            revision_id = ''
1106
 
        elif _mod_revision.is_null(revision_id):
 
852
        elif revision.is_null(revision_id):
1107
853
            return {}
1108
854
 
1109
855
        path = self.bzrdir._path_for_remote_call(self._client)
1133
879
        return RemoteStreamSource(self, to_format)
1134
880
 
1135
881
    @needs_read_lock
1136
 
    def get_file_graph(self):
1137
 
        return graph.Graph(self.texts)
1138
 
 
1139
 
    @needs_read_lock
1140
882
    def has_revision(self, revision_id):
1141
883
        """True if this repository has a copy of the revision."""
1142
884
        # Copy of bzrlib.repository.Repository.has_revision
1194
936
        """See Repository.gather_stats()."""
1195
937
        path = self.bzrdir._path_for_remote_call(self._client)
1196
938
        # revid can be None to indicate no revisions, not just NULL_REVISION
1197
 
        if revid is None or _mod_revision.is_null(revid):
 
939
        if revid is None or revision.is_null(revid):
1198
940
            fmt_revid = ''
1199
941
        else:
1200
942
            fmt_revid = revid
1483
1225
 
1484
1226
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1485
1227
                           timezone=None, committer=None, revprops=None,
1486
 
                           revision_id=None, lossy=False):
 
1228
                           revision_id=None):
1487
1229
        # FIXME: It ought to be possible to call this without immediately
1488
1230
        # triggering _ensure_real.  For now it's the easiest thing to do.
1489
1231
        self._ensure_real()
1490
1232
        real_repo = self._real_repository
1491
1233
        builder = real_repo.get_commit_builder(branch, parents,
1492
1234
                config, timestamp=timestamp, timezone=timezone,
1493
 
                committer=committer, revprops=revprops,
1494
 
                revision_id=revision_id, lossy=lossy)
 
1235
                committer=committer, revprops=revprops, revision_id=revision_id)
1495
1236
        return builder
1496
1237
 
1497
1238
    def add_fallback_repository(self, repository):
1603
1344
        return result
1604
1345
 
1605
1346
    @needs_read_lock
1606
 
    def search_missing_revision_ids(self, other,
1607
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1608
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1609
 
            limit=None):
 
1347
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1610
1348
        """Return the revision ids that other has that this does not.
1611
1349
 
1612
1350
        These are returned in topological order.
1613
1351
 
1614
1352
        revision_id: only return revision ids included by revision_id.
1615
1353
        """
1616
 
        if symbol_versioning.deprecated_passed(revision_id):
1617
 
            symbol_versioning.warn(
1618
 
                'search_missing_revision_ids(revision_id=...) was '
1619
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
1620
 
                DeprecationWarning, stacklevel=2)
1621
 
            if revision_ids is not None:
1622
 
                raise AssertionError(
1623
 
                    'revision_ids is mutually exclusive with revision_id')
1624
 
            if revision_id is not None:
1625
 
                revision_ids = [revision_id]
1626
 
        inter_repo = _mod_repository.InterRepository.get(other, self)
1627
 
        return inter_repo.search_missing_revision_ids(
1628
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
1629
 
            if_present_ids=if_present_ids, limit=limit)
 
1354
        return repository.InterRepository.get(
 
1355
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1630
1356
 
1631
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1357
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1632
1358
            fetch_spec=None):
1633
1359
        # No base implementation to use as RemoteRepository is not a subclass
1634
1360
        # of Repository; so this is a copy of Repository.fetch().
1645
1371
            # check that last_revision is in 'from' and then return a
1646
1372
            # no-operation.
1647
1373
            if (revision_id is not None and
1648
 
                not _mod_revision.is_null(revision_id)):
 
1374
                not revision.is_null(revision_id)):
1649
1375
                self.get_revision(revision_id)
1650
1376
            return 0, []
1651
1377
        # if there is no specific appropriate InterRepository, this will get
1652
1378
        # the InterRepository base class, which raises an
1653
1379
        # IncompatibleRepositories when asked to fetch.
1654
 
        inter = _mod_repository.InterRepository.get(source, self)
1655
 
        return inter.fetch(revision_id=revision_id,
 
1380
        inter = repository.InterRepository.get(source, self)
 
1381
        return inter.fetch(revision_id=revision_id, pb=pb,
1656
1382
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1657
1383
 
1658
1384
    def create_bundle(self, target, base, fileobj, format=None):
1660
1386
        self._real_repository.create_bundle(target, base, fileobj, format)
1661
1387
 
1662
1388
    @needs_read_lock
1663
 
    @symbol_versioning.deprecated_method(
1664
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1665
1389
    def get_ancestry(self, revision_id, topo_sorted=True):
1666
1390
        self._ensure_real()
1667
1391
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1884
1608
            tmpdir = osutils.mkdtemp()
1885
1609
            try:
1886
1610
                _extract_tar(tar, tmpdir)
1887
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1611
                tmp_bzrdir = BzrDir.open(tmpdir)
1888
1612
                tmp_repo = tmp_bzrdir.open_repository()
1889
1613
                tmp_repo.copy_content_into(destination, revision_id)
1890
1614
            finally:
1975
1699
    def supports_rich_root(self):
1976
1700
        return self._format.rich_root_data
1977
1701
 
1978
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1979
1702
    def iter_reverse_revision_history(self, revision_id):
1980
1703
        self._ensure_real()
1981
1704
        return self._real_repository.iter_reverse_revision_history(revision_id)
2002
1725
        return self._real_repository.item_keys_introduced_by(revision_ids,
2003
1726
            _files_pb=_files_pb)
2004
1727
 
 
1728
    def revision_graph_can_have_wrong_parents(self):
 
1729
        # The answer depends on the remote repo format.
 
1730
        self._ensure_real()
 
1731
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1732
 
2005
1733
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2006
1734
        self._ensure_real()
2007
1735
        return self._real_repository._find_inconsistent_revision_parents(
2015
1743
        providers = [self._unstacked_provider]
2016
1744
        if other is not None:
2017
1745
            providers.insert(0, other)
2018
 
        return graph.StackedParentsProvider(_LazyListJoin(
2019
 
            providers, self._fallback_repositories))
 
1746
        providers.extend(r._make_parents_provider() for r in
 
1747
                         self._fallback_repositories)
 
1748
        return graph.StackedParentsProvider(providers)
2020
1749
 
2021
1750
    def _serialise_search_recipe(self, recipe):
2022
1751
        """Serialise a graph search recipe.
2030
1759
        return '\n'.join((start_keys, stop_keys, count))
2031
1760
 
2032
1761
    def _serialise_search_result(self, search_result):
2033
 
        parts = search_result.get_network_struct()
 
1762
        if isinstance(search_result, graph.PendingAncestryResult):
 
1763
            parts = ['ancestry-of']
 
1764
            parts.extend(search_result.heads)
 
1765
        else:
 
1766
            recipe = search_result.get_recipe()
 
1767
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
2034
1768
        return '\n'.join(parts)
2035
1769
 
2036
1770
    def autopack(self):
2046
1780
            raise errors.UnexpectedSmartServerResponse(response)
2047
1781
 
2048
1782
 
2049
 
class RemoteStreamSink(vf_repository.StreamSink):
 
1783
class RemoteStreamSink(repository.StreamSink):
2050
1784
 
2051
1785
    def _insert_real(self, stream, src_format, resume_tokens):
2052
1786
        self.target_repo._ensure_real()
2153
1887
        self._last_substream and self._last_stream so that the stream can be
2154
1888
        resumed by _resume_stream_with_vfs.
2155
1889
        """
2156
 
 
 
1890
                    
2157
1891
        stream_iter = iter(stream)
2158
1892
        for substream_kind, substream in stream_iter:
2159
1893
            if substream_kind == 'inventory-deltas':
2162
1896
                return
2163
1897
            else:
2164
1898
                yield substream_kind, substream
2165
 
 
2166
 
 
2167
 
class RemoteStreamSource(vf_repository.StreamSource):
 
1899
            
 
1900
 
 
1901
class RemoteStreamSource(repository.StreamSource):
2168
1902
    """Stream data from a remote server."""
2169
1903
 
2170
1904
    def get_stream(self, search):
2230
1964
        candidate_verbs = [
2231
1965
            ('Repository.get_stream_1.19', (1, 19)),
2232
1966
            ('Repository.get_stream', (1, 13))]
2233
 
 
2234
1967
        found_verb = False
2235
1968
        for verb, version in candidate_verbs:
2236
1969
            if medium._is_remote_before(version):
2240
1973
                    verb, args, search_bytes)
2241
1974
            except errors.UnknownSmartMethod:
2242
1975
                medium._remember_remote_is_before(version)
2243
 
            except errors.UnknownErrorFromSmartServer, e:
2244
 
                if isinstance(search, graph.EverythingResult):
2245
 
                    error_verb = e.error_from_smart_server.error_verb
2246
 
                    if error_verb == 'BadSearch':
2247
 
                        # Pre-2.4 servers don't support this sort of search.
2248
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
2249
 
                        # good idea in general?  It might provide a little bit
2250
 
                        # of protection against client-side bugs.
2251
 
                        medium._remember_remote_is_before((2, 4))
2252
 
                        break
2253
 
                raise
2254
1976
            else:
2255
1977
                response_tuple, response_handler = response
2256
1978
                found_verb = True
2371
2093
                                  name=name)
2372
2094
        return result
2373
2095
 
2374
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2096
    def initialize(self, a_bzrdir, name=None):
2375
2097
        # 1) get the network name to use.
2376
2098
        if self._custom_format:
2377
2099
            network_name = self._custom_format.network_name()
2378
2100
        else:
2379
2101
            # Select the current bzrlib default and ask for that.
2380
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
2102
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
2381
2103
            reference_format = reference_bzrdir_format.get_branch_format()
2382
2104
            self._custom_format = reference_format
2383
2105
            network_name = reference_format.network_name()
2405
2127
        # Turn the response into a RemoteRepository object.
2406
2128
        format = RemoteBranchFormat(network_name=response[1])
2407
2129
        repo_format = response_tuple_to_repo_format(response[3:])
2408
 
        repo_path = response[2]
2409
 
        if repository is not None:
2410
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2411
 
            url_diff = urlutils.relative_url(repository.user_url,
2412
 
                    remote_repo_url)
2413
 
            if url_diff != '.':
2414
 
                raise AssertionError(
2415
 
                    'repository.user_url %r does not match URL from server '
2416
 
                    'response (%r + %r)'
2417
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
2418
 
            remote_repo = repository
 
2130
        if response[2] == '':
 
2131
            repo_bzrdir = a_bzrdir
2419
2132
        else:
2420
 
            if repo_path == '':
2421
 
                repo_bzrdir = a_bzrdir
2422
 
            else:
2423
 
                repo_bzrdir = RemoteBzrDir(
2424
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2425
 
                    a_bzrdir._client)
2426
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2133
            repo_bzrdir = RemoteBzrDir(
 
2134
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
2135
                a_bzrdir._client)
 
2136
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2427
2137
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2428
2138
            format=format, setup_stacking=False, name=name)
2429
2139
        # XXX: We know this is a new branch, so it must have revno 0, revid
2450
2160
        self._ensure_real()
2451
2161
        return self._custom_format.supports_set_append_revisions_only()
2452
2162
 
2453
 
    def _use_default_local_heads_to_fetch(self):
2454
 
        # If the branch format is a metadir format *and* its heads_to_fetch
2455
 
        # implementation is not overridden vs the base class, we can use the
2456
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
2457
 
        # usually cheaper in terms of net round trips, as the last-revision and
2458
 
        # tags info fetched is cached and would be fetched anyway.
2459
 
        self._ensure_real()
2460
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
2461
 
            branch_class = self._custom_format._branch_class()
2462
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2463
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2464
 
                return True
2465
 
        return False
2466
2163
 
2467
2164
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2468
2165
    """Branch stored on a server accessed by HPSS RPC.
2667
2364
            self._is_stacked = False
2668
2365
        else:
2669
2366
            self._is_stacked = True
2670
 
 
 
2367
        
2671
2368
    def _vfs_get_tags_bytes(self):
2672
2369
        self._ensure_real()
2673
2370
        return self._real_branch._get_tags_bytes()
2674
2371
 
2675
 
    @needs_read_lock
2676
2372
    def _get_tags_bytes(self):
2677
 
        if self._tags_bytes is None:
2678
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
2679
 
        return self._tags_bytes
2680
 
 
2681
 
    def _get_tags_bytes_via_hpss(self):
2682
2373
        medium = self._client._medium
2683
2374
        if medium._is_remote_before((1, 13)):
2684
2375
            return self._vfs_get_tags_bytes()
2694
2385
        return self._real_branch._set_tags_bytes(bytes)
2695
2386
 
2696
2387
    def _set_tags_bytes(self, bytes):
2697
 
        if self.is_locked():
2698
 
            self._tags_bytes = bytes
2699
2388
        medium = self._client._medium
2700
2389
        if medium._is_remote_before((1, 18)):
2701
2390
            self._vfs_set_tags_bytes(bytes)
2855
2544
            missing_parent = parent_map[missing_parent]
2856
2545
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2857
2546
 
2858
 
    def _read_last_revision_info(self):
 
2547
    def _last_revision_info(self):
2859
2548
        response = self._call('Branch.last_revision_info', self._remote_path())
2860
2549
        if response[0] != 'ok':
2861
2550
            raise SmartProtocolError('unexpected response code %s' % (response,))
2924
2613
            raise errors.UnexpectedSmartServerResponse(response)
2925
2614
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2926
2615
 
2927
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2928
2616
    @needs_write_lock
2929
2617
    def set_revision_history(self, rev_history):
2930
 
        """See Branch.set_revision_history."""
2931
 
        self._set_revision_history(rev_history)
2932
 
 
2933
 
    @needs_write_lock
2934
 
    def _set_revision_history(self, rev_history):
2935
2618
        # Send just the tip revision of the history; the server will generate
2936
2619
        # the full history from that.  If the revision doesn't exist in this
2937
2620
        # branch, NoSuchRevision will be raised.
2995
2678
            _override_hook_target=self, **kwargs)
2996
2679
 
2997
2680
    @needs_read_lock
2998
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
2681
    def push(self, target, overwrite=False, stop_revision=None):
2999
2682
        self._ensure_real()
3000
2683
        return self._real_branch.push(
3001
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
2684
            target, overwrite=overwrite, stop_revision=stop_revision,
3002
2685
            _override_hook_source_branch=self)
3003
2686
 
3004
2687
    def is_locked(self):
3014
2697
        # XXX: These should be returned by the set_last_revision_info verb
3015
2698
        old_revno, old_revid = self.last_revision_info()
3016
2699
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3017
 
        if not revision_id or not isinstance(revision_id, basestring):
3018
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2700
        revision_id = ensure_null(revision_id)
3019
2701
        try:
3020
2702
            response = self._call('Branch.set_last_revision_info',
3021
2703
                self._remote_path(), self._lock_token, self._repo_lock_token,
3050
2732
            except errors.UnknownSmartMethod:
3051
2733
                medium._remember_remote_is_before((1, 6))
3052
2734
        self._clear_cached_state_of_remote_branch_only()
3053
 
        self._set_revision_history(self._lefthand_history(revision_id,
 
2735
        self.set_revision_history(self._lefthand_history(revision_id,
3054
2736
            last_rev=last_rev,other_branch=other_branch))
3055
2737
 
3056
2738
    def set_push_location(self, location):
3057
2739
        self._ensure_real()
3058
2740
        return self._real_branch.set_push_location(location)
3059
2741
 
3060
 
    def heads_to_fetch(self):
3061
 
        if self._format._use_default_local_heads_to_fetch():
3062
 
            # We recognise this format, and its heads-to-fetch implementation
3063
 
            # is the default one (tip + tags).  In this case it's cheaper to
3064
 
            # just use the default implementation rather than a special RPC as
3065
 
            # the tip and tags data is cached.
3066
 
            return branch.Branch.heads_to_fetch(self)
3067
 
        medium = self._client._medium
3068
 
        if medium._is_remote_before((2, 4)):
3069
 
            return self._vfs_heads_to_fetch()
3070
 
        try:
3071
 
            return self._rpc_heads_to_fetch()
3072
 
        except errors.UnknownSmartMethod:
3073
 
            medium._remember_remote_is_before((2, 4))
3074
 
            return self._vfs_heads_to_fetch()
3075
 
 
3076
 
    def _rpc_heads_to_fetch(self):
3077
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3078
 
        if len(response) != 2:
3079
 
            raise errors.UnexpectedSmartServerResponse(response)
3080
 
        must_fetch, if_present_fetch = response
3081
 
        return set(must_fetch), set(if_present_fetch)
3082
 
 
3083
 
    def _vfs_heads_to_fetch(self):
3084
 
        self._ensure_real()
3085
 
        return self._real_branch.heads_to_fetch()
3086
 
 
3087
2742
 
3088
2743
class RemoteConfig(object):
3089
2744
    """A Config that reads and writes from smart verbs.
3103
2758
        """
3104
2759
        try:
3105
2760
            configobj = self._get_configobj()
3106
 
            section_obj = None
3107
2761
            if section is None:
3108
2762
                section_obj = configobj
3109
2763
            else:
3110
2764
                try:
3111
2765
                    section_obj = configobj[section]
3112
2766
                except KeyError:
3113
 
                    pass
3114
 
            if section_obj is None:
3115
 
                value = default
3116
 
            else:
3117
 
                value = section_obj.get(name, default)
 
2767
                    return default
 
2768
            return section_obj.get(name, default)
3118
2769
        except errors.UnknownSmartMethod:
3119
 
            value = self._vfs_get_option(name, section, default)
3120
 
        for hook in config.OldConfigHooks['get']:
3121
 
            hook(self, name, value)
3122
 
        return value
 
2770
            return self._vfs_get_option(name, section, default)
3123
2771
 
3124
2772
    def _response_to_configobj(self, response):
3125
2773
        if len(response[0]) and response[0][0] != 'ok':
3126
2774
            raise errors.UnexpectedSmartServerResponse(response)
3127
2775
        lines = response[1].read_body_bytes().splitlines()
3128
 
        conf = config.ConfigObj(lines, encoding='utf-8')
3129
 
        for hook in config.OldConfigHooks['load']:
3130
 
            hook(self)
3131
 
        return conf
 
2776
        return config.ConfigObj(lines, encoding='utf-8')
3132
2777
 
3133
2778
 
3134
2779
class RemoteBranchConfig(RemoteConfig):
3286
2931
                    'Missing key %r in context %r', key_err.args[0], context)
3287
2932
                raise err
3288
2933
 
3289
 
    if err.error_verb == 'NoSuchRevision':
 
2934
    if err.error_verb == 'IncompatibleRepositories':
 
2935
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2936
            err.error_args[1], err.error_args[2])
 
2937
    elif err.error_verb == 'NoSuchRevision':
3290
2938
        raise NoSuchRevision(find('branch'), err.error_args[0])
3291
2939
    elif err.error_verb == 'nosuchrevision':
3292
2940
        raise NoSuchRevision(find('repository'), err.error_args[0])
3299
2947
            detail=extra)
3300
2948
    elif err.error_verb == 'norepository':
3301
2949
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2950
    elif err.error_verb == 'LockContention':
 
2951
        raise errors.LockContention('(remote lock)')
3302
2952
    elif err.error_verb == 'UnlockableTransport':
3303
2953
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2954
    elif err.error_verb == 'LockFailed':
 
2955
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3304
2956
    elif err.error_verb == 'TokenMismatch':
3305
2957
        raise errors.TokenMismatch(find('token'), '(remote token)')
3306
2958
    elif err.error_verb == 'Diverged':
3307
2959
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2960
    elif err.error_verb == 'TipChangeRejected':
 
2961
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2962
    elif err.error_verb == 'UnstackableBranchFormat':
 
2963
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2964
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2965
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3308
2966
    elif err.error_verb == 'NotStacked':
3309
2967
        raise errors.NotStacked(branch=find('branch'))
3310
2968
    elif err.error_verb == 'PermissionDenied':
3320
2978
    elif err.error_verb == 'NoSuchFile':
3321
2979
        path = get_path()
3322
2980
        raise errors.NoSuchFile(path)
3323
 
    _translate_error_without_context(err)
3324
 
 
3325
 
 
3326
 
def _translate_error_without_context(err):
3327
 
    """Translate any ErrorFromSmartServer values that don't require context"""
3328
 
    if err.error_verb == 'IncompatibleRepositories':
3329
 
        raise errors.IncompatibleRepositories(err.error_args[0],
3330
 
            err.error_args[1], err.error_args[2])
3331
 
    elif err.error_verb == 'LockContention':
3332
 
        raise errors.LockContention('(remote lock)')
3333
 
    elif err.error_verb == 'LockFailed':
3334
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3335
 
    elif err.error_verb == 'TipChangeRejected':
3336
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3337
 
    elif err.error_verb == 'UnstackableBranchFormat':
3338
 
        raise errors.UnstackableBranchFormat(*err.error_args)
3339
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
3340
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3341
2981
    elif err.error_verb == 'FileExists':
3342
2982
        raise errors.FileExists(err.error_args[0])
3343
2983
    elif err.error_verb == 'DirectoryNotEmpty':
3362
3002
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3363
3003
    elif err.error_verb == 'ReadOnlyError':
3364
3004
        raise errors.TransportNotPossible('readonly transport')
3365
 
    elif err.error_verb == 'MemoryError':
3366
 
        raise errors.BzrError("remote server out of memory\n"
3367
 
            "Retry non-remotely, or contact the server admin for details.")
3368
3005
    raise errors.UnknownErrorFromSmartServer(err)