← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-09 00:44:25 UTC
  • mfrom: (4454.3.79 1.17-rework-annotate)
  • Revision ID: pqm@pqm.ubuntu.com-20090709004425-6tukiuklys5y02m5
(jam) Rework the internals of annotate to use a class object (fixes
        bug #387952)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remote.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
 
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
23
    bencode,
21
24
    branch,
22
 
    bzrdir as _mod_bzrdir,
 
25
    bzrdir,
23
26
    config,
24
 
    controldir,
25
27
    debug,
26
28
    errors,
27
29
    graph,
28
 
    lock,
29
30
    lockdir,
30
 
    repository as _mod_repository,
 
31
    repository,
 
32
    revision,
31
33
    revision as _mod_revision,
32
 
    static_tuple,
33
34
    symbol_versioning,
34
 
    urlutils,
35
 
    vf_repository,
36
 
    )
37
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
35
)
 
36
from bzrlib.branch import BranchReferenceFormat
 
37
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
39
from bzrlib.errors import (
40
40
    NoSuchRevision,
41
41
    SmartProtocolError,
42
42
    )
43
43
from bzrlib.lockable_files import LockableFiles
44
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.smart.client import _SmartClient
46
 
from bzrlib.revision import NULL_REVISION
47
 
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
 
45
from bzrlib.revision import ensure_null, NULL_REVISION
48
46
from bzrlib.trace import mutter, note, warning
49
47
 
50
48
 
63
61
        except errors.ErrorFromSmartServer, err:
64
62
            self._translate_error(err, **err_context)
65
63
 
66
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
67
 
        try:
68
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
69
 
        except errors.ErrorFromSmartServer, err:
70
 
            self._translate_error(err, **err_context)
71
 
 
72
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
73
65
                                             **err_context):
74
66
        try:
88
80
    return format
89
81
 
90
82
 
91
 
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
92
 
# does not have to be imported unless a remote format is involved.
93
 
 
94
 
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
95
 
    """Format representing bzrdirs accessed via a smart server"""
96
 
 
97
 
    supports_workingtrees = False
98
 
 
99
 
    def __init__(self):
100
 
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
101
 
        # XXX: It's a bit ugly that the network name is here, because we'd
102
 
        # like to believe that format objects are stateless or at least
103
 
        # immutable,  However, we do at least avoid mutating the name after
104
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
105
 
        self._network_name = None
106
 
 
107
 
    def __repr__(self):
108
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
109
 
            self._network_name)
110
 
 
111
 
    def get_format_description(self):
112
 
        if self._network_name:
113
 
            real_format = controldir.network_format_registry.get(self._network_name)
114
 
            return 'Remote: ' + real_format.get_format_description()
115
 
        return 'bzr remote bzrdir'
116
 
 
117
 
    def get_format_string(self):
118
 
        raise NotImplementedError(self.get_format_string)
119
 
 
120
 
    def network_name(self):
121
 
        if self._network_name:
122
 
            return self._network_name
123
 
        else:
124
 
            raise AssertionError("No network name set.")
125
 
 
126
 
    def initialize_on_transport(self, transport):
127
 
        try:
128
 
            # hand off the request to the smart server
129
 
            client_medium = transport.get_smart_medium()
130
 
        except errors.NoSmartMedium:
131
 
            # TODO: lookup the local format from a server hint.
132
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
133
 
            return local_dir_format.initialize_on_transport(transport)
134
 
        client = _SmartClient(client_medium)
135
 
        path = client.remote_path_from_transport(transport)
136
 
        try:
137
 
            response = client.call('BzrDirFormat.initialize', path)
138
 
        except errors.ErrorFromSmartServer, err:
139
 
            _translate_error(err, path=path)
140
 
        if response[0] != 'ok':
141
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
142
 
        format = RemoteBzrDirFormat()
143
 
        self._supply_sub_formats_to(format)
144
 
        return RemoteBzrDir(transport, format)
145
 
 
146
 
    def parse_NoneTrueFalse(self, arg):
147
 
        if not arg:
148
 
            return None
149
 
        if arg == 'False':
150
 
            return False
151
 
        if arg == 'True':
152
 
            return True
153
 
        raise AssertionError("invalid arg %r" % arg)
154
 
 
155
 
    def _serialize_NoneTrueFalse(self, arg):
156
 
        if arg is False:
157
 
            return 'False'
158
 
        if arg:
159
 
            return 'True'
160
 
        return ''
161
 
 
162
 
    def _serialize_NoneString(self, arg):
163
 
        return arg or ''
164
 
 
165
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
166
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
167
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
168
 
        shared_repo=False):
169
 
        try:
170
 
            # hand off the request to the smart server
171
 
            client_medium = transport.get_smart_medium()
172
 
        except errors.NoSmartMedium:
173
 
            do_vfs = True
174
 
        else:
175
 
            # Decline to open it if the server doesn't support our required
176
 
            # version (3) so that the VFS-based transport will do it.
177
 
            if client_medium.should_probe():
178
 
                try:
179
 
                    server_version = client_medium.protocol_version()
180
 
                    if server_version != '2':
181
 
                        do_vfs = True
182
 
                    else:
183
 
                        do_vfs = False
184
 
                except errors.SmartProtocolError:
185
 
                    # Apparently there's no usable smart server there, even though
186
 
                    # the medium supports the smart protocol.
187
 
                    do_vfs = True
188
 
            else:
189
 
                do_vfs = False
190
 
        if not do_vfs:
191
 
            client = _SmartClient(client_medium)
192
 
            path = client.remote_path_from_transport(transport)
193
 
            if client_medium._is_remote_before((1, 16)):
194
 
                do_vfs = True
195
 
        if do_vfs:
196
 
            # TODO: lookup the local format from a server hint.
197
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
198
 
            self._supply_sub_formats_to(local_dir_format)
199
 
            return local_dir_format.initialize_on_transport_ex(transport,
200
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
201
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
202
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
203
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
204
 
                vfs_only=True)
205
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
206
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
207
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
208
 
 
209
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
210
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
211
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
212
 
        args = []
213
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
214
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
215
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
216
 
        args.append(self._serialize_NoneString(stacked_on))
217
 
        # stack_on_pwd is often/usually our transport
218
 
        if stack_on_pwd:
219
 
            try:
220
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
221
 
                if not stack_on_pwd:
222
 
                    stack_on_pwd = '.'
223
 
            except errors.PathNotChild:
224
 
                pass
225
 
        args.append(self._serialize_NoneString(stack_on_pwd))
226
 
        args.append(self._serialize_NoneString(repo_format_name))
227
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
228
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
229
 
        request_network_name = self._network_name or \
230
 
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
231
 
        try:
232
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
233
 
                request_network_name, path, *args)
234
 
        except errors.UnknownSmartMethod:
235
 
            client._medium._remember_remote_is_before((1,16))
236
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
237
 
            self._supply_sub_formats_to(local_dir_format)
238
 
            return local_dir_format.initialize_on_transport_ex(transport,
239
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
240
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
241
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
242
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
243
 
                vfs_only=True)
244
 
        except errors.ErrorFromSmartServer, err:
245
 
            _translate_error(err, path=path)
246
 
        repo_path = response[0]
247
 
        bzrdir_name = response[6]
248
 
        require_stacking = response[7]
249
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
250
 
        format = RemoteBzrDirFormat()
251
 
        format._network_name = bzrdir_name
252
 
        self._supply_sub_formats_to(format)
253
 
        bzrdir = RemoteBzrDir(transport, format, _client=client)
254
 
        if repo_path:
255
 
            repo_format = response_tuple_to_repo_format(response[1:])
256
 
            if repo_path == '.':
257
 
                repo_path = ''
258
 
            if repo_path:
259
 
                repo_bzrdir_format = RemoteBzrDirFormat()
260
 
                repo_bzrdir_format._network_name = response[5]
261
 
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
262
 
                    repo_bzrdir_format)
263
 
            else:
264
 
                repo_bzr = bzrdir
265
 
            final_stack = response[8] or None
266
 
            final_stack_pwd = response[9] or None
267
 
            if final_stack_pwd:
268
 
                final_stack_pwd = urlutils.join(
269
 
                    transport.base, final_stack_pwd)
270
 
            remote_repo = RemoteRepository(repo_bzr, repo_format)
271
 
            if len(response) > 10:
272
 
                # Updated server verb that locks remotely.
273
 
                repo_lock_token = response[10] or None
274
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
275
 
                if repo_lock_token:
276
 
                    remote_repo.dont_leave_lock_in_place()
277
 
            else:
278
 
                remote_repo.lock_write()
279
 
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
280
 
                final_stack_pwd, require_stacking)
281
 
            policy.acquire_repository()
282
 
        else:
283
 
            remote_repo = None
284
 
            policy = None
285
 
        bzrdir._format.set_branch_format(self.get_branch_format())
286
 
        if require_stacking:
287
 
            # The repo has already been created, but we need to make sure that
288
 
            # we'll make a stackable branch.
289
 
            bzrdir._format.require_stacking(_skip_repo=True)
290
 
        return remote_repo, bzrdir, require_stacking, policy
291
 
 
292
 
    def _open(self, transport):
293
 
        return RemoteBzrDir(transport, self)
294
 
 
295
 
    def __eq__(self, other):
296
 
        if not isinstance(other, RemoteBzrDirFormat):
297
 
            return False
298
 
        return self.get_format_description() == other.get_format_description()
299
 
 
300
 
    def __return_repository_format(self):
301
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
302
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
303
 
        # that it should use that for init() etc.
304
 
        result = RemoteRepositoryFormat()
305
 
        custom_format = getattr(self, '_repository_format', None)
306
 
        if custom_format:
307
 
            if isinstance(custom_format, RemoteRepositoryFormat):
308
 
                return custom_format
309
 
            else:
310
 
                # We will use the custom format to create repositories over the
311
 
                # wire; expose its details like rich_root_data for code to
312
 
                # query
313
 
                result._custom_format = custom_format
314
 
        return result
315
 
 
316
 
    def get_branch_format(self):
317
 
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
318
 
        if not isinstance(result, RemoteBranchFormat):
319
 
            new_result = RemoteBranchFormat()
320
 
            new_result._custom_format = result
321
 
            # cache the result
322
 
            self.set_branch_format(new_result)
323
 
            result = new_result
324
 
        return result
325
 
 
326
 
    repository_format = property(__return_repository_format,
327
 
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
328
 
 
329
 
 
330
 
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
 
83
# Note: RemoteBzrDirFormat is in bzrdir.py
 
84
 
 
85
class RemoteBzrDir(BzrDir, _RpcHelper):
331
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
332
87
 
333
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
88
    def __init__(self, transport, format, _client=None):
334
89
        """Construct a RemoteBzrDir.
335
90
 
336
91
        :param _client: Private parameter for testing. Disables probing and the
337
92
            use of a real bzrdir.
338
93
        """
339
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
94
        BzrDir.__init__(self, transport, format)
340
95
        # this object holds a delegated bzrdir that uses file-level operations
341
96
        # to talk to the other side
342
97
        self._real_bzrdir = None
343
 
        self._has_working_tree = None
344
98
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
99
        # create_branch for details.
346
100
        self._next_open_branch_result = None
350
104
            self._client = client._SmartClient(medium)
351
105
        else:
352
106
            self._client = _client
353
 
            if not _force_probe:
354
 
                return
355
 
 
356
 
        self._probe_bzrdir()
357
 
 
358
 
    def __repr__(self):
359
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
360
 
 
361
 
    def _probe_bzrdir(self):
362
 
        medium = self._client._medium
 
107
            return
 
108
 
363
109
        path = self._path_for_remote_call(self._client)
364
 
        if medium._is_remote_before((2, 1)):
365
 
            self._rpc_open(path)
366
 
            return
367
 
        try:
368
 
            self._rpc_open_2_1(path)
369
 
            return
370
 
        except errors.UnknownSmartMethod:
371
 
            medium._remember_remote_is_before((2, 1))
372
 
            self._rpc_open(path)
373
 
 
374
 
    def _rpc_open_2_1(self, path):
375
 
        response = self._call('BzrDir.open_2.1', path)
376
 
        if response == ('no',):
377
 
            raise errors.NotBranchError(path=self.root_transport.base)
378
 
        elif response[0] == 'yes':
379
 
            if response[1] == 'yes':
380
 
                self._has_working_tree = True
381
 
            elif response[1] == 'no':
382
 
                self._has_working_tree = False
383
 
            else:
384
 
                raise errors.UnexpectedSmartServerResponse(response)
385
 
        else:
386
 
            raise errors.UnexpectedSmartServerResponse(response)
387
 
 
388
 
    def _rpc_open(self, path):
389
110
        response = self._call('BzrDir.open', path)
390
111
        if response not in [('yes',), ('no',)]:
391
112
            raise errors.UnexpectedSmartServerResponse(response)
392
113
        if response == ('no',):
393
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
114
            raise errors.NotBranchError(path=transport.base)
394
115
 
395
116
    def _ensure_real(self):
396
117
        """Ensure that there is a _real_bzrdir set.
398
119
        Used before calls to self._real_bzrdir.
399
120
        """
400
121
        if not self._real_bzrdir:
401
 
            if 'hpssvfs' in debug.debug_flags:
402
 
                import traceback
403
 
                warning('VFS BzrDir access triggered\n%s',
404
 
                    ''.join(traceback.format_stack()))
405
 
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
122
            self._real_bzrdir = BzrDir.open_from_transport(
406
123
                self.root_transport, _server_formats=False)
407
124
            self._format._network_name = \
408
125
                self._real_bzrdir._format.network_name()
414
131
        # Prevent aliasing problems in the next_open_branch_result cache.
415
132
        # See create_branch for rationale.
416
133
        self._next_open_branch_result = None
417
 
        return _mod_bzrdir.BzrDir.break_lock(self)
 
134
        return BzrDir.break_lock(self)
418
135
 
419
136
    def _vfs_cloning_metadir(self, require_stacking=False):
420
137
        self._ensure_real()
451
168
        if len(branch_info) != 2:
452
169
            raise errors.UnexpectedSmartServerResponse(response)
453
170
        branch_ref, branch_name = branch_info
454
 
        format = controldir.network_format_registry.get(control_name)
 
171
        format = bzrdir.network_format_registry.get(control_name)
455
172
        if repo_name:
456
 
            format.repository_format = _mod_repository.network_format_registry.get(
 
173
            format.repository_format = repository.network_format_registry.get(
457
174
                repo_name)
458
175
        if branch_ref == 'ref':
459
176
            # XXX: we need possible_transports here to avoid reopening the
460
177
            # connection to the referenced location
461
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
 
178
            ref_bzrdir = BzrDir.open(branch_name)
462
179
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
180
            format.set_branch_format(branch_format)
464
181
        elif branch_ref == 'branch':
483
200
        self._ensure_real()
484
201
        self._real_bzrdir.destroy_repository()
485
202
 
486
 
    def create_branch(self, name=None, repository=None):
 
203
    def create_branch(self):
487
204
        # as per meta1 formats - just delegate to the format object which may
488
205
        # be parameterised.
489
 
        real_branch = self._format.get_branch_format().initialize(self,
490
 
            name=name, repository=repository)
 
206
        real_branch = self._format.get_branch_format().initialize(self)
491
207
        if not isinstance(real_branch, RemoteBranch):
492
 
            if not isinstance(repository, RemoteRepository):
493
 
                raise AssertionError(
494
 
                    'need a RemoteRepository to use with RemoteBranch, got %r'
495
 
                    % (repository,))
496
 
            result = RemoteBranch(self, repository, real_branch, name=name)
 
208
            result = RemoteBranch(self, self.find_repository(), real_branch)
497
209
        else:
498
210
            result = real_branch
499
211
        # BzrDir.clone_on_transport() uses the result of create_branch but does
505
217
        self._next_open_branch_result = result
506
218
        return result
507
219
 
508
 
    def destroy_branch(self, name=None):
 
220
    def destroy_branch(self):
509
221
        """See BzrDir.destroy_branch"""
510
222
        self._ensure_real()
511
 
        self._real_bzrdir.destroy_branch(name=name)
 
223
        self._real_bzrdir.destroy_branch()
512
224
        self._next_open_branch_result = None
513
225
 
514
 
    def create_workingtree(self, revision_id=None, from_branch=None,
515
 
        accelerator_tree=None, hardlink=False):
 
226
    def create_workingtree(self, revision_id=None, from_branch=None):
516
227
        raise errors.NotLocalUrl(self.transport.base)
517
228
 
518
 
    def find_branch_format(self, name=None):
 
229
    def find_branch_format(self):
519
230
        """Find the branch 'format' for this bzrdir.
520
231
 
521
232
        This might be a synthetic object for e.g. RemoteBranch and SVN.
522
233
        """
523
 
        b = self.open_branch(name=name)
 
234
        b = self.open_branch()
524
235
        return b._format
525
236
 
526
 
    def get_branch_reference(self, name=None):
 
237
    def get_branch_reference(self):
527
238
        """See BzrDir.get_branch_reference()."""
528
 
        if name is not None:
529
 
            # XXX JRV20100304: Support opening colocated branches
530
 
            raise errors.NoColocatedBranchSupport(self)
531
239
        response = self._get_branch_reference()
532
240
        if response[0] == 'ref':
533
241
            return response[1]
537
245
    def _get_branch_reference(self):
538
246
        path = self._path_for_remote_call(self._client)
539
247
        medium = self._client._medium
540
 
        candidate_calls = [
541
 
            ('BzrDir.open_branchV3', (2, 1)),
542
 
            ('BzrDir.open_branchV2', (1, 13)),
543
 
            ('BzrDir.open_branch', None),
544
 
            ]
545
 
        for verb, required_version in candidate_calls:
546
 
            if required_version and medium._is_remote_before(required_version):
547
 
                continue
 
248
        if not medium._is_remote_before((1, 13)):
548
249
            try:
549
 
                response = self._call(verb, path)
 
250
                response = self._call('BzrDir.open_branchV2', path)
 
251
                if response[0] not in ('ref', 'branch'):
 
252
                    raise errors.UnexpectedSmartServerResponse(response)
 
253
                return response
550
254
            except errors.UnknownSmartMethod:
551
 
                if required_version is None:
552
 
                    raise
553
 
                medium._remember_remote_is_before(required_version)
554
 
            else:
555
 
                break
556
 
        if verb == 'BzrDir.open_branch':
557
 
            if response[0] != 'ok':
558
 
                raise errors.UnexpectedSmartServerResponse(response)
559
 
            if response[1] != '':
560
 
                return ('ref', response[1])
561
 
            else:
562
 
                return ('branch', '')
563
 
        if response[0] not in ('ref', 'branch'):
 
255
                medium._remember_remote_is_before((1, 13))
 
256
        response = self._call('BzrDir.open_branch', path)
 
257
        if response[0] != 'ok':
564
258
            raise errors.UnexpectedSmartServerResponse(response)
565
 
        return response
 
259
        if response[1] != '':
 
260
            return ('ref', response[1])
 
261
        else:
 
262
            return ('branch', '')
566
263
 
567
 
    def _get_tree_branch(self, name=None):
 
264
    def _get_tree_branch(self):
568
265
        """See BzrDir._get_tree_branch()."""
569
 
        return None, self.open_branch(name=name)
 
266
        return None, self.open_branch()
570
267
 
571
 
    def open_branch(self, name=None, unsupported=False,
572
 
                    ignore_fallbacks=False):
573
 
        if unsupported:
 
268
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
269
        if _unsupported:
574
270
            raise NotImplementedError('unsupported flag support not implemented yet.')
575
271
        if self._next_open_branch_result is not None:
576
272
            # See create_branch for details.
581
277
        if response[0] == 'ref':
582
278
            # a branch reference, use the existing BranchReference logic.
583
279
            format = BranchReferenceFormat()
584
 
            return format.open(self, name=name, _found=True,
585
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
280
            return format.open(self, _found=True, location=response[1],
 
281
                ignore_fallbacks=ignore_fallbacks)
586
282
        branch_format_name = response[1]
587
283
        if not branch_format_name:
588
284
            branch_format_name = None
589
285
        format = RemoteBranchFormat(network_name=branch_format_name)
590
286
        return RemoteBranch(self, self.find_repository(), format=format,
591
 
            setup_stacking=not ignore_fallbacks, name=name)
 
287
            setup_stacking=not ignore_fallbacks)
592
288
 
593
289
    def _open_repo_v1(self, path):
594
290
        verb = 'BzrDir.find_repository'
655
351
        else:
656
352
            raise errors.NoRepositoryPresent(self)
657
353
 
658
 
    def has_workingtree(self):
659
 
        if self._has_working_tree is None:
660
 
            self._ensure_real()
661
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
662
 
        return self._has_working_tree
663
 
 
664
354
    def open_workingtree(self, recommend_upgrade=True):
665
 
        if self.has_workingtree():
 
355
        self._ensure_real()
 
356
        if self._real_bzrdir.has_workingtree():
666
357
            raise errors.NotLocalUrl(self.root_transport)
667
358
        else:
668
359
            raise errors.NoWorkingTree(self.root_transport.base)
671
362
        """Return the path to be used for this bzrdir in a remote call."""
672
363
        return client.remote_path_from_transport(self.root_transport)
673
364
 
674
 
    def get_branch_transport(self, branch_format, name=None):
 
365
    def get_branch_transport(self, branch_format):
675
366
        self._ensure_real()
676
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
367
        return self._real_bzrdir.get_branch_transport(branch_format)
677
368
 
678
369
    def get_repository_transport(self, repository_format):
679
370
        self._ensure_real()
687
378
        """Upgrading of remote bzrdirs is not supported yet."""
688
379
        return False
689
380
 
690
 
    def needs_format_conversion(self, format):
 
381
    def needs_format_conversion(self, format=None):
691
382
        """Upgrading of remote bzrdirs is not supported yet."""
 
383
        if format is None:
 
384
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
385
                % 'needs_format_conversion(format=None)')
692
386
        return False
693
387
 
694
388
    def clone(self, url, revision_id=None, force_new_repo=False,
701
395
        return RemoteBzrDirConfig(self)
702
396
 
703
397
 
704
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
398
class RemoteRepositoryFormat(repository.RepositoryFormat):
705
399
    """Format for repositories accessed over a _SmartClient.
706
400
 
707
401
    Instances of this repository are represented by RemoteRepository
722
416
    """
723
417
 
724
418
    _matchingbzrdir = RemoteBzrDirFormat()
725
 
    supports_full_versioned_files = True
726
 
    supports_leaving_lock = True
727
419
 
728
420
    def __init__(self):
729
 
        _mod_repository.RepositoryFormat.__init__(self)
 
421
        repository.RepositoryFormat.__init__(self)
730
422
        self._custom_format = None
731
423
        self._network_name = None
732
424
        self._creating_bzrdir = None
733
 
        self._revision_graph_can_have_wrong_parents = None
734
 
        self._supports_chks = None
735
425
        self._supports_external_lookups = None
736
426
        self._supports_tree_reference = None
737
 
        self._supports_funky_characters = None
738
427
        self._rich_root_data = None
739
428
 
740
 
    def __repr__(self):
741
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
742
 
            self._network_name)
743
 
 
744
429
    @property
745
430
    def fast_deltas(self):
746
431
        self._ensure_real()
754
439
        return self._rich_root_data
755
440
 
756
441
    @property
757
 
    def supports_chks(self):
758
 
        if self._supports_chks is None:
759
 
            self._ensure_real()
760
 
            self._supports_chks = self._custom_format.supports_chks
761
 
        return self._supports_chks
762
 
 
763
 
    @property
764
442
    def supports_external_lookups(self):
765
443
        if self._supports_external_lookups is None:
766
444
            self._ensure_real()
769
447
        return self._supports_external_lookups
770
448
 
771
449
    @property
772
 
    def supports_funky_characters(self):
773
 
        if self._supports_funky_characters is None:
774
 
            self._ensure_real()
775
 
            self._supports_funky_characters = \
776
 
                self._custom_format.supports_funky_characters
777
 
        return self._supports_funky_characters
778
 
 
779
 
    @property
780
450
    def supports_tree_reference(self):
781
451
        if self._supports_tree_reference is None:
782
452
            self._ensure_real()
784
454
                self._custom_format.supports_tree_reference
785
455
        return self._supports_tree_reference
786
456
 
787
 
    @property
788
 
    def revision_graph_can_have_wrong_parents(self):
789
 
        if self._revision_graph_can_have_wrong_parents is None:
790
 
            self._ensure_real()
791
 
            self._revision_graph_can_have_wrong_parents = \
792
 
                self._custom_format.revision_graph_can_have_wrong_parents
793
 
        return self._revision_graph_can_have_wrong_parents
794
 
 
795
457
    def _vfs_initialize(self, a_bzrdir, shared):
796
458
        """Helper for common code in initialize."""
797
459
        if self._custom_format:
832
494
            network_name = self._network_name
833
495
        else:
834
496
            # Select the current bzrlib default and ask for that.
835
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
497
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
836
498
            reference_format = reference_bzrdir_format.repository_format
837
499
            network_name = reference_format.network_name()
838
500
        # 2) try direct creation via RPC
864
526
 
865
527
    def _ensure_real(self):
866
528
        if self._custom_format is None:
867
 
            self._custom_format = _mod_repository.network_format_registry.get(
 
529
            self._custom_format = repository.network_format_registry.get(
868
530
                self._network_name)
869
531
 
870
532
    @property
883
545
        return self._custom_format._fetch_reconcile
884
546
 
885
547
    def get_format_description(self):
886
 
        self._ensure_real()
887
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
548
        return 'bzr remote repository'
888
549
 
889
550
    def __eq__(self, other):
890
551
        return self.__class__ is other.__class__
891
552
 
 
553
    def check_conversion_target(self, target_format):
 
554
        if self.rich_root_data and not target_format.rich_root_data:
 
555
            raise errors.BadConversionTarget(
 
556
                'Does not support rich root data.', target_format)
 
557
        if (self.supports_tree_reference and
 
558
            not getattr(target_format, 'supports_tree_reference', False)):
 
559
            raise errors.BadConversionTarget(
 
560
                'Does not support nested trees', target_format)
 
561
 
892
562
    def network_name(self):
893
563
        if self._network_name:
894
564
            return self._network_name
906
576
        return self._custom_format._serializer
907
577
 
908
578
 
909
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
910
 
    controldir.ControlComponent):
 
579
class RemoteRepository(_RpcHelper):
911
580
    """Repository accessed over rpc.
912
581
 
913
582
    For the moment most operations are performed using local transport-backed
956
625
        # Additional places to query for data.
957
626
        self._fallback_repositories = []
958
627
 
959
 
    @property
960
 
    def user_transport(self):
961
 
        return self.bzrdir.user_transport
962
 
 
963
 
    @property
964
 
    def control_transport(self):
965
 
        # XXX: Normally you shouldn't directly get at the remote repository
966
 
        # transport, but I'm not sure it's worth making this method
967
 
        # optional -- mbp 2010-04-21
968
 
        return self.bzrdir.get_repository_transport(None)
969
 
 
970
628
    def __str__(self):
971
629
        return "%s(%s)" % (self.__class__.__name__, self.base)
972
630
 
1080
738
    def find_text_key_references(self):
1081
739
        """Find the text key references within the repository.
1082
740
 
 
741
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
742
        revision_ids. Each altered file-ids has the exact revision_ids that
 
743
        altered it listed explicitly.
1083
744
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1084
745
            to whether they were referred to by the inventory of the
1085
746
            revision_id that they contain. The inventory texts from all present
1103
764
        """Private method for using with old (< 1.2) servers to fallback."""
1104
765
        if revision_id is None:
1105
766
            revision_id = ''
1106
 
        elif _mod_revision.is_null(revision_id):
 
767
        elif revision.is_null(revision_id):
1107
768
            return {}
1108
769
 
1109
770
        path = self.bzrdir._path_for_remote_call(self._client)
1133
794
        return RemoteStreamSource(self, to_format)
1134
795
 
1135
796
    @needs_read_lock
1136
 
    def get_file_graph(self):
1137
 
        return graph.Graph(self.texts)
1138
 
 
1139
 
    @needs_read_lock
1140
797
    def has_revision(self, revision_id):
1141
798
        """True if this repository has a copy of the revision."""
1142
799
        # Copy of bzrlib.repository.Repository.has_revision
1156
813
            result.add(_mod_revision.NULL_REVISION)
1157
814
        return result
1158
815
 
1159
 
    def _has_same_fallbacks(self, other_repo):
1160
 
        """Returns true if the repositories have the same fallbacks."""
1161
 
        # XXX: copied from Repository; it should be unified into a base class
1162
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
1163
 
        my_fb = self._fallback_repositories
1164
 
        other_fb = other_repo._fallback_repositories
1165
 
        if len(my_fb) != len(other_fb):
1166
 
            return False
1167
 
        for f, g in zip(my_fb, other_fb):
1168
 
            if not f.has_same_location(g):
1169
 
                return False
1170
 
        return True
1171
 
 
1172
816
    def has_same_location(self, other):
1173
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
1174
 
        # one; unfortunately the tests rely on slightly different behaviour at
1175
 
        # present -- mbp 20090710
1176
817
        return (self.__class__ is other.__class__ and
1177
818
                self.bzrdir.transport.base == other.bzrdir.transport.base)
1178
819
 
1181
822
        parents_provider = self._make_parents_provider(other_repository)
1182
823
        return graph.Graph(parents_provider)
1183
824
 
1184
 
    @needs_read_lock
1185
 
    def get_known_graph_ancestry(self, revision_ids):
1186
 
        """Return the known graph for a set of revision ids and their ancestors.
1187
 
        """
1188
 
        st = static_tuple.StaticTuple
1189
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
1190
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1191
 
        return graph.GraphThunkIdsToKeys(known_graph)
1192
 
 
1193
825
    def gather_stats(self, revid=None, committers=None):
1194
826
        """See Repository.gather_stats()."""
1195
827
        path = self.bzrdir._path_for_remote_call(self._client)
1196
828
        # revid can be None to indicate no revisions, not just NULL_REVISION
1197
 
        if revid is None or _mod_revision.is_null(revid):
 
829
        if revid is None or revision.is_null(revid):
1198
830
            fmt_revid = ''
1199
831
        else:
1200
832
            fmt_revid = revid
1255
887
    def is_write_locked(self):
1256
888
        return self._lock_mode == 'w'
1257
889
 
1258
 
    def _warn_if_deprecated(self, branch=None):
1259
 
        # If we have a real repository, the check will be done there, if we
1260
 
        # don't the check will be done remotely.
1261
 
        pass
1262
 
 
1263
890
    def lock_read(self):
1264
 
        """Lock the repository for read operations.
1265
 
 
1266
 
        :return: A bzrlib.lock.LogicalLockResult.
1267
 
        """
1268
891
        # wrong eventually - want a local lock cache context
1269
892
        if not self._lock_mode:
1270
 
            self._note_lock('r')
1271
893
            self._lock_mode = 'r'
1272
894
            self._lock_count = 1
1273
895
            self._unstacked_provider.enable_cache(cache_misses=True)
1277
899
                repo.lock_read()
1278
900
        else:
1279
901
            self._lock_count += 1
1280
 
        return lock.LogicalLockResult(self.unlock)
1281
902
 
1282
903
    def _remote_lock_write(self, token):
1283
904
        path = self.bzrdir._path_for_remote_call(self._client)
1294
915
 
1295
916
    def lock_write(self, token=None, _skip_rpc=False):
1296
917
        if not self._lock_mode:
1297
 
            self._note_lock('w')
1298
918
            if _skip_rpc:
1299
919
                if self._lock_token is not None:
1300
920
                    if token != self._lock_token:
1323
943
            raise errors.ReadOnlyError(self)
1324
944
        else:
1325
945
            self._lock_count += 1
1326
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
946
        return self._lock_token or None
1327
947
 
1328
948
    def leave_lock_in_place(self):
1329
949
        if not self._lock_token:
1403
1023
        else:
1404
1024
            raise errors.UnexpectedSmartServerResponse(response)
1405
1025
 
1406
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1407
1026
    def unlock(self):
1408
1027
        if not self._lock_count:
1409
 
            return lock.cant_unlock_not_held(self)
 
1028
            raise errors.LockNotHeld(self)
1410
1029
        self._lock_count -= 1
1411
1030
        if self._lock_count > 0:
1412
1031
            return
1483
1102
 
1484
1103
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1485
1104
                           timezone=None, committer=None, revprops=None,
1486
 
                           revision_id=None, lossy=False):
 
1105
                           revision_id=None):
1487
1106
        # FIXME: It ought to be possible to call this without immediately
1488
1107
        # triggering _ensure_real.  For now it's the easiest thing to do.
1489
1108
        self._ensure_real()
1490
1109
        real_repo = self._real_repository
1491
1110
        builder = real_repo.get_commit_builder(branch, parents,
1492
1111
                config, timestamp=timestamp, timezone=timezone,
1493
 
                committer=committer, revprops=revprops,
1494
 
                revision_id=revision_id, lossy=lossy)
 
1112
                committer=committer, revprops=revprops, revision_id=revision_id)
1495
1113
        return builder
1496
1114
 
1497
1115
    def add_fallback_repository(self, repository):
1510
1128
            # state, so always add a lock here. If a caller passes us a locked
1511
1129
            # repository, they are responsible for unlocking it later.
1512
1130
            repository.lock_read()
1513
 
        self._check_fallback_repository(repository)
1514
1131
        self._fallback_repositories.append(repository)
1515
1132
        # If self._real_repository was parameterised already (e.g. because a
1516
1133
        # _real_branch had its get_stacked_on_url method called), then the
1517
1134
        # repository to be added may already be in the _real_repositories list.
1518
1135
        if self._real_repository is not None:
1519
 
            fallback_locations = [repo.user_url for repo in
 
1136
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1520
1137
                self._real_repository._fallback_repositories]
1521
 
            if repository.user_url not in fallback_locations:
 
1138
            if repository.bzrdir.root_transport.base not in fallback_locations:
1522
1139
                self._real_repository.add_fallback_repository(repository)
1523
1140
 
1524
 
    def _check_fallback_repository(self, repository):
1525
 
        """Check that this repository can fallback to repository safely.
1526
 
 
1527
 
        Raise an error if not.
1528
 
 
1529
 
        :param repository: A repository to fallback to.
1530
 
        """
1531
 
        return _mod_repository.InterRepository._assert_same_model(
1532
 
            self, repository)
1533
 
 
1534
1141
    def add_inventory(self, revid, inv, parents):
1535
1142
        self._ensure_real()
1536
1143
        return self._real_repository.add_inventory(revid, inv, parents)
1537
1144
 
1538
1145
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1539
 
            parents, basis_inv=None, propagate_caches=False):
 
1146
                               parents):
1540
1147
        self._ensure_real()
1541
1148
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1542
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1543
 
            propagate_caches=propagate_caches)
 
1149
            delta, new_revision_id, parents)
1544
1150
 
1545
1151
    def add_revision(self, rev_id, rev, inv=None, config=None):
1546
1152
        self._ensure_real()
1552
1158
        self._ensure_real()
1553
1159
        return self._real_repository.get_inventory(revision_id)
1554
1160
 
1555
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1161
    def iter_inventories(self, revision_ids):
1556
1162
        self._ensure_real()
1557
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1163
        return self._real_repository.iter_inventories(revision_ids)
1558
1164
 
1559
1165
    @needs_read_lock
1560
1166
    def get_revision(self, revision_id):
1576
1182
        return self._real_repository.make_working_trees()
1577
1183
 
1578
1184
    def refresh_data(self):
1579
 
        """Re-read any data needed to synchronise with disk.
 
1185
        """Re-read any data needed to to synchronise with disk.
1580
1186
 
1581
1187
        This method is intended to be called after another repository instance
1582
1188
        (such as one used by a smart server) has inserted data into the
1583
 
        repository. On all repositories this will work outside of write groups.
1584
 
        Some repository formats (pack and newer for bzrlib native formats)
1585
 
        support refresh_data inside write groups. If called inside a write
1586
 
        group on a repository that does not support refreshing in a write group
1587
 
        IsInWriteGroupError will be raised.
 
1189
        repository. It may not be called during a write group, but may be
 
1190
        called at any other time.
1588
1191
        """
 
1192
        if self.is_in_write_group():
 
1193
            raise errors.InternalBzrError(
 
1194
                "May not refresh_data while in a write group.")
1589
1195
        if self._real_repository is not None:
1590
1196
            self._real_repository.refresh_data()
1591
1197
 
1603
1209
        return result
1604
1210
 
1605
1211
    @needs_read_lock
1606
 
    def search_missing_revision_ids(self, other,
1607
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1608
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1609
 
            limit=None):
 
1212
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1610
1213
        """Return the revision ids that other has that this does not.
1611
1214
 
1612
1215
        These are returned in topological order.
1613
1216
 
1614
1217
        revision_id: only return revision ids included by revision_id.
1615
1218
        """
1616
 
        if symbol_versioning.deprecated_passed(revision_id):
1617
 
            symbol_versioning.warn(
1618
 
                'search_missing_revision_ids(revision_id=...) was '
1619
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
1620
 
                DeprecationWarning, stacklevel=2)
1621
 
            if revision_ids is not None:
1622
 
                raise AssertionError(
1623
 
                    'revision_ids is mutually exclusive with revision_id')
1624
 
            if revision_id is not None:
1625
 
                revision_ids = [revision_id]
1626
 
        inter_repo = _mod_repository.InterRepository.get(other, self)
1627
 
        return inter_repo.search_missing_revision_ids(
1628
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
1629
 
            if_present_ids=if_present_ids, limit=limit)
 
1219
        return repository.InterRepository.get(
 
1220
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1630
1221
 
1631
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1222
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1632
1223
            fetch_spec=None):
1633
1224
        # No base implementation to use as RemoteRepository is not a subclass
1634
1225
        # of Repository; so this is a copy of Repository.fetch().
1639
1230
            raise errors.InternalBzrError(
1640
1231
                "May not fetch while in a write group.")
1641
1232
        # fast path same-url fetch operations
1642
 
        if (self.has_same_location(source)
1643
 
            and fetch_spec is None
1644
 
            and self._has_same_fallbacks(source)):
 
1233
        if self.has_same_location(source) and fetch_spec is None:
1645
1234
            # check that last_revision is in 'from' and then return a
1646
1235
            # no-operation.
1647
1236
            if (revision_id is not None and
1648
 
                not _mod_revision.is_null(revision_id)):
 
1237
                not revision.is_null(revision_id)):
1649
1238
                self.get_revision(revision_id)
1650
1239
            return 0, []
1651
1240
        # if there is no specific appropriate InterRepository, this will get
1652
1241
        # the InterRepository base class, which raises an
1653
1242
        # IncompatibleRepositories when asked to fetch.
1654
 
        inter = _mod_repository.InterRepository.get(source, self)
1655
 
        return inter.fetch(revision_id=revision_id,
 
1243
        inter = repository.InterRepository.get(source, self)
 
1244
        return inter.fetch(revision_id=revision_id, pb=pb,
1656
1245
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1657
1246
 
1658
1247
    def create_bundle(self, target, base, fileobj, format=None):
1660
1249
        self._real_repository.create_bundle(target, base, fileobj, format)
1661
1250
 
1662
1251
    @needs_read_lock
1663
 
    @symbol_versioning.deprecated_method(
1664
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1665
1252
    def get_ancestry(self, revision_id, topo_sorted=True):
1666
1253
        self._ensure_real()
1667
1254
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1822
1409
        return self._real_repository.get_signature_text(revision_id)
1823
1410
 
1824
1411
    @needs_read_lock
1825
 
    def _get_inventory_xml(self, revision_id):
1826
 
        self._ensure_real()
1827
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1412
    def get_inventory_xml(self, revision_id):
 
1413
        self._ensure_real()
 
1414
        return self._real_repository.get_inventory_xml(revision_id)
 
1415
 
 
1416
    def deserialise_inventory(self, revision_id, xml):
 
1417
        self._ensure_real()
 
1418
        return self._real_repository.deserialise_inventory(revision_id, xml)
1828
1419
 
1829
1420
    def reconcile(self, other=None, thorough=False):
1830
1421
        self._ensure_real()
1857
1448
        return self._real_repository.get_revision_reconcile(revision_id)
1858
1449
 
1859
1450
    @needs_read_lock
1860
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1451
    def check(self, revision_ids=None):
1861
1452
        self._ensure_real()
1862
 
        return self._real_repository.check(revision_ids=revision_ids,
1863
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1453
        return self._real_repository.check(revision_ids=revision_ids)
1864
1454
 
1865
1455
    def copy_content_into(self, destination, revision_id=None):
1866
1456
        self._ensure_real()
1884
1474
            tmpdir = osutils.mkdtemp()
1885
1475
            try:
1886
1476
                _extract_tar(tar, tmpdir)
1887
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1477
                tmp_bzrdir = BzrDir.open(tmpdir)
1888
1478
                tmp_repo = tmp_bzrdir.open_repository()
1889
1479
                tmp_repo.copy_content_into(destination, revision_id)
1890
1480
            finally:
1906
1496
        return self._real_repository.inventories
1907
1497
 
1908
1498
    @needs_write_lock
1909
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1499
    def pack(self, hint=None):
1910
1500
        """Compress the data within the repository.
1911
1501
 
1912
1502
        This is not currently implemented within the smart server.
1913
1503
        """
1914
1504
        self._ensure_real()
1915
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1505
        return self._real_repository.pack(hint=hint)
1916
1506
 
1917
1507
    @property
1918
1508
    def revisions(self):
1975
1565
    def supports_rich_root(self):
1976
1566
        return self._format.rich_root_data
1977
1567
 
1978
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1979
1568
    def iter_reverse_revision_history(self, revision_id):
1980
1569
        self._ensure_real()
1981
1570
        return self._real_repository.iter_reverse_revision_history(revision_id)
2002
1591
        return self._real_repository.item_keys_introduced_by(revision_ids,
2003
1592
            _files_pb=_files_pb)
2004
1593
 
2005
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2006
 
        self._ensure_real()
2007
 
        return self._real_repository._find_inconsistent_revision_parents(
2008
 
            revisions_iterator)
 
1594
    def revision_graph_can_have_wrong_parents(self):
 
1595
        # The answer depends on the remote repo format.
 
1596
        self._ensure_real()
 
1597
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1598
 
 
1599
    def _find_inconsistent_revision_parents(self):
 
1600
        self._ensure_real()
 
1601
        return self._real_repository._find_inconsistent_revision_parents()
2009
1602
 
2010
1603
    def _check_for_inconsistent_revision_parents(self):
2011
1604
        self._ensure_real()
2015
1608
        providers = [self._unstacked_provider]
2016
1609
        if other is not None:
2017
1610
            providers.insert(0, other)
2018
 
        return graph.StackedParentsProvider(_LazyListJoin(
2019
 
            providers, self._fallback_repositories))
 
1611
        providers.extend(r._make_parents_provider() for r in
 
1612
                         self._fallback_repositories)
 
1613
        return graph.StackedParentsProvider(providers)
2020
1614
 
2021
1615
    def _serialise_search_recipe(self, recipe):
2022
1616
        """Serialise a graph search recipe.
2030
1624
        return '\n'.join((start_keys, stop_keys, count))
2031
1625
 
2032
1626
    def _serialise_search_result(self, search_result):
2033
 
        parts = search_result.get_network_struct()
 
1627
        if isinstance(search_result, graph.PendingAncestryResult):
 
1628
            parts = ['ancestry-of']
 
1629
            parts.extend(search_result.heads)
 
1630
        else:
 
1631
            recipe = search_result.get_recipe()
 
1632
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
2034
1633
        return '\n'.join(parts)
2035
1634
 
2036
1635
    def autopack(self):
2046
1645
            raise errors.UnexpectedSmartServerResponse(response)
2047
1646
 
2048
1647
 
2049
 
class RemoteStreamSink(vf_repository.StreamSink):
 
1648
class RemoteStreamSink(repository.StreamSink):
2050
1649
 
2051
1650
    def _insert_real(self, stream, src_format, resume_tokens):
2052
1651
        self.target_repo._ensure_real()
2059
1658
    def insert_stream(self, stream, src_format, resume_tokens):
2060
1659
        target = self.target_repo
2061
1660
        target._unstacked_provider.missing_keys.clear()
2062
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2063
1661
        if target._lock_token:
2064
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2065
 
            lock_args = (target._lock_token or '',)
 
1662
            verb = 'Repository.insert_stream_locked'
 
1663
            extra_args = (target._lock_token or '',)
 
1664
            required_version = (1, 14)
2066
1665
        else:
2067
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
2068
 
            lock_args = ()
 
1666
            verb = 'Repository.insert_stream'
 
1667
            extra_args = ()
 
1668
            required_version = (1, 13)
2069
1669
        client = target._client
2070
1670
        medium = client._medium
 
1671
        if medium._is_remote_before(required_version):
 
1672
            # No possible way this can work.
 
1673
            return self._insert_real(stream, src_format, resume_tokens)
2071
1674
        path = target.bzrdir._path_for_remote_call(client)
2072
 
        # Probe for the verb to use with an empty stream before sending the
2073
 
        # real stream to it.  We do this both to avoid the risk of sending a
2074
 
        # large request that is then rejected, and because we don't want to
2075
 
        # implement a way to buffer, rewind, or restart the stream.
2076
 
        found_verb = False
2077
 
        for verb, required_version in candidate_calls:
2078
 
            if medium._is_remote_before(required_version):
2079
 
                continue
2080
 
            if resume_tokens:
2081
 
                # We've already done the probing (and set _is_remote_before) on
2082
 
                # a previous insert.
2083
 
                found_verb = True
2084
 
                break
 
1675
        if not resume_tokens:
 
1676
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1677
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1678
            # fallback to the _real_repositories sink *with a partial stream*.
 
1679
            # Thats bad because we insert less data than bzr expected. To avoid
 
1680
            # this we do a trial push to make sure the verb is accessible, and
 
1681
            # do not fallback when actually pushing the stream. A cleanup patch
 
1682
            # is going to look at rewinding/restarting the stream/partial
 
1683
            # buffering etc.
2085
1684
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2086
1685
            try:
2087
1686
                response = client.call_with_body_stream(
2088
 
                    (verb, path, '') + lock_args, byte_stream)
 
1687
                    (verb, path, '') + extra_args, byte_stream)
2089
1688
            except errors.UnknownSmartMethod:
2090
1689
                medium._remember_remote_is_before(required_version)
2091
 
            else:
2092
 
                found_verb = True
2093
 
                break
2094
 
        if not found_verb:
2095
 
            # Have to use VFS.
2096
 
            return self._insert_real(stream, src_format, resume_tokens)
2097
 
        self._last_inv_record = None
2098
 
        self._last_substream = None
2099
 
        if required_version < (1, 19):
2100
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
2101
 
            # make sure we don't send any.  If the stream contains inventory
2102
 
            # deltas we'll interrupt the smart insert_stream request and
2103
 
            # fallback to VFS.
2104
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1690
                return self._insert_real(stream, src_format, resume_tokens)
2105
1691
        byte_stream = smart_repo._stream_to_byte_stream(
2106
1692
            stream, src_format)
2107
1693
        resume_tokens = ' '.join(resume_tokens)
2108
1694
        response = client.call_with_body_stream(
2109
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1695
            (verb, path, resume_tokens) + extra_args, byte_stream)
2110
1696
        if response[0][0] not in ('ok', 'missing-basis'):
2111
1697
            raise errors.UnexpectedSmartServerResponse(response)
2112
 
        if self._last_substream is not None:
2113
 
            # The stream included an inventory-delta record, but the remote
2114
 
            # side isn't new enough to support them.  So we need to send the
2115
 
            # rest of the stream via VFS.
2116
 
            self.target_repo.refresh_data()
2117
 
            return self._resume_stream_with_vfs(response, src_format)
2118
1698
        if response[0][0] == 'missing-basis':
2119
1699
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2120
1700
            resume_tokens = tokens
2123
1703
            self.target_repo.refresh_data()
2124
1704
            return [], set()
2125
1705
 
2126
 
    def _resume_stream_with_vfs(self, response, src_format):
2127
 
        """Resume sending a stream via VFS, first resending the record and
2128
 
        substream that couldn't be sent via an insert_stream verb.
2129
 
        """
2130
 
        if response[0][0] == 'missing-basis':
2131
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2132
 
            # Ignore missing_keys, we haven't finished inserting yet
2133
 
        else:
2134
 
            tokens = []
2135
 
        def resume_substream():
2136
 
            # Yield the substream that was interrupted.
2137
 
            for record in self._last_substream:
2138
 
                yield record
2139
 
            self._last_substream = None
2140
 
        def resume_stream():
2141
 
            # Finish sending the interrupted substream
2142
 
            yield ('inventory-deltas', resume_substream())
2143
 
            # Then simply continue sending the rest of the stream.
2144
 
            for substream_kind, substream in self._last_stream:
2145
 
                yield substream_kind, substream
2146
 
        return self._insert_real(resume_stream(), src_format, tokens)
2147
 
 
2148
 
    def _stop_stream_if_inventory_delta(self, stream):
2149
 
        """Normally this just lets the original stream pass-through unchanged.
2150
 
 
2151
 
        However if any 'inventory-deltas' substream occurs it will stop
2152
 
        streaming, and store the interrupted substream and stream in
2153
 
        self._last_substream and self._last_stream so that the stream can be
2154
 
        resumed by _resume_stream_with_vfs.
2155
 
        """
2156
 
 
2157
 
        stream_iter = iter(stream)
2158
 
        for substream_kind, substream in stream_iter:
2159
 
            if substream_kind == 'inventory-deltas':
2160
 
                self._last_substream = substream
2161
 
                self._last_stream = stream_iter
2162
 
                return
2163
 
            else:
2164
 
                yield substream_kind, substream
2165
 
 
2166
 
 
2167
 
class RemoteStreamSource(vf_repository.StreamSource):
 
1706
 
 
1707
class RemoteStreamSource(repository.StreamSource):
2168
1708
    """Stream data from a remote server."""
2169
1709
 
2170
1710
    def get_stream(self, search):
2171
1711
        if (self.from_repository._fallback_repositories and
2172
1712
            self.to_format._fetch_order == 'topological'):
2173
1713
            return self._real_stream(self.from_repository, search)
2174
 
        sources = []
2175
 
        seen = set()
2176
 
        repos = [self.from_repository]
2177
 
        while repos:
2178
 
            repo = repos.pop(0)
2179
 
            if repo in seen:
2180
 
                continue
2181
 
            seen.add(repo)
2182
 
            repos.extend(repo._fallback_repositories)
2183
 
            sources.append(repo)
2184
 
        return self.missing_parents_chain(search, sources)
2185
 
 
2186
 
    def get_stream_for_missing_keys(self, missing_keys):
2187
 
        self.from_repository._ensure_real()
2188
 
        real_repo = self.from_repository._real_repository
2189
 
        real_source = real_repo._get_source(self.to_format)
2190
 
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1714
        return self.missing_parents_chain(search, [self.from_repository] +
 
1715
            self.from_repository._fallback_repositories)
2191
1716
 
2192
1717
    def _real_stream(self, repo, search):
2193
1718
        """Get a stream for search from repo.
2200
1725
        """
2201
1726
        source = repo._get_source(self.to_format)
2202
1727
        if isinstance(source, RemoteStreamSource):
2203
 
            repo._ensure_real()
2204
 
            source = repo._real_repository._get_source(self.to_format)
 
1728
            return repository.StreamSource.get_stream(source, search)
2205
1729
        return source.get_stream(search)
2206
1730
 
2207
1731
    def _get_stream(self, repo, search):
2224
1748
            return self._real_stream(repo, search)
2225
1749
        client = repo._client
2226
1750
        medium = client._medium
 
1751
        if medium._is_remote_before((1, 13)):
 
1752
            # streaming was added in 1.13
 
1753
            return self._real_stream(repo, search)
2227
1754
        path = repo.bzrdir._path_for_remote_call(client)
2228
 
        search_bytes = repo._serialise_search_result(search)
2229
 
        args = (path, self.to_format.network_name())
2230
 
        candidate_verbs = [
2231
 
            ('Repository.get_stream_1.19', (1, 19)),
2232
 
            ('Repository.get_stream', (1, 13))]
2233
 
 
2234
 
        found_verb = False
2235
 
        for verb, version in candidate_verbs:
2236
 
            if medium._is_remote_before(version):
2237
 
                continue
2238
 
            try:
2239
 
                response = repo._call_with_body_bytes_expecting_body(
2240
 
                    verb, args, search_bytes)
2241
 
            except errors.UnknownSmartMethod:
2242
 
                medium._remember_remote_is_before(version)
2243
 
            except errors.UnknownErrorFromSmartServer, e:
2244
 
                if isinstance(search, graph.EverythingResult):
2245
 
                    error_verb = e.error_from_smart_server.error_verb
2246
 
                    if error_verb == 'BadSearch':
2247
 
                        # Pre-2.4 servers don't support this sort of search.
2248
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
2249
 
                        # good idea in general?  It might provide a little bit
2250
 
                        # of protection against client-side bugs.
2251
 
                        medium._remember_remote_is_before((2, 4))
2252
 
                        break
2253
 
                raise
2254
 
            else:
2255
 
                response_tuple, response_handler = response
2256
 
                found_verb = True
2257
 
                break
2258
 
        if not found_verb:
 
1755
        try:
 
1756
            search_bytes = repo._serialise_search_result(search)
 
1757
            response = repo._call_with_body_bytes_expecting_body(
 
1758
                'Repository.get_stream',
 
1759
                (path, self.to_format.network_name()), search_bytes)
 
1760
            response_tuple, response_handler = response
 
1761
        except errors.UnknownSmartMethod:
 
1762
            medium._remember_remote_is_before((1,13))
2259
1763
            return self._real_stream(repo, search)
2260
1764
        if response_tuple[0] != 'ok':
2261
1765
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2262
1766
        byte_stream = response_handler.read_streamed_body()
2263
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2264
 
            self._record_counter)
 
1767
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
2265
1768
        if src_format.network_name() != repo._format.network_name():
2266
1769
            raise AssertionError(
2267
1770
                "Mismatched RemoteRepository and stream src %r, %r" % (
2274
1777
        :param search: The overall search to satisfy with streams.
2275
1778
        :param sources: A list of Repository objects to query.
2276
1779
        """
2277
 
        self.from_serialiser = self.from_repository._format._serializer
 
1780
        self.serialiser = self.to_format._serializer
2278
1781
        self.seen_revs = set()
2279
1782
        self.referenced_revs = set()
2280
1783
        # If there are heads in the search, or the key count is > 0, we are not
2297
1800
    def missing_parents_rev_handler(self, substream):
2298
1801
        for content in substream:
2299
1802
            revision_bytes = content.get_bytes_as('fulltext')
2300
 
            revision = self.from_serialiser.read_revision_from_string(
2301
 
                revision_bytes)
 
1803
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2302
1804
            self.seen_revs.add(content.key[-1])
2303
1805
            self.referenced_revs.update(revision.parent_ids)
2304
1806
            yield content
2343
1845
                self._network_name)
2344
1846
 
2345
1847
    def get_format_description(self):
2346
 
        self._ensure_real()
2347
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1848
        return 'Remote BZR Branch'
2348
1849
 
2349
1850
    def network_name(self):
2350
1851
        return self._network_name
2351
1852
 
2352
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2353
 
        return a_bzrdir.open_branch(name=name, 
2354
 
            ignore_fallbacks=ignore_fallbacks)
 
1853
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1854
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2355
1855
 
2356
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1856
    def _vfs_initialize(self, a_bzrdir):
2357
1857
        # Initialisation when using a local bzrdir object, or a non-vfs init
2358
1858
        # method is not available on the server.
2359
1859
        # self._custom_format is always set - the start of initialize ensures
2360
1860
        # that.
2361
1861
        if isinstance(a_bzrdir, RemoteBzrDir):
2362
1862
            a_bzrdir._ensure_real()
2363
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2364
 
                name)
 
1863
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2365
1864
        else:
2366
1865
            # We assume the bzrdir is parameterised; it may not be.
2367
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1866
            result = self._custom_format.initialize(a_bzrdir)
2368
1867
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2369
1868
            not isinstance(result, RemoteBranch)):
2370
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2371
 
                                  name=name)
 
1869
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2372
1870
        return result
2373
1871
 
2374
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1872
    def initialize(self, a_bzrdir):
2375
1873
        # 1) get the network name to use.
2376
1874
        if self._custom_format:
2377
1875
            network_name = self._custom_format.network_name()
2378
1876
        else:
2379
1877
            # Select the current bzrlib default and ask for that.
2380
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
1878
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
2381
1879
            reference_format = reference_bzrdir_format.get_branch_format()
2382
1880
            self._custom_format = reference_format
2383
1881
            network_name = reference_format.network_name()
2384
1882
        # Being asked to create on a non RemoteBzrDir:
2385
1883
        if not isinstance(a_bzrdir, RemoteBzrDir):
2386
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1884
            return self._vfs_initialize(a_bzrdir)
2387
1885
        medium = a_bzrdir._client._medium
2388
1886
        if medium._is_remote_before((1, 13)):
2389
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1887
            return self._vfs_initialize(a_bzrdir)
2390
1888
        # Creating on a remote bzr dir.
2391
1889
        # 2) try direct creation via RPC
2392
1890
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2393
 
        if name is not None:
2394
 
            # XXX JRV20100304: Support creating colocated branches
2395
 
            raise errors.NoColocatedBranchSupport(self)
2396
1891
        verb = 'BzrDir.create_branch'
2397
1892
        try:
2398
1893
            response = a_bzrdir._call(verb, path, network_name)
2399
1894
        except errors.UnknownSmartMethod:
2400
1895
            # Fallback - use vfs methods
2401
1896
            medium._remember_remote_is_before((1, 13))
2402
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1897
            return self._vfs_initialize(a_bzrdir)
2403
1898
        if response[0] != 'ok':
2404
1899
            raise errors.UnexpectedSmartServerResponse(response)
2405
1900
        # Turn the response into a RemoteRepository object.
2406
1901
        format = RemoteBranchFormat(network_name=response[1])
2407
1902
        repo_format = response_tuple_to_repo_format(response[3:])
2408
 
        repo_path = response[2]
2409
 
        if repository is not None:
2410
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2411
 
            url_diff = urlutils.relative_url(repository.user_url,
2412
 
                    remote_repo_url)
2413
 
            if url_diff != '.':
2414
 
                raise AssertionError(
2415
 
                    'repository.user_url %r does not match URL from server '
2416
 
                    'response (%r + %r)'
2417
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
2418
 
            remote_repo = repository
 
1903
        if response[2] == '':
 
1904
            repo_bzrdir = a_bzrdir
2419
1905
        else:
2420
 
            if repo_path == '':
2421
 
                repo_bzrdir = a_bzrdir
2422
 
            else:
2423
 
                repo_bzrdir = RemoteBzrDir(
2424
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2425
 
                    a_bzrdir._client)
2426
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
1906
            repo_bzrdir = RemoteBzrDir(
 
1907
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
1908
                a_bzrdir._client)
 
1909
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2427
1910
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2428
 
            format=format, setup_stacking=False, name=name)
 
1911
            format=format, setup_stacking=False)
2429
1912
        # XXX: We know this is a new branch, so it must have revno 0, revid
2430
1913
        # NULL_REVISION. Creating the branch locked would make this be unable
2431
1914
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2450
1933
        self._ensure_real()
2451
1934
        return self._custom_format.supports_set_append_revisions_only()
2452
1935
 
2453
 
    def _use_default_local_heads_to_fetch(self):
2454
 
        # If the branch format is a metadir format *and* its heads_to_fetch
2455
 
        # implementation is not overridden vs the base class, we can use the
2456
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
2457
 
        # usually cheaper in terms of net round trips, as the last-revision and
2458
 
        # tags info fetched is cached and would be fetched anyway.
2459
 
        self._ensure_real()
2460
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
2461
 
            branch_class = self._custom_format._branch_class()
2462
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2463
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2464
 
                return True
2465
 
        return False
2466
1936
 
2467
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1937
class RemoteBranch(branch.Branch, _RpcHelper):
2468
1938
    """Branch stored on a server accessed by HPSS RPC.
2469
1939
 
2470
1940
    At the moment most operations are mapped down to simple file operations.
2471
1941
    """
2472
1942
 
2473
1943
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2474
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1944
        _client=None, format=None, setup_stacking=True):
2475
1945
        """Create a RemoteBranch instance.
2476
1946
 
2477
1947
        :param real_branch: An optional local implementation of the branch
2483
1953
        :param setup_stacking: If True make an RPC call to determine the
2484
1954
            stacked (or not) status of the branch. If False assume the branch
2485
1955
            is not stacked.
2486
 
        :param name: Colocated branch name
2487
1956
        """
2488
1957
        # We intentionally don't call the parent class's __init__, because it
2489
1958
        # will try to assign to self.tags, which is a property in this subclass.
2508
1977
            self._real_branch = None
2509
1978
        # Fill out expected attributes of branch for bzrlib API users.
2510
1979
        self._clear_cached_state()
2511
 
        # TODO: deprecate self.base in favor of user_url
2512
 
        self.base = self.bzrdir.user_url
2513
 
        self._name = name
 
1980
        self.base = self.bzrdir.root_transport.base
2514
1981
        self._control_files = None
2515
1982
        self._lock_mode = None
2516
1983
        self._lock_token = None
2527
1994
                    self._real_branch._format.network_name()
2528
1995
        else:
2529
1996
            self._format = format
2530
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2531
 
        # branch.open_branch method.
2532
 
        self._real_ignore_fallbacks = not setup_stacking
2533
1997
        if not self._format._network_name:
2534
1998
            # Did not get from open_branchV2 - old server.
2535
1999
            self._ensure_real()
2580
2044
                raise AssertionError('smart server vfs must be enabled '
2581
2045
                    'to use vfs implementation')
2582
2046
            self.bzrdir._ensure_real()
2583
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2584
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
2047
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2585
2048
            if self.repository._real_repository is None:
2586
2049
                # Give the remote repository the matching real repo.
2587
2050
                real_repo = self._real_branch.repository
2667
2130
            self._is_stacked = False
2668
2131
        else:
2669
2132
            self._is_stacked = True
2670
 
 
 
2133
        
2671
2134
    def _vfs_get_tags_bytes(self):
2672
2135
        self._ensure_real()
2673
2136
        return self._real_branch._get_tags_bytes()
2674
2137
 
2675
 
    @needs_read_lock
2676
2138
    def _get_tags_bytes(self):
2677
 
        if self._tags_bytes is None:
2678
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
2679
 
        return self._tags_bytes
2680
 
 
2681
 
    def _get_tags_bytes_via_hpss(self):
2682
2139
        medium = self._client._medium
2683
2140
        if medium._is_remote_before((1, 13)):
2684
2141
            return self._vfs_get_tags_bytes()
2689
2146
            return self._vfs_get_tags_bytes()
2690
2147
        return response[0]
2691
2148
 
2692
 
    def _vfs_set_tags_bytes(self, bytes):
2693
 
        self._ensure_real()
2694
 
        return self._real_branch._set_tags_bytes(bytes)
2695
 
 
2696
 
    def _set_tags_bytes(self, bytes):
2697
 
        if self.is_locked():
2698
 
            self._tags_bytes = bytes
2699
 
        medium = self._client._medium
2700
 
        if medium._is_remote_before((1, 18)):
2701
 
            self._vfs_set_tags_bytes(bytes)
2702
 
            return
2703
 
        try:
2704
 
            args = (
2705
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2706
 
            response = self._call_with_body_bytes(
2707
 
                'Branch.set_tags_bytes', args, bytes)
2708
 
        except errors.UnknownSmartMethod:
2709
 
            medium._remember_remote_is_before((1, 18))
2710
 
            self._vfs_set_tags_bytes(bytes)
2711
 
 
2712
2149
    def lock_read(self):
2713
 
        """Lock the branch for read operations.
2714
 
 
2715
 
        :return: A bzrlib.lock.LogicalLockResult.
2716
 
        """
2717
2150
        self.repository.lock_read()
2718
2151
        if not self._lock_mode:
2719
 
            self._note_lock('r')
2720
2152
            self._lock_mode = 'r'
2721
2153
            self._lock_count = 1
2722
2154
            if self._real_branch is not None:
2723
2155
                self._real_branch.lock_read()
2724
2156
        else:
2725
2157
            self._lock_count += 1
2726
 
        return lock.LogicalLockResult(self.unlock)
2727
2158
 
2728
2159
    def _remote_lock_write(self, token):
2729
2160
        if token is None:
2730
2161
            branch_token = repo_token = ''
2731
2162
        else:
2732
2163
            branch_token = token
2733
 
            repo_token = self.repository.lock_write().repository_token
 
2164
            repo_token = self.repository.lock_write()
2734
2165
            self.repository.unlock()
2735
2166
        err_context = {'token': token}
2736
 
        try:
2737
 
            response = self._call(
2738
 
                'Branch.lock_write', self._remote_path(), branch_token,
2739
 
                repo_token or '', **err_context)
2740
 
        except errors.LockContention, e:
2741
 
            # The LockContention from the server doesn't have any
2742
 
            # information about the lock_url. We re-raise LockContention
2743
 
            # with valid lock_url.
2744
 
            raise errors.LockContention('(remote lock)',
2745
 
                self.repository.base.split('.bzr/')[0])
 
2167
        response = self._call(
 
2168
            'Branch.lock_write', self._remote_path(), branch_token,
 
2169
            repo_token or '', **err_context)
2746
2170
        if response[0] != 'ok':
2747
2171
            raise errors.UnexpectedSmartServerResponse(response)
2748
2172
        ok, branch_token, repo_token = response
2750
2174
 
2751
2175
    def lock_write(self, token=None):
2752
2176
        if not self._lock_mode:
2753
 
            self._note_lock('w')
2754
2177
            # Lock the branch and repo in one remote call.
2755
2178
            remote_tokens = self._remote_lock_write(token)
2756
2179
            self._lock_token, self._repo_lock_token = remote_tokens
2769
2192
            self._lock_mode = 'w'
2770
2193
            self._lock_count = 1
2771
2194
        elif self._lock_mode == 'r':
2772
 
            raise errors.ReadOnlyError(self)
 
2195
            raise errors.ReadOnlyTransaction
2773
2196
        else:
2774
2197
            if token is not None:
2775
2198
                # A token was given to lock_write, and we're relocking, so
2780
2203
            self._lock_count += 1
2781
2204
            # Re-lock the repository too.
2782
2205
            self.repository.lock_write(self._repo_lock_token)
2783
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2206
        return self._lock_token or None
 
2207
 
 
2208
    def _set_tags_bytes(self, bytes):
 
2209
        self._ensure_real()
 
2210
        return self._real_branch._set_tags_bytes(bytes)
2784
2211
 
2785
2212
    def _unlock(self, branch_token, repo_token):
2786
2213
        err_context = {'token': str((branch_token, repo_token))}
2791
2218
            return
2792
2219
        raise errors.UnexpectedSmartServerResponse(response)
2793
2220
 
2794
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2795
2221
    def unlock(self):
2796
2222
        try:
2797
2223
            self._lock_count -= 1
2837
2263
            raise NotImplementedError(self.dont_leave_lock_in_place)
2838
2264
        self._leave_lock = False
2839
2265
 
2840
 
    @needs_read_lock
2841
2266
    def get_rev_id(self, revno, history=None):
2842
2267
        if revno == 0:
2843
2268
            return _mod_revision.NULL_REVISION
2855
2280
            missing_parent = parent_map[missing_parent]
2856
2281
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2857
2282
 
2858
 
    def _read_last_revision_info(self):
 
2283
    def _last_revision_info(self):
2859
2284
        response = self._call('Branch.last_revision_info', self._remote_path())
2860
2285
        if response[0] != 'ok':
2861
2286
            raise SmartProtocolError('unexpected response code %s' % (response,))
2924
2349
            raise errors.UnexpectedSmartServerResponse(response)
2925
2350
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2926
2351
 
2927
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2928
2352
    @needs_write_lock
2929
2353
    def set_revision_history(self, rev_history):
2930
 
        """See Branch.set_revision_history."""
2931
 
        self._set_revision_history(rev_history)
2932
 
 
2933
 
    @needs_write_lock
2934
 
    def _set_revision_history(self, rev_history):
2935
2354
        # Send just the tip revision of the history; the server will generate
2936
2355
        # the full history from that.  If the revision doesn't exist in this
2937
2356
        # branch, NoSuchRevision will be raised.
2995
2414
            _override_hook_target=self, **kwargs)
2996
2415
 
2997
2416
    @needs_read_lock
2998
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
2417
    def push(self, target, overwrite=False, stop_revision=None):
2999
2418
        self._ensure_real()
3000
2419
        return self._real_branch.push(
3001
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
2420
            target, overwrite=overwrite, stop_revision=stop_revision,
3002
2421
            _override_hook_source_branch=self)
3003
2422
 
3004
2423
    def is_locked(self):
3014
2433
        # XXX: These should be returned by the set_last_revision_info verb
3015
2434
        old_revno, old_revid = self.last_revision_info()
3016
2435
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3017
 
        if not revision_id or not isinstance(revision_id, basestring):
3018
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2436
        revision_id = ensure_null(revision_id)
3019
2437
        try:
3020
2438
            response = self._call('Branch.set_last_revision_info',
3021
2439
                self._remote_path(), self._lock_token, self._repo_lock_token,
3050
2468
            except errors.UnknownSmartMethod:
3051
2469
                medium._remember_remote_is_before((1, 6))
3052
2470
        self._clear_cached_state_of_remote_branch_only()
3053
 
        self._set_revision_history(self._lefthand_history(revision_id,
 
2471
        self.set_revision_history(self._lefthand_history(revision_id,
3054
2472
            last_rev=last_rev,other_branch=other_branch))
3055
2473
 
3056
2474
    def set_push_location(self, location):
3057
2475
        self._ensure_real()
3058
2476
        return self._real_branch.set_push_location(location)
3059
2477
 
3060
 
    def heads_to_fetch(self):
3061
 
        if self._format._use_default_local_heads_to_fetch():
3062
 
            # We recognise this format, and its heads-to-fetch implementation
3063
 
            # is the default one (tip + tags).  In this case it's cheaper to
3064
 
            # just use the default implementation rather than a special RPC as
3065
 
            # the tip and tags data is cached.
3066
 
            return branch.Branch.heads_to_fetch(self)
3067
 
        medium = self._client._medium
3068
 
        if medium._is_remote_before((2, 4)):
3069
 
            return self._vfs_heads_to_fetch()
3070
 
        try:
3071
 
            return self._rpc_heads_to_fetch()
3072
 
        except errors.UnknownSmartMethod:
3073
 
            medium._remember_remote_is_before((2, 4))
3074
 
            return self._vfs_heads_to_fetch()
3075
 
 
3076
 
    def _rpc_heads_to_fetch(self):
3077
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3078
 
        if len(response) != 2:
3079
 
            raise errors.UnexpectedSmartServerResponse(response)
3080
 
        must_fetch, if_present_fetch = response
3081
 
        return set(must_fetch), set(if_present_fetch)
3082
 
 
3083
 
    def _vfs_heads_to_fetch(self):
3084
 
        self._ensure_real()
3085
 
        return self._real_branch.heads_to_fetch()
3086
 
 
3087
2478
 
3088
2479
class RemoteConfig(object):
3089
2480
    """A Config that reads and writes from smart verbs.
3103
2494
        """
3104
2495
        try:
3105
2496
            configobj = self._get_configobj()
3106
 
            section_obj = None
3107
2497
            if section is None:
3108
2498
                section_obj = configobj
3109
2499
            else:
3110
2500
                try:
3111
2501
                    section_obj = configobj[section]
3112
2502
                except KeyError:
3113
 
                    pass
3114
 
            if section_obj is None:
3115
 
                value = default
3116
 
            else:
3117
 
                value = section_obj.get(name, default)
 
2503
                    return default
 
2504
            return section_obj.get(name, default)
3118
2505
        except errors.UnknownSmartMethod:
3119
 
            value = self._vfs_get_option(name, section, default)
3120
 
        for hook in config.OldConfigHooks['get']:
3121
 
            hook(self, name, value)
3122
 
        return value
 
2506
            return self._vfs_get_option(name, section, default)
3123
2507
 
3124
2508
    def _response_to_configobj(self, response):
3125
2509
        if len(response[0]) and response[0][0] != 'ok':
3126
2510
            raise errors.UnexpectedSmartServerResponse(response)
3127
2511
        lines = response[1].read_body_bytes().splitlines()
3128
 
        conf = config.ConfigObj(lines, encoding='utf-8')
3129
 
        for hook in config.OldConfigHooks['load']:
3130
 
            hook(self)
3131
 
        return conf
 
2512
        return config.ConfigObj(lines, encoding='utf-8')
3132
2513
 
3133
2514
 
3134
2515
class RemoteBranchConfig(RemoteConfig):
3153
2534
        medium = self._branch._client._medium
3154
2535
        if medium._is_remote_before((1, 14)):
3155
2536
            return self._vfs_set_option(value, name, section)
3156
 
        if isinstance(value, dict):
3157
 
            if medium._is_remote_before((2, 2)):
3158
 
                return self._vfs_set_option(value, name, section)
3159
 
            return self._set_config_option_dict(value, name, section)
3160
 
        else:
3161
 
            return self._set_config_option(value, name, section)
3162
 
 
3163
 
    def _set_config_option(self, value, name, section):
3164
2537
        try:
3165
2538
            path = self._branch._remote_path()
3166
2539
            response = self._branch._client.call('Branch.set_config_option',
3167
2540
                path, self._branch._lock_token, self._branch._repo_lock_token,
3168
2541
                value.encode('utf8'), name, section or '')
3169
2542
        except errors.UnknownSmartMethod:
3170
 
            medium = self._branch._client._medium
3171
2543
            medium._remember_remote_is_before((1, 14))
3172
2544
            return self._vfs_set_option(value, name, section)
3173
2545
        if response != ():
3174
2546
            raise errors.UnexpectedSmartServerResponse(response)
3175
2547
 
3176
 
    def _serialize_option_dict(self, option_dict):
3177
 
        utf8_dict = {}
3178
 
        for key, value in option_dict.items():
3179
 
            if isinstance(key, unicode):
3180
 
                key = key.encode('utf8')
3181
 
            if isinstance(value, unicode):
3182
 
                value = value.encode('utf8')
3183
 
            utf8_dict[key] = value
3184
 
        return bencode.bencode(utf8_dict)
3185
 
 
3186
 
    def _set_config_option_dict(self, value, name, section):
3187
 
        try:
3188
 
            path = self._branch._remote_path()
3189
 
            serialised_dict = self._serialize_option_dict(value)
3190
 
            response = self._branch._client.call(
3191
 
                'Branch.set_config_option_dict',
3192
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
3193
 
                serialised_dict, name, section or '')
3194
 
        except errors.UnknownSmartMethod:
3195
 
            medium = self._branch._client._medium
3196
 
            medium._remember_remote_is_before((2, 2))
3197
 
            return self._vfs_set_option(value, name, section)
3198
 
        if response != ():
3199
 
            raise errors.UnexpectedSmartServerResponse(response)
3200
 
 
3201
2548
    def _real_object(self):
3202
2549
        self._branch._ensure_real()
3203
2550
        return self._branch._real_branch
3290
2637
        raise NoSuchRevision(find('branch'), err.error_args[0])
3291
2638
    elif err.error_verb == 'nosuchrevision':
3292
2639
        raise NoSuchRevision(find('repository'), err.error_args[0])
3293
 
    elif err.error_verb == 'nobranch':
3294
 
        if len(err.error_args) >= 1:
3295
 
            extra = err.error_args[0]
3296
 
        else:
3297
 
            extra = None
3298
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3299
 
            detail=extra)
 
2640
    elif err.error_tuple == ('nobranch',):
 
2641
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
3300
2642
    elif err.error_verb == 'norepository':
3301
2643
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2644
    elif err.error_verb == 'LockContention':
 
2645
        raise errors.LockContention('(remote lock)')
3302
2646
    elif err.error_verb == 'UnlockableTransport':
3303
2647
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2648
    elif err.error_verb == 'LockFailed':
 
2649
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3304
2650
    elif err.error_verb == 'TokenMismatch':
3305
2651
        raise errors.TokenMismatch(find('token'), '(remote token)')
3306
2652
    elif err.error_verb == 'Diverged':
3307
2653
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2654
    elif err.error_verb == 'TipChangeRejected':
 
2655
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2656
    elif err.error_verb == 'UnstackableBranchFormat':
 
2657
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2658
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2659
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3308
2660
    elif err.error_verb == 'NotStacked':
3309
2661
        raise errors.NotStacked(branch=find('branch'))
3310
2662
    elif err.error_verb == 'PermissionDenied':
3320
2672
    elif err.error_verb == 'NoSuchFile':
3321
2673
        path = get_path()
3322
2674
        raise errors.NoSuchFile(path)
3323
 
    _translate_error_without_context(err)
3324
 
 
3325
 
 
3326
 
def _translate_error_without_context(err):
3327
 
    """Translate any ErrorFromSmartServer values that don't require context"""
3328
 
    if err.error_verb == 'IncompatibleRepositories':
3329
 
        raise errors.IncompatibleRepositories(err.error_args[0],
3330
 
            err.error_args[1], err.error_args[2])
3331
 
    elif err.error_verb == 'LockContention':
3332
 
        raise errors.LockContention('(remote lock)')
3333
 
    elif err.error_verb == 'LockFailed':
3334
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3335
 
    elif err.error_verb == 'TipChangeRejected':
3336
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3337
 
    elif err.error_verb == 'UnstackableBranchFormat':
3338
 
        raise errors.UnstackableBranchFormat(*err.error_args)
3339
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
3340
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3341
2675
    elif err.error_verb == 'FileExists':
3342
2676
        raise errors.FileExists(err.error_args[0])
3343
2677
    elif err.error_verb == 'DirectoryNotEmpty':
3362
2696
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3363
2697
    elif err.error_verb == 'ReadOnlyError':
3364
2698
        raise errors.TransportNotPossible('readonly transport')
3365
 
    elif err.error_verb == 'MemoryError':
3366
 
        raise errors.BzrError("remote server out of memory\n"
3367
 
            "Retry non-remotely, or contact the server admin for details.")
3368
2699
    raise errors.UnknownErrorFromSmartServer(err)