← 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-09-18 14:42:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6149.
  • Revision ID: jelmer@samba.org-20110918144226-xwerkr5h05sx5tqa
Add RepositoryFormat.supports_nesting_repositories.

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
491
745
        self._rich_root_data = None
492
746
 
493
747
    def __repr__(self):
522
776
        return self._supports_external_lookups
523
777
 
524
778
    @property
 
779
    def supports_funky_characters(self):
 
780
        if self._supports_funky_characters is None:
 
781
            self._ensure_real()
 
782
            self._supports_funky_characters = \
 
783
                self._custom_format.supports_funky_characters
 
784
        return self._supports_funky_characters
 
785
 
 
786
    @property
525
787
    def supports_tree_reference(self):
526
788
        if self._supports_tree_reference is None:
527
789
            self._ensure_real()
529
791
                self._custom_format.supports_tree_reference
530
792
        return self._supports_tree_reference
531
793
 
 
794
    @property
 
795
    def revision_graph_can_have_wrong_parents(self):
 
796
        if self._revision_graph_can_have_wrong_parents is None:
 
797
            self._ensure_real()
 
798
            self._revision_graph_can_have_wrong_parents = \
 
799
                self._custom_format.revision_graph_can_have_wrong_parents
 
800
        return self._revision_graph_can_have_wrong_parents
 
801
 
532
802
    def _vfs_initialize(self, a_bzrdir, shared):
533
803
        """Helper for common code in initialize."""
534
804
        if self._custom_format:
569
839
            network_name = self._network_name
570
840
        else:
571
841
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
842
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
843
            reference_format = reference_bzrdir_format.repository_format
574
844
            network_name = reference_format.network_name()
575
845
        # 2) try direct creation via RPC
601
871
 
602
872
    def _ensure_real(self):
603
873
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
 
874
            self._custom_format = _mod_repository.network_format_registry.get(
605
875
                self._network_name)
606
876
 
607
877
    @property
644
914
 
645
915
 
646
916
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
917
    controldir.ControlComponent):
648
918
    """Repository accessed over rpc.
649
919
 
650
920
    For the moment most operations are performed using local transport-backed
703
973
        # transport, but I'm not sure it's worth making this method
704
974
        # optional -- mbp 2010-04-21
705
975
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
976
 
707
977
    def __str__(self):
708
978
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
979
 
817
1087
    def find_text_key_references(self):
818
1088
        """Find the text key references within the repository.
819
1089
 
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
1090
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1091
            to whether they were referred to by the inventory of the
825
1092
            revision_id that they contain. The inventory texts from all present
843
1110
        """Private method for using with old (< 1.2) servers to fallback."""
844
1111
        if revision_id is None:
845
1112
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1113
        elif _mod_revision.is_null(revision_id):
847
1114
            return {}
848
1115
 
849
1116
        path = self.bzrdir._path_for_remote_call(self._client)
873
1140
        return RemoteStreamSource(self, to_format)
874
1141
 
875
1142
    @needs_read_lock
 
1143
    def get_file_graph(self):
 
1144
        return graph.Graph(self.texts)
 
1145
 
 
1146
    @needs_read_lock
876
1147
    def has_revision(self, revision_id):
877
1148
        """True if this repository has a copy of the revision."""
878
1149
        # Copy of bzrlib.repository.Repository.has_revision
895
1166
    def _has_same_fallbacks(self, other_repo):
896
1167
        """Returns true if the repositories have the same fallbacks."""
897
1168
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1169
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1170
        my_fb = self._fallback_repositories
900
1171
        other_fb = other_repo._fallback_repositories
901
1172
        if len(my_fb) != len(other_fb):
930
1201
        """See Repository.gather_stats()."""
931
1202
        path = self.bzrdir._path_for_remote_call(self._client)
932
1203
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1204
        if revid is None or _mod_revision.is_null(revid):
934
1205
            fmt_revid = ''
935
1206
        else:
936
1207
            fmt_revid = revid
997
1268
        pass
998
1269
 
999
1270
    def lock_read(self):
 
1271
        """Lock the repository for read operations.
 
1272
 
 
1273
        :return: A bzrlib.lock.LogicalLockResult.
 
1274
        """
1000
1275
        # wrong eventually - want a local lock cache context
1001
1276
        if not self._lock_mode:
1002
1277
            self._note_lock('r')
1009
1284
                repo.lock_read()
1010
1285
        else:
1011
1286
            self._lock_count += 1
 
1287
        return lock.LogicalLockResult(self.unlock)
1012
1288
 
1013
1289
    def _remote_lock_write(self, token):
1014
1290
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1330
            raise errors.ReadOnlyError(self)
1055
1331
        else:
1056
1332
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1333
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1334
 
1059
1335
    def leave_lock_in_place(self):
1060
1336
        if not self._lock_token:
1214
1490
 
1215
1491
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1492
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
 
1493
                           revision_id=None, lossy=False):
1218
1494
        # FIXME: It ought to be possible to call this without immediately
1219
1495
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
1496
        self._ensure_real()
1221
1497
        real_repo = self._real_repository
1222
1498
        builder = real_repo.get_commit_builder(branch, parents,
1223
1499
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
 
1500
                committer=committer, revprops=revprops,
 
1501
                revision_id=revision_id, lossy=lossy)
1225
1502
        return builder
1226
1503
 
1227
1504
    def add_fallback_repository(self, repository):
1235
1512
        # We need to accumulate additional repositories here, to pass them in
1236
1513
        # on various RPC's.
1237
1514
        #
 
1515
        # Make the check before we lock: this raises an exception.
 
1516
        self._check_fallback_repository(repository)
1238
1517
        if self.is_locked():
1239
1518
            # We will call fallback.unlock() when we transition to the unlocked
1240
1519
            # state, so always add a lock here. If a caller passes us a locked
1241
1520
            # repository, they are responsible for unlocking it later.
1242
1521
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1522
        self._fallback_repositories.append(repository)
1245
1523
        # If self._real_repository was parameterised already (e.g. because a
1246
1524
        # _real_branch had its get_stacked_on_url method called), then the
1306
1584
        return self._real_repository.make_working_trees()
1307
1585
 
1308
1586
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
1587
        """Re-read any data needed to synchronise with disk.
1310
1588
 
1311
1589
        This method is intended to be called after another repository instance
1312
1590
        (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.
 
1591
        repository. On all repositories this will work outside of write groups.
 
1592
        Some repository formats (pack and newer for bzrlib native formats)
 
1593
        support refresh_data inside write groups. If called inside a write
 
1594
        group on a repository that does not support refreshing in a write group
 
1595
        IsInWriteGroupError will be raised.
1315
1596
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
1597
        if self._real_repository is not None:
1320
1598
            self._real_repository.refresh_data()
1321
1599
 
1333
1611
        return result
1334
1612
 
1335
1613
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1614
    def search_missing_revision_ids(self, other,
 
1615
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
1616
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
1617
            limit=None):
1337
1618
        """Return the revision ids that other has that this does not.
1338
1619
 
1339
1620
        These are returned in topological order.
1340
1621
 
1341
1622
        revision_id: only return revision ids included by revision_id.
1342
1623
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
1624
        if symbol_versioning.deprecated_passed(revision_id):
 
1625
            symbol_versioning.warn(
 
1626
                'search_missing_revision_ids(revision_id=...) was '
 
1627
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
1628
                DeprecationWarning, stacklevel=2)
 
1629
            if revision_ids is not None:
 
1630
                raise AssertionError(
 
1631
                    'revision_ids is mutually exclusive with revision_id')
 
1632
            if revision_id is not None:
 
1633
                revision_ids = [revision_id]
 
1634
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
1635
        return inter_repo.search_missing_revision_ids(
 
1636
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
1637
            if_present_ids=if_present_ids, limit=limit)
1345
1638
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1639
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
1640
            fetch_spec=None):
1348
1641
        # No base implementation to use as RemoteRepository is not a subclass
1349
1642
        # of Repository; so this is a copy of Repository.fetch().
1360
1653
            # check that last_revision is in 'from' and then return a
1361
1654
            # no-operation.
1362
1655
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
1656
                not _mod_revision.is_null(revision_id)):
1364
1657
                self.get_revision(revision_id)
1365
1658
            return 0, []
1366
1659
        # if there is no specific appropriate InterRepository, this will get
1367
1660
        # the InterRepository base class, which raises an
1368
1661
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1662
        inter = _mod_repository.InterRepository.get(source, self)
 
1663
        return inter.fetch(revision_id=revision_id,
1371
1664
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
1665
 
1373
1666
    def create_bundle(self, target, base, fileobj, format=None):
1375
1668
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
1669
 
1377
1670
    @needs_read_lock
 
1671
    @symbol_versioning.deprecated_method(
 
1672
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
1673
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
1674
        self._ensure_real()
1380
1675
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1394
1689
        self._ensure_real()
1395
1690
        return self._real_repository.iter_files_bytes(desired_files)
1396
1691
 
 
1692
    def get_cached_parent_map(self, revision_ids):
 
1693
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
1694
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
 
1695
 
1397
1696
    def get_parent_map(self, revision_ids):
1398
1697
        """See bzrlib.Graph.get_parent_map()."""
1399
1698
        return self._make_parents_provider().get_parent_map(revision_ids)
1457
1756
        if parents_map is None:
1458
1757
            # Repository is not locked, so there's no cache.
1459
1758
            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)
 
1759
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
1760
            (start_set, stop_keys,
 
1761
             key_count) = graph.search_result_from_parent_map(
 
1762
                parents_map, self._unstacked_provider.missing_keys)
 
1763
        else:
 
1764
            (start_set, stop_keys,
 
1765
             key_count) = graph.limited_search_result_from_parent_map(
 
1766
                parents_map, self._unstacked_provider.missing_keys,
 
1767
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
1768
        recipe = ('manual', start_set, stop_keys, key_count)
1481
1769
        body = self._serialise_search_recipe(recipe)
1482
1770
        path = self.bzrdir._path_for_remote_call(self._client)
1586
1874
        from bzrlib import osutils
1587
1875
        import tarfile
1588
1876
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
1877
        note(gettext("Copying repository content as tarball..."))
1590
1878
        tar_file = self._get_tarball('bz2')
1591
1879
        if tar_file is None:
1592
1880
            return None
1597
1885
            tmpdir = osutils.mkdtemp()
1598
1886
            try:
1599
1887
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1888
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
1889
                tmp_repo = tmp_bzrdir.open_repository()
1602
1890
                tmp_repo.copy_content_into(destination, revision_id)
1603
1891
            finally:
1688
1976
    def supports_rich_root(self):
1689
1977
        return self._format.rich_root_data
1690
1978
 
 
1979
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
1980
    def iter_reverse_revision_history(self, revision_id):
1692
1981
        self._ensure_real()
1693
1982
        return self._real_repository.iter_reverse_revision_history(revision_id)
1714
2003
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2004
            _files_pb=_files_pb)
1716
2005
 
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
2006
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2007
        self._ensure_real()
1724
2008
        return self._real_repository._find_inconsistent_revision_parents(
1732
2016
        providers = [self._unstacked_provider]
1733
2017
        if other is not None:
1734
2018
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2019
        return graph.StackedParentsProvider(_LazyListJoin(
 
2020
            providers, self._fallback_repositories))
1738
2021
 
1739
2022
    def _serialise_search_recipe(self, recipe):
1740
2023
        """Serialise a graph search recipe.
1748
2031
        return '\n'.join((start_keys, stop_keys, count))
1749
2032
 
1750
2033
    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)]
 
2034
        parts = search_result.get_network_struct()
1757
2035
        return '\n'.join(parts)
1758
2036
 
1759
2037
    def autopack(self):
1769
2047
            raise errors.UnexpectedSmartServerResponse(response)
1770
2048
 
1771
2049
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2050
class RemoteStreamSink(vf_repository.StreamSink):
1773
2051
 
1774
2052
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2053
        self.target_repo._ensure_real()
1876
2154
        self._last_substream and self._last_stream so that the stream can be
1877
2155
        resumed by _resume_stream_with_vfs.
1878
2156
        """
1879
 
                    
 
2157
 
1880
2158
        stream_iter = iter(stream)
1881
2159
        for substream_kind, substream in stream_iter:
1882
2160
            if substream_kind == 'inventory-deltas':
1885
2163
                return
1886
2164
            else:
1887
2165
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2166
 
 
2167
 
 
2168
class RemoteStreamSource(vf_repository.StreamSource):
1891
2169
    """Stream data from a remote server."""
1892
2170
 
1893
2171
    def get_stream(self, search):
1953
2231
        candidate_verbs = [
1954
2232
            ('Repository.get_stream_1.19', (1, 19)),
1955
2233
            ('Repository.get_stream', (1, 13))]
 
2234
 
1956
2235
        found_verb = False
1957
2236
        for verb, version in candidate_verbs:
1958
2237
            if medium._is_remote_before(version):
1962
2241
                    verb, args, search_bytes)
1963
2242
            except errors.UnknownSmartMethod:
1964
2243
                medium._remember_remote_is_before(version)
 
2244
            except errors.UnknownErrorFromSmartServer, e:
 
2245
                if isinstance(search, graph.EverythingResult):
 
2246
                    error_verb = e.error_from_smart_server.error_verb
 
2247
                    if error_verb == 'BadSearch':
 
2248
                        # Pre-2.4 servers don't support this sort of search.
 
2249
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2250
                        # good idea in general?  It might provide a little bit
 
2251
                        # of protection against client-side bugs.
 
2252
                        medium._remember_remote_is_before((2, 4))
 
2253
                        break
 
2254
                raise
1965
2255
            else:
1966
2256
                response_tuple, response_handler = response
1967
2257
                found_verb = True
1971
2261
        if response_tuple[0] != 'ok':
1972
2262
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
2263
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
2264
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
2265
            self._record_counter)
1975
2266
        if src_format.network_name() != repo._format.network_name():
1976
2267
            raise AssertionError(
1977
2268
                "Mismatched RemoteRepository and stream src %r, %r" % (
2063
2354
        return a_bzrdir.open_branch(name=name, 
2064
2355
            ignore_fallbacks=ignore_fallbacks)
2065
2356
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
2357
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
2358
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
2359
        # method is not available on the server.
2069
2360
        # self._custom_format is always set - the start of initialize ensures
2071
2362
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
2363
            a_bzrdir._ensure_real()
2073
2364
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
2365
                name, append_revisions_only=append_revisions_only)
2075
2366
        else:
2076
2367
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
2368
            result = self._custom_format.initialize(a_bzrdir, name,
 
2369
                append_revisions_only=append_revisions_only)
2078
2370
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
2371
            not isinstance(result, RemoteBranch)):
2080
2372
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
2373
                                  name=name)
2082
2374
        return result
2083
2375
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
2376
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2377
                   append_revisions_only=None):
2085
2378
        # 1) get the network name to use.
2086
2379
        if self._custom_format:
2087
2380
            network_name = self._custom_format.network_name()
2088
2381
        else:
2089
2382
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
2383
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
2384
            reference_format = reference_bzrdir_format.get_branch_format()
2092
2385
            self._custom_format = reference_format
2093
2386
            network_name = reference_format.network_name()
2094
2387
        # Being asked to create on a non RemoteBzrDir:
2095
2388
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2389
            return self._vfs_initialize(a_bzrdir, name=name,
 
2390
                append_revisions_only=append_revisions_only)
2097
2391
        medium = a_bzrdir._client._medium
2098
2392
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2393
            return self._vfs_initialize(a_bzrdir, name=name,
 
2394
                append_revisions_only=append_revisions_only)
2100
2395
        # Creating on a remote bzr dir.
2101
2396
        # 2) try direct creation via RPC
2102
2397
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
2404
        except errors.UnknownSmartMethod:
2110
2405
            # Fallback - use vfs methods
2111
2406
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2407
            return self._vfs_initialize(a_bzrdir, name=name,
 
2408
                    append_revisions_only=append_revisions_only)
2113
2409
        if response[0] != 'ok':
2114
2410
            raise errors.UnexpectedSmartServerResponse(response)
2115
2411
        # Turn the response into a RemoteRepository object.
2116
2412
        format = RemoteBranchFormat(network_name=response[1])
2117
2413
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
2414
        repo_path = response[2]
 
2415
        if repository is not None:
 
2416
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
2417
            url_diff = urlutils.relative_url(repository.user_url,
 
2418
                    remote_repo_url)
 
2419
            if url_diff != '.':
 
2420
                raise AssertionError(
 
2421
                    'repository.user_url %r does not match URL from server '
 
2422
                    'response (%r + %r)'
 
2423
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
2424
            remote_repo = repository
2120
2425
        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)
 
2426
            if repo_path == '':
 
2427
                repo_bzrdir = a_bzrdir
 
2428
            else:
 
2429
                repo_bzrdir = RemoteBzrDir(
 
2430
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
2431
                    a_bzrdir._client)
 
2432
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
2433
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
2434
            format=format, setup_stacking=False, name=name)
 
2435
        if append_revisions_only:
 
2436
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
2437
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
2438
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
2439
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
2458
        self._ensure_real()
2149
2459
        return self._custom_format.supports_set_append_revisions_only()
2150
2460
 
 
2461
    def _use_default_local_heads_to_fetch(self):
 
2462
        # If the branch format is a metadir format *and* its heads_to_fetch
 
2463
        # implementation is not overridden vs the base class, we can use the
 
2464
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
2465
        # usually cheaper in terms of net round trips, as the last-revision and
 
2466
        # tags info fetched is cached and would be fetched anyway.
 
2467
        self._ensure_real()
 
2468
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
2469
            branch_class = self._custom_format._branch_class()
 
2470
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
2471
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
2472
                return True
 
2473
        return False
2151
2474
 
2152
2475
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
2476
    """Branch stored on a server accessed by HPSS RPC.
2311
2634
                self.bzrdir, self._client)
2312
2635
        return self._control_files
2313
2636
 
2314
 
    def _get_checkout_format(self):
 
2637
    def _get_checkout_format(self, lightweight=False):
2315
2638
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
 
2639
        if lightweight:
 
2640
            format = RemoteBzrDirFormat()
 
2641
            self.bzrdir._format._supply_sub_formats_to(format)
 
2642
            format.workingtree_format = self._real_branch._get_checkout_format(
 
2643
                lightweight=lightweight).workingtree_format
 
2644
            return format
 
2645
        else:
 
2646
            return self._real_branch._get_checkout_format(lightweight=False)
2317
2647
 
2318
2648
    def get_physical_lock_status(self):
2319
2649
        """See Branch.get_physical_lock_status()."""
2352
2682
            self._is_stacked = False
2353
2683
        else:
2354
2684
            self._is_stacked = True
2355
 
        
 
2685
 
2356
2686
    def _vfs_get_tags_bytes(self):
2357
2687
        self._ensure_real()
2358
2688
        return self._real_branch._get_tags_bytes()
2359
2689
 
 
2690
    @needs_read_lock
2360
2691
    def _get_tags_bytes(self):
 
2692
        if self._tags_bytes is None:
 
2693
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
2694
        return self._tags_bytes
 
2695
 
 
2696
    def _get_tags_bytes_via_hpss(self):
2361
2697
        medium = self._client._medium
2362
2698
        if medium._is_remote_before((1, 13)):
2363
2699
            return self._vfs_get_tags_bytes()
2373
2709
        return self._real_branch._set_tags_bytes(bytes)
2374
2710
 
2375
2711
    def _set_tags_bytes(self, bytes):
 
2712
        if self.is_locked():
 
2713
            self._tags_bytes = bytes
2376
2714
        medium = self._client._medium
2377
2715
        if medium._is_remote_before((1, 18)):
2378
2716
            self._vfs_set_tags_bytes(bytes)
2387
2725
            self._vfs_set_tags_bytes(bytes)
2388
2726
 
2389
2727
    def lock_read(self):
 
2728
        """Lock the branch for read operations.
 
2729
 
 
2730
        :return: A bzrlib.lock.LogicalLockResult.
 
2731
        """
2390
2732
        self.repository.lock_read()
2391
2733
        if not self._lock_mode:
2392
2734
            self._note_lock('r')
2396
2738
                self._real_branch.lock_read()
2397
2739
        else:
2398
2740
            self._lock_count += 1
 
2741
        return lock.LogicalLockResult(self.unlock)
2399
2742
 
2400
2743
    def _remote_lock_write(self, token):
2401
2744
        if token is None:
2402
2745
            branch_token = repo_token = ''
2403
2746
        else:
2404
2747
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
2748
            repo_token = self.repository.lock_write().repository_token
2406
2749
            self.repository.unlock()
2407
2750
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
2751
        try:
 
2752
            response = self._call(
 
2753
                'Branch.lock_write', self._remote_path(), branch_token,
 
2754
                repo_token or '', **err_context)
 
2755
        except errors.LockContention, e:
 
2756
            # The LockContention from the server doesn't have any
 
2757
            # information about the lock_url. We re-raise LockContention
 
2758
            # with valid lock_url.
 
2759
            raise errors.LockContention('(remote lock)',
 
2760
                self.repository.base.split('.bzr/')[0])
2411
2761
        if response[0] != 'ok':
2412
2762
            raise errors.UnexpectedSmartServerResponse(response)
2413
2763
        ok, branch_token, repo_token = response
2434
2784
            self._lock_mode = 'w'
2435
2785
            self._lock_count = 1
2436
2786
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
2787
            raise errors.ReadOnlyError(self)
2438
2788
        else:
2439
2789
            if token is not None:
2440
2790
                # A token was given to lock_write, and we're relocking, so
2445
2795
            self._lock_count += 1
2446
2796
            # Re-lock the repository too.
2447
2797
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
2798
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
2799
 
2450
2800
    def _unlock(self, branch_token, repo_token):
2451
2801
        err_context = {'token': str((branch_token, repo_token))}
2520
2870
            missing_parent = parent_map[missing_parent]
2521
2871
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
2872
 
2523
 
    def _last_revision_info(self):
 
2873
    def _read_last_revision_info(self):
2524
2874
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2875
        if response[0] != 'ok':
2526
2876
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
2939
            raise errors.UnexpectedSmartServerResponse(response)
2590
2940
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
2941
 
 
2942
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
2943
    @needs_write_lock
2593
2944
    def set_revision_history(self, rev_history):
 
2945
        """See Branch.set_revision_history."""
 
2946
        self._set_revision_history(rev_history)
 
2947
 
 
2948
    @needs_write_lock
 
2949
    def _set_revision_history(self, rev_history):
2594
2950
        # Send just the tip revision of the history; the server will generate
2595
2951
        # the full history from that.  If the revision doesn't exist in this
2596
2952
        # branch, NoSuchRevision will be raised.
2654
3010
            _override_hook_target=self, **kwargs)
2655
3011
 
2656
3012
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3013
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3014
        self._ensure_real()
2659
3015
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3016
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3017
            _override_hook_source_branch=self)
2662
3018
 
2663
3019
    def is_locked(self):
2673
3029
        # XXX: These should be returned by the set_last_revision_info verb
2674
3030
        old_revno, old_revid = self.last_revision_info()
2675
3031
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3032
        if not revision_id or not isinstance(revision_id, basestring):
 
3033
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3034
        try:
2678
3035
            response = self._call('Branch.set_last_revision_info',
2679
3036
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3065
            except errors.UnknownSmartMethod:
2709
3066
                medium._remember_remote_is_before((1, 6))
2710
3067
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3068
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3069
            last_rev=last_rev,other_branch=other_branch))
2713
3070
 
2714
3071
    def set_push_location(self, location):
2715
3072
        self._ensure_real()
2716
3073
        return self._real_branch.set_push_location(location)
2717
3074
 
 
3075
    def heads_to_fetch(self):
 
3076
        if self._format._use_default_local_heads_to_fetch():
 
3077
            # We recognise this format, and its heads-to-fetch implementation
 
3078
            # is the default one (tip + tags).  In this case it's cheaper to
 
3079
            # just use the default implementation rather than a special RPC as
 
3080
            # the tip and tags data is cached.
 
3081
            return branch.Branch.heads_to_fetch(self)
 
3082
        medium = self._client._medium
 
3083
        if medium._is_remote_before((2, 4)):
 
3084
            return self._vfs_heads_to_fetch()
 
3085
        try:
 
3086
            return self._rpc_heads_to_fetch()
 
3087
        except errors.UnknownSmartMethod:
 
3088
            medium._remember_remote_is_before((2, 4))
 
3089
            return self._vfs_heads_to_fetch()
 
3090
 
 
3091
    def _rpc_heads_to_fetch(self):
 
3092
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3093
        if len(response) != 2:
 
3094
            raise errors.UnexpectedSmartServerResponse(response)
 
3095
        must_fetch, if_present_fetch = response
 
3096
        return set(must_fetch), set(if_present_fetch)
 
3097
 
 
3098
    def _vfs_heads_to_fetch(self):
 
3099
        self._ensure_real()
 
3100
        return self._real_branch.heads_to_fetch()
 
3101
 
2718
3102
 
2719
3103
class RemoteConfig(object):
2720
3104
    """A Config that reads and writes from smart verbs.
2734
3118
        """
2735
3119
        try:
2736
3120
            configobj = self._get_configobj()
 
3121
            section_obj = None
2737
3122
            if section is None:
2738
3123
                section_obj = configobj
2739
3124
            else:
2740
3125
                try:
2741
3126
                    section_obj = configobj[section]
2742
3127
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3128
                    pass
 
3129
            if section_obj is None:
 
3130
                value = default
 
3131
            else:
 
3132
                value = section_obj.get(name, default)
2745
3133
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3134
            value = self._vfs_get_option(name, section, default)
 
3135
        for hook in config.OldConfigHooks['get']:
 
3136
            hook(self, name, value)
 
3137
        return value
2747
3138
 
2748
3139
    def _response_to_configobj(self, response):
2749
3140
        if len(response[0]) and response[0][0] != 'ok':
2750
3141
            raise errors.UnexpectedSmartServerResponse(response)
2751
3142
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3143
        conf = config.ConfigObj(lines, encoding='utf-8')
 
3144
        for hook in config.OldConfigHooks['load']:
 
3145
            hook(self)
 
3146
        return conf
2753
3147
 
2754
3148
 
2755
3149
class RemoteBranchConfig(RemoteConfig):
2774
3168
        medium = self._branch._client._medium
2775
3169
        if medium._is_remote_before((1, 14)):
2776
3170
            return self._vfs_set_option(value, name, section)
 
3171
        if isinstance(value, dict):
 
3172
            if medium._is_remote_before((2, 2)):
 
3173
                return self._vfs_set_option(value, name, section)
 
3174
            return self._set_config_option_dict(value, name, section)
 
3175
        else:
 
3176
            return self._set_config_option(value, name, section)
 
3177
 
 
3178
    def _set_config_option(self, value, name, section):
2777
3179
        try:
2778
3180
            path = self._branch._remote_path()
2779
3181
            response = self._branch._client.call('Branch.set_config_option',
2780
3182
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
3183
                value.encode('utf8'), name, section or '')
2782
3184
        except errors.UnknownSmartMethod:
 
3185
            medium = self._branch._client._medium
2783
3186
            medium._remember_remote_is_before((1, 14))
2784
3187
            return self._vfs_set_option(value, name, section)
2785
3188
        if response != ():
2786
3189
            raise errors.UnexpectedSmartServerResponse(response)
2787
3190
 
 
3191
    def _serialize_option_dict(self, option_dict):
 
3192
        utf8_dict = {}
 
3193
        for key, value in option_dict.items():
 
3194
            if isinstance(key, unicode):
 
3195
                key = key.encode('utf8')
 
3196
            if isinstance(value, unicode):
 
3197
                value = value.encode('utf8')
 
3198
            utf8_dict[key] = value
 
3199
        return bencode.bencode(utf8_dict)
 
3200
 
 
3201
    def _set_config_option_dict(self, value, name, section):
 
3202
        try:
 
3203
            path = self._branch._remote_path()
 
3204
            serialised_dict = self._serialize_option_dict(value)
 
3205
            response = self._branch._client.call(
 
3206
                'Branch.set_config_option_dict',
 
3207
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
3208
                serialised_dict, name, section or '')
 
3209
        except errors.UnknownSmartMethod:
 
3210
            medium = self._branch._client._medium
 
3211
            medium._remember_remote_is_before((2, 2))
 
3212
            return self._vfs_set_option(value, name, section)
 
3213
        if response != ():
 
3214
            raise errors.UnexpectedSmartServerResponse(response)
 
3215
 
2788
3216
    def _real_object(self):
2789
3217
        self._branch._ensure_real()
2790
3218
        return self._branch._real_branch
2873
3301
                    'Missing key %r in context %r', key_err.args[0], context)
2874
3302
                raise err
2875
3303
 
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':
 
3304
    if err.error_verb == 'NoSuchRevision':
2880
3305
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
3306
    elif err.error_verb == 'nosuchrevision':
2882
3307
        raise NoSuchRevision(find('repository'), err.error_args[0])
2889
3314
            detail=extra)
2890
3315
    elif err.error_verb == 'norepository':
2891
3316
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
3317
    elif err.error_verb == 'UnlockableTransport':
2895
3318
        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
3319
    elif err.error_verb == 'TokenMismatch':
2899
3320
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
3321
    elif err.error_verb == 'Diverged':
2901
3322
        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
3323
    elif err.error_verb == 'NotStacked':
2909
3324
        raise errors.NotStacked(branch=find('branch'))
2910
3325
    elif err.error_verb == 'PermissionDenied':
2920
3335
    elif err.error_verb == 'NoSuchFile':
2921
3336
        path = get_path()
2922
3337
        raise errors.NoSuchFile(path)
 
3338
    _translate_error_without_context(err)
 
3339
 
 
3340
 
 
3341
def _translate_error_without_context(err):
 
3342
    """Translate any ErrorFromSmartServer values that don't require context"""
 
3343
    if err.error_verb == 'IncompatibleRepositories':
 
3344
        raise errors.IncompatibleRepositories(err.error_args[0],
 
3345
            err.error_args[1], err.error_args[2])
 
3346
    elif err.error_verb == 'LockContention':
 
3347
        raise errors.LockContention('(remote lock)')
 
3348
    elif err.error_verb == 'LockFailed':
 
3349
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
3350
    elif err.error_verb == 'TipChangeRejected':
 
3351
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
3352
    elif err.error_verb == 'UnstackableBranchFormat':
 
3353
        raise errors.UnstackableBranchFormat(*err.error_args)
 
3354
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
3355
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2923
3356
    elif err.error_verb == 'FileExists':
2924
3357
        raise errors.FileExists(err.error_args[0])
2925
3358
    elif err.error_verb == 'DirectoryNotEmpty':
2944
3377
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
3378
    elif err.error_verb == 'ReadOnlyError':
2946
3379
        raise errors.TransportNotPossible('readonly transport')
 
3380
    elif err.error_verb == 'MemoryError':
 
3381
        raise errors.BzrError("remote server out of memory\n"
 
3382
            "Retry non-remotely, or contact the server admin for details.")
2947
3383
    raise errors.UnknownErrorFromSmartServer(err)