/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Vincent Ladeuil
  • Date: 2011-11-18 07:29:20 UTC
  • mfrom: (6277 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6278.
  • Revision ID: v.ladeuil+lp@free.fr-20111118072920-76q1ho772bkmnno2
Merge trunk to resolve news conflict

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
 
44
from bzrlib.inventory import Inventory
43
45
from bzrlib.lockable_files import LockableFiles
44
46
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
 
47
from bzrlib.smart.client import _SmartClient
 
48
from bzrlib.revision import NULL_REVISION
 
49
from bzrlib.revisiontree import InventoryRevisionTree
 
50
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
46
51
from bzrlib.trace import mutter, note, warning
47
52
 
48
53
 
 
54
_DEFAULT_SEARCH_DEPTH = 100
 
55
 
 
56
 
49
57
class _RpcHelper(object):
50
58
    """Mixin class that helps with issuing RPCs."""
51
59
 
86
94
    return format
87
95
 
88
96
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
97
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
 
98
# does not have to be imported unless a remote format is involved.
 
99
 
 
100
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
 
101
    """Format representing bzrdirs accessed via a smart server"""
 
102
 
 
103
    supports_workingtrees = False
 
104
 
 
105
    def __init__(self):
 
106
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
 
107
        # XXX: It's a bit ugly that the network name is here, because we'd
 
108
        # like to believe that format objects are stateless or at least
 
109
        # immutable,  However, we do at least avoid mutating the name after
 
110
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
111
        self._network_name = None
 
112
 
 
113
    def __repr__(self):
 
114
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
115
            self._network_name)
 
116
 
 
117
    def get_format_description(self):
 
118
        if self._network_name:
 
119
            real_format = controldir.network_format_registry.get(self._network_name)
 
120
            return 'Remote: ' + real_format.get_format_description()
 
121
        return 'bzr remote bzrdir'
 
122
 
 
123
    def get_format_string(self):
 
124
        raise NotImplementedError(self.get_format_string)
 
125
 
 
126
    def network_name(self):
 
127
        if self._network_name:
 
128
            return self._network_name
 
129
        else:
 
130
            raise AssertionError("No network name set.")
 
131
 
 
132
    def initialize_on_transport(self, transport):
 
133
        try:
 
134
            # hand off the request to the smart server
 
135
            client_medium = transport.get_smart_medium()
 
136
        except errors.NoSmartMedium:
 
137
            # TODO: lookup the local format from a server hint.
 
138
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
139
            return local_dir_format.initialize_on_transport(transport)
 
140
        client = _SmartClient(client_medium)
 
141
        path = client.remote_path_from_transport(transport)
 
142
        try:
 
143
            response = client.call('BzrDirFormat.initialize', path)
 
144
        except errors.ErrorFromSmartServer, err:
 
145
            _translate_error(err, path=path)
 
146
        if response[0] != 'ok':
 
147
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
148
        format = RemoteBzrDirFormat()
 
149
        self._supply_sub_formats_to(format)
 
150
        return RemoteBzrDir(transport, format)
 
151
 
 
152
    def parse_NoneTrueFalse(self, arg):
 
153
        if not arg:
 
154
            return None
 
155
        if arg == 'False':
 
156
            return False
 
157
        if arg == 'True':
 
158
            return True
 
159
        raise AssertionError("invalid arg %r" % arg)
 
160
 
 
161
    def _serialize_NoneTrueFalse(self, arg):
 
162
        if arg is False:
 
163
            return 'False'
 
164
        if arg:
 
165
            return 'True'
 
166
        return ''
 
167
 
 
168
    def _serialize_NoneString(self, arg):
 
169
        return arg or ''
 
170
 
 
171
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
172
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
173
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
174
        shared_repo=False):
 
175
        try:
 
176
            # hand off the request to the smart server
 
177
            client_medium = transport.get_smart_medium()
 
178
        except errors.NoSmartMedium:
 
179
            do_vfs = True
 
180
        else:
 
181
            # Decline to open it if the server doesn't support our required
 
182
            # version (3) so that the VFS-based transport will do it.
 
183
            if client_medium.should_probe():
 
184
                try:
 
185
                    server_version = client_medium.protocol_version()
 
186
                    if server_version != '2':
 
187
                        do_vfs = True
 
188
                    else:
 
189
                        do_vfs = False
 
190
                except errors.SmartProtocolError:
 
191
                    # Apparently there's no usable smart server there, even though
 
192
                    # the medium supports the smart protocol.
 
193
                    do_vfs = True
 
194
            else:
 
195
                do_vfs = False
 
196
        if not do_vfs:
 
197
            client = _SmartClient(client_medium)
 
198
            path = client.remote_path_from_transport(transport)
 
199
            if client_medium._is_remote_before((1, 16)):
 
200
                do_vfs = True
 
201
        if do_vfs:
 
202
            # TODO: lookup the local format from a server hint.
 
203
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
204
            self._supply_sub_formats_to(local_dir_format)
 
205
            return local_dir_format.initialize_on_transport_ex(transport,
 
206
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
207
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
208
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
209
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
210
                vfs_only=True)
 
211
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
212
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
213
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
214
 
 
215
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
216
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
217
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
218
        args = []
 
219
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
220
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
221
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
222
        args.append(self._serialize_NoneString(stacked_on))
 
223
        # stack_on_pwd is often/usually our transport
 
224
        if stack_on_pwd:
 
225
            try:
 
226
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
227
                if not stack_on_pwd:
 
228
                    stack_on_pwd = '.'
 
229
            except errors.PathNotChild:
 
230
                pass
 
231
        args.append(self._serialize_NoneString(stack_on_pwd))
 
232
        args.append(self._serialize_NoneString(repo_format_name))
 
233
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
234
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
235
        request_network_name = self._network_name or \
 
236
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
 
237
        try:
 
238
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
239
                request_network_name, path, *args)
 
240
        except errors.UnknownSmartMethod:
 
241
            client._medium._remember_remote_is_before((1,16))
 
242
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
243
            self._supply_sub_formats_to(local_dir_format)
 
244
            return local_dir_format.initialize_on_transport_ex(transport,
 
245
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
246
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
247
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
248
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
249
                vfs_only=True)
 
250
        except errors.ErrorFromSmartServer, err:
 
251
            _translate_error(err, path=path)
 
252
        repo_path = response[0]
 
253
        bzrdir_name = response[6]
 
254
        require_stacking = response[7]
 
255
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
256
        format = RemoteBzrDirFormat()
 
257
        format._network_name = bzrdir_name
 
258
        self._supply_sub_formats_to(format)
 
259
        bzrdir = RemoteBzrDir(transport, format, _client=client)
 
260
        if repo_path:
 
261
            repo_format = response_tuple_to_repo_format(response[1:])
 
262
            if repo_path == '.':
 
263
                repo_path = ''
 
264
            if repo_path:
 
265
                repo_bzrdir_format = RemoteBzrDirFormat()
 
266
                repo_bzrdir_format._network_name = response[5]
 
267
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
 
268
                    repo_bzrdir_format)
 
269
            else:
 
270
                repo_bzr = bzrdir
 
271
            final_stack = response[8] or None
 
272
            final_stack_pwd = response[9] or None
 
273
            if final_stack_pwd:
 
274
                final_stack_pwd = urlutils.join(
 
275
                    transport.base, final_stack_pwd)
 
276
            remote_repo = RemoteRepository(repo_bzr, repo_format)
 
277
            if len(response) > 10:
 
278
                # Updated server verb that locks remotely.
 
279
                repo_lock_token = response[10] or None
 
280
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
281
                if repo_lock_token:
 
282
                    remote_repo.dont_leave_lock_in_place()
 
283
            else:
 
284
                remote_repo.lock_write()
 
285
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
 
286
                final_stack_pwd, require_stacking)
 
287
            policy.acquire_repository()
 
288
        else:
 
289
            remote_repo = None
 
290
            policy = None
 
291
        bzrdir._format.set_branch_format(self.get_branch_format())
 
292
        if require_stacking:
 
293
            # The repo has already been created, but we need to make sure that
 
294
            # we'll make a stackable branch.
 
295
            bzrdir._format.require_stacking(_skip_repo=True)
 
296
        return remote_repo, bzrdir, require_stacking, policy
 
297
 
 
298
    def _open(self, transport):
 
299
        return RemoteBzrDir(transport, self)
 
300
 
 
301
    def __eq__(self, other):
 
302
        if not isinstance(other, RemoteBzrDirFormat):
 
303
            return False
 
304
        return self.get_format_description() == other.get_format_description()
 
305
 
 
306
    def __return_repository_format(self):
 
307
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
308
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
309
        # that it should use that for init() etc.
 
310
        result = RemoteRepositoryFormat()
 
311
        custom_format = getattr(self, '_repository_format', None)
 
312
        if custom_format:
 
313
            if isinstance(custom_format, RemoteRepositoryFormat):
 
314
                return custom_format
 
315
            else:
 
316
                # We will use the custom format to create repositories over the
 
317
                # wire; expose its details like rich_root_data for code to
 
318
                # query
 
319
                result._custom_format = custom_format
 
320
        return result
 
321
 
 
322
    def get_branch_format(self):
 
323
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
 
324
        if not isinstance(result, RemoteBranchFormat):
 
325
            new_result = RemoteBranchFormat()
 
326
            new_result._custom_format = result
 
327
            # cache the result
 
328
            self.set_branch_format(new_result)
 
329
            result = new_result
 
330
        return result
 
331
 
 
332
    repository_format = property(__return_repository_format,
 
333
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
 
334
 
 
335
 
 
336
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
92
337
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
338
 
94
339
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
342
        :param _client: Private parameter for testing. Disables probing and the
98
343
            use of a real bzrdir.
99
344
        """
100
 
        BzrDir.__init__(self, transport, format)
 
345
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
346
        # this object holds a delegated bzrdir that uses file-level operations
102
347
        # to talk to the other side
103
348
        self._real_bzrdir = None
163
408
                import traceback
164
409
                warning('VFS BzrDir access triggered\n%s',
165
410
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
 
411
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
167
412
                self.root_transport, _server_formats=False)
168
413
            self._format._network_name = \
169
414
                self._real_bzrdir._format.network_name()
175
420
        # Prevent aliasing problems in the next_open_branch_result cache.
176
421
        # See create_branch for rationale.
177
422
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
423
        return _mod_bzrdir.BzrDir.break_lock(self)
179
424
 
180
425
    def _vfs_cloning_metadir(self, require_stacking=False):
181
426
        self._ensure_real()
212
457
        if len(branch_info) != 2:
213
458
            raise errors.UnexpectedSmartServerResponse(response)
214
459
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
460
        format = controldir.network_format_registry.get(control_name)
216
461
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
 
462
            format.repository_format = _mod_repository.network_format_registry.get(
218
463
                repo_name)
219
464
        if branch_ref == 'ref':
220
465
            # XXX: we need possible_transports here to avoid reopening the
221
466
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
467
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
468
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
469
            format.set_branch_format(branch_format)
225
470
        elif branch_ref == 'branch':
244
489
        self._ensure_real()
245
490
        self._real_bzrdir.destroy_repository()
246
491
 
247
 
    def create_branch(self, name=None):
 
492
    def create_branch(self, name=None, repository=None,
 
493
                      append_revisions_only=None):
248
494
        # as per meta1 formats - just delegate to the format object which may
249
495
        # be parameterised.
250
496
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
497
            name=name, repository=repository,
 
498
            append_revisions_only=append_revisions_only)
252
499
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
500
            if not isinstance(repository, RemoteRepository):
 
501
                raise AssertionError(
 
502
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
503
                    % (repository,))
 
504
            result = RemoteBranch(self, repository, real_branch, name=name)
255
505
        else:
256
506
            result = real_branch
257
507
        # BzrDir.clone_on_transport() uses the result of create_branch but does
269
519
        self._real_bzrdir.destroy_branch(name=name)
270
520
        self._next_open_branch_result = None
271
521
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
522
    def create_workingtree(self, revision_id=None, from_branch=None,
 
523
        accelerator_tree=None, hardlink=False):
273
524
        raise errors.NotLocalUrl(self.transport.base)
274
525
 
275
 
    def find_branch_format(self):
 
526
    def find_branch_format(self, name=None):
276
527
        """Find the branch 'format' for this bzrdir.
277
528
 
278
529
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
530
        """
280
 
        b = self.open_branch()
 
531
        b = self.open_branch(name=name)
281
532
        return b._format
282
533
 
283
 
    def get_branch_reference(self):
 
534
    def get_branch_reference(self, name=None):
284
535
        """See BzrDir.get_branch_reference()."""
 
536
        if name is not None:
 
537
            # XXX JRV20100304: Support opening colocated branches
 
538
            raise errors.NoColocatedBranchSupport(self)
285
539
        response = self._get_branch_reference()
286
540
        if response[0] == 'ref':
287
541
            return response[1]
318
572
            raise errors.UnexpectedSmartServerResponse(response)
319
573
        return response
320
574
 
321
 
    def _get_tree_branch(self):
 
575
    def _get_tree_branch(self, name=None):
322
576
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
577
        return None, self.open_branch(name=name)
324
578
 
325
579
    def open_branch(self, name=None, unsupported=False,
326
580
                    ignore_fallbacks=False):
423
677
 
424
678
    def _path_for_remote_call(self, client):
425
679
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
680
        return urlutils.split_segment_parameters_raw(
 
681
            client.remote_path_from_transport(self.root_transport))[0]
427
682
 
428
683
    def get_branch_transport(self, branch_format, name=None):
429
684
        self._ensure_real()
441
696
        """Upgrading of remote bzrdirs is not supported yet."""
442
697
        return False
443
698
 
444
 
    def needs_format_conversion(self, format=None):
 
699
    def needs_format_conversion(self, format):
445
700
        """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
701
        return False
450
702
 
451
 
    def clone(self, url, revision_id=None, force_new_repo=False,
452
 
              preserve_stacking=False):
453
 
        self._ensure_real()
454
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
 
 
457
703
    def _get_config(self):
458
704
        return RemoteBzrDirConfig(self)
459
705
 
460
706
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
707
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
708
    """Format for repositories accessed over a _SmartClient.
463
709
 
464
710
    Instances of this repository are represented by RemoteRepository
479
725
    """
480
726
 
481
727
    _matchingbzrdir = RemoteBzrDirFormat()
 
728
    supports_full_versioned_files = True
 
729
    supports_leaving_lock = True
482
730
 
483
731
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
732
        _mod_repository.RepositoryFormat.__init__(self)
485
733
        self._custom_format = None
486
734
        self._network_name = None
487
735
        self._creating_bzrdir = None
 
736
        self._revision_graph_can_have_wrong_parents = None
488
737
        self._supports_chks = None
489
738
        self._supports_external_lookups = None
490
739
        self._supports_tree_reference = None
 
740
        self._supports_funky_characters = None
 
741
        self._supports_nesting_repositories = None
491
742
        self._rich_root_data = None
492
743
 
493
744
    def __repr__(self):
522
773
        return self._supports_external_lookups
523
774
 
524
775
    @property
 
776
    def supports_funky_characters(self):
 
777
        if self._supports_funky_characters is None:
 
778
            self._ensure_real()
 
779
            self._supports_funky_characters = \
 
780
                self._custom_format.supports_funky_characters
 
781
        return self._supports_funky_characters
 
782
 
 
783
    @property
 
784
    def supports_nesting_repositories(self):
 
785
        if self._supports_nesting_repositories is None:
 
786
            self._ensure_real()
 
787
            self._supports_nesting_repositories = \
 
788
                self._custom_format.supports_nesting_repositories
 
789
        return self._supports_nesting_repositories
 
790
 
 
791
    @property
525
792
    def supports_tree_reference(self):
526
793
        if self._supports_tree_reference is None:
527
794
            self._ensure_real()
529
796
                self._custom_format.supports_tree_reference
530
797
        return self._supports_tree_reference
531
798
 
 
799
    @property
 
800
    def revision_graph_can_have_wrong_parents(self):
 
801
        if self._revision_graph_can_have_wrong_parents is None:
 
802
            self._ensure_real()
 
803
            self._revision_graph_can_have_wrong_parents = \
 
804
                self._custom_format.revision_graph_can_have_wrong_parents
 
805
        return self._revision_graph_can_have_wrong_parents
 
806
 
532
807
    def _vfs_initialize(self, a_bzrdir, shared):
533
808
        """Helper for common code in initialize."""
534
809
        if self._custom_format:
569
844
            network_name = self._network_name
570
845
        else:
571
846
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
847
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
848
            reference_format = reference_bzrdir_format.repository_format
574
849
            network_name = reference_format.network_name()
575
850
        # 2) try direct creation via RPC
601
876
 
602
877
    def _ensure_real(self):
603
878
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
 
879
            self._custom_format = _mod_repository.network_format_registry.get(
605
880
                self._network_name)
606
881
 
607
882
    @property
644
919
 
645
920
 
646
921
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
922
    controldir.ControlComponent):
648
923
    """Repository accessed over rpc.
649
924
 
650
925
    For the moment most operations are performed using local transport-backed
703
978
        # transport, but I'm not sure it's worth making this method
704
979
        # optional -- mbp 2010-04-21
705
980
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
981
 
707
982
    def __str__(self):
708
983
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
984
 
817
1092
    def find_text_key_references(self):
818
1093
        """Find the text key references within the repository.
819
1094
 
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
1095
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1096
            to whether they were referred to by the inventory of the
825
1097
            revision_id that they contain. The inventory texts from all present
843
1115
        """Private method for using with old (< 1.2) servers to fallback."""
844
1116
        if revision_id is None:
845
1117
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1118
        elif _mod_revision.is_null(revision_id):
847
1119
            return {}
848
1120
 
849
1121
        path = self.bzrdir._path_for_remote_call(self._client)
873
1145
        return RemoteStreamSource(self, to_format)
874
1146
 
875
1147
    @needs_read_lock
 
1148
    def get_file_graph(self):
 
1149
        return graph.Graph(self.texts)
 
1150
 
 
1151
    @needs_read_lock
876
1152
    def has_revision(self, revision_id):
877
1153
        """True if this repository has a copy of the revision."""
878
1154
        # Copy of bzrlib.repository.Repository.has_revision
895
1171
    def _has_same_fallbacks(self, other_repo):
896
1172
        """Returns true if the repositories have the same fallbacks."""
897
1173
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1174
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1175
        my_fb = self._fallback_repositories
900
1176
        other_fb = other_repo._fallback_repositories
901
1177
        if len(my_fb) != len(other_fb):
930
1206
        """See Repository.gather_stats()."""
931
1207
        path = self.bzrdir._path_for_remote_call(self._client)
932
1208
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1209
        if revid is None or _mod_revision.is_null(revid):
934
1210
            fmt_revid = ''
935
1211
        else:
936
1212
            fmt_revid = revid
997
1273
        pass
998
1274
 
999
1275
    def lock_read(self):
 
1276
        """Lock the repository for read operations.
 
1277
 
 
1278
        :return: A bzrlib.lock.LogicalLockResult.
 
1279
        """
1000
1280
        # wrong eventually - want a local lock cache context
1001
1281
        if not self._lock_mode:
1002
1282
            self._note_lock('r')
1009
1289
                repo.lock_read()
1010
1290
        else:
1011
1291
            self._lock_count += 1
 
1292
        return lock.LogicalLockResult(self.unlock)
1012
1293
 
1013
1294
    def _remote_lock_write(self, token):
1014
1295
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1335
            raise errors.ReadOnlyError(self)
1055
1336
        else:
1056
1337
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1338
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1339
 
1059
1340
    def leave_lock_in_place(self):
1060
1341
        if not self._lock_token:
1194
1475
            return t
1195
1476
        raise errors.UnexpectedSmartServerResponse(response)
1196
1477
 
 
1478
    @needs_read_lock
1197
1479
    def sprout(self, to_bzrdir, revision_id=None):
1198
 
        # TODO: Option to control what format is created?
1199
 
        self._ensure_real()
1200
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1201
 
                                                             shared=False)
 
1480
        """Create a descendent repository for new development.
 
1481
 
 
1482
        Unlike clone, this does not copy the settings of the repository.
 
1483
        """
 
1484
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1202
1485
        dest_repo.fetch(self, revision_id=revision_id)
1203
1486
        return dest_repo
1204
1487
 
 
1488
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1489
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1490
            # use target default format.
 
1491
            dest_repo = a_bzrdir.create_repository()
 
1492
        else:
 
1493
            # Most control formats need the repository to be specifically
 
1494
            # created, but on some old all-in-one formats it's not needed
 
1495
            try:
 
1496
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1497
            except errors.UninitializableFormat:
 
1498
                dest_repo = a_bzrdir.open_repository()
 
1499
        return dest_repo
 
1500
 
1205
1501
    ### These methods are just thin shims to the VFS object for now.
1206
1502
 
 
1503
    @needs_read_lock
1207
1504
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(revision_id)
 
1505
        revision_id = _mod_revision.ensure_null(revision_id)
 
1506
        if revision_id == _mod_revision.NULL_REVISION:
 
1507
            return InventoryRevisionTree(self,
 
1508
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1509
        else:
 
1510
            return list(self.revision_trees([revision_id]))[0]
1210
1511
 
1211
1512
    def get_serializer_format(self):
1212
1513
        self._ensure_real()
1214
1515
 
1215
1516
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1517
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
 
1518
                           revision_id=None, lossy=False):
1218
1519
        # FIXME: It ought to be possible to call this without immediately
1219
1520
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
1521
        self._ensure_real()
1221
1522
        real_repo = self._real_repository
1222
1523
        builder = real_repo.get_commit_builder(branch, parents,
1223
1524
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
 
1525
                committer=committer, revprops=revprops,
 
1526
                revision_id=revision_id, lossy=lossy)
1225
1527
        return builder
1226
1528
 
1227
1529
    def add_fallback_repository(self, repository):
1235
1537
        # We need to accumulate additional repositories here, to pass them in
1236
1538
        # on various RPC's.
1237
1539
        #
 
1540
        # Make the check before we lock: this raises an exception.
 
1541
        self._check_fallback_repository(repository)
1238
1542
        if self.is_locked():
1239
1543
            # We will call fallback.unlock() when we transition to the unlocked
1240
1544
            # state, so always add a lock here. If a caller passes us a locked
1241
1545
            # repository, they are responsible for unlocking it later.
1242
1546
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1547
        self._fallback_repositories.append(repository)
1245
1548
        # If self._real_repository was parameterised already (e.g. because a
1246
1549
        # _real_branch had its get_stacked_on_url method called), then the
1288
1591
 
1289
1592
    @needs_read_lock
1290
1593
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
1594
        return self.get_revisions([revision_id])[0]
1293
1595
 
1294
1596
    def get_transaction(self):
1295
1597
        self._ensure_real()
1297
1599
 
1298
1600
    @needs_read_lock
1299
1601
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
1602
        dest_repo = self._create_sprouting_repo(
 
1603
            a_bzrdir, shared=self.is_shared())
 
1604
        self.copy_content_into(dest_repo, revision_id)
 
1605
        return dest_repo
1302
1606
 
1303
1607
    def make_working_trees(self):
1304
1608
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_repository.make_working_trees()
 
1609
        path = self.bzrdir._path_for_remote_call(self._client)
 
1610
        try:
 
1611
            response = self._call('Repository.make_working_trees', path)
 
1612
        except errors.UnknownSmartMethod:
 
1613
            self._ensure_real()
 
1614
            return self._real_repository.make_working_trees()
 
1615
        if response[0] not in ('yes', 'no'):
 
1616
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
1617
        return response[0] == 'yes'
1307
1618
 
1308
1619
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
1620
        """Re-read any data needed to synchronise with disk.
1310
1621
 
1311
1622
        This method is intended to be called after another repository instance
1312
1623
        (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.
 
1624
        repository. On all repositories this will work outside of write groups.
 
1625
        Some repository formats (pack and newer for bzrlib native formats)
 
1626
        support refresh_data inside write groups. If called inside a write
 
1627
        group on a repository that does not support refreshing in a write group
 
1628
        IsInWriteGroupError will be raised.
1315
1629
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
1630
        if self._real_repository is not None:
1320
1631
            self._real_repository.refresh_data()
1321
1632
 
1333
1644
        return result
1334
1645
 
1335
1646
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1647
    def search_missing_revision_ids(self, other,
 
1648
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
1649
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
1650
            limit=None):
1337
1651
        """Return the revision ids that other has that this does not.
1338
1652
 
1339
1653
        These are returned in topological order.
1340
1654
 
1341
1655
        revision_id: only return revision ids included by revision_id.
1342
1656
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
1657
        if symbol_versioning.deprecated_passed(revision_id):
 
1658
            symbol_versioning.warn(
 
1659
                'search_missing_revision_ids(revision_id=...) was '
 
1660
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
1661
                DeprecationWarning, stacklevel=2)
 
1662
            if revision_ids is not None:
 
1663
                raise AssertionError(
 
1664
                    'revision_ids is mutually exclusive with revision_id')
 
1665
            if revision_id is not None:
 
1666
                revision_ids = [revision_id]
 
1667
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
1668
        return inter_repo.search_missing_revision_ids(
 
1669
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
1670
            if_present_ids=if_present_ids, limit=limit)
1345
1671
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1672
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
1673
            fetch_spec=None):
1348
1674
        # No base implementation to use as RemoteRepository is not a subclass
1349
1675
        # of Repository; so this is a copy of Repository.fetch().
1360
1686
            # check that last_revision is in 'from' and then return a
1361
1687
            # no-operation.
1362
1688
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
1689
                not _mod_revision.is_null(revision_id)):
1364
1690
                self.get_revision(revision_id)
1365
1691
            return 0, []
1366
1692
        # if there is no specific appropriate InterRepository, this will get
1367
1693
        # the InterRepository base class, which raises an
1368
1694
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1695
        inter = _mod_repository.InterRepository.get(source, self)
 
1696
        return inter.fetch(revision_id=revision_id,
1371
1697
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
1698
 
1373
1699
    def create_bundle(self, target, base, fileobj, format=None):
1375
1701
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
1702
 
1377
1703
    @needs_read_lock
 
1704
    @symbol_versioning.deprecated_method(
 
1705
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
1706
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
1707
        self._ensure_real()
1380
1708
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1394
1722
        self._ensure_real()
1395
1723
        return self._real_repository.iter_files_bytes(desired_files)
1396
1724
 
 
1725
    def get_cached_parent_map(self, revision_ids):
 
1726
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
1727
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
 
1728
 
1397
1729
    def get_parent_map(self, revision_ids):
1398
1730
        """See bzrlib.Graph.get_parent_map()."""
1399
1731
        return self._make_parents_provider().get_parent_map(revision_ids)
1457
1789
        if parents_map is None:
1458
1790
            # Repository is not locked, so there's no cache.
1459
1791
            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)
 
1792
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
1793
            (start_set, stop_keys,
 
1794
             key_count) = graph.search_result_from_parent_map(
 
1795
                parents_map, self._unstacked_provider.missing_keys)
 
1796
        else:
 
1797
            (start_set, stop_keys,
 
1798
             key_count) = graph.limited_search_result_from_parent_map(
 
1799
                parents_map, self._unstacked_provider.missing_keys,
 
1800
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
1801
        recipe = ('manual', start_set, stop_keys, key_count)
1481
1802
        body = self._serialise_search_recipe(recipe)
1482
1803
        path = self.bzrdir._path_for_remote_call(self._client)
1555
1876
 
1556
1877
    @needs_read_lock
1557
1878
    def get_revision_delta(self, revision_id, specific_fileids=None):
1558
 
        self._ensure_real()
1559
 
        return self._real_repository.get_revision_delta(revision_id,
1560
 
            specific_fileids=specific_fileids)
 
1879
        r = self.get_revision(revision_id)
 
1880
        return list(self.get_deltas_for_revisions([r],
 
1881
            specific_fileids=specific_fileids))[0]
1561
1882
 
1562
1883
    @needs_read_lock
1563
1884
    def revision_trees(self, revision_ids):
1576
1897
            callback_refs=callback_refs, check_repo=check_repo)
1577
1898
 
1578
1899
    def copy_content_into(self, destination, revision_id=None):
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.copy_content_into(
1581
 
            destination, revision_id=revision_id)
 
1900
        """Make a complete copy of the content in self into destination.
 
1901
 
 
1902
        This is a destructive operation! Do not use it on existing
 
1903
        repositories.
 
1904
        """
 
1905
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
1906
        return interrepo.copy_content(revision_id)
1582
1907
 
1583
1908
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
1909
        # get a tarball of the remote repository, and copy from that into the
1586
1911
        from bzrlib import osutils
1587
1912
        import tarfile
1588
1913
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
1914
        note(gettext("Copying repository content as tarball..."))
1590
1915
        tar_file = self._get_tarball('bz2')
1591
1916
        if tar_file is None:
1592
1917
            return None
1597
1922
            tmpdir = osutils.mkdtemp()
1598
1923
            try:
1599
1924
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1925
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
1926
                tmp_repo = tmp_bzrdir.open_repository()
1602
1927
                tmp_repo.copy_content_into(destination, revision_id)
1603
1928
            finally:
1688
2013
    def supports_rich_root(self):
1689
2014
        return self._format.rich_root_data
1690
2015
 
 
2016
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
2017
    def iter_reverse_revision_history(self, revision_id):
1692
2018
        self._ensure_real()
1693
2019
        return self._real_repository.iter_reverse_revision_history(revision_id)
1696
2022
    def _serializer(self):
1697
2023
        return self._format._serializer
1698
2024
 
 
2025
    @needs_write_lock
1699
2026
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1700
 
        self._ensure_real()
1701
 
        return self._real_repository.store_revision_signature(
1702
 
            gpg_strategy, plaintext, revision_id)
 
2027
        signature = gpg_strategy.sign(plaintext)
 
2028
        self.add_signature_text(revision_id, signature)
1703
2029
 
1704
2030
    def add_signature_text(self, revision_id, signature):
1705
2031
        self._ensure_real()
1706
2032
        return self._real_repository.add_signature_text(revision_id, signature)
1707
2033
 
1708
2034
    def has_signature_for_revision_id(self, revision_id):
 
2035
        path = self.bzrdir._path_for_remote_call(self._client)
 
2036
        try:
 
2037
            response = self._call('Repository.has_signature_for_revision_id',
 
2038
                path, revision_id)
 
2039
        except errors.UnknownSmartMethod:
 
2040
            self._ensure_real()
 
2041
            return self._real_repository.has_signature_for_revision_id(
 
2042
                revision_id)
 
2043
        if response[0] not in ('yes', 'no'):
 
2044
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2045
        return (response[0] == 'yes')
 
2046
 
 
2047
    def verify_revision_signature(self, revision_id, gpg_strategy):
1709
2048
        self._ensure_real()
1710
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2049
        return self._real_repository.verify_revision_signature(
 
2050
            revision_id, gpg_strategy)
1711
2051
 
1712
2052
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2053
        self._ensure_real()
1714
2054
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2055
            _files_pb=_files_pb)
1716
2056
 
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
2057
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2058
        self._ensure_real()
1724
2059
        return self._real_repository._find_inconsistent_revision_parents(
1732
2067
        providers = [self._unstacked_provider]
1733
2068
        if other is not None:
1734
2069
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2070
        return graph.StackedParentsProvider(_LazyListJoin(
 
2071
            providers, self._fallback_repositories))
1738
2072
 
1739
2073
    def _serialise_search_recipe(self, recipe):
1740
2074
        """Serialise a graph search recipe.
1748
2082
        return '\n'.join((start_keys, stop_keys, count))
1749
2083
 
1750
2084
    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)]
 
2085
        parts = search_result.get_network_struct()
1757
2086
        return '\n'.join(parts)
1758
2087
 
1759
2088
    def autopack(self):
1769
2098
            raise errors.UnexpectedSmartServerResponse(response)
1770
2099
 
1771
2100
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2101
class RemoteStreamSink(vf_repository.StreamSink):
1773
2102
 
1774
2103
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2104
        self.target_repo._ensure_real()
1876
2205
        self._last_substream and self._last_stream so that the stream can be
1877
2206
        resumed by _resume_stream_with_vfs.
1878
2207
        """
1879
 
                    
 
2208
 
1880
2209
        stream_iter = iter(stream)
1881
2210
        for substream_kind, substream in stream_iter:
1882
2211
            if substream_kind == 'inventory-deltas':
1885
2214
                return
1886
2215
            else:
1887
2216
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2217
 
 
2218
 
 
2219
class RemoteStreamSource(vf_repository.StreamSource):
1891
2220
    """Stream data from a remote server."""
1892
2221
 
1893
2222
    def get_stream(self, search):
1953
2282
        candidate_verbs = [
1954
2283
            ('Repository.get_stream_1.19', (1, 19)),
1955
2284
            ('Repository.get_stream', (1, 13))]
 
2285
 
1956
2286
        found_verb = False
1957
2287
        for verb, version in candidate_verbs:
1958
2288
            if medium._is_remote_before(version):
1962
2292
                    verb, args, search_bytes)
1963
2293
            except errors.UnknownSmartMethod:
1964
2294
                medium._remember_remote_is_before(version)
 
2295
            except errors.UnknownErrorFromSmartServer, e:
 
2296
                if isinstance(search, graph.EverythingResult):
 
2297
                    error_verb = e.error_from_smart_server.error_verb
 
2298
                    if error_verb == 'BadSearch':
 
2299
                        # Pre-2.4 servers don't support this sort of search.
 
2300
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2301
                        # good idea in general?  It might provide a little bit
 
2302
                        # of protection against client-side bugs.
 
2303
                        medium._remember_remote_is_before((2, 4))
 
2304
                        break
 
2305
                raise
1965
2306
            else:
1966
2307
                response_tuple, response_handler = response
1967
2308
                found_verb = True
1971
2312
        if response_tuple[0] != 'ok':
1972
2313
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
2314
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
2315
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
2316
            self._record_counter)
1975
2317
        if src_format.network_name() != repo._format.network_name():
1976
2318
            raise AssertionError(
1977
2319
                "Mismatched RemoteRepository and stream src %r, %r" % (
2063
2405
        return a_bzrdir.open_branch(name=name, 
2064
2406
            ignore_fallbacks=ignore_fallbacks)
2065
2407
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
2408
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
2409
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
2410
        # method is not available on the server.
2069
2411
        # self._custom_format is always set - the start of initialize ensures
2071
2413
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
2414
            a_bzrdir._ensure_real()
2073
2415
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
2416
                name, append_revisions_only=append_revisions_only)
2075
2417
        else:
2076
2418
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
2419
            result = self._custom_format.initialize(a_bzrdir, name,
 
2420
                append_revisions_only=append_revisions_only)
2078
2421
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
2422
            not isinstance(result, RemoteBranch)):
2080
2423
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
2424
                                  name=name)
2082
2425
        return result
2083
2426
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
2427
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2428
                   append_revisions_only=None):
2085
2429
        # 1) get the network name to use.
2086
2430
        if self._custom_format:
2087
2431
            network_name = self._custom_format.network_name()
2088
2432
        else:
2089
2433
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
2434
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
2435
            reference_format = reference_bzrdir_format.get_branch_format()
2092
2436
            self._custom_format = reference_format
2093
2437
            network_name = reference_format.network_name()
2094
2438
        # Being asked to create on a non RemoteBzrDir:
2095
2439
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2440
            return self._vfs_initialize(a_bzrdir, name=name,
 
2441
                append_revisions_only=append_revisions_only)
2097
2442
        medium = a_bzrdir._client._medium
2098
2443
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2444
            return self._vfs_initialize(a_bzrdir, name=name,
 
2445
                append_revisions_only=append_revisions_only)
2100
2446
        # Creating on a remote bzr dir.
2101
2447
        # 2) try direct creation via RPC
2102
2448
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
2455
        except errors.UnknownSmartMethod:
2110
2456
            # Fallback - use vfs methods
2111
2457
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
2458
            return self._vfs_initialize(a_bzrdir, name=name,
 
2459
                    append_revisions_only=append_revisions_only)
2113
2460
        if response[0] != 'ok':
2114
2461
            raise errors.UnexpectedSmartServerResponse(response)
2115
2462
        # Turn the response into a RemoteRepository object.
2116
2463
        format = RemoteBranchFormat(network_name=response[1])
2117
2464
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
2465
        repo_path = response[2]
 
2466
        if repository is not None:
 
2467
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
2468
            url_diff = urlutils.relative_url(repository.user_url,
 
2469
                    remote_repo_url)
 
2470
            if url_diff != '.':
 
2471
                raise AssertionError(
 
2472
                    'repository.user_url %r does not match URL from server '
 
2473
                    'response (%r + %r)'
 
2474
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
2475
            remote_repo = repository
2120
2476
        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)
 
2477
            if repo_path == '':
 
2478
                repo_bzrdir = a_bzrdir
 
2479
            else:
 
2480
                repo_bzrdir = RemoteBzrDir(
 
2481
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
2482
                    a_bzrdir._client)
 
2483
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
2484
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
2485
            format=format, setup_stacking=False, name=name)
 
2486
        if append_revisions_only:
 
2487
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
2488
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
2489
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
2490
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
2509
        self._ensure_real()
2149
2510
        return self._custom_format.supports_set_append_revisions_only()
2150
2511
 
 
2512
    def _use_default_local_heads_to_fetch(self):
 
2513
        # If the branch format is a metadir format *and* its heads_to_fetch
 
2514
        # implementation is not overridden vs the base class, we can use the
 
2515
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
2516
        # usually cheaper in terms of net round trips, as the last-revision and
 
2517
        # tags info fetched is cached and would be fetched anyway.
 
2518
        self._ensure_real()
 
2519
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
2520
            branch_class = self._custom_format._branch_class()
 
2521
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
2522
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
2523
                return True
 
2524
        return False
2151
2525
 
2152
2526
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
2527
    """Branch stored on a server accessed by HPSS RPC.
2311
2685
                self.bzrdir, self._client)
2312
2686
        return self._control_files
2313
2687
 
2314
 
    def _get_checkout_format(self):
 
2688
    def _get_checkout_format(self, lightweight=False):
2315
2689
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
 
2690
        if lightweight:
 
2691
            format = RemoteBzrDirFormat()
 
2692
            self.bzrdir._format._supply_sub_formats_to(format)
 
2693
            format.workingtree_format = self._real_branch._get_checkout_format(
 
2694
                lightweight=lightweight).workingtree_format
 
2695
            return format
 
2696
        else:
 
2697
            return self._real_branch._get_checkout_format(lightweight=False)
2317
2698
 
2318
2699
    def get_physical_lock_status(self):
2319
2700
        """See Branch.get_physical_lock_status()."""
2352
2733
            self._is_stacked = False
2353
2734
        else:
2354
2735
            self._is_stacked = True
2355
 
        
 
2736
 
2356
2737
    def _vfs_get_tags_bytes(self):
2357
2738
        self._ensure_real()
2358
2739
        return self._real_branch._get_tags_bytes()
2359
2740
 
 
2741
    @needs_read_lock
2360
2742
    def _get_tags_bytes(self):
 
2743
        if self._tags_bytes is None:
 
2744
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
2745
        return self._tags_bytes
 
2746
 
 
2747
    def _get_tags_bytes_via_hpss(self):
2361
2748
        medium = self._client._medium
2362
2749
        if medium._is_remote_before((1, 13)):
2363
2750
            return self._vfs_get_tags_bytes()
2373
2760
        return self._real_branch._set_tags_bytes(bytes)
2374
2761
 
2375
2762
    def _set_tags_bytes(self, bytes):
 
2763
        if self.is_locked():
 
2764
            self._tags_bytes = bytes
2376
2765
        medium = self._client._medium
2377
2766
        if medium._is_remote_before((1, 18)):
2378
2767
            self._vfs_set_tags_bytes(bytes)
2387
2776
            self._vfs_set_tags_bytes(bytes)
2388
2777
 
2389
2778
    def lock_read(self):
 
2779
        """Lock the branch for read operations.
 
2780
 
 
2781
        :return: A bzrlib.lock.LogicalLockResult.
 
2782
        """
2390
2783
        self.repository.lock_read()
2391
2784
        if not self._lock_mode:
2392
2785
            self._note_lock('r')
2396
2789
                self._real_branch.lock_read()
2397
2790
        else:
2398
2791
            self._lock_count += 1
 
2792
        return lock.LogicalLockResult(self.unlock)
2399
2793
 
2400
2794
    def _remote_lock_write(self, token):
2401
2795
        if token is None:
2402
2796
            branch_token = repo_token = ''
2403
2797
        else:
2404
2798
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
2799
            repo_token = self.repository.lock_write().repository_token
2406
2800
            self.repository.unlock()
2407
2801
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
2802
        try:
 
2803
            response = self._call(
 
2804
                'Branch.lock_write', self._remote_path(), branch_token,
 
2805
                repo_token or '', **err_context)
 
2806
        except errors.LockContention, e:
 
2807
            # The LockContention from the server doesn't have any
 
2808
            # information about the lock_url. We re-raise LockContention
 
2809
            # with valid lock_url.
 
2810
            raise errors.LockContention('(remote lock)',
 
2811
                self.repository.base.split('.bzr/')[0])
2411
2812
        if response[0] != 'ok':
2412
2813
            raise errors.UnexpectedSmartServerResponse(response)
2413
2814
        ok, branch_token, repo_token = response
2434
2835
            self._lock_mode = 'w'
2435
2836
            self._lock_count = 1
2436
2837
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
2838
            raise errors.ReadOnlyError(self)
2438
2839
        else:
2439
2840
            if token is not None:
2440
2841
                # A token was given to lock_write, and we're relocking, so
2445
2846
            self._lock_count += 1
2446
2847
            # Re-lock the repository too.
2447
2848
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
2849
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
2850
 
2450
2851
    def _unlock(self, branch_token, repo_token):
2451
2852
        err_context = {'token': str((branch_token, repo_token))}
2520
2921
            missing_parent = parent_map[missing_parent]
2521
2922
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
2923
 
2523
 
    def _last_revision_info(self):
 
2924
    def _read_last_revision_info(self):
2524
2925
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
2926
        if response[0] != 'ok':
2526
2927
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
2990
            raise errors.UnexpectedSmartServerResponse(response)
2590
2991
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
2992
 
 
2993
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
2994
    @needs_write_lock
2593
2995
    def set_revision_history(self, rev_history):
 
2996
        """See Branch.set_revision_history."""
 
2997
        self._set_revision_history(rev_history)
 
2998
 
 
2999
    @needs_write_lock
 
3000
    def _set_revision_history(self, rev_history):
2594
3001
        # Send just the tip revision of the history; the server will generate
2595
3002
        # the full history from that.  If the revision doesn't exist in this
2596
3003
        # branch, NoSuchRevision will be raised.
2654
3061
            _override_hook_target=self, **kwargs)
2655
3062
 
2656
3063
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3064
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3065
        self._ensure_real()
2659
3066
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3067
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3068
            _override_hook_source_branch=self)
2662
3069
 
2663
3070
    def is_locked(self):
2673
3080
        # XXX: These should be returned by the set_last_revision_info verb
2674
3081
        old_revno, old_revid = self.last_revision_info()
2675
3082
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3083
        if not revision_id or not isinstance(revision_id, basestring):
 
3084
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3085
        try:
2678
3086
            response = self._call('Branch.set_last_revision_info',
2679
3087
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3116
            except errors.UnknownSmartMethod:
2709
3117
                medium._remember_remote_is_before((1, 6))
2710
3118
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3119
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3120
            last_rev=last_rev,other_branch=other_branch))
2713
3121
 
2714
3122
    def set_push_location(self, location):
2715
3123
        self._ensure_real()
2716
3124
        return self._real_branch.set_push_location(location)
2717
3125
 
 
3126
    def heads_to_fetch(self):
 
3127
        if self._format._use_default_local_heads_to_fetch():
 
3128
            # We recognise this format, and its heads-to-fetch implementation
 
3129
            # is the default one (tip + tags).  In this case it's cheaper to
 
3130
            # just use the default implementation rather than a special RPC as
 
3131
            # the tip and tags data is cached.
 
3132
            return branch.Branch.heads_to_fetch(self)
 
3133
        medium = self._client._medium
 
3134
        if medium._is_remote_before((2, 4)):
 
3135
            return self._vfs_heads_to_fetch()
 
3136
        try:
 
3137
            return self._rpc_heads_to_fetch()
 
3138
        except errors.UnknownSmartMethod:
 
3139
            medium._remember_remote_is_before((2, 4))
 
3140
            return self._vfs_heads_to_fetch()
 
3141
 
 
3142
    def _rpc_heads_to_fetch(self):
 
3143
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3144
        if len(response) != 2:
 
3145
            raise errors.UnexpectedSmartServerResponse(response)
 
3146
        must_fetch, if_present_fetch = response
 
3147
        return set(must_fetch), set(if_present_fetch)
 
3148
 
 
3149
    def _vfs_heads_to_fetch(self):
 
3150
        self._ensure_real()
 
3151
        return self._real_branch.heads_to_fetch()
 
3152
 
2718
3153
 
2719
3154
class RemoteConfig(object):
2720
3155
    """A Config that reads and writes from smart verbs.
2734
3169
        """
2735
3170
        try:
2736
3171
            configobj = self._get_configobj()
 
3172
            section_obj = None
2737
3173
            if section is None:
2738
3174
                section_obj = configobj
2739
3175
            else:
2740
3176
                try:
2741
3177
                    section_obj = configobj[section]
2742
3178
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3179
                    pass
 
3180
            if section_obj is None:
 
3181
                value = default
 
3182
            else:
 
3183
                value = section_obj.get(name, default)
2745
3184
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3185
            value = self._vfs_get_option(name, section, default)
 
3186
        for hook in config.OldConfigHooks['get']:
 
3187
            hook(self, name, value)
 
3188
        return value
2747
3189
 
2748
3190
    def _response_to_configobj(self, response):
2749
3191
        if len(response[0]) and response[0][0] != 'ok':
2750
3192
            raise errors.UnexpectedSmartServerResponse(response)
2751
3193
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3194
        conf = config.ConfigObj(lines, encoding='utf-8')
 
3195
        for hook in config.OldConfigHooks['load']:
 
3196
            hook(self)
 
3197
        return conf
2753
3198
 
2754
3199
 
2755
3200
class RemoteBranchConfig(RemoteConfig):
2774
3219
        medium = self._branch._client._medium
2775
3220
        if medium._is_remote_before((1, 14)):
2776
3221
            return self._vfs_set_option(value, name, section)
 
3222
        if isinstance(value, dict):
 
3223
            if medium._is_remote_before((2, 2)):
 
3224
                return self._vfs_set_option(value, name, section)
 
3225
            return self._set_config_option_dict(value, name, section)
 
3226
        else:
 
3227
            return self._set_config_option(value, name, section)
 
3228
 
 
3229
    def _set_config_option(self, value, name, section):
2777
3230
        try:
2778
3231
            path = self._branch._remote_path()
2779
3232
            response = self._branch._client.call('Branch.set_config_option',
2780
3233
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
3234
                value.encode('utf8'), name, section or '')
2782
3235
        except errors.UnknownSmartMethod:
 
3236
            medium = self._branch._client._medium
2783
3237
            medium._remember_remote_is_before((1, 14))
2784
3238
            return self._vfs_set_option(value, name, section)
2785
3239
        if response != ():
2786
3240
            raise errors.UnexpectedSmartServerResponse(response)
2787
3241
 
 
3242
    def _serialize_option_dict(self, option_dict):
 
3243
        utf8_dict = {}
 
3244
        for key, value in option_dict.items():
 
3245
            if isinstance(key, unicode):
 
3246
                key = key.encode('utf8')
 
3247
            if isinstance(value, unicode):
 
3248
                value = value.encode('utf8')
 
3249
            utf8_dict[key] = value
 
3250
        return bencode.bencode(utf8_dict)
 
3251
 
 
3252
    def _set_config_option_dict(self, value, name, section):
 
3253
        try:
 
3254
            path = self._branch._remote_path()
 
3255
            serialised_dict = self._serialize_option_dict(value)
 
3256
            response = self._branch._client.call(
 
3257
                'Branch.set_config_option_dict',
 
3258
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
3259
                serialised_dict, name, section or '')
 
3260
        except errors.UnknownSmartMethod:
 
3261
            medium = self._branch._client._medium
 
3262
            medium._remember_remote_is_before((2, 2))
 
3263
            return self._vfs_set_option(value, name, section)
 
3264
        if response != ():
 
3265
            raise errors.UnexpectedSmartServerResponse(response)
 
3266
 
2788
3267
    def _real_object(self):
2789
3268
        self._branch._ensure_real()
2790
3269
        return self._branch._real_branch
2873
3352
                    'Missing key %r in context %r', key_err.args[0], context)
2874
3353
                raise err
2875
3354
 
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':
 
3355
    if err.error_verb == 'NoSuchRevision':
2880
3356
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
3357
    elif err.error_verb == 'nosuchrevision':
2882
3358
        raise NoSuchRevision(find('repository'), err.error_args[0])
2889
3365
            detail=extra)
2890
3366
    elif err.error_verb == 'norepository':
2891
3367
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
3368
    elif err.error_verb == 'UnlockableTransport':
2895
3369
        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
3370
    elif err.error_verb == 'TokenMismatch':
2899
3371
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
3372
    elif err.error_verb == 'Diverged':
2901
3373
        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
3374
    elif err.error_verb == 'NotStacked':
2909
3375
        raise errors.NotStacked(branch=find('branch'))
2910
3376
    elif err.error_verb == 'PermissionDenied':
2920
3386
    elif err.error_verb == 'NoSuchFile':
2921
3387
        path = get_path()
2922
3388
        raise errors.NoSuchFile(path)
 
3389
    _translate_error_without_context(err)
 
3390
 
 
3391
 
 
3392
def _translate_error_without_context(err):
 
3393
    """Translate any ErrorFromSmartServer values that don't require context"""
 
3394
    if err.error_verb == 'IncompatibleRepositories':
 
3395
        raise errors.IncompatibleRepositories(err.error_args[0],
 
3396
            err.error_args[1], err.error_args[2])
 
3397
    elif err.error_verb == 'LockContention':
 
3398
        raise errors.LockContention('(remote lock)')
 
3399
    elif err.error_verb == 'LockFailed':
 
3400
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
3401
    elif err.error_verb == 'TipChangeRejected':
 
3402
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
3403
    elif err.error_verb == 'UnstackableBranchFormat':
 
3404
        raise errors.UnstackableBranchFormat(*err.error_args)
 
3405
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
3406
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2923
3407
    elif err.error_verb == 'FileExists':
2924
3408
        raise errors.FileExists(err.error_args[0])
2925
3409
    elif err.error_verb == 'DirectoryNotEmpty':
2944
3428
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
3429
    elif err.error_verb == 'ReadOnlyError':
2946
3430
        raise errors.TransportNotPossible('readonly transport')
 
3431
    elif err.error_verb == 'MemoryError':
 
3432
        raise errors.BzrError("remote server out of memory\n"
 
3433
            "Retry non-remotely, or contact the server admin for details.")
2947
3434
    raise errors.UnknownErrorFromSmartServer(err)