← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-27 08:02:52 UTC
  • mto: This revision was merged to the branch mainline in revision 4573.
  • Revision ID: andrew.bennetts@canonical.com-20090727080252-1r4s9oqwlkzgywx7
Fix trivial bug in _vfs_set_tags_bytes.

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, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
from bzrlib import (
20
20
    bencode,
21
21
    branch,
22
 
    bzrdir as _mod_bzrdir,
 
22
    bzrdir,
23
23
    config,
24
 
    controldir,
25
24
    debug,
26
25
    errors,
27
26
    graph,
28
27
    lock,
29
28
    lockdir,
30
 
    repository as _mod_repository,
 
29
    repository,
 
30
    revision,
31
31
    revision as _mod_revision,
32
 
    static_tuple,
33
32
    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
 
33
)
 
34
from bzrlib.branch import BranchReferenceFormat
 
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
37
from bzrlib.errors import (
40
38
    NoSuchRevision,
41
39
    SmartProtocolError,
42
40
    )
43
41
from bzrlib.lockable_files import LockableFiles
44
42
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
 
43
from bzrlib.revision import ensure_null, NULL_REVISION
48
44
from bzrlib.trace import mutter, note, warning
49
45
 
50
46
 
88
84
    return format
89
85
 
90
86
 
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):
 
87
# Note: RemoteBzrDirFormat is in bzrdir.py
 
88
 
 
89
class RemoteBzrDir(BzrDir, _RpcHelper):
331
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
332
91
 
333
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
92
    def __init__(self, transport, format, _client=None):
334
93
        """Construct a RemoteBzrDir.
335
94
 
336
95
        :param _client: Private parameter for testing. Disables probing and the
337
96
            use of a real bzrdir.
338
97
        """
339
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
98
        BzrDir.__init__(self, transport, format)
340
99
        # this object holds a delegated bzrdir that uses file-level operations
341
100
        # to talk to the other side
342
101
        self._real_bzrdir = None
343
 
        self._has_working_tree = None
344
102
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
103
        # create_branch for details.
346
104
        self._next_open_branch_result = None
350
108
            self._client = client._SmartClient(medium)
351
109
        else:
352
110
            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
 
111
            return
 
112
 
363
113
        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
114
        response = self._call('BzrDir.open', path)
390
115
        if response not in [('yes',), ('no',)]:
391
116
            raise errors.UnexpectedSmartServerResponse(response)
392
117
        if response == ('no',):
393
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
118
            raise errors.NotBranchError(path=transport.base)
394
119
 
395
120
    def _ensure_real(self):
396
121
        """Ensure that there is a _real_bzrdir set.
398
123
        Used before calls to self._real_bzrdir.
399
124
        """
400
125
        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(
 
126
            self._real_bzrdir = BzrDir.open_from_transport(
406
127
                self.root_transport, _server_formats=False)
407
128
            self._format._network_name = \
408
129
                self._real_bzrdir._format.network_name()
414
135
        # Prevent aliasing problems in the next_open_branch_result cache.
415
136
        # See create_branch for rationale.
416
137
        self._next_open_branch_result = None
417
 
        return _mod_bzrdir.BzrDir.break_lock(self)
 
138
        return BzrDir.break_lock(self)
418
139
 
419
140
    def _vfs_cloning_metadir(self, require_stacking=False):
420
141
        self._ensure_real()
451
172
        if len(branch_info) != 2:
452
173
            raise errors.UnexpectedSmartServerResponse(response)
453
174
        branch_ref, branch_name = branch_info
454
 
        format = controldir.network_format_registry.get(control_name)
 
175
        format = bzrdir.network_format_registry.get(control_name)
455
176
        if repo_name:
456
 
            format.repository_format = _mod_repository.network_format_registry.get(
 
177
            format.repository_format = repository.network_format_registry.get(
457
178
                repo_name)
458
179
        if branch_ref == 'ref':
459
180
            # XXX: we need possible_transports here to avoid reopening the
460
181
            # connection to the referenced location
461
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
 
182
            ref_bzrdir = BzrDir.open(branch_name)
462
183
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
184
            format.set_branch_format(branch_format)
464
185
        elif branch_ref == 'branch':
483
204
        self._ensure_real()
484
205
        self._real_bzrdir.destroy_repository()
485
206
 
486
 
    def create_branch(self, name=None, repository=None):
 
207
    def create_branch(self):
487
208
        # as per meta1 formats - just delegate to the format object which may
488
209
        # be parameterised.
489
 
        real_branch = self._format.get_branch_format().initialize(self,
490
 
            name=name, repository=repository)
 
210
        real_branch = self._format.get_branch_format().initialize(self)
491
211
        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)
 
212
            result = RemoteBranch(self, self.find_repository(), real_branch)
497
213
        else:
498
214
            result = real_branch
499
215
        # BzrDir.clone_on_transport() uses the result of create_branch but does
505
221
        self._next_open_branch_result = result
506
222
        return result
507
223
 
508
 
    def destroy_branch(self, name=None):
 
224
    def destroy_branch(self):
509
225
        """See BzrDir.destroy_branch"""
510
226
        self._ensure_real()
511
 
        self._real_bzrdir.destroy_branch(name=name)
 
227
        self._real_bzrdir.destroy_branch()
512
228
        self._next_open_branch_result = None
513
229
 
514
 
    def create_workingtree(self, revision_id=None, from_branch=None,
515
 
        accelerator_tree=None, hardlink=False):
 
230
    def create_workingtree(self, revision_id=None, from_branch=None):
516
231
        raise errors.NotLocalUrl(self.transport.base)
517
232
 
518
 
    def find_branch_format(self, name=None):
 
233
    def find_branch_format(self):
519
234
        """Find the branch 'format' for this bzrdir.
520
235
 
521
236
        This might be a synthetic object for e.g. RemoteBranch and SVN.
522
237
        """
523
 
        b = self.open_branch(name=name)
 
238
        b = self.open_branch()
524
239
        return b._format
525
240
 
526
 
    def get_branch_reference(self, name=None):
 
241
    def get_branch_reference(self):
527
242
        """See BzrDir.get_branch_reference()."""
528
 
        if name is not None:
529
 
            # XXX JRV20100304: Support opening colocated branches
530
 
            raise errors.NoColocatedBranchSupport(self)
531
243
        response = self._get_branch_reference()
532
244
        if response[0] == 'ref':
533
245
            return response[1]
537
249
    def _get_branch_reference(self):
538
250
        path = self._path_for_remote_call(self._client)
539
251
        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
 
252
        if not medium._is_remote_before((1, 13)):
548
253
            try:
549
 
                response = self._call(verb, path)
 
254
                response = self._call('BzrDir.open_branchV2', path)
 
255
                if response[0] not in ('ref', 'branch'):
 
256
                    raise errors.UnexpectedSmartServerResponse(response)
 
257
                return response
550
258
            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'):
 
259
                medium._remember_remote_is_before((1, 13))
 
260
        response = self._call('BzrDir.open_branch', path)
 
261
        if response[0] != 'ok':
564
262
            raise errors.UnexpectedSmartServerResponse(response)
565
 
        return response
 
263
        if response[1] != '':
 
264
            return ('ref', response[1])
 
265
        else:
 
266
            return ('branch', '')
566
267
 
567
 
    def _get_tree_branch(self, name=None):
 
268
    def _get_tree_branch(self):
568
269
        """See BzrDir._get_tree_branch()."""
569
 
        return None, self.open_branch(name=name)
 
270
        return None, self.open_branch()
570
271
 
571
 
    def open_branch(self, name=None, unsupported=False,
572
 
                    ignore_fallbacks=False):
573
 
        if unsupported:
 
272
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
 
273
        if _unsupported:
574
274
            raise NotImplementedError('unsupported flag support not implemented yet.')
575
275
        if self._next_open_branch_result is not None:
576
276
            # See create_branch for details.
581
281
        if response[0] == 'ref':
582
282
            # a branch reference, use the existing BranchReference logic.
583
283
            format = BranchReferenceFormat()
584
 
            return format.open(self, name=name, _found=True,
585
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
284
            return format.open(self, _found=True, location=response[1],
 
285
                ignore_fallbacks=ignore_fallbacks)
586
286
        branch_format_name = response[1]
587
287
        if not branch_format_name:
588
288
            branch_format_name = None
589
289
        format = RemoteBranchFormat(network_name=branch_format_name)
590
290
        return RemoteBranch(self, self.find_repository(), format=format,
591
 
            setup_stacking=not ignore_fallbacks, name=name)
 
291
            setup_stacking=not ignore_fallbacks)
592
292
 
593
293
    def _open_repo_v1(self, path):
594
294
        verb = 'BzrDir.find_repository'
655
355
        else:
656
356
            raise errors.NoRepositoryPresent(self)
657
357
 
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
358
    def open_workingtree(self, recommend_upgrade=True):
665
 
        if self.has_workingtree():
 
359
        self._ensure_real()
 
360
        if self._real_bzrdir.has_workingtree():
666
361
            raise errors.NotLocalUrl(self.root_transport)
667
362
        else:
668
363
            raise errors.NoWorkingTree(self.root_transport.base)
669
364
 
670
365
    def _path_for_remote_call(self, client):
671
366
        """Return the path to be used for this bzrdir in a remote call."""
672
 
        return urlutils.split_segment_parameters_raw(
673
 
            client.remote_path_from_transport(self.root_transport))[0]
 
367
        return client.remote_path_from_transport(self.root_transport)
674
368
 
675
 
    def get_branch_transport(self, branch_format, name=None):
 
369
    def get_branch_transport(self, branch_format):
676
370
        self._ensure_real()
677
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
371
        return self._real_bzrdir.get_branch_transport(branch_format)
678
372
 
679
373
    def get_repository_transport(self, repository_format):
680
374
        self._ensure_real()
688
382
        """Upgrading of remote bzrdirs is not supported yet."""
689
383
        return False
690
384
 
691
 
    def needs_format_conversion(self, format):
 
385
    def needs_format_conversion(self, format=None):
692
386
        """Upgrading of remote bzrdirs is not supported yet."""
 
387
        if format is None:
 
388
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
389
                % 'needs_format_conversion(format=None)')
693
390
        return False
694
391
 
695
392
    def clone(self, url, revision_id=None, force_new_repo=False,
702
399
        return RemoteBzrDirConfig(self)
703
400
 
704
401
 
705
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
402
class RemoteRepositoryFormat(repository.RepositoryFormat):
706
403
    """Format for repositories accessed over a _SmartClient.
707
404
 
708
405
    Instances of this repository are represented by RemoteRepository
723
420
    """
724
421
 
725
422
    _matchingbzrdir = RemoteBzrDirFormat()
726
 
    supports_full_versioned_files = True
727
 
    supports_leaving_lock = True
728
423
 
729
424
    def __init__(self):
730
 
        _mod_repository.RepositoryFormat.__init__(self)
 
425
        repository.RepositoryFormat.__init__(self)
731
426
        self._custom_format = None
732
427
        self._network_name = None
733
428
        self._creating_bzrdir = None
734
 
        self._revision_graph_can_have_wrong_parents = None
735
 
        self._supports_chks = None
736
429
        self._supports_external_lookups = None
737
430
        self._supports_tree_reference = None
738
 
        self._supports_funky_characters = None
739
431
        self._rich_root_data = None
740
432
 
741
 
    def __repr__(self):
742
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
743
 
            self._network_name)
744
 
 
745
433
    @property
746
434
    def fast_deltas(self):
747
435
        self._ensure_real()
755
443
        return self._rich_root_data
756
444
 
757
445
    @property
758
 
    def supports_chks(self):
759
 
        if self._supports_chks is None:
760
 
            self._ensure_real()
761
 
            self._supports_chks = self._custom_format.supports_chks
762
 
        return self._supports_chks
763
 
 
764
 
    @property
765
446
    def supports_external_lookups(self):
766
447
        if self._supports_external_lookups is None:
767
448
            self._ensure_real()
770
451
        return self._supports_external_lookups
771
452
 
772
453
    @property
773
 
    def supports_funky_characters(self):
774
 
        if self._supports_funky_characters is None:
775
 
            self._ensure_real()
776
 
            self._supports_funky_characters = \
777
 
                self._custom_format.supports_funky_characters
778
 
        return self._supports_funky_characters
779
 
 
780
 
    @property
781
454
    def supports_tree_reference(self):
782
455
        if self._supports_tree_reference is None:
783
456
            self._ensure_real()
785
458
                self._custom_format.supports_tree_reference
786
459
        return self._supports_tree_reference
787
460
 
788
 
    @property
789
 
    def revision_graph_can_have_wrong_parents(self):
790
 
        if self._revision_graph_can_have_wrong_parents is None:
791
 
            self._ensure_real()
792
 
            self._revision_graph_can_have_wrong_parents = \
793
 
                self._custom_format.revision_graph_can_have_wrong_parents
794
 
        return self._revision_graph_can_have_wrong_parents
795
 
 
796
461
    def _vfs_initialize(self, a_bzrdir, shared):
797
462
        """Helper for common code in initialize."""
798
463
        if self._custom_format:
833
498
            network_name = self._network_name
834
499
        else:
835
500
            # Select the current bzrlib default and ask for that.
836
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
501
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
837
502
            reference_format = reference_bzrdir_format.repository_format
838
503
            network_name = reference_format.network_name()
839
504
        # 2) try direct creation via RPC
865
530
 
866
531
    def _ensure_real(self):
867
532
        if self._custom_format is None:
868
 
            self._custom_format = _mod_repository.network_format_registry.get(
 
533
            self._custom_format = repository.network_format_registry.get(
869
534
                self._network_name)
870
535
 
871
536
    @property
884
549
        return self._custom_format._fetch_reconcile
885
550
 
886
551
    def get_format_description(self):
887
 
        self._ensure_real()
888
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
552
        return 'bzr remote repository'
889
553
 
890
554
    def __eq__(self, other):
891
555
        return self.__class__ is other.__class__
892
556
 
 
557
    def check_conversion_target(self, target_format):
 
558
        if self.rich_root_data and not target_format.rich_root_data:
 
559
            raise errors.BadConversionTarget(
 
560
                'Does not support rich root data.', target_format)
 
561
        if (self.supports_tree_reference and
 
562
            not getattr(target_format, 'supports_tree_reference', False)):
 
563
            raise errors.BadConversionTarget(
 
564
                'Does not support nested trees', target_format)
 
565
 
893
566
    def network_name(self):
894
567
        if self._network_name:
895
568
            return self._network_name
907
580
        return self._custom_format._serializer
908
581
 
909
582
 
910
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
911
 
    controldir.ControlComponent):
 
583
class RemoteRepository(_RpcHelper):
912
584
    """Repository accessed over rpc.
913
585
 
914
586
    For the moment most operations are performed using local transport-backed
957
629
        # Additional places to query for data.
958
630
        self._fallback_repositories = []
959
631
 
960
 
    @property
961
 
    def user_transport(self):
962
 
        return self.bzrdir.user_transport
963
 
 
964
 
    @property
965
 
    def control_transport(self):
966
 
        # XXX: Normally you shouldn't directly get at the remote repository
967
 
        # transport, but I'm not sure it's worth making this method
968
 
        # optional -- mbp 2010-04-21
969
 
        return self.bzrdir.get_repository_transport(None)
970
 
 
971
632
    def __str__(self):
972
633
        return "%s(%s)" % (self.__class__.__name__, self.base)
973
634
 
1081
742
    def find_text_key_references(self):
1082
743
        """Find the text key references within the repository.
1083
744
 
 
745
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
746
        revision_ids. Each altered file-ids has the exact revision_ids that
 
747
        altered it listed explicitly.
1084
748
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1085
749
            to whether they were referred to by the inventory of the
1086
750
            revision_id that they contain. The inventory texts from all present
1104
768
        """Private method for using with old (< 1.2) servers to fallback."""
1105
769
        if revision_id is None:
1106
770
            revision_id = ''
1107
 
        elif _mod_revision.is_null(revision_id):
 
771
        elif revision.is_null(revision_id):
1108
772
            return {}
1109
773
 
1110
774
        path = self.bzrdir._path_for_remote_call(self._client)
1134
798
        return RemoteStreamSource(self, to_format)
1135
799
 
1136
800
    @needs_read_lock
1137
 
    def get_file_graph(self):
1138
 
        return graph.Graph(self.texts)
1139
 
 
1140
 
    @needs_read_lock
1141
801
    def has_revision(self, revision_id):
1142
802
        """True if this repository has a copy of the revision."""
1143
803
        # Copy of bzrlib.repository.Repository.has_revision
1160
820
    def _has_same_fallbacks(self, other_repo):
1161
821
        """Returns true if the repositories have the same fallbacks."""
1162
822
        # XXX: copied from Repository; it should be unified into a base class
1163
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
 
823
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
1164
824
        my_fb = self._fallback_repositories
1165
825
        other_fb = other_repo._fallback_repositories
1166
826
        if len(my_fb) != len(other_fb):
1182
842
        parents_provider = self._make_parents_provider(other_repository)
1183
843
        return graph.Graph(parents_provider)
1184
844
 
1185
 
    @needs_read_lock
1186
 
    def get_known_graph_ancestry(self, revision_ids):
1187
 
        """Return the known graph for a set of revision ids and their ancestors.
1188
 
        """
1189
 
        st = static_tuple.StaticTuple
1190
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
1191
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1192
 
        return graph.GraphThunkIdsToKeys(known_graph)
1193
 
 
1194
845
    def gather_stats(self, revid=None, committers=None):
1195
846
        """See Repository.gather_stats()."""
1196
847
        path = self.bzrdir._path_for_remote_call(self._client)
1197
848
        # revid can be None to indicate no revisions, not just NULL_REVISION
1198
 
        if revid is None or _mod_revision.is_null(revid):
 
849
        if revid is None or revision.is_null(revid):
1199
850
            fmt_revid = ''
1200
851
        else:
1201
852
            fmt_revid = revid
1256
907
    def is_write_locked(self):
1257
908
        return self._lock_mode == 'w'
1258
909
 
1259
 
    def _warn_if_deprecated(self, branch=None):
1260
 
        # If we have a real repository, the check will be done there, if we
1261
 
        # don't the check will be done remotely.
1262
 
        pass
1263
 
 
1264
910
    def lock_read(self):
1265
 
        """Lock the repository for read operations.
1266
 
 
1267
 
        :return: A bzrlib.lock.LogicalLockResult.
1268
 
        """
1269
911
        # wrong eventually - want a local lock cache context
1270
912
        if not self._lock_mode:
1271
 
            self._note_lock('r')
1272
913
            self._lock_mode = 'r'
1273
914
            self._lock_count = 1
1274
915
            self._unstacked_provider.enable_cache(cache_misses=True)
1278
919
                repo.lock_read()
1279
920
        else:
1280
921
            self._lock_count += 1
1281
 
        return lock.LogicalLockResult(self.unlock)
1282
922
 
1283
923
    def _remote_lock_write(self, token):
1284
924
        path = self.bzrdir._path_for_remote_call(self._client)
1295
935
 
1296
936
    def lock_write(self, token=None, _skip_rpc=False):
1297
937
        if not self._lock_mode:
1298
 
            self._note_lock('w')
1299
938
            if _skip_rpc:
1300
939
                if self._lock_token is not None:
1301
940
                    if token != self._lock_token:
1324
963
            raise errors.ReadOnlyError(self)
1325
964
        else:
1326
965
            self._lock_count += 1
1327
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
966
        return self._lock_token or None
1328
967
 
1329
968
    def leave_lock_in_place(self):
1330
969
        if not self._lock_token:
1404
1043
        else:
1405
1044
            raise errors.UnexpectedSmartServerResponse(response)
1406
1045
 
1407
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1408
1046
    def unlock(self):
1409
1047
        if not self._lock_count:
1410
1048
            return lock.cant_unlock_not_held(self)
1484
1122
 
1485
1123
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1486
1124
                           timezone=None, committer=None, revprops=None,
1487
 
                           revision_id=None, lossy=False):
 
1125
                           revision_id=None):
1488
1126
        # FIXME: It ought to be possible to call this without immediately
1489
1127
        # triggering _ensure_real.  For now it's the easiest thing to do.
1490
1128
        self._ensure_real()
1491
1129
        real_repo = self._real_repository
1492
1130
        builder = real_repo.get_commit_builder(branch, parents,
1493
1131
                config, timestamp=timestamp, timezone=timezone,
1494
 
                committer=committer, revprops=revprops,
1495
 
                revision_id=revision_id, lossy=lossy)
 
1132
                committer=committer, revprops=revprops, revision_id=revision_id)
1496
1133
        return builder
1497
1134
 
1498
1135
    def add_fallback_repository(self, repository):
1511
1148
            # state, so always add a lock here. If a caller passes us a locked
1512
1149
            # repository, they are responsible for unlocking it later.
1513
1150
            repository.lock_read()
1514
 
        self._check_fallback_repository(repository)
1515
1151
        self._fallback_repositories.append(repository)
1516
1152
        # If self._real_repository was parameterised already (e.g. because a
1517
1153
        # _real_branch had its get_stacked_on_url method called), then the
1518
1154
        # repository to be added may already be in the _real_repositories list.
1519
1155
        if self._real_repository is not None:
1520
 
            fallback_locations = [repo.user_url for repo in
 
1156
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1521
1157
                self._real_repository._fallback_repositories]
1522
 
            if repository.user_url not in fallback_locations:
 
1158
            if repository.bzrdir.root_transport.base not in fallback_locations:
1523
1159
                self._real_repository.add_fallback_repository(repository)
1524
1160
 
1525
 
    def _check_fallback_repository(self, repository):
1526
 
        """Check that this repository can fallback to repository safely.
1527
 
 
1528
 
        Raise an error if not.
1529
 
 
1530
 
        :param repository: A repository to fallback to.
1531
 
        """
1532
 
        return _mod_repository.InterRepository._assert_same_model(
1533
 
            self, repository)
1534
 
 
1535
1161
    def add_inventory(self, revid, inv, parents):
1536
1162
        self._ensure_real()
1537
1163
        return self._real_repository.add_inventory(revid, inv, parents)
1538
1164
 
1539
1165
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1540
 
            parents, basis_inv=None, propagate_caches=False):
 
1166
                               parents):
1541
1167
        self._ensure_real()
1542
1168
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1543
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1544
 
            propagate_caches=propagate_caches)
 
1169
            delta, new_revision_id, parents)
1545
1170
 
1546
1171
    def add_revision(self, rev_id, rev, inv=None, config=None):
1547
1172
        self._ensure_real()
1553
1178
        self._ensure_real()
1554
1179
        return self._real_repository.get_inventory(revision_id)
1555
1180
 
1556
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1181
    def iter_inventories(self, revision_ids):
1557
1182
        self._ensure_real()
1558
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1183
        return self._real_repository.iter_inventories(revision_ids)
1559
1184
 
1560
1185
    @needs_read_lock
1561
1186
    def get_revision(self, revision_id):
1577
1202
        return self._real_repository.make_working_trees()
1578
1203
 
1579
1204
    def refresh_data(self):
1580
 
        """Re-read any data needed to synchronise with disk.
 
1205
        """Re-read any data needed to to synchronise with disk.
1581
1206
 
1582
1207
        This method is intended to be called after another repository instance
1583
1208
        (such as one used by a smart server) has inserted data into the
1584
 
        repository. On all repositories this will work outside of write groups.
1585
 
        Some repository formats (pack and newer for bzrlib native formats)
1586
 
        support refresh_data inside write groups. If called inside a write
1587
 
        group on a repository that does not support refreshing in a write group
1588
 
        IsInWriteGroupError will be raised.
 
1209
        repository. It may not be called during a write group, but may be
 
1210
        called at any other time.
1589
1211
        """
 
1212
        if self.is_in_write_group():
 
1213
            raise errors.InternalBzrError(
 
1214
                "May not refresh_data while in a write group.")
1590
1215
        if self._real_repository is not None:
1591
1216
            self._real_repository.refresh_data()
1592
1217
 
1604
1229
        return result
1605
1230
 
1606
1231
    @needs_read_lock
1607
 
    def search_missing_revision_ids(self, other,
1608
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1609
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1610
 
            limit=None):
 
1232
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1611
1233
        """Return the revision ids that other has that this does not.
1612
1234
 
1613
1235
        These are returned in topological order.
1614
1236
 
1615
1237
        revision_id: only return revision ids included by revision_id.
1616
1238
        """
1617
 
        if symbol_versioning.deprecated_passed(revision_id):
1618
 
            symbol_versioning.warn(
1619
 
                'search_missing_revision_ids(revision_id=...) was '
1620
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
1621
 
                DeprecationWarning, stacklevel=2)
1622
 
            if revision_ids is not None:
1623
 
                raise AssertionError(
1624
 
                    'revision_ids is mutually exclusive with revision_id')
1625
 
            if revision_id is not None:
1626
 
                revision_ids = [revision_id]
1627
 
        inter_repo = _mod_repository.InterRepository.get(other, self)
1628
 
        return inter_repo.search_missing_revision_ids(
1629
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
1630
 
            if_present_ids=if_present_ids, limit=limit)
 
1239
        return repository.InterRepository.get(
 
1240
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1631
1241
 
1632
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1242
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1633
1243
            fetch_spec=None):
1634
1244
        # No base implementation to use as RemoteRepository is not a subclass
1635
1245
        # of Repository; so this is a copy of Repository.fetch().
1646
1256
            # check that last_revision is in 'from' and then return a
1647
1257
            # no-operation.
1648
1258
            if (revision_id is not None and
1649
 
                not _mod_revision.is_null(revision_id)):
 
1259
                not revision.is_null(revision_id)):
1650
1260
                self.get_revision(revision_id)
1651
1261
            return 0, []
1652
1262
        # if there is no specific appropriate InterRepository, this will get
1653
1263
        # the InterRepository base class, which raises an
1654
1264
        # IncompatibleRepositories when asked to fetch.
1655
 
        inter = _mod_repository.InterRepository.get(source, self)
1656
 
        return inter.fetch(revision_id=revision_id,
 
1265
        inter = repository.InterRepository.get(source, self)
 
1266
        return inter.fetch(revision_id=revision_id, pb=pb,
1657
1267
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1658
1268
 
1659
1269
    def create_bundle(self, target, base, fileobj, format=None):
1661
1271
        self._real_repository.create_bundle(target, base, fileobj, format)
1662
1272
 
1663
1273
    @needs_read_lock
1664
 
    @symbol_versioning.deprecated_method(
1665
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1666
1274
    def get_ancestry(self, revision_id, topo_sorted=True):
1667
1275
        self._ensure_real()
1668
1276
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1823
1431
        return self._real_repository.get_signature_text(revision_id)
1824
1432
 
1825
1433
    @needs_read_lock
1826
 
    def _get_inventory_xml(self, revision_id):
1827
 
        self._ensure_real()
1828
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1434
    def get_inventory_xml(self, revision_id):
 
1435
        self._ensure_real()
 
1436
        return self._real_repository.get_inventory_xml(revision_id)
 
1437
 
 
1438
    def deserialise_inventory(self, revision_id, xml):
 
1439
        self._ensure_real()
 
1440
        return self._real_repository.deserialise_inventory(revision_id, xml)
1829
1441
 
1830
1442
    def reconcile(self, other=None, thorough=False):
1831
1443
        self._ensure_real()
1858
1470
        return self._real_repository.get_revision_reconcile(revision_id)
1859
1471
 
1860
1472
    @needs_read_lock
1861
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1473
    def check(self, revision_ids=None):
1862
1474
        self._ensure_real()
1863
 
        return self._real_repository.check(revision_ids=revision_ids,
1864
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1475
        return self._real_repository.check(revision_ids=revision_ids)
1865
1476
 
1866
1477
    def copy_content_into(self, destination, revision_id=None):
1867
1478
        self._ensure_real()
1885
1496
            tmpdir = osutils.mkdtemp()
1886
1497
            try:
1887
1498
                _extract_tar(tar, tmpdir)
1888
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1499
                tmp_bzrdir = BzrDir.open(tmpdir)
1889
1500
                tmp_repo = tmp_bzrdir.open_repository()
1890
1501
                tmp_repo.copy_content_into(destination, revision_id)
1891
1502
            finally:
1907
1518
        return self._real_repository.inventories
1908
1519
 
1909
1520
    @needs_write_lock
1910
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1521
    def pack(self, hint=None):
1911
1522
        """Compress the data within the repository.
1912
1523
 
1913
1524
        This is not currently implemented within the smart server.
1914
1525
        """
1915
1526
        self._ensure_real()
1916
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1527
        return self._real_repository.pack(hint=hint)
1917
1528
 
1918
1529
    @property
1919
1530
    def revisions(self):
1976
1587
    def supports_rich_root(self):
1977
1588
        return self._format.rich_root_data
1978
1589
 
1979
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1980
1590
    def iter_reverse_revision_history(self, revision_id):
1981
1591
        self._ensure_real()
1982
1592
        return self._real_repository.iter_reverse_revision_history(revision_id)
2003
1613
        return self._real_repository.item_keys_introduced_by(revision_ids,
2004
1614
            _files_pb=_files_pb)
2005
1615
 
2006
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2007
 
        self._ensure_real()
2008
 
        return self._real_repository._find_inconsistent_revision_parents(
2009
 
            revisions_iterator)
 
1616
    def revision_graph_can_have_wrong_parents(self):
 
1617
        # The answer depends on the remote repo format.
 
1618
        self._ensure_real()
 
1619
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1620
 
 
1621
    def _find_inconsistent_revision_parents(self):
 
1622
        self._ensure_real()
 
1623
        return self._real_repository._find_inconsistent_revision_parents()
2010
1624
 
2011
1625
    def _check_for_inconsistent_revision_parents(self):
2012
1626
        self._ensure_real()
2016
1630
        providers = [self._unstacked_provider]
2017
1631
        if other is not None:
2018
1632
            providers.insert(0, other)
2019
 
        return graph.StackedParentsProvider(_LazyListJoin(
2020
 
            providers, self._fallback_repositories))
 
1633
        providers.extend(r._make_parents_provider() for r in
 
1634
                         self._fallback_repositories)
 
1635
        return graph.StackedParentsProvider(providers)
2021
1636
 
2022
1637
    def _serialise_search_recipe(self, recipe):
2023
1638
        """Serialise a graph search recipe.
2031
1646
        return '\n'.join((start_keys, stop_keys, count))
2032
1647
 
2033
1648
    def _serialise_search_result(self, search_result):
2034
 
        parts = search_result.get_network_struct()
 
1649
        if isinstance(search_result, graph.PendingAncestryResult):
 
1650
            parts = ['ancestry-of']
 
1651
            parts.extend(search_result.heads)
 
1652
        else:
 
1653
            recipe = search_result.get_recipe()
 
1654
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
2035
1655
        return '\n'.join(parts)
2036
1656
 
2037
1657
    def autopack(self):
2047
1667
            raise errors.UnexpectedSmartServerResponse(response)
2048
1668
 
2049
1669
 
2050
 
class RemoteStreamSink(vf_repository.StreamSink):
 
1670
class RemoteStreamSink(repository.StreamSink):
2051
1671
 
2052
1672
    def _insert_real(self, stream, src_format, resume_tokens):
2053
1673
        self.target_repo._ensure_real()
2060
1680
    def insert_stream(self, stream, src_format, resume_tokens):
2061
1681
        target = self.target_repo
2062
1682
        target._unstacked_provider.missing_keys.clear()
2063
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2064
1683
        if target._lock_token:
2065
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2066
 
            lock_args = (target._lock_token or '',)
 
1684
            verb = 'Repository.insert_stream_locked'
 
1685
            extra_args = (target._lock_token or '',)
 
1686
            required_version = (1, 14)
2067
1687
        else:
2068
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
2069
 
            lock_args = ()
 
1688
            verb = 'Repository.insert_stream'
 
1689
            extra_args = ()
 
1690
            required_version = (1, 13)
2070
1691
        client = target._client
2071
1692
        medium = client._medium
 
1693
        if medium._is_remote_before(required_version):
 
1694
            # No possible way this can work.
 
1695
            return self._insert_real(stream, src_format, resume_tokens)
2072
1696
        path = target.bzrdir._path_for_remote_call(client)
2073
 
        # Probe for the verb to use with an empty stream before sending the
2074
 
        # real stream to it.  We do this both to avoid the risk of sending a
2075
 
        # large request that is then rejected, and because we don't want to
2076
 
        # implement a way to buffer, rewind, or restart the stream.
2077
 
        found_verb = False
2078
 
        for verb, required_version in candidate_calls:
2079
 
            if medium._is_remote_before(required_version):
2080
 
                continue
2081
 
            if resume_tokens:
2082
 
                # We've already done the probing (and set _is_remote_before) on
2083
 
                # a previous insert.
2084
 
                found_verb = True
2085
 
                break
 
1697
        if not resume_tokens:
 
1698
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1699
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1700
            # fallback to the _real_repositories sink *with a partial stream*.
 
1701
            # Thats bad because we insert less data than bzr expected. To avoid
 
1702
            # this we do a trial push to make sure the verb is accessible, and
 
1703
            # do not fallback when actually pushing the stream. A cleanup patch
 
1704
            # is going to look at rewinding/restarting the stream/partial
 
1705
            # buffering etc.
2086
1706
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2087
1707
            try:
2088
1708
                response = client.call_with_body_stream(
2089
 
                    (verb, path, '') + lock_args, byte_stream)
 
1709
                    (verb, path, '') + extra_args, byte_stream)
2090
1710
            except errors.UnknownSmartMethod:
2091
1711
                medium._remember_remote_is_before(required_version)
2092
 
            else:
2093
 
                found_verb = True
2094
 
                break
2095
 
        if not found_verb:
2096
 
            # Have to use VFS.
2097
 
            return self._insert_real(stream, src_format, resume_tokens)
2098
 
        self._last_inv_record = None
2099
 
        self._last_substream = None
2100
 
        if required_version < (1, 19):
2101
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
2102
 
            # make sure we don't send any.  If the stream contains inventory
2103
 
            # deltas we'll interrupt the smart insert_stream request and
2104
 
            # fallback to VFS.
2105
 
            stream = self._stop_stream_if_inventory_delta(stream)
 
1712
                return self._insert_real(stream, src_format, resume_tokens)
2106
1713
        byte_stream = smart_repo._stream_to_byte_stream(
2107
1714
            stream, src_format)
2108
1715
        resume_tokens = ' '.join(resume_tokens)
2109
1716
        response = client.call_with_body_stream(
2110
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1717
            (verb, path, resume_tokens) + extra_args, byte_stream)
2111
1718
        if response[0][0] not in ('ok', 'missing-basis'):
2112
1719
            raise errors.UnexpectedSmartServerResponse(response)
2113
 
        if self._last_substream is not None:
2114
 
            # The stream included an inventory-delta record, but the remote
2115
 
            # side isn't new enough to support them.  So we need to send the
2116
 
            # rest of the stream via VFS.
2117
 
            self.target_repo.refresh_data()
2118
 
            return self._resume_stream_with_vfs(response, src_format)
2119
1720
        if response[0][0] == 'missing-basis':
2120
1721
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2121
1722
            resume_tokens = tokens
2124
1725
            self.target_repo.refresh_data()
2125
1726
            return [], set()
2126
1727
 
2127
 
    def _resume_stream_with_vfs(self, response, src_format):
2128
 
        """Resume sending a stream via VFS, first resending the record and
2129
 
        substream that couldn't be sent via an insert_stream verb.
2130
 
        """
2131
 
        if response[0][0] == 'missing-basis':
2132
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2133
 
            # Ignore missing_keys, we haven't finished inserting yet
2134
 
        else:
2135
 
            tokens = []
2136
 
        def resume_substream():
2137
 
            # Yield the substream that was interrupted.
2138
 
            for record in self._last_substream:
2139
 
                yield record
2140
 
            self._last_substream = None
2141
 
        def resume_stream():
2142
 
            # Finish sending the interrupted substream
2143
 
            yield ('inventory-deltas', resume_substream())
2144
 
            # Then simply continue sending the rest of the stream.
2145
 
            for substream_kind, substream in self._last_stream:
2146
 
                yield substream_kind, substream
2147
 
        return self._insert_real(resume_stream(), src_format, tokens)
2148
 
 
2149
 
    def _stop_stream_if_inventory_delta(self, stream):
2150
 
        """Normally this just lets the original stream pass-through unchanged.
2151
 
 
2152
 
        However if any 'inventory-deltas' substream occurs it will stop
2153
 
        streaming, and store the interrupted substream and stream in
2154
 
        self._last_substream and self._last_stream so that the stream can be
2155
 
        resumed by _resume_stream_with_vfs.
2156
 
        """
2157
 
 
2158
 
        stream_iter = iter(stream)
2159
 
        for substream_kind, substream in stream_iter:
2160
 
            if substream_kind == 'inventory-deltas':
2161
 
                self._last_substream = substream
2162
 
                self._last_stream = stream_iter
2163
 
                return
2164
 
            else:
2165
 
                yield substream_kind, substream
2166
 
 
2167
 
 
2168
 
class RemoteStreamSource(vf_repository.StreamSource):
 
1728
 
 
1729
class RemoteStreamSource(repository.StreamSource):
2169
1730
    """Stream data from a remote server."""
2170
1731
 
2171
1732
    def get_stream(self, search):
2172
1733
        if (self.from_repository._fallback_repositories and
2173
1734
            self.to_format._fetch_order == 'topological'):
2174
1735
            return self._real_stream(self.from_repository, search)
2175
 
        sources = []
2176
 
        seen = set()
2177
 
        repos = [self.from_repository]
2178
 
        while repos:
2179
 
            repo = repos.pop(0)
2180
 
            if repo in seen:
2181
 
                continue
2182
 
            seen.add(repo)
2183
 
            repos.extend(repo._fallback_repositories)
2184
 
            sources.append(repo)
2185
 
        return self.missing_parents_chain(search, sources)
2186
 
 
2187
 
    def get_stream_for_missing_keys(self, missing_keys):
2188
 
        self.from_repository._ensure_real()
2189
 
        real_repo = self.from_repository._real_repository
2190
 
        real_source = real_repo._get_source(self.to_format)
2191
 
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1736
        return self.missing_parents_chain(search, [self.from_repository] +
 
1737
            self.from_repository._fallback_repositories)
2192
1738
 
2193
1739
    def _real_stream(self, repo, search):
2194
1740
        """Get a stream for search from repo.
2201
1747
        """
2202
1748
        source = repo._get_source(self.to_format)
2203
1749
        if isinstance(source, RemoteStreamSource):
2204
 
            repo._ensure_real()
2205
 
            source = repo._real_repository._get_source(self.to_format)
 
1750
            return repository.StreamSource.get_stream(source, search)
2206
1751
        return source.get_stream(search)
2207
1752
 
2208
1753
    def _get_stream(self, repo, search):
2225
1770
            return self._real_stream(repo, search)
2226
1771
        client = repo._client
2227
1772
        medium = client._medium
 
1773
        if medium._is_remote_before((1, 13)):
 
1774
            # streaming was added in 1.13
 
1775
            return self._real_stream(repo, search)
2228
1776
        path = repo.bzrdir._path_for_remote_call(client)
2229
 
        search_bytes = repo._serialise_search_result(search)
2230
 
        args = (path, self.to_format.network_name())
2231
 
        candidate_verbs = [
2232
 
            ('Repository.get_stream_1.19', (1, 19)),
2233
 
            ('Repository.get_stream', (1, 13))]
2234
 
 
2235
 
        found_verb = False
2236
 
        for verb, version in candidate_verbs:
2237
 
            if medium._is_remote_before(version):
2238
 
                continue
2239
 
            try:
2240
 
                response = repo._call_with_body_bytes_expecting_body(
2241
 
                    verb, args, search_bytes)
2242
 
            except errors.UnknownSmartMethod:
2243
 
                medium._remember_remote_is_before(version)
2244
 
            except errors.UnknownErrorFromSmartServer, e:
2245
 
                if isinstance(search, graph.EverythingResult):
2246
 
                    error_verb = e.error_from_smart_server.error_verb
2247
 
                    if error_verb == 'BadSearch':
2248
 
                        # Pre-2.4 servers don't support this sort of search.
2249
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
2250
 
                        # good idea in general?  It might provide a little bit
2251
 
                        # of protection against client-side bugs.
2252
 
                        medium._remember_remote_is_before((2, 4))
2253
 
                        break
2254
 
                raise
2255
 
            else:
2256
 
                response_tuple, response_handler = response
2257
 
                found_verb = True
2258
 
                break
2259
 
        if not found_verb:
 
1777
        try:
 
1778
            search_bytes = repo._serialise_search_result(search)
 
1779
            response = repo._call_with_body_bytes_expecting_body(
 
1780
                'Repository.get_stream',
 
1781
                (path, self.to_format.network_name()), search_bytes)
 
1782
            response_tuple, response_handler = response
 
1783
        except errors.UnknownSmartMethod:
 
1784
            medium._remember_remote_is_before((1,13))
2260
1785
            return self._real_stream(repo, search)
2261
1786
        if response_tuple[0] != 'ok':
2262
1787
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2263
1788
        byte_stream = response_handler.read_streamed_body()
2264
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2265
 
            self._record_counter)
 
1789
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
2266
1790
        if src_format.network_name() != repo._format.network_name():
2267
1791
            raise AssertionError(
2268
1792
                "Mismatched RemoteRepository and stream src %r, %r" % (
2275
1799
        :param search: The overall search to satisfy with streams.
2276
1800
        :param sources: A list of Repository objects to query.
2277
1801
        """
2278
 
        self.from_serialiser = self.from_repository._format._serializer
 
1802
        self.serialiser = self.to_format._serializer
2279
1803
        self.seen_revs = set()
2280
1804
        self.referenced_revs = set()
2281
1805
        # If there are heads in the search, or the key count is > 0, we are not
2298
1822
    def missing_parents_rev_handler(self, substream):
2299
1823
        for content in substream:
2300
1824
            revision_bytes = content.get_bytes_as('fulltext')
2301
 
            revision = self.from_serialiser.read_revision_from_string(
2302
 
                revision_bytes)
 
1825
            revision = self.serialiser.read_revision_from_string(revision_bytes)
2303
1826
            self.seen_revs.add(content.key[-1])
2304
1827
            self.referenced_revs.update(revision.parent_ids)
2305
1828
            yield content
2344
1867
                self._network_name)
2345
1868
 
2346
1869
    def get_format_description(self):
2347
 
        self._ensure_real()
2348
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1870
        return 'Remote BZR Branch'
2349
1871
 
2350
1872
    def network_name(self):
2351
1873
        return self._network_name
2352
1874
 
2353
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2354
 
        return a_bzrdir.open_branch(name=name, 
2355
 
            ignore_fallbacks=ignore_fallbacks)
 
1875
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1876
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2356
1877
 
2357
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1878
    def _vfs_initialize(self, a_bzrdir):
2358
1879
        # Initialisation when using a local bzrdir object, or a non-vfs init
2359
1880
        # method is not available on the server.
2360
1881
        # self._custom_format is always set - the start of initialize ensures
2361
1882
        # that.
2362
1883
        if isinstance(a_bzrdir, RemoteBzrDir):
2363
1884
            a_bzrdir._ensure_real()
2364
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2365
 
                name)
 
1885
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2366
1886
        else:
2367
1887
            # We assume the bzrdir is parameterised; it may not be.
2368
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1888
            result = self._custom_format.initialize(a_bzrdir)
2369
1889
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
1890
            not isinstance(result, RemoteBranch)):
2371
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2372
 
                                  name=name)
 
1891
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2373
1892
        return result
2374
1893
 
2375
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1894
    def initialize(self, a_bzrdir):
2376
1895
        # 1) get the network name to use.
2377
1896
        if self._custom_format:
2378
1897
            network_name = self._custom_format.network_name()
2379
1898
        else:
2380
1899
            # Select the current bzrlib default and ask for that.
2381
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
 
1900
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
2382
1901
            reference_format = reference_bzrdir_format.get_branch_format()
2383
1902
            self._custom_format = reference_format
2384
1903
            network_name = reference_format.network_name()
2385
1904
        # Being asked to create on a non RemoteBzrDir:
2386
1905
        if not isinstance(a_bzrdir, RemoteBzrDir):
2387
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1906
            return self._vfs_initialize(a_bzrdir)
2388
1907
        medium = a_bzrdir._client._medium
2389
1908
        if medium._is_remote_before((1, 13)):
2390
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1909
            return self._vfs_initialize(a_bzrdir)
2391
1910
        # Creating on a remote bzr dir.
2392
1911
        # 2) try direct creation via RPC
2393
1912
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2394
 
        if name is not None:
2395
 
            # XXX JRV20100304: Support creating colocated branches
2396
 
            raise errors.NoColocatedBranchSupport(self)
2397
1913
        verb = 'BzrDir.create_branch'
2398
1914
        try:
2399
1915
            response = a_bzrdir._call(verb, path, network_name)
2400
1916
        except errors.UnknownSmartMethod:
2401
1917
            # Fallback - use vfs methods
2402
1918
            medium._remember_remote_is_before((1, 13))
2403
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1919
            return self._vfs_initialize(a_bzrdir)
2404
1920
        if response[0] != 'ok':
2405
1921
            raise errors.UnexpectedSmartServerResponse(response)
2406
1922
        # Turn the response into a RemoteRepository object.
2407
1923
        format = RemoteBranchFormat(network_name=response[1])
2408
1924
        repo_format = response_tuple_to_repo_format(response[3:])
2409
 
        repo_path = response[2]
2410
 
        if repository is not None:
2411
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2412
 
            url_diff = urlutils.relative_url(repository.user_url,
2413
 
                    remote_repo_url)
2414
 
            if url_diff != '.':
2415
 
                raise AssertionError(
2416
 
                    'repository.user_url %r does not match URL from server '
2417
 
                    'response (%r + %r)'
2418
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
2419
 
            remote_repo = repository
 
1925
        if response[2] == '':
 
1926
            repo_bzrdir = a_bzrdir
2420
1927
        else:
2421
 
            if repo_path == '':
2422
 
                repo_bzrdir = a_bzrdir
2423
 
            else:
2424
 
                repo_bzrdir = RemoteBzrDir(
2425
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2426
 
                    a_bzrdir._client)
2427
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
1928
            repo_bzrdir = RemoteBzrDir(
 
1929
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
1930
                a_bzrdir._client)
 
1931
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2428
1932
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
 
            format=format, setup_stacking=False, name=name)
 
1933
            format=format, setup_stacking=False)
2430
1934
        # XXX: We know this is a new branch, so it must have revno 0, revid
2431
1935
        # NULL_REVISION. Creating the branch locked would make this be unable
2432
1936
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2451
1955
        self._ensure_real()
2452
1956
        return self._custom_format.supports_set_append_revisions_only()
2453
1957
 
2454
 
    def _use_default_local_heads_to_fetch(self):
2455
 
        # If the branch format is a metadir format *and* its heads_to_fetch
2456
 
        # implementation is not overridden vs the base class, we can use the
2457
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
2458
 
        # usually cheaper in terms of net round trips, as the last-revision and
2459
 
        # tags info fetched is cached and would be fetched anyway.
2460
 
        self._ensure_real()
2461
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
2462
 
            branch_class = self._custom_format._branch_class()
2463
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2464
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2465
 
                return True
2466
 
        return False
2467
1958
 
2468
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1959
class RemoteBranch(branch.Branch, _RpcHelper):
2469
1960
    """Branch stored on a server accessed by HPSS RPC.
2470
1961
 
2471
1962
    At the moment most operations are mapped down to simple file operations.
2472
1963
    """
2473
1964
 
2474
1965
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2475
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1966
        _client=None, format=None, setup_stacking=True):
2476
1967
        """Create a RemoteBranch instance.
2477
1968
 
2478
1969
        :param real_branch: An optional local implementation of the branch
2484
1975
        :param setup_stacking: If True make an RPC call to determine the
2485
1976
            stacked (or not) status of the branch. If False assume the branch
2486
1977
            is not stacked.
2487
 
        :param name: Colocated branch name
2488
1978
        """
2489
1979
        # We intentionally don't call the parent class's __init__, because it
2490
1980
        # will try to assign to self.tags, which is a property in this subclass.
2509
1999
            self._real_branch = None
2510
2000
        # Fill out expected attributes of branch for bzrlib API users.
2511
2001
        self._clear_cached_state()
2512
 
        # TODO: deprecate self.base in favor of user_url
2513
 
        self.base = self.bzrdir.user_url
2514
 
        self._name = name
 
2002
        self.base = self.bzrdir.root_transport.base
2515
2003
        self._control_files = None
2516
2004
        self._lock_mode = None
2517
2005
        self._lock_token = None
2528
2016
                    self._real_branch._format.network_name()
2529
2017
        else:
2530
2018
            self._format = format
2531
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2532
 
        # branch.open_branch method.
2533
 
        self._real_ignore_fallbacks = not setup_stacking
2534
2019
        if not self._format._network_name:
2535
2020
            # Did not get from open_branchV2 - old server.
2536
2021
            self._ensure_real()
2581
2066
                raise AssertionError('smart server vfs must be enabled '
2582
2067
                    'to use vfs implementation')
2583
2068
            self.bzrdir._ensure_real()
2584
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2585
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
2069
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2586
2070
            if self.repository._real_repository is None:
2587
2071
                # Give the remote repository the matching real repo.
2588
2072
                real_repo = self._real_branch.repository
2668
2152
            self._is_stacked = False
2669
2153
        else:
2670
2154
            self._is_stacked = True
2671
 
 
 
2155
        
2672
2156
    def _vfs_get_tags_bytes(self):
2673
2157
        self._ensure_real()
2674
2158
        return self._real_branch._get_tags_bytes()
2675
2159
 
2676
 
    @needs_read_lock
2677
2160
    def _get_tags_bytes(self):
2678
 
        if self._tags_bytes is None:
2679
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
2680
 
        return self._tags_bytes
2681
 
 
2682
 
    def _get_tags_bytes_via_hpss(self):
2683
2161
        medium = self._client._medium
2684
2162
        if medium._is_remote_before((1, 13)):
2685
2163
            return self._vfs_get_tags_bytes()
2695
2173
        return self._real_branch._set_tags_bytes(bytes)
2696
2174
 
2697
2175
    def _set_tags_bytes(self, bytes):
2698
 
        if self.is_locked():
2699
 
            self._tags_bytes = bytes
2700
2176
        medium = self._client._medium
2701
2177
        if medium._is_remote_before((1, 18)):
2702
2178
            self._vfs_set_tags_bytes(bytes)
2703
 
            return
2704
2179
        try:
2705
2180
            args = (
2706
2181
                self._remote_path(), self._lock_token, self._repo_lock_token)
2711
2186
            self._vfs_set_tags_bytes(bytes)
2712
2187
 
2713
2188
    def lock_read(self):
2714
 
        """Lock the branch for read operations.
2715
 
 
2716
 
        :return: A bzrlib.lock.LogicalLockResult.
2717
 
        """
2718
2189
        self.repository.lock_read()
2719
2190
        if not self._lock_mode:
2720
 
            self._note_lock('r')
2721
2191
            self._lock_mode = 'r'
2722
2192
            self._lock_count = 1
2723
2193
            if self._real_branch is not None:
2724
2194
                self._real_branch.lock_read()
2725
2195
        else:
2726
2196
            self._lock_count += 1
2727
 
        return lock.LogicalLockResult(self.unlock)
2728
2197
 
2729
2198
    def _remote_lock_write(self, token):
2730
2199
        if token is None:
2731
2200
            branch_token = repo_token = ''
2732
2201
        else:
2733
2202
            branch_token = token
2734
 
            repo_token = self.repository.lock_write().repository_token
 
2203
            repo_token = self.repository.lock_write()
2735
2204
            self.repository.unlock()
2736
2205
        err_context = {'token': token}
2737
 
        try:
2738
 
            response = self._call(
2739
 
                'Branch.lock_write', self._remote_path(), branch_token,
2740
 
                repo_token or '', **err_context)
2741
 
        except errors.LockContention, e:
2742
 
            # The LockContention from the server doesn't have any
2743
 
            # information about the lock_url. We re-raise LockContention
2744
 
            # with valid lock_url.
2745
 
            raise errors.LockContention('(remote lock)',
2746
 
                self.repository.base.split('.bzr/')[0])
 
2206
        response = self._call(
 
2207
            'Branch.lock_write', self._remote_path(), branch_token,
 
2208
            repo_token or '', **err_context)
2747
2209
        if response[0] != 'ok':
2748
2210
            raise errors.UnexpectedSmartServerResponse(response)
2749
2211
        ok, branch_token, repo_token = response
2751
2213
 
2752
2214
    def lock_write(self, token=None):
2753
2215
        if not self._lock_mode:
2754
 
            self._note_lock('w')
2755
2216
            # Lock the branch and repo in one remote call.
2756
2217
            remote_tokens = self._remote_lock_write(token)
2757
2218
            self._lock_token, self._repo_lock_token = remote_tokens
2770
2231
            self._lock_mode = 'w'
2771
2232
            self._lock_count = 1
2772
2233
        elif self._lock_mode == 'r':
2773
 
            raise errors.ReadOnlyError(self)
 
2234
            raise errors.ReadOnlyTransaction
2774
2235
        else:
2775
2236
            if token is not None:
2776
2237
                # A token was given to lock_write, and we're relocking, so
2781
2242
            self._lock_count += 1
2782
2243
            # Re-lock the repository too.
2783
2244
            self.repository.lock_write(self._repo_lock_token)
2784
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
2245
        return self._lock_token or None
2785
2246
 
2786
2247
    def _unlock(self, branch_token, repo_token):
2787
2248
        err_context = {'token': str((branch_token, repo_token))}
2792
2253
            return
2793
2254
        raise errors.UnexpectedSmartServerResponse(response)
2794
2255
 
2795
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2796
2256
    def unlock(self):
2797
2257
        try:
2798
2258
            self._lock_count -= 1
2838
2298
            raise NotImplementedError(self.dont_leave_lock_in_place)
2839
2299
        self._leave_lock = False
2840
2300
 
2841
 
    @needs_read_lock
2842
2301
    def get_rev_id(self, revno, history=None):
2843
2302
        if revno == 0:
2844
2303
            return _mod_revision.NULL_REVISION
2856
2315
            missing_parent = parent_map[missing_parent]
2857
2316
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2858
2317
 
2859
 
    def _read_last_revision_info(self):
 
2318
    def _last_revision_info(self):
2860
2319
        response = self._call('Branch.last_revision_info', self._remote_path())
2861
2320
        if response[0] != 'ok':
2862
2321
            raise SmartProtocolError('unexpected response code %s' % (response,))
2925
2384
            raise errors.UnexpectedSmartServerResponse(response)
2926
2385
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2927
2386
 
2928
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2929
2387
    @needs_write_lock
2930
2388
    def set_revision_history(self, rev_history):
2931
 
        """See Branch.set_revision_history."""
2932
 
        self._set_revision_history(rev_history)
2933
 
 
2934
 
    @needs_write_lock
2935
 
    def _set_revision_history(self, rev_history):
2936
2389
        # Send just the tip revision of the history; the server will generate
2937
2390
        # the full history from that.  If the revision doesn't exist in this
2938
2391
        # branch, NoSuchRevision will be raised.
2996
2449
            _override_hook_target=self, **kwargs)
2997
2450
 
2998
2451
    @needs_read_lock
2999
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
2452
    def push(self, target, overwrite=False, stop_revision=None):
3000
2453
        self._ensure_real()
3001
2454
        return self._real_branch.push(
3002
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
2455
            target, overwrite=overwrite, stop_revision=stop_revision,
3003
2456
            _override_hook_source_branch=self)
3004
2457
 
3005
2458
    def is_locked(self):
3015
2468
        # XXX: These should be returned by the set_last_revision_info verb
3016
2469
        old_revno, old_revid = self.last_revision_info()
3017
2470
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3018
 
        if not revision_id or not isinstance(revision_id, basestring):
3019
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2471
        revision_id = ensure_null(revision_id)
3020
2472
        try:
3021
2473
            response = self._call('Branch.set_last_revision_info',
3022
2474
                self._remote_path(), self._lock_token, self._repo_lock_token,
3051
2503
            except errors.UnknownSmartMethod:
3052
2504
                medium._remember_remote_is_before((1, 6))
3053
2505
        self._clear_cached_state_of_remote_branch_only()
3054
 
        self._set_revision_history(self._lefthand_history(revision_id,
 
2506
        self.set_revision_history(self._lefthand_history(revision_id,
3055
2507
            last_rev=last_rev,other_branch=other_branch))
3056
2508
 
3057
2509
    def set_push_location(self, location):
3058
2510
        self._ensure_real()
3059
2511
        return self._real_branch.set_push_location(location)
3060
2512
 
3061
 
    def heads_to_fetch(self):
3062
 
        if self._format._use_default_local_heads_to_fetch():
3063
 
            # We recognise this format, and its heads-to-fetch implementation
3064
 
            # is the default one (tip + tags).  In this case it's cheaper to
3065
 
            # just use the default implementation rather than a special RPC as
3066
 
            # the tip and tags data is cached.
3067
 
            return branch.Branch.heads_to_fetch(self)
3068
 
        medium = self._client._medium
3069
 
        if medium._is_remote_before((2, 4)):
3070
 
            return self._vfs_heads_to_fetch()
3071
 
        try:
3072
 
            return self._rpc_heads_to_fetch()
3073
 
        except errors.UnknownSmartMethod:
3074
 
            medium._remember_remote_is_before((2, 4))
3075
 
            return self._vfs_heads_to_fetch()
3076
 
 
3077
 
    def _rpc_heads_to_fetch(self):
3078
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3079
 
        if len(response) != 2:
3080
 
            raise errors.UnexpectedSmartServerResponse(response)
3081
 
        must_fetch, if_present_fetch = response
3082
 
        return set(must_fetch), set(if_present_fetch)
3083
 
 
3084
 
    def _vfs_heads_to_fetch(self):
3085
 
        self._ensure_real()
3086
 
        return self._real_branch.heads_to_fetch()
3087
 
 
3088
2513
 
3089
2514
class RemoteConfig(object):
3090
2515
    """A Config that reads and writes from smart verbs.
3104
2529
        """
3105
2530
        try:
3106
2531
            configobj = self._get_configobj()
3107
 
            section_obj = None
3108
2532
            if section is None:
3109
2533
                section_obj = configobj
3110
2534
            else:
3111
2535
                try:
3112
2536
                    section_obj = configobj[section]
3113
2537
                except KeyError:
3114
 
                    pass
3115
 
            if section_obj is None:
3116
 
                value = default
3117
 
            else:
3118
 
                value = section_obj.get(name, default)
 
2538
                    return default
 
2539
            return section_obj.get(name, default)
3119
2540
        except errors.UnknownSmartMethod:
3120
 
            value = self._vfs_get_option(name, section, default)
3121
 
        for hook in config.OldConfigHooks['get']:
3122
 
            hook(self, name, value)
3123
 
        return value
 
2541
            return self._vfs_get_option(name, section, default)
3124
2542
 
3125
2543
    def _response_to_configobj(self, response):
3126
2544
        if len(response[0]) and response[0][0] != 'ok':
3127
2545
            raise errors.UnexpectedSmartServerResponse(response)
3128
2546
        lines = response[1].read_body_bytes().splitlines()
3129
 
        conf = config.ConfigObj(lines, encoding='utf-8')
3130
 
        for hook in config.OldConfigHooks['load']:
3131
 
            hook(self)
3132
 
        return conf
 
2547
        return config.ConfigObj(lines, encoding='utf-8')
3133
2548
 
3134
2549
 
3135
2550
class RemoteBranchConfig(RemoteConfig):
3154
2569
        medium = self._branch._client._medium
3155
2570
        if medium._is_remote_before((1, 14)):
3156
2571
            return self._vfs_set_option(value, name, section)
3157
 
        if isinstance(value, dict):
3158
 
            if medium._is_remote_before((2, 2)):
3159
 
                return self._vfs_set_option(value, name, section)
3160
 
            return self._set_config_option_dict(value, name, section)
3161
 
        else:
3162
 
            return self._set_config_option(value, name, section)
3163
 
 
3164
 
    def _set_config_option(self, value, name, section):
3165
2572
        try:
3166
2573
            path = self._branch._remote_path()
3167
2574
            response = self._branch._client.call('Branch.set_config_option',
3168
2575
                path, self._branch._lock_token, self._branch._repo_lock_token,
3169
2576
                value.encode('utf8'), name, section or '')
3170
2577
        except errors.UnknownSmartMethod:
3171
 
            medium = self._branch._client._medium
3172
2578
            medium._remember_remote_is_before((1, 14))
3173
2579
            return self._vfs_set_option(value, name, section)
3174
2580
        if response != ():
3175
2581
            raise errors.UnexpectedSmartServerResponse(response)
3176
2582
 
3177
 
    def _serialize_option_dict(self, option_dict):
3178
 
        utf8_dict = {}
3179
 
        for key, value in option_dict.items():
3180
 
            if isinstance(key, unicode):
3181
 
                key = key.encode('utf8')
3182
 
            if isinstance(value, unicode):
3183
 
                value = value.encode('utf8')
3184
 
            utf8_dict[key] = value
3185
 
        return bencode.bencode(utf8_dict)
3186
 
 
3187
 
    def _set_config_option_dict(self, value, name, section):
3188
 
        try:
3189
 
            path = self._branch._remote_path()
3190
 
            serialised_dict = self._serialize_option_dict(value)
3191
 
            response = self._branch._client.call(
3192
 
                'Branch.set_config_option_dict',
3193
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
3194
 
                serialised_dict, name, section or '')
3195
 
        except errors.UnknownSmartMethod:
3196
 
            medium = self._branch._client._medium
3197
 
            medium._remember_remote_is_before((2, 2))
3198
 
            return self._vfs_set_option(value, name, section)
3199
 
        if response != ():
3200
 
            raise errors.UnexpectedSmartServerResponse(response)
3201
 
 
3202
2583
    def _real_object(self):
3203
2584
        self._branch._ensure_real()
3204
2585
        return self._branch._real_branch
3291
2672
        raise NoSuchRevision(find('branch'), err.error_args[0])
3292
2673
    elif err.error_verb == 'nosuchrevision':
3293
2674
        raise NoSuchRevision(find('repository'), err.error_args[0])
3294
 
    elif err.error_verb == 'nobranch':
3295
 
        if len(err.error_args) >= 1:
3296
 
            extra = err.error_args[0]
3297
 
        else:
3298
 
            extra = None
3299
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3300
 
            detail=extra)
 
2675
    elif err.error_tuple == ('nobranch',):
 
2676
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
3301
2677
    elif err.error_verb == 'norepository':
3302
2678
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2679
    elif err.error_verb == 'LockContention':
 
2680
        raise errors.LockContention('(remote lock)')
3303
2681
    elif err.error_verb == 'UnlockableTransport':
3304
2682
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2683
    elif err.error_verb == 'LockFailed':
 
2684
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3305
2685
    elif err.error_verb == 'TokenMismatch':
3306
2686
        raise errors.TokenMismatch(find('token'), '(remote token)')
3307
2687
    elif err.error_verb == 'Diverged':
3308
2688
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2689
    elif err.error_verb == 'TipChangeRejected':
 
2690
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2691
    elif err.error_verb == 'UnstackableBranchFormat':
 
2692
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2693
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2694
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3309
2695
    elif err.error_verb == 'NotStacked':
3310
2696
        raise errors.NotStacked(branch=find('branch'))
3311
2697
    elif err.error_verb == 'PermissionDenied':
3321
2707
    elif err.error_verb == 'NoSuchFile':
3322
2708
        path = get_path()
3323
2709
        raise errors.NoSuchFile(path)
3324
 
    _translate_error_without_context(err)
3325
 
 
3326
 
 
3327
 
def _translate_error_without_context(err):
3328
 
    """Translate any ErrorFromSmartServer values that don't require context"""
3329
 
    if err.error_verb == 'IncompatibleRepositories':
3330
 
        raise errors.IncompatibleRepositories(err.error_args[0],
3331
 
            err.error_args[1], err.error_args[2])
3332
 
    elif err.error_verb == 'LockContention':
3333
 
        raise errors.LockContention('(remote lock)')
3334
 
    elif err.error_verb == 'LockFailed':
3335
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3336
 
    elif err.error_verb == 'TipChangeRejected':
3337
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3338
 
    elif err.error_verb == 'UnstackableBranchFormat':
3339
 
        raise errors.UnstackableBranchFormat(*err.error_args)
3340
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
3341
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3342
2710
    elif err.error_verb == 'FileExists':
3343
2711
        raise errors.FileExists(err.error_args[0])
3344
2712
    elif err.error_verb == 'DirectoryNotEmpty':
3363
2731
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3364
2732
    elif err.error_verb == 'ReadOnlyError':
3365
2733
        raise errors.TransportNotPossible('readonly transport')
3366
 
    elif err.error_verb == 'MemoryError':
3367
 
        raise errors.BzrError("remote server out of memory\n"
3368
 
            "Retry non-remotely, or contact the server admin for details.")
3369
2734
    raise errors.UnknownErrorFromSmartServer(err)