← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 12:49:33 UTC
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014124933-732wmdc39ebzga0b
Fix last locking issues.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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,
 
22
    bzrdir as _mod_bzrdir,
23
23
    config,
 
24
    controldir,
24
25
    debug,
25
26
    errors,
26
27
    graph,
27
28
    lock,
28
29
    lockdir,
29
 
    repository,
30
30
    repository as _mod_repository,
31
 
    revision,
32
31
    revision as _mod_revision,
33
32
    static_tuple,
34
33
    symbol_versioning,
35
 
)
36
 
from bzrlib.branch import BranchReferenceFormat
37
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
34
    urlutils,
 
35
    vf_repository,
 
36
    )
 
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
39
from bzrlib.errors import (
40
40
    NoSuchRevision,
41
41
    SmartProtocolError,
42
42
    )
 
43
from bzrlib.i18n import gettext
43
44
from bzrlib.lockable_files import LockableFiles
44
45
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
 
46
from bzrlib.smart.client import _SmartClient
 
47
from bzrlib.revision import NULL_REVISION
 
48
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
46
49
from bzrlib.trace import mutter, note, warning
47
50
 
48
51
 
 
52
_DEFAULT_SEARCH_DEPTH = 100
 
53
 
 
54
 
49
55
class _RpcHelper(object):
50
56
    """Mixin class that helps with issuing RPCs."""
51
57
 
86
92
    return format
87
93
 
88
94
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
95
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
 
96
# does not have to be imported unless a remote format is involved.
 
97
 
 
98
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
 
99
    """Format representing bzrdirs accessed via a smart server"""
 
100
 
 
101
    supports_workingtrees = False
 
102
 
 
103
    def __init__(self):
 
104
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
 
105
        # XXX: It's a bit ugly that the network name is here, because we'd
 
106
        # like to believe that format objects are stateless or at least
 
107
        # immutable,  However, we do at least avoid mutating the name after
 
108
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
109
        self._network_name = None
 
110
 
 
111
    def __repr__(self):
 
112
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
113
            self._network_name)
 
114
 
 
115
    def get_format_description(self):
 
116
        if self._network_name:
 
117
            real_format = controldir.network_format_registry.get(self._network_name)
 
118
            return 'Remote: ' + real_format.get_format_description()
 
119
        return 'bzr remote bzrdir'
 
120
 
 
121
    def get_format_string(self):
 
122
        raise NotImplementedError(self.get_format_string)
 
123
 
 
124
    def network_name(self):
 
125
        if self._network_name:
 
126
            return self._network_name
 
127
        else:
 
128
            raise AssertionError("No network name set.")
 
129
 
 
130
    def initialize_on_transport(self, transport):
 
131
        try:
 
132
            # hand off the request to the smart server
 
133
            client_medium = transport.get_smart_medium()
 
134
        except errors.NoSmartMedium:
 
135
            # TODO: lookup the local format from a server hint.
 
136
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
137
            return local_dir_format.initialize_on_transport(transport)
 
138
        client = _SmartClient(client_medium)
 
139
        path = client.remote_path_from_transport(transport)
 
140
        try:
 
141
            response = client.call('BzrDirFormat.initialize', path)
 
142
        except errors.ErrorFromSmartServer, err:
 
143
            _translate_error(err, path=path)
 
144
        if response[0] != 'ok':
 
145
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
146
        format = RemoteBzrDirFormat()
 
147
        self._supply_sub_formats_to(format)
 
148
        return RemoteBzrDir(transport, format)
 
149
 
 
150
    def parse_NoneTrueFalse(self, arg):
 
151
        if not arg:
 
152
            return None
 
153
        if arg == 'False':
 
154
            return False
 
155
        if arg == 'True':
 
156
            return True
 
157
        raise AssertionError("invalid arg %r" % arg)
 
158
 
 
159
    def _serialize_NoneTrueFalse(self, arg):
 
160
        if arg is False:
 
161
            return 'False'
 
162
        if arg:
 
163
            return 'True'
 
164
        return ''
 
165
 
 
166
    def _serialize_NoneString(self, arg):
 
167
        return arg or ''
 
168
 
 
169
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
170
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
171
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
172
        shared_repo=False):
 
173
        try:
 
174
            # hand off the request to the smart server
 
175
            client_medium = transport.get_smart_medium()
 
176
        except errors.NoSmartMedium:
 
177
            do_vfs = True
 
178
        else:
 
179
            # Decline to open it if the server doesn't support our required
 
180
            # version (3) so that the VFS-based transport will do it.
 
181
            if client_medium.should_probe():
 
182
                try:
 
183
                    server_version = client_medium.protocol_version()
 
184
                    if server_version != '2':
 
185
                        do_vfs = True
 
186
                    else:
 
187
                        do_vfs = False
 
188
                except errors.SmartProtocolError:
 
189
                    # Apparently there's no usable smart server there, even though
 
190
                    # the medium supports the smart protocol.
 
191
                    do_vfs = True
 
192
            else:
 
193
                do_vfs = False
 
194
        if not do_vfs:
 
195
            client = _SmartClient(client_medium)
 
196
            path = client.remote_path_from_transport(transport)
 
197
            if client_medium._is_remote_before((1, 16)):
 
198
                do_vfs = True
 
199
        if do_vfs:
 
200
            # TODO: lookup the local format from a server hint.
 
201
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
202
            self._supply_sub_formats_to(local_dir_format)
 
203
            return local_dir_format.initialize_on_transport_ex(transport,
 
204
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
205
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
206
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
207
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
208
                vfs_only=True)
 
209
        return self._initialize_on_transport_ex_rpc(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
 
 
213
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
214
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
215
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
216
        args = []
 
217
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
218
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
219
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
220
        args.append(self._serialize_NoneString(stacked_on))
 
221
        # stack_on_pwd is often/usually our transport
 
222
        if stack_on_pwd:
 
223
            try:
 
224
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
225
                if not stack_on_pwd:
 
226
                    stack_on_pwd = '.'
 
227
            except errors.PathNotChild:
 
228
                pass
 
229
        args.append(self._serialize_NoneString(stack_on_pwd))
 
230
        args.append(self._serialize_NoneString(repo_format_name))
 
231
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
232
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
233
        request_network_name = self._network_name or \
 
234
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
 
235
        try:
 
236
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
237
                request_network_name, path, *args)
 
238
        except errors.UnknownSmartMethod:
 
239
            client._medium._remember_remote_is_before((1,16))
 
240
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
241
            self._supply_sub_formats_to(local_dir_format)
 
242
            return local_dir_format.initialize_on_transport_ex(transport,
 
243
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
244
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
245
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
246
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
247
                vfs_only=True)
 
248
        except errors.ErrorFromSmartServer, err:
 
249
            _translate_error(err, path=path)
 
250
        repo_path = response[0]
 
251
        bzrdir_name = response[6]
 
252
        require_stacking = response[7]
 
253
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
254
        format = RemoteBzrDirFormat()
 
255
        format._network_name = bzrdir_name
 
256
        self._supply_sub_formats_to(format)
 
257
        bzrdir = RemoteBzrDir(transport, format, _client=client)
 
258
        if repo_path:
 
259
            repo_format = response_tuple_to_repo_format(response[1:])
 
260
            if repo_path == '.':
 
261
                repo_path = ''
 
262
            if repo_path:
 
263
                repo_bzrdir_format = RemoteBzrDirFormat()
 
264
                repo_bzrdir_format._network_name = response[5]
 
265
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
 
266
                    repo_bzrdir_format)
 
267
            else:
 
268
                repo_bzr = bzrdir
 
269
            final_stack = response[8] or None
 
270
            final_stack_pwd = response[9] or None
 
271
            if final_stack_pwd:
 
272
                final_stack_pwd = urlutils.join(
 
273
                    transport.base, final_stack_pwd)
 
274
            remote_repo = RemoteRepository(repo_bzr, repo_format)
 
275
            if len(response) > 10:
 
276
                # Updated server verb that locks remotely.
 
277
                repo_lock_token = response[10] or None
 
278
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
279
                if repo_lock_token:
 
280
                    remote_repo.dont_leave_lock_in_place()
 
281
            else:
 
282
                remote_repo.lock_write()
 
283
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
 
284
                final_stack_pwd, require_stacking)
 
285
            policy.acquire_repository()
 
286
        else:
 
287
            remote_repo = None
 
288
            policy = None
 
289
        bzrdir._format.set_branch_format(self.get_branch_format())
 
290
        if require_stacking:
 
291
            # The repo has already been created, but we need to make sure that
 
292
            # we'll make a stackable branch.
 
293
            bzrdir._format.require_stacking(_skip_repo=True)
 
294
        return remote_repo, bzrdir, require_stacking, policy
 
295
 
 
296
    def _open(self, transport):
 
297
        return RemoteBzrDir(transport, self)
 
298
 
 
299
    def __eq__(self, other):
 
300
        if not isinstance(other, RemoteBzrDirFormat):
 
301
            return False
 
302
        return self.get_format_description() == other.get_format_description()
 
303
 
 
304
    def __return_repository_format(self):
 
305
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
306
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
307
        # that it should use that for init() etc.
 
308
        result = RemoteRepositoryFormat()
 
309
        custom_format = getattr(self, '_repository_format', None)
 
310
        if custom_format:
 
311
            if isinstance(custom_format, RemoteRepositoryFormat):
 
312
                return custom_format
 
313
            else:
 
314
                # We will use the custom format to create repositories over the
 
315
                # wire; expose its details like rich_root_data for code to
 
316
                # query
 
317
                result._custom_format = custom_format
 
318
        return result
 
319
 
 
320
    def get_branch_format(self):
 
321
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
 
322
        if not isinstance(result, RemoteBranchFormat):
 
323
            new_result = RemoteBranchFormat()
 
324
            new_result._custom_format = result
 
325
            # cache the result
 
326
            self.set_branch_format(new_result)
 
327
            result = new_result
 
328
        return result
 
329
 
 
330
    repository_format = property(__return_repository_format,
 
331
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
 
332
 
 
333
 
 
334
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
92
335
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
336
 
94
337
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
340
        :param _client: Private parameter for testing. Disables probing and the
98
341
            use of a real bzrdir.
99
342
        """
100
 
        BzrDir.__init__(self, transport, format)
 
343
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
344
        # this object holds a delegated bzrdir that uses file-level operations
102
345
        # to talk to the other side
103
346
        self._real_bzrdir = None
163
406
                import traceback
164
407
                warning('VFS BzrDir access triggered\n%s',
165
408
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
 
409
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
167
410
                self.root_transport, _server_formats=False)
168
411
            self._format._network_name = \
169
412
                self._real_bzrdir._format.network_name()
175
418
        # Prevent aliasing problems in the next_open_branch_result cache.
176
419
        # See create_branch for rationale.
177
420
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
421
        return _mod_bzrdir.BzrDir.break_lock(self)
179
422
 
180
423
    def _vfs_cloning_metadir(self, require_stacking=False):
181
424
        self._ensure_real()
212
455
        if len(branch_info) != 2:
213
456
            raise errors.UnexpectedSmartServerResponse(response)
214
457
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
458
        format = controldir.network_format_registry.get(control_name)
216
459
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
 
460
            format.repository_format = _mod_repository.network_format_registry.get(
218
461
                repo_name)
219
462
        if branch_ref == 'ref':
220
463
            # XXX: we need possible_transports here to avoid reopening the
221
464
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
465
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
466
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
467
            format.set_branch_format(branch_format)
225
468
        elif branch_ref == 'branch':
244
487
        self._ensure_real()
245
488
        self._real_bzrdir.destroy_repository()
246
489
 
247
 
    def create_branch(self, name=None):
 
490
    def create_branch(self, name=None, repository=None,
 
491
                      append_revisions_only=None):
248
492
        # as per meta1 formats - just delegate to the format object which may
249
493
        # be parameterised.
250
494
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
495
            name=name, repository=repository,
 
496
            append_revisions_only=append_revisions_only)
252
497
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
498
            if not isinstance(repository, RemoteRepository):
 
499
                raise AssertionError(
 
500
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
501
                    % (repository,))
 
502
            result = RemoteBranch(self, repository, real_branch, name=name)
255
503
        else:
256
504
            result = real_branch
257
505
        # BzrDir.clone_on_transport() uses the result of create_branch but does
269
517
        self._real_bzrdir.destroy_branch(name=name)
270
518
        self._next_open_branch_result = None
271
519
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
520
    def create_workingtree(self, revision_id=None, from_branch=None,
 
521
        accelerator_tree=None, hardlink=False):
273
522
        raise errors.NotLocalUrl(self.transport.base)
274
523
 
275
 
    def find_branch_format(self):
 
524
    def find_branch_format(self, name=None):
276
525
        """Find the branch 'format' for this bzrdir.
277
526
 
278
527
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
528
        """
280
 
        b = self.open_branch()
 
529
        b = self.open_branch(name=name)
281
530
        return b._format
282
531
 
283
 
    def get_branch_reference(self):
 
532
    def get_branch_reference(self, name=None):
284
533
        """See BzrDir.get_branch_reference()."""
 
534
        if name is not None:
 
535
            # XXX JRV20100304: Support opening colocated branches
 
536
            raise errors.NoColocatedBranchSupport(self)
285
537
        response = self._get_branch_reference()
286
538
        if response[0] == 'ref':
287
539
            return response[1]
318
570
            raise errors.UnexpectedSmartServerResponse(response)
319
571
        return response
320
572
 
321
 
    def _get_tree_branch(self):
 
573
    def _get_tree_branch(self, name=None):
322
574
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
575
        return None, self.open_branch(name=name)
324
576
 
325
577
    def open_branch(self, name=None, unsupported=False,
326
578
                    ignore_fallbacks=False):
423
675
 
424
676
    def _path_for_remote_call(self, client):
425
677
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
678
        return urlutils.split_segment_parameters_raw(
 
679
            client.remote_path_from_transport(self.root_transport))[0]
427
680
 
428
681
    def get_branch_transport(self, branch_format, name=None):
429
682
        self._ensure_real()
441
694
        """Upgrading of remote bzrdirs is not supported yet."""
442
695
        return False
443
696
 
444
 
    def needs_format_conversion(self, format=None):
 
697
    def needs_format_conversion(self, format):
445
698
        """Upgrading of remote bzrdirs is not supported yet."""
446
 
        if format is None:
447
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
448
 
                % 'needs_format_conversion(format=None)')
449
699
        return False
450
700
 
451
701
    def clone(self, url, revision_id=None, force_new_repo=False,
458
708
        return RemoteBzrDirConfig(self)
459
709
 
460
710
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
711
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
712
    """Format for repositories accessed over a _SmartClient.
463
713
 
464
714
    Instances of this repository are represented by RemoteRepository
479
729
    """
480
730
 
481
731
    _matchingbzrdir = RemoteBzrDirFormat()
 
732
    supports_full_versioned_files = True
 
733
    supports_leaving_lock = True
482
734
 
483
735
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
736
        _mod_repository.RepositoryFormat.__init__(self)
485
737
        self._custom_format = None
486
738
        self._network_name = None
487
739
        self._creating_bzrdir = None
 
740
        self._revision_graph_can_have_wrong_parents = None
488
741
        self._supports_chks = None
489
742
        self._supports_external_lookups = None
490
743
        self._supports_tree_reference = None
 
744
        self._supports_funky_characters = None
 
745
        self._supports_nesting_repositories = None
491
746
        self._rich_root_data = None
492
747
 
493
748
    def __repr__(self):
522
777
        return self._supports_external_lookups
523
778
 
524
779
    @property
 
780
    def supports_funky_characters(self):
 
781
        if self._supports_funky_characters is None:
 
782
            self._ensure_real()
 
783
            self._supports_funky_characters = \
 
784
                self._custom_format.supports_funky_characters
 
785
        return self._supports_funky_characters
 
786
 
 
787
    @property
 
788
    def supports_nesting_repositories(self):
 
789
        if self._supports_nesting_repositories is None:
 
790
            self._ensure_real()
 
791
            self._supports_nesting_repositories = \
 
792
                self._custom_format.supports_nesting_repositories
 
793
        return self._supports_nesting_repositories
 
794
 
 
795
    @property
525
796
    def supports_tree_reference(self):
526
797
        if self._supports_tree_reference is None:
527
798
            self._ensure_real()
529
800
                self._custom_format.supports_tree_reference
530
801
        return self._supports_tree_reference
531
802
 
 
803
    @property
 
804
    def revision_graph_can_have_wrong_parents(self):
 
805
        if self._revision_graph_can_have_wrong_parents is None:
 
806
            self._ensure_real()
 
807
            self._revision_graph_can_have_wrong_parents = \
 
808
                self._custom_format.revision_graph_can_have_wrong_parents
 
809
        return self._revision_graph_can_have_wrong_parents
 
810
 
532
811
    def _vfs_initialize(self, a_bzrdir, shared):
533
812
        """Helper for common code in initialize."""
534
813
        if self._custom_format:
569
848
            network_name = self._network_name
570
849
        else:
571
850
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
851
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
852
            reference_format = reference_bzrdir_format.repository_format
574
853
            network_name = reference_format.network_name()
575
854
        # 2) try direct creation via RPC
601
880
 
602
881
    def _ensure_real(self):
603
882
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
 
883
            self._custom_format = _mod_repository.network_format_registry.get(
605
884
                self._network_name)
606
885
 
607
886
    @property
644
923
 
645
924
 
646
925
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
926
    controldir.ControlComponent):
648
927
    """Repository accessed over rpc.
649
928
 
650
929
    For the moment most operations are performed using local transport-backed
703
982
        # transport, but I'm not sure it's worth making this method
704
983
        # optional -- mbp 2010-04-21
705
984
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
985
 
707
986
    def __str__(self):
708
987
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
988
 
817
1096
    def find_text_key_references(self):
818
1097
        """Find the text key references within the repository.
819
1098
 
820
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
821
 
        revision_ids. Each altered file-ids has the exact revision_ids that
822
 
        altered it listed explicitly.
823
1099
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1100
            to whether they were referred to by the inventory of the
825
1101
            revision_id that they contain. The inventory texts from all present
843
1119
        """Private method for using with old (< 1.2) servers to fallback."""
844
1120
        if revision_id is None:
845
1121
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1122
        elif _mod_revision.is_null(revision_id):
847
1123
            return {}
848
1124
 
849
1125
        path = self.bzrdir._path_for_remote_call(self._client)
873
1149
        return RemoteStreamSource(self, to_format)
874
1150
 
875
1151
    @needs_read_lock
 
1152
    def get_file_graph(self):
 
1153
        return graph.Graph(self.texts)
 
1154
 
 
1155
    @needs_read_lock
876
1156
    def has_revision(self, revision_id):
877
1157
        """True if this repository has a copy of the revision."""
878
1158
        # Copy of bzrlib.repository.Repository.has_revision
895
1175
    def _has_same_fallbacks(self, other_repo):
896
1176
        """Returns true if the repositories have the same fallbacks."""
897
1177
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1178
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1179
        my_fb = self._fallback_repositories
900
1180
        other_fb = other_repo._fallback_repositories
901
1181
        if len(my_fb) != len(other_fb):
930
1210
        """See Repository.gather_stats()."""
931
1211
        path = self.bzrdir._path_for_remote_call(self._client)
932
1212
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1213
        if revid is None or _mod_revision.is_null(revid):
934
1214
            fmt_revid = ''
935
1215
        else:
936
1216
            fmt_revid = revid
997
1277
        pass
998
1278
 
999
1279
    def lock_read(self):
 
1280
        """Lock the repository for read operations.
 
1281
 
 
1282
        :return: A bzrlib.lock.LogicalLockResult.
 
1283
        """
1000
1284
        # wrong eventually - want a local lock cache context
1001
1285
        if not self._lock_mode:
1002
1286
            self._note_lock('r')
1009
1293
                repo.lock_read()
1010
1294
        else:
1011
1295
            self._lock_count += 1
 
1296
        return lock.LogicalLockResult(self.unlock)
1012
1297
 
1013
1298
    def _remote_lock_write(self, token):
1014
1299
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1339
            raise errors.ReadOnlyError(self)
1055
1340
        else:
1056
1341
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1342
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1343
 
1059
1344
    def leave_lock_in_place(self):
1060
1345
        if not self._lock_token:
1214
1499
 
1215
1500
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1501
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
 
1502
                           revision_id=None, lossy=False):
1218
1503
        # FIXME: It ought to be possible to call this without immediately
1219
1504
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
1505
        self._ensure_real()
1221
1506
        real_repo = self._real_repository
1222
1507
        builder = real_repo.get_commit_builder(branch, parents,
1223
1508
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
 
1509
                committer=committer, revprops=revprops,
 
1510
                revision_id=revision_id, lossy=lossy)
1225
1511
        return builder
1226
1512
 
1227
1513
    def add_fallback_repository(self, repository):
1235
1521
        # We need to accumulate additional repositories here, to pass them in
1236
1522
        # on various RPC's.
1237
1523
        #
 
1524
        # Make the check before we lock: this raises an exception.
 
1525
        self._check_fallback_repository(repository)
1238
1526
        if self.is_locked():
1239
1527
            # We will call fallback.unlock() when we transition to the unlocked
1240
1528
            # state, so always add a lock here. If a caller passes us a locked
1241
1529
            # repository, they are responsible for unlocking it later.
1242
1530
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1531
        self._fallback_repositories.append(repository)
1245
1532
        # If self._real_repository was parameterised already (e.g. because a
1246
1533
        # _real_branch had its get_stacked_on_url method called), then the
1306
1593
        return self._real_repository.make_working_trees()
1307
1594
 
1308
1595
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
1596
        """Re-read any data needed to synchronise with disk.
1310
1597
 
1311
1598
        This method is intended to be called after another repository instance
1312
1599
        (such as one used by a smart server) has inserted data into the
1313
 
        repository. It may not be called during a write group, but may be
1314
 
        called at any other time.
 
1600
        repository. On all repositories this will work outside of write groups.
 
1601
        Some repository formats (pack and newer for bzrlib native formats)
 
1602
        support refresh_data inside write groups. If called inside a write
 
1603
        group on a repository that does not support refreshing in a write group
 
1604
        IsInWriteGroupError will be raised.
1315
1605
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
1606
        if self._real_repository is not None:
1320
1607
            self._real_repository.refresh_data()
1321
1608
 
1333
1620
        return result
1334
1621
 
1335
1622
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1623
    def search_missing_revision_ids(self, other,
 
1624
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
1625
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
1626
            limit=None):
1337
1627
        """Return the revision ids that other has that this does not.
1338
1628
 
1339
1629
        These are returned in topological order.
1340
1630
 
1341
1631
        revision_id: only return revision ids included by revision_id.
1342
1632
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
1633
        if symbol_versioning.deprecated_passed(revision_id):
 
1634
            symbol_versioning.warn(
 
1635
                'search_missing_revision_ids(revision_id=...) was '
 
1636
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
1637
                DeprecationWarning, stacklevel=2)
 
1638
            if revision_ids is not None:
 
1639
                raise AssertionError(
 
1640
                    'revision_ids is mutually exclusive with revision_id')
 
1641
            if revision_id is not None:
 
1642
                revision_ids = [revision_id]
 
1643
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
1644
        return inter_repo.search_missing_revision_ids(
 
1645
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
1646
            if_present_ids=if_present_ids, limit=limit)
1345
1647
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1648
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
1649
            fetch_spec=None):
1348
1650
        # No base implementation to use as RemoteRepository is not a subclass
1349
1651
        # of Repository; so this is a copy of Repository.fetch().
1360
1662
            # check that last_revision is in 'from' and then return a
1361
1663
            # no-operation.
1362
1664
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
1665
                not _mod_revision.is_null(revision_id)):
1364
1666
                self.get_revision(revision_id)
1365
1667
            return 0, []
1366
1668
        # if there is no specific appropriate InterRepository, this will get
1367
1669
        # the InterRepository base class, which raises an
1368
1670
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1671
        inter = _mod_repository.InterRepository.get(source, self)
 
1672
        return inter.fetch(revision_id=revision_id,
1371
1673
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
1674
 
1373
1675
    def create_bundle(self, target, base, fileobj, format=None):
1375
1677
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
1678
 
1377
1679
    @needs_read_lock
 
1680
    @symbol_versioning.deprecated_method(
 
1681
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
1682
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
1683
        self._ensure_real()
1380
1684
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1394
1698
        self._ensure_real()
1395
1699
        return self._real_repository.iter_files_bytes(desired_files)
1396
1700
 
 
1701
    def get_cached_parent_map(self, revision_ids):
 
1702
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
1703
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
 
1704
 
1397
1705
    def get_parent_map(self, revision_ids):
1398
1706
        """See bzrlib.Graph.get_parent_map()."""
1399
1707
        return self._make_parents_provider().get_parent_map(revision_ids)
1457
1765
        if parents_map is None:
1458
1766
            # Repository is not locked, so there's no cache.
1459
1767
            parents_map = {}
1460
 
        # start_set is all the keys in the cache
1461
 
        start_set = set(parents_map)
1462
 
        # result set is all the references to keys in the cache
1463
 
        result_parents = set()
1464
 
        for parents in parents_map.itervalues():
1465
 
            result_parents.update(parents)
1466
 
        stop_keys = result_parents.difference(start_set)
1467
 
        # We don't need to send ghosts back to the server as a position to
1468
 
        # stop either.
1469
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1470
 
        key_count = len(parents_map)
1471
 
        if (NULL_REVISION in result_parents
1472
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1473
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1474
 
            # in our cache of "missing" keys we need to increment our key count
1475
 
            # by 1, because the reconsitituted SearchResult on the server will
1476
 
            # still consider NULL_REVISION to be an included key.
1477
 
            key_count += 1
1478
 
        included_keys = start_set.intersection(result_parents)
1479
 
        start_set.difference_update(included_keys)
 
1768
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
1769
            (start_set, stop_keys,
 
1770
             key_count) = graph.search_result_from_parent_map(
 
1771
                parents_map, self._unstacked_provider.missing_keys)
 
1772
        else:
 
1773
            (start_set, stop_keys,
 
1774
             key_count) = graph.limited_search_result_from_parent_map(
 
1775
                parents_map, self._unstacked_provider.missing_keys,
 
1776
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
1777
        recipe = ('manual', start_set, stop_keys, key_count)
1481
1778
        body = self._serialise_search_recipe(recipe)
1482
1779
        path = self.bzrdir._path_for_remote_call(self._client)
1586
1883
        from bzrlib import osutils
1587
1884
        import tarfile
1588
1885
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
1886
        note(gettext("Copying repository content as tarball..."))
1590
1887
        tar_file = self._get_tarball('bz2')
1591
1888
        if tar_file is None:
1592
1889
            return None
1597
1894
            tmpdir = osutils.mkdtemp()
1598
1895
            try:
1599
1896
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1897
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
1898
                tmp_repo = tmp_bzrdir.open_repository()
1602
1899
                tmp_repo.copy_content_into(destination, revision_id)
1603
1900
            finally:
1688
1985
    def supports_rich_root(self):
1689
1986
        return self._format.rich_root_data
1690
1987
 
 
1988
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
1989
    def iter_reverse_revision_history(self, revision_id):
1692
1990
        self._ensure_real()
1693
1991
        return self._real_repository.iter_reverse_revision_history(revision_id)
1714
2012
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2013
            _files_pb=_files_pb)
1716
2014
 
1717
 
    def revision_graph_can_have_wrong_parents(self):
1718
 
        # The answer depends on the remote repo format.
1719
 
        self._ensure_real()
1720
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
 
 
1722
2015
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2016
        self._ensure_real()
1724
2017
        return self._real_repository._find_inconsistent_revision_parents(
1732
2025
        providers = [self._unstacked_provider]
1733
2026
        if other is not None:
1734
2027
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2028
        return graph.StackedParentsProvider(_LazyListJoin(
 
2029
            providers, self._fallback_repositories))
1738
2030
 
1739
2031
    def _serialise_search_recipe(self, recipe):
1740
2032
        """Serialise a graph search recipe.
1748
2040
        return '\n'.join((start_keys, stop_keys, count))
1749
2041
 
1750
2042
    def _serialise_search_result(self, search_result):
1751
 
        if isinstance(search_result, graph.PendingAncestryResult):
1752
 
            parts = ['ancestry-of']
1753
 
            parts.extend(search_result.heads)
1754
 
        else:
1755
 
            recipe = search_result.get_recipe()
1756
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
2043
        parts = search_result.get_network_struct()
1757
2044
        return '\n'.join(parts)
1758
2045
 
1759
2046
    def autopack(self):
1769
2056
            raise errors.UnexpectedSmartServerResponse(response)
1770
2057
 
1771
2058
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2059
class RemoteStreamSink(vf_repository.StreamSink):
1773
2060
 
1774
2061
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2062
        self.target_repo._ensure_real()
1876
2163
        self._last_substream and self._last_stream so that the stream can be
1877
2164
        resumed by _resume_stream_with_vfs.
1878
2165
        """
1879
 
                    
 
2166
 
1880
2167
        stream_iter = iter(stream)
1881
2168
        for substream_kind, substream in stream_iter:
1882
2169
            if substream_kind == 'inventory-deltas':
1885
2172
                return
1886
2173
            else:
1887
2174
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2175
 
 
2176
 
 
2177
class RemoteStreamSource(vf_repository.StreamSource):
1891
2178
    """Stream data from a remote server."""
1892
2179
 
1893
2180
    def get_stream(self, search):
1953
2240
        candidate_verbs = [
1954
2241
            ('Repository.get_stream_1.19', (1, 19)),
1955
2242
            ('Repository.get_stream', (1, 13))]
 
2243
 
1956
2244
        found_verb = False
1957
2245
        for verb, version in candidate_verbs:
1958
2246
            if medium._is_remote_before(version):
1962
2250
                    verb, args, search_bytes)
1963
2251
            except errors.UnknownSmartMethod:
1964
2252
                medium._remember_remote_is_before(version)
 
2253
            except errors.UnknownErrorFromSmartServer, e:
 
2254
                if isinstance(search, graph.EverythingResult):
 
2255
                    error_verb = e.error_from_smart_server.error_verb
 
2256
                    if error_verb == 'BadSearch':
 
2257
                        # Pre-2.4 servers don't support this sort of search.
 
2258
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2259
                        # good idea in general?  It might provide a little bit
 
2260
                        # of protection against client-side bugs.
 
2261
                        medium._remember_remote_is_before((2, 4))
 
2262
                        break
 
2263
                raise
1965
2264
            else:
1966
2265
                response_tuple, response_handler = response
1967
2266
                found_verb = True
1971
2270
        if response_tuple[0] != 'ok':
1972
2271
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
2272
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
2273
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
2274
            self._record_counter)
1975
2275
        if src_format.network_name() != repo._format.network_name():
1976
2276
            raise AssertionError(
1977
2277
                "Mismatched RemoteRepository and stream src %r, %r" % (
2063
2363
        return a_bzrdir.open_branch(name=name, 
2064
2364
            ignore_fallbacks=ignore_fallbacks)
2065
2365
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
2366
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
2367
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
2368
        # method is not available on the server.
2069
2369
        # self._custom_format is always set - the start of initialize ensures
2071
2371
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
2372
            a_bzrdir._ensure_real()
2073
2373
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
2374
                name, append_revisions_only=append_revisions_only)
2075
2375
        else:
2076
2376
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
2377
            result = self._custom_format.initialize(a_bzrdir, name,
 
2378
                append_revisions_only=append_revisions_only)
2078
2379
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
2380
            not isinstance(result, RemoteBranch)):
2080
2381
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
2382
                                  name=name)
2082
2383
        return result
2083
2384
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
2385
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2386
                   append_revisions_only=None):
2085
2387
        # 1) get the network name to use.
2086
2388
        if self._custom_format:
2087
2389
            network_name = self._custom_format.network_name()
2088
2390
        else:
2089
2391
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
2392
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
2393
            reference_format = reference_bzrdir_format.get_branch_format()
2092
2394
            self._custom_format = reference_format
2093
2395
            network_name = reference_format.network_name()
2094
2396
        # Being asked to create on a non RemoteBzrDir:
2095
2397
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2398
            return self._vfs_initialize(a_bzrdir, name=name,
 
2399
                append_revisions_only=append_revisions_only)
2097
2400
        medium = a_bzrdir._client._medium
2098
2401
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2402
            return self._vfs_initialize(a_bzrdir, name=name,
 
2403
                append_revisions_only=append_revisions_only)
2100
2404
        # Creating on a remote bzr dir.
2101
2405
        # 2) try direct creation via RPC
2102
2406
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
2413
        except errors.UnknownSmartMethod:
2110
2414
            # Fallback - use vfs methods
2111
2415
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2416
            return self._vfs_initialize(a_bzrdir, name=name,
 
2417
                    append_revisions_only=append_revisions_only)
2113
2418
        if response[0] != 'ok':
2114
2419
            raise errors.UnexpectedSmartServerResponse(response)
2115
2420
        # Turn the response into a RemoteRepository object.
2116
2421
        format = RemoteBranchFormat(network_name=response[1])
2117
2422
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
2423
        repo_path = response[2]
 
2424
        if repository is not None:
 
2425
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
2426
            url_diff = urlutils.relative_url(repository.user_url,
 
2427
                    remote_repo_url)
 
2428
            if url_diff != '.':
 
2429
                raise AssertionError(
 
2430
                    'repository.user_url %r does not match URL from server '
 
2431
                    'response (%r + %r)'
 
2432
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
2433
            remote_repo = repository
2120
2434
        else:
2121
 
            repo_bzrdir = RemoteBzrDir(
2122
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2123
 
                a_bzrdir._client)
2124
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2435
            if repo_path == '':
 
2436
                repo_bzrdir = a_bzrdir
 
2437
            else:
 
2438
                repo_bzrdir = RemoteBzrDir(
 
2439
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
2440
                    a_bzrdir._client)
 
2441
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
2442
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
2443
            format=format, setup_stacking=False, name=name)
 
2444
        if append_revisions_only:
 
2445
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
2446
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
2447
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
2448
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
2467
        self._ensure_real()
2149
2468
        return self._custom_format.supports_set_append_revisions_only()
2150
2469
 
 
2470
    def _use_default_local_heads_to_fetch(self):
 
2471
        # If the branch format is a metadir format *and* its heads_to_fetch
 
2472
        # implementation is not overridden vs the base class, we can use the
 
2473
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
2474
        # usually cheaper in terms of net round trips, as the last-revision and
 
2475
        # tags info fetched is cached and would be fetched anyway.
 
2476
        self._ensure_real()
 
2477
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
2478
            branch_class = self._custom_format._branch_class()
 
2479
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
2480
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
2481
                return True
 
2482
        return False
2151
2483
 
2152
2484
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
2485
    """Branch stored on a server accessed by HPSS RPC.
2311
2643
                self.bzrdir, self._client)
2312
2644
        return self._control_files
2313
2645
 
2314
 
    def _get_checkout_format(self):
 
2646
    def _get_checkout_format(self, lightweight=False):
2315
2647
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
 
2648
        if lightweight:
 
2649
            format = RemoteBzrDirFormat()
 
2650
            self.bzrdir._format._supply_sub_formats_to(format)
 
2651
            format.workingtree_format = self._real_branch._get_checkout_format(
 
2652
                lightweight=lightweight).workingtree_format
 
2653
            return format
 
2654
        else:
 
2655
            return self._real_branch._get_checkout_format(lightweight=False)
2317
2656
 
2318
2657
    def get_physical_lock_status(self):
2319
2658
        """See Branch.get_physical_lock_status()."""
2352
2691
            self._is_stacked = False
2353
2692
        else:
2354
2693
            self._is_stacked = True
2355
 
        
 
2694
 
2356
2695
    def _vfs_get_tags_bytes(self):
2357
2696
        self._ensure_real()
2358
2697
        return self._real_branch._get_tags_bytes()
2359
2698
 
 
2699
    @needs_read_lock
2360
2700
    def _get_tags_bytes(self):
 
2701
        if self._tags_bytes is None:
 
2702
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
2703
        return self._tags_bytes
 
2704
 
 
2705
    def _get_tags_bytes_via_hpss(self):
2361
2706
        medium = self._client._medium
2362
2707
        if medium._is_remote_before((1, 13)):
2363
2708
            return self._vfs_get_tags_bytes()
2373
2718
        return self._real_branch._set_tags_bytes(bytes)
2374
2719
 
2375
2720
    def _set_tags_bytes(self, bytes):
 
2721
        if self.is_locked():
 
2722
            self._tags_bytes = bytes
2376
2723
        medium = self._client._medium
2377
2724
        if medium._is_remote_before((1, 18)):
2378
2725
            self._vfs_set_tags_bytes(bytes)
2387
2734
            self._vfs_set_tags_bytes(bytes)
2388
2735
 
2389
2736
    def lock_read(self):
 
2737
        """Lock the branch for read operations.
 
2738
 
 
2739
        :return: A bzrlib.lock.LogicalLockResult.
 
2740
        """
2390
2741
        self.repository.lock_read()
2391
2742
        if not self._lock_mode:
2392
2743
            self._note_lock('r')
2396
2747
                self._real_branch.lock_read()
2397
2748
        else:
2398
2749
            self._lock_count += 1
 
2750
        return lock.LogicalLockResult(self.unlock)
2399
2751
 
2400
2752
    def _remote_lock_write(self, token):
2401
2753
        if token is None:
2402
2754
            branch_token = repo_token = ''
2403
2755
        else:
2404
2756
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
2757
            repo_token = self.repository.lock_write().repository_token
2406
2758
            self.repository.unlock()
2407
2759
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
2760
        try:
 
2761
            response = self._call(
 
2762
                'Branch.lock_write', self._remote_path(), branch_token,
 
2763
                repo_token or '', **err_context)
 
2764
        except errors.LockContention, e:
 
2765
            # The LockContention from the server doesn't have any
 
2766
            # information about the lock_url. We re-raise LockContention
 
2767
            # with valid lock_url.
 
2768
            raise errors.LockContention('(remote lock)',
 
2769
                self.repository.base.split('.bzr/')[0])
2411
2770
        if response[0] != 'ok':
2412
2771
            raise errors.UnexpectedSmartServerResponse(response)
2413
2772
        ok, branch_token, repo_token = response
2434
2793
            self._lock_mode = 'w'
2435
2794
            self._lock_count = 1
2436
2795
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
2796
            raise errors.ReadOnlyError(self)
2438
2797
        else:
2439
2798
            if token is not None:
2440
2799
                # A token was given to lock_write, and we're relocking, so
2445
2804
            self._lock_count += 1
2446
2805
            # Re-lock the repository too.
2447
2806
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
2807
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
2808
 
2450
2809
    def _unlock(self, branch_token, repo_token):
2451
2810
        err_context = {'token': str((branch_token, repo_token))}
2520
2879
            missing_parent = parent_map[missing_parent]
2521
2880
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
2881
 
2523
 
    def _last_revision_info(self):
 
2882
    def _read_last_revision_info(self):
2524
2883
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2884
        if response[0] != 'ok':
2526
2885
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
2948
            raise errors.UnexpectedSmartServerResponse(response)
2590
2949
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
2950
 
 
2951
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
2952
    @needs_write_lock
2593
2953
    def set_revision_history(self, rev_history):
 
2954
        """See Branch.set_revision_history."""
 
2955
        self._set_revision_history(rev_history)
 
2956
 
 
2957
    @needs_write_lock
 
2958
    def _set_revision_history(self, rev_history):
2594
2959
        # Send just the tip revision of the history; the server will generate
2595
2960
        # the full history from that.  If the revision doesn't exist in this
2596
2961
        # branch, NoSuchRevision will be raised.
2654
3019
            _override_hook_target=self, **kwargs)
2655
3020
 
2656
3021
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3022
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3023
        self._ensure_real()
2659
3024
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3025
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3026
            _override_hook_source_branch=self)
2662
3027
 
2663
3028
    def is_locked(self):
2673
3038
        # XXX: These should be returned by the set_last_revision_info verb
2674
3039
        old_revno, old_revid = self.last_revision_info()
2675
3040
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3041
        if not revision_id or not isinstance(revision_id, basestring):
 
3042
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3043
        try:
2678
3044
            response = self._call('Branch.set_last_revision_info',
2679
3045
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3074
            except errors.UnknownSmartMethod:
2709
3075
                medium._remember_remote_is_before((1, 6))
2710
3076
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3077
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3078
            last_rev=last_rev,other_branch=other_branch))
2713
3079
 
2714
3080
    def set_push_location(self, location):
2715
3081
        self._ensure_real()
2716
3082
        return self._real_branch.set_push_location(location)
2717
3083
 
 
3084
    def heads_to_fetch(self):
 
3085
        if self._format._use_default_local_heads_to_fetch():
 
3086
            # We recognise this format, and its heads-to-fetch implementation
 
3087
            # is the default one (tip + tags).  In this case it's cheaper to
 
3088
            # just use the default implementation rather than a special RPC as
 
3089
            # the tip and tags data is cached.
 
3090
            return branch.Branch.heads_to_fetch(self)
 
3091
        medium = self._client._medium
 
3092
        if medium._is_remote_before((2, 4)):
 
3093
            return self._vfs_heads_to_fetch()
 
3094
        try:
 
3095
            return self._rpc_heads_to_fetch()
 
3096
        except errors.UnknownSmartMethod:
 
3097
            medium._remember_remote_is_before((2, 4))
 
3098
            return self._vfs_heads_to_fetch()
 
3099
 
 
3100
    def _rpc_heads_to_fetch(self):
 
3101
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3102
        if len(response) != 2:
 
3103
            raise errors.UnexpectedSmartServerResponse(response)
 
3104
        must_fetch, if_present_fetch = response
 
3105
        return set(must_fetch), set(if_present_fetch)
 
3106
 
 
3107
    def _vfs_heads_to_fetch(self):
 
3108
        self._ensure_real()
 
3109
        return self._real_branch.heads_to_fetch()
 
3110
 
2718
3111
 
2719
3112
class RemoteConfig(object):
2720
3113
    """A Config that reads and writes from smart verbs.
2734
3127
        """
2735
3128
        try:
2736
3129
            configobj = self._get_configobj()
 
3130
            section_obj = None
2737
3131
            if section is None:
2738
3132
                section_obj = configobj
2739
3133
            else:
2740
3134
                try:
2741
3135
                    section_obj = configobj[section]
2742
3136
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3137
                    pass
 
3138
            if section_obj is None:
 
3139
                value = default
 
3140
            else:
 
3141
                value = section_obj.get(name, default)
2745
3142
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3143
            value = self._vfs_get_option(name, section, default)
 
3144
        for hook in config.OldConfigHooks['get']:
 
3145
            hook(self, name, value)
 
3146
        return value
2747
3147
 
2748
3148
    def _response_to_configobj(self, response):
2749
3149
        if len(response[0]) and response[0][0] != 'ok':
2750
3150
            raise errors.UnexpectedSmartServerResponse(response)
2751
3151
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3152
        conf = config.ConfigObj(lines, encoding='utf-8')
 
3153
        for hook in config.OldConfigHooks['load']:
 
3154
            hook(self)
 
3155
        return conf
2753
3156
 
2754
3157
 
2755
3158
class RemoteBranchConfig(RemoteConfig):
2774
3177
        medium = self._branch._client._medium
2775
3178
        if medium._is_remote_before((1, 14)):
2776
3179
            return self._vfs_set_option(value, name, section)
 
3180
        if isinstance(value, dict):
 
3181
            if medium._is_remote_before((2, 2)):
 
3182
                return self._vfs_set_option(value, name, section)
 
3183
            return self._set_config_option_dict(value, name, section)
 
3184
        else:
 
3185
            return self._set_config_option(value, name, section)
 
3186
 
 
3187
    def _set_config_option(self, value, name, section):
2777
3188
        try:
2778
3189
            path = self._branch._remote_path()
2779
3190
            response = self._branch._client.call('Branch.set_config_option',
2780
3191
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
3192
                value.encode('utf8'), name, section or '')
2782
3193
        except errors.UnknownSmartMethod:
 
3194
            medium = self._branch._client._medium
2783
3195
            medium._remember_remote_is_before((1, 14))
2784
3196
            return self._vfs_set_option(value, name, section)
2785
3197
        if response != ():
2786
3198
            raise errors.UnexpectedSmartServerResponse(response)
2787
3199
 
 
3200
    def _serialize_option_dict(self, option_dict):
 
3201
        utf8_dict = {}
 
3202
        for key, value in option_dict.items():
 
3203
            if isinstance(key, unicode):
 
3204
                key = key.encode('utf8')
 
3205
            if isinstance(value, unicode):
 
3206
                value = value.encode('utf8')
 
3207
            utf8_dict[key] = value
 
3208
        return bencode.bencode(utf8_dict)
 
3209
 
 
3210
    def _set_config_option_dict(self, value, name, section):
 
3211
        try:
 
3212
            path = self._branch._remote_path()
 
3213
            serialised_dict = self._serialize_option_dict(value)
 
3214
            response = self._branch._client.call(
 
3215
                'Branch.set_config_option_dict',
 
3216
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
3217
                serialised_dict, name, section or '')
 
3218
        except errors.UnknownSmartMethod:
 
3219
            medium = self._branch._client._medium
 
3220
            medium._remember_remote_is_before((2, 2))
 
3221
            return self._vfs_set_option(value, name, section)
 
3222
        if response != ():
 
3223
            raise errors.UnexpectedSmartServerResponse(response)
 
3224
 
2788
3225
    def _real_object(self):
2789
3226
        self._branch._ensure_real()
2790
3227
        return self._branch._real_branch
2873
3310
                    'Missing key %r in context %r', key_err.args[0], context)
2874
3311
                raise err
2875
3312
 
2876
 
    if err.error_verb == 'IncompatibleRepositories':
2877
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2878
 
            err.error_args[1], err.error_args[2])
2879
 
    elif err.error_verb == 'NoSuchRevision':
 
3313
    if err.error_verb == 'NoSuchRevision':
2880
3314
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
3315
    elif err.error_verb == 'nosuchrevision':
2882
3316
        raise NoSuchRevision(find('repository'), err.error_args[0])
2889
3323
            detail=extra)
2890
3324
    elif err.error_verb == 'norepository':
2891
3325
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
3326
    elif err.error_verb == 'UnlockableTransport':
2895
3327
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2896
 
    elif err.error_verb == 'LockFailed':
2897
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2898
3328
    elif err.error_verb == 'TokenMismatch':
2899
3329
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
3330
    elif err.error_verb == 'Diverged':
2901
3331
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2902
 
    elif err.error_verb == 'TipChangeRejected':
2903
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2904
 
    elif err.error_verb == 'UnstackableBranchFormat':
2905
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2906
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2907
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2908
3332
    elif err.error_verb == 'NotStacked':
2909
3333
        raise errors.NotStacked(branch=find('branch'))
2910
3334
    elif err.error_verb == 'PermissionDenied':
2920
3344
    elif err.error_verb == 'NoSuchFile':
2921
3345
        path = get_path()
2922
3346
        raise errors.NoSuchFile(path)
 
3347
    _translate_error_without_context(err)
 
3348
 
 
3349
 
 
3350
def _translate_error_without_context(err):
 
3351
    """Translate any ErrorFromSmartServer values that don't require context"""
 
3352
    if err.error_verb == 'IncompatibleRepositories':
 
3353
        raise errors.IncompatibleRepositories(err.error_args[0],
 
3354
            err.error_args[1], err.error_args[2])
 
3355
    elif err.error_verb == 'LockContention':
 
3356
        raise errors.LockContention('(remote lock)')
 
3357
    elif err.error_verb == 'LockFailed':
 
3358
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
3359
    elif err.error_verb == 'TipChangeRejected':
 
3360
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
3361
    elif err.error_verb == 'UnstackableBranchFormat':
 
3362
        raise errors.UnstackableBranchFormat(*err.error_args)
 
3363
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
3364
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2923
3365
    elif err.error_verb == 'FileExists':
2924
3366
        raise errors.FileExists(err.error_args[0])
2925
3367
    elif err.error_verb == 'DirectoryNotEmpty':
2944
3386
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
3387
    elif err.error_verb == 'ReadOnlyError':
2946
3388
        raise errors.TransportNotPossible('readonly transport')
 
3389
    elif err.error_verb == 'MemoryError':
 
3390
        raise errors.BzrError("remote server out of memory\n"
 
3391
            "Retry non-remotely, or contact the server admin for details.")
2947
3392
    raise errors.UnknownErrorFromSmartServer(err)