~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-02 17:28:44 UTC
  • mfrom: (3744.2.2 merge_reprocess)
  • Revision ID: pqm@pqm.ubuntu.com-20081002172844-d6df1l8dzpsqzyup
(jam) For 'bzr merge' enable '--reprocess' by default whenever
        '--show-base' is not set.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
16
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
 
    bzrdir as _mod_bzrdir,
23
 
    config,
24
 
    controldir,
25
24
    debug,
26
25
    errors,
27
26
    graph,
28
 
    lock,
29
27
    lockdir,
30
 
    repository as _mod_repository,
31
 
    revision as _mod_revision,
32
 
    static_tuple,
 
28
    repository,
 
29
    revision,
33
30
    symbol_versioning,
34
31
    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
 
32
)
 
33
from bzrlib.branch import BranchReferenceFormat
 
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
36
from bzrlib.errors import (
40
37
    NoSuchRevision,
41
38
    SmartProtocolError,
42
39
    )
43
40
from bzrlib.lockable_files import LockableFiles
44
 
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.smart.client import _SmartClient
46
 
from bzrlib.revision import NULL_REVISION
47
 
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
 
41
from bzrlib.smart import client, vfs
 
42
from bzrlib.revision import ensure_null, NULL_REVISION
48
43
from bzrlib.trace import mutter, note, warning
49
44
 
50
45
 
51
 
class _RpcHelper(object):
52
 
    """Mixin class that helps with issuing RPCs."""
53
 
 
54
 
    def _call(self, method, *args, **err_context):
55
 
        try:
56
 
            return self._client.call(method, *args)
57
 
        except errors.ErrorFromSmartServer, err:
58
 
            self._translate_error(err, **err_context)
59
 
 
60
 
    def _call_expecting_body(self, method, *args, **err_context):
61
 
        try:
62
 
            return self._client.call_expecting_body(method, *args)
63
 
        except errors.ErrorFromSmartServer, err:
64
 
            self._translate_error(err, **err_context)
65
 
 
66
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
67
 
        try:
68
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
69
 
        except errors.ErrorFromSmartServer, err:
70
 
            self._translate_error(err, **err_context)
71
 
 
72
 
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
73
 
                                             **err_context):
74
 
        try:
75
 
            return self._client.call_with_body_bytes_expecting_body(
76
 
                method, args, body_bytes)
77
 
        except errors.ErrorFromSmartServer, err:
78
 
            self._translate_error(err, **err_context)
79
 
 
80
 
 
81
 
def response_tuple_to_repo_format(response):
82
 
    """Convert a response tuple describing a repository format to a format."""
83
 
    format = RemoteRepositoryFormat()
84
 
    format._rich_root_data = (response[0] == 'yes')
85
 
    format._supports_tree_reference = (response[1] == 'yes')
86
 
    format._supports_external_lookups = (response[2] == 'yes')
87
 
    format._network_name = response[3]
88
 
    return format
89
 
 
90
 
 
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):
 
46
# Note: RemoteBzrDirFormat is in bzrdir.py
 
47
 
 
48
class RemoteBzrDir(BzrDir):
331
49
    """Control directory on a remote server, accessed via bzr:// or similar."""
332
50
 
333
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
51
    def __init__(self, transport, _client=None):
334
52
        """Construct a RemoteBzrDir.
335
53
 
336
54
        :param _client: Private parameter for testing. Disables probing and the
337
55
            use of a real bzrdir.
338
56
        """
339
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
57
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
340
58
        # this object holds a delegated bzrdir that uses file-level operations
341
59
        # to talk to the other side
342
60
        self._real_bzrdir = None
343
 
        self._has_working_tree = None
344
 
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
 
        # create_branch for details.
346
 
        self._next_open_branch_result = None
347
61
 
348
62
        if _client is None:
349
63
            medium = transport.get_smart_medium()
350
64
            self._client = client._SmartClient(medium)
351
65
        else:
352
66
            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
 
67
            return
 
68
 
363
69
        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
 
        response = self._call('BzrDir.open', path)
 
70
        response = self._client.call('BzrDir.open', path)
390
71
        if response not in [('yes',), ('no',)]:
391
72
            raise errors.UnexpectedSmartServerResponse(response)
392
73
        if response == ('no',):
393
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
74
            raise errors.NotBranchError(path=transport.base)
394
75
 
395
76
    def _ensure_real(self):
396
77
        """Ensure that there is a _real_bzrdir set.
398
79
        Used before calls to self._real_bzrdir.
399
80
        """
400
81
        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(
 
82
            self._real_bzrdir = BzrDir.open_from_transport(
406
83
                self.root_transport, _server_formats=False)
407
 
            self._format._network_name = \
408
 
                self._real_bzrdir._format.network_name()
 
84
 
 
85
    def cloning_metadir(self, stacked=False):
 
86
        self._ensure_real()
 
87
        return self._real_bzrdir.cloning_metadir(stacked)
409
88
 
410
89
    def _translate_error(self, err, **context):
411
90
        _translate_error(err, bzrdir=self, **context)
412
 
 
413
 
    def break_lock(self):
414
 
        # Prevent aliasing problems in the next_open_branch_result cache.
415
 
        # See create_branch for rationale.
416
 
        self._next_open_branch_result = None
417
 
        return _mod_bzrdir.BzrDir.break_lock(self)
418
 
 
419
 
    def _vfs_cloning_metadir(self, require_stacking=False):
420
 
        self._ensure_real()
421
 
        return self._real_bzrdir.cloning_metadir(
422
 
            require_stacking=require_stacking)
423
 
 
424
 
    def cloning_metadir(self, require_stacking=False):
425
 
        medium = self._client._medium
426
 
        if medium._is_remote_before((1, 13)):
427
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
428
 
        verb = 'BzrDir.cloning_metadir'
429
 
        if require_stacking:
430
 
            stacking = 'True'
431
 
        else:
432
 
            stacking = 'False'
433
 
        path = self._path_for_remote_call(self._client)
434
 
        try:
435
 
            response = self._call(verb, path, stacking)
436
 
        except errors.UnknownSmartMethod:
437
 
            medium._remember_remote_is_before((1, 13))
438
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
439
 
        except errors.UnknownErrorFromSmartServer, err:
440
 
            if err.error_tuple != ('BranchReference',):
441
 
                raise
442
 
            # We need to resolve the branch reference to determine the
443
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
444
 
            # referenced branch (and bzrdir, etc) but only when the caller
445
 
            # didn't already resolve the branch reference.
446
 
            referenced_branch = self.open_branch()
447
 
            return referenced_branch.bzrdir.cloning_metadir()
448
 
        if len(response) != 3:
449
 
            raise errors.UnexpectedSmartServerResponse(response)
450
 
        control_name, repo_name, branch_info = response
451
 
        if len(branch_info) != 2:
452
 
            raise errors.UnexpectedSmartServerResponse(response)
453
 
        branch_ref, branch_name = branch_info
454
 
        format = controldir.network_format_registry.get(control_name)
455
 
        if repo_name:
456
 
            format.repository_format = _mod_repository.network_format_registry.get(
457
 
                repo_name)
458
 
        if branch_ref == 'ref':
459
 
            # XXX: we need possible_transports here to avoid reopening the
460
 
            # connection to the referenced location
461
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
462
 
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
 
            format.set_branch_format(branch_format)
464
 
        elif branch_ref == 'branch':
465
 
            if branch_name:
466
 
                format.set_branch_format(
467
 
                    branch.network_format_registry.get(branch_name))
468
 
        else:
469
 
            raise errors.UnexpectedSmartServerResponse(response)
470
 
        return format
471
 
 
 
91
        
472
92
    def create_repository(self, shared=False):
473
 
        # as per meta1 formats - just delegate to the format object which may
474
 
        # be parameterised.
475
 
        result = self._format.repository_format.initialize(self, shared)
476
 
        if not isinstance(result, RemoteRepository):
477
 
            return self.open_repository()
478
 
        else:
479
 
            return result
 
93
        self._ensure_real()
 
94
        self._real_bzrdir.create_repository(shared=shared)
 
95
        return self.open_repository()
480
96
 
481
97
    def destroy_repository(self):
482
98
        """See BzrDir.destroy_repository"""
483
99
        self._ensure_real()
484
100
        self._real_bzrdir.destroy_repository()
485
101
 
486
 
    def create_branch(self, name=None, repository=None):
487
 
        # as per meta1 formats - just delegate to the format object which may
488
 
        # be parameterised.
489
 
        real_branch = self._format.get_branch_format().initialize(self,
490
 
            name=name, repository=repository)
491
 
        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)
497
 
        else:
498
 
            result = real_branch
499
 
        # BzrDir.clone_on_transport() uses the result of create_branch but does
500
 
        # not return it to its callers; we save approximately 8% of our round
501
 
        # trips by handing the branch we created back to the first caller to
502
 
        # open_branch rather than probing anew. Long term we need a API in
503
 
        # bzrdir that doesn't discard result objects (like result_branch).
504
 
        # RBC 20090225
505
 
        self._next_open_branch_result = result
506
 
        return result
 
102
    def create_branch(self):
 
103
        self._ensure_real()
 
104
        real_branch = self._real_bzrdir.create_branch()
 
105
        return RemoteBranch(self, self.find_repository(), real_branch)
507
106
 
508
 
    def destroy_branch(self, name=None):
 
107
    def destroy_branch(self):
509
108
        """See BzrDir.destroy_branch"""
510
109
        self._ensure_real()
511
 
        self._real_bzrdir.destroy_branch(name=name)
512
 
        self._next_open_branch_result = None
 
110
        self._real_bzrdir.destroy_branch()
513
111
 
514
 
    def create_workingtree(self, revision_id=None, from_branch=None,
515
 
        accelerator_tree=None, hardlink=False):
 
112
    def create_workingtree(self, revision_id=None, from_branch=None):
516
113
        raise errors.NotLocalUrl(self.transport.base)
517
114
 
518
 
    def find_branch_format(self, name=None):
 
115
    def find_branch_format(self):
519
116
        """Find the branch 'format' for this bzrdir.
520
117
 
521
118
        This might be a synthetic object for e.g. RemoteBranch and SVN.
522
119
        """
523
 
        b = self.open_branch(name=name)
 
120
        b = self.open_branch()
524
121
        return b._format
525
122
 
526
 
    def get_branch_reference(self, name=None):
 
123
    def get_branch_reference(self):
527
124
        """See BzrDir.get_branch_reference()."""
528
 
        if name is not None:
529
 
            # XXX JRV20100304: Support opening colocated branches
530
 
            raise errors.NoColocatedBranchSupport(self)
531
 
        response = self._get_branch_reference()
532
 
        if response[0] == 'ref':
533
 
            return response[1]
 
125
        path = self._path_for_remote_call(self._client)
 
126
        try:
 
127
            response = self._client.call('BzrDir.open_branch', path)
 
128
        except errors.ErrorFromSmartServer, err:
 
129
            self._translate_error(err)
 
130
        if response[0] == 'ok':
 
131
            if response[1] == '':
 
132
                # branch at this location.
 
133
                return None
 
134
            else:
 
135
                # a branch reference, use the existing BranchReference logic.
 
136
                return response[1]
534
137
        else:
535
 
            return None
536
 
 
537
 
    def _get_branch_reference(self):
538
 
        path = self._path_for_remote_call(self._client)
539
 
        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
548
 
            try:
549
 
                response = self._call(verb, path)
550
 
            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'):
564
138
            raise errors.UnexpectedSmartServerResponse(response)
565
 
        return response
566
139
 
567
 
    def _get_tree_branch(self, name=None):
 
140
    def _get_tree_branch(self):
568
141
        """See BzrDir._get_tree_branch()."""
569
 
        return None, self.open_branch(name=name)
 
142
        return None, self.open_branch()
570
143
 
571
 
    def open_branch(self, name=None, unsupported=False,
572
 
                    ignore_fallbacks=False):
573
 
        if unsupported:
 
144
    def open_branch(self, _unsupported=False):
 
145
        if _unsupported:
574
146
            raise NotImplementedError('unsupported flag support not implemented yet.')
575
 
        if self._next_open_branch_result is not None:
576
 
            # See create_branch for details.
577
 
            result = self._next_open_branch_result
578
 
            self._next_open_branch_result = None
579
 
            return result
580
 
        response = self._get_branch_reference()
581
 
        if response[0] == 'ref':
 
147
        reference_url = self.get_branch_reference()
 
148
        if reference_url is None:
 
149
            # branch at this location.
 
150
            return RemoteBranch(self, self.find_repository())
 
151
        else:
582
152
            # a branch reference, use the existing BranchReference logic.
583
153
            format = BranchReferenceFormat()
584
 
            return format.open(self, name=name, _found=True,
585
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
586
 
        branch_format_name = response[1]
587
 
        if not branch_format_name:
588
 
            branch_format_name = None
589
 
        format = RemoteBranchFormat(network_name=branch_format_name)
590
 
        return RemoteBranch(self, self.find_repository(), format=format,
591
 
            setup_stacking=not ignore_fallbacks, name=name)
592
 
 
593
 
    def _open_repo_v1(self, path):
594
 
        verb = 'BzrDir.find_repository'
595
 
        response = self._call(verb, path)
596
 
        if response[0] != 'ok':
597
 
            raise errors.UnexpectedSmartServerResponse(response)
598
 
        # servers that only support the v1 method don't support external
599
 
        # references either.
600
 
        self._ensure_real()
601
 
        repo = self._real_bzrdir.open_repository()
602
 
        response = response + ('no', repo._format.network_name())
603
 
        return response, repo
604
 
 
605
 
    def _open_repo_v2(self, path):
 
154
            return format.open(self, _found=True, location=reference_url)
 
155
                
 
156
    def open_repository(self):
 
157
        path = self._path_for_remote_call(self._client)
606
158
        verb = 'BzrDir.find_repositoryV2'
607
 
        response = self._call(verb, path)
608
 
        if response[0] != 'ok':
609
 
            raise errors.UnexpectedSmartServerResponse(response)
610
 
        self._ensure_real()
611
 
        repo = self._real_bzrdir.open_repository()
612
 
        response = response + (repo._format.network_name(),)
613
 
        return response, repo
614
 
 
615
 
    def _open_repo_v3(self, path):
616
 
        verb = 'BzrDir.find_repositoryV3'
617
 
        medium = self._client._medium
618
 
        if medium._is_remote_before((1, 13)):
619
 
            raise errors.UnknownSmartMethod(verb)
620
159
        try:
621
 
            response = self._call(verb, path)
622
 
        except errors.UnknownSmartMethod:
623
 
            medium._remember_remote_is_before((1, 13))
624
 
            raise
625
 
        if response[0] != 'ok':
626
 
            raise errors.UnexpectedSmartServerResponse(response)
627
 
        return response, None
628
 
 
629
 
    def open_repository(self):
630
 
        path = self._path_for_remote_call(self._client)
631
 
        response = None
632
 
        for probe in [self._open_repo_v3, self._open_repo_v2,
633
 
            self._open_repo_v1]:
634
160
            try:
635
 
                response, real_repo = probe(path)
636
 
                break
 
161
                response = self._client.call(verb, path)
637
162
            except errors.UnknownSmartMethod:
638
 
                pass
639
 
        if response is None:
640
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
 
163
                verb = 'BzrDir.find_repository'
 
164
                response = self._client.call(verb, path)
 
165
        except errors.ErrorFromSmartServer, err:
 
166
            self._translate_error(err)
641
167
        if response[0] != 'ok':
642
168
            raise errors.UnexpectedSmartServerResponse(response)
643
 
        if len(response) != 6:
 
169
        if verb == 'BzrDir.find_repository':
 
170
            # servers that don't support the V2 method don't support external
 
171
            # references either.
 
172
            response = response + ('no', )
 
173
        if not (len(response) == 5):
644
174
            raise SmartProtocolError('incorrect response length %s' % (response,))
645
175
        if response[1] == '':
646
 
            # repo is at this dir.
647
 
            format = response_tuple_to_repo_format(response[2:])
 
176
            format = RemoteRepositoryFormat()
 
177
            format.rich_root_data = (response[2] == 'yes')
 
178
            format.supports_tree_reference = (response[3] == 'yes')
 
179
            # No wire format to check this yet.
 
180
            format.supports_external_lookups = (response[4] == 'yes')
648
181
            # Used to support creating a real format instance when needed.
649
182
            format._creating_bzrdir = self
650
 
            remote_repo = RemoteRepository(self, format)
651
 
            format._creating_repo = remote_repo
652
 
            if real_repo is not None:
653
 
                remote_repo._set_real_repository(real_repo)
654
 
            return remote_repo
 
183
            return RemoteRepository(self, format)
655
184
        else:
656
185
            raise errors.NoRepositoryPresent(self)
657
186
 
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
187
    def open_workingtree(self, recommend_upgrade=True):
665
 
        if self.has_workingtree():
 
188
        self._ensure_real()
 
189
        if self._real_bzrdir.has_workingtree():
666
190
            raise errors.NotLocalUrl(self.root_transport)
667
191
        else:
668
192
            raise errors.NoWorkingTree(self.root_transport.base)
669
193
 
670
194
    def _path_for_remote_call(self, client):
671
195
        """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]
 
196
        return client.remote_path_from_transport(self.root_transport)
674
197
 
675
 
    def get_branch_transport(self, branch_format, name=None):
 
198
    def get_branch_transport(self, branch_format):
676
199
        self._ensure_real()
677
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
200
        return self._real_bzrdir.get_branch_transport(branch_format)
678
201
 
679
202
    def get_repository_transport(self, repository_format):
680
203
        self._ensure_real()
688
211
        """Upgrading of remote bzrdirs is not supported yet."""
689
212
        return False
690
213
 
691
 
    def needs_format_conversion(self, format):
 
214
    def needs_format_conversion(self, format=None):
692
215
        """Upgrading of remote bzrdirs is not supported yet."""
693
216
        return False
694
217
 
698
221
        return self._real_bzrdir.clone(url, revision_id=revision_id,
699
222
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
700
223
 
701
 
    def _get_config(self):
702
 
        return RemoteBzrDirConfig(self)
703
 
 
704
 
 
705
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
224
    def get_config(self):
 
225
        self._ensure_real()
 
226
        return self._real_bzrdir.get_config()
 
227
 
 
228
 
 
229
class RemoteRepositoryFormat(repository.RepositoryFormat):
706
230
    """Format for repositories accessed over a _SmartClient.
707
231
 
708
232
    Instances of this repository are represented by RemoteRepository
713
237
    the attributes rich_root_data and supports_tree_reference are set
714
238
    on a per instance basis, and are not set (and should not be) at
715
239
    the class level.
716
 
 
717
 
    :ivar _custom_format: If set, a specific concrete repository format that
718
 
        will be used when initializing a repository with this
719
 
        RemoteRepositoryFormat.
720
 
    :ivar _creating_repo: If set, the repository object that this
721
 
        RemoteRepositoryFormat was created for: it can be called into
722
 
        to obtain data like the network name.
723
240
    """
724
241
 
725
242
    _matchingbzrdir = RemoteBzrDirFormat()
726
 
    supports_full_versioned_files = True
727
 
    supports_leaving_lock = True
728
 
 
729
 
    def __init__(self):
730
 
        _mod_repository.RepositoryFormat.__init__(self)
731
 
        self._custom_format = None
732
 
        self._network_name = None
733
 
        self._creating_bzrdir = None
734
 
        self._revision_graph_can_have_wrong_parents = None
735
 
        self._supports_chks = None
736
 
        self._supports_external_lookups = None
737
 
        self._supports_tree_reference = None
738
 
        self._supports_funky_characters = None
739
 
        self._rich_root_data = None
740
 
 
741
 
    def __repr__(self):
742
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
743
 
            self._network_name)
744
 
 
745
 
    @property
746
 
    def fast_deltas(self):
747
 
        self._ensure_real()
748
 
        return self._custom_format.fast_deltas
749
 
 
750
 
    @property
751
 
    def rich_root_data(self):
752
 
        if self._rich_root_data is None:
753
 
            self._ensure_real()
754
 
            self._rich_root_data = self._custom_format.rich_root_data
755
 
        return self._rich_root_data
756
 
 
757
 
    @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
 
    def supports_external_lookups(self):
766
 
        if self._supports_external_lookups is None:
767
 
            self._ensure_real()
768
 
            self._supports_external_lookups = \
769
 
                self._custom_format.supports_external_lookups
770
 
        return self._supports_external_lookups
771
 
 
772
 
    @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
 
    def supports_tree_reference(self):
782
 
        if self._supports_tree_reference is None:
783
 
            self._ensure_real()
784
 
            self._supports_tree_reference = \
785
 
                self._custom_format.supports_tree_reference
786
 
        return self._supports_tree_reference
787
 
 
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
 
    def _vfs_initialize(self, a_bzrdir, shared):
797
 
        """Helper for common code in initialize."""
798
 
        if self._custom_format:
799
 
            # Custom format requested
800
 
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
801
 
        elif self._creating_bzrdir is not None:
802
 
            # Use the format that the repository we were created to back
803
 
            # has.
 
243
 
 
244
    def initialize(self, a_bzrdir, shared=False):
 
245
        if not isinstance(a_bzrdir, RemoteBzrDir):
804
246
            prior_repo = self._creating_bzrdir.open_repository()
805
247
            prior_repo._ensure_real()
806
 
            result = prior_repo._real_repository._format.initialize(
 
248
            return prior_repo._real_repository._format.initialize(
807
249
                a_bzrdir, shared=shared)
808
 
        else:
809
 
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
810
 
            # support remote initialization.
811
 
            # We delegate to a real object at this point (as RemoteBzrDir
812
 
            # delegate to the repository format which would lead to infinite
813
 
            # recursion if we just called a_bzrdir.create_repository.
814
 
            a_bzrdir._ensure_real()
815
 
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
816
 
        if not isinstance(result, RemoteRepository):
817
 
            return self.open(a_bzrdir)
818
 
        else:
819
 
            return result
820
 
 
821
 
    def initialize(self, a_bzrdir, shared=False):
822
 
        # Being asked to create on a non RemoteBzrDir:
823
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
824
 
            return self._vfs_initialize(a_bzrdir, shared)
825
 
        medium = a_bzrdir._client._medium
826
 
        if medium._is_remote_before((1, 13)):
827
 
            return self._vfs_initialize(a_bzrdir, shared)
828
 
        # Creating on a remote bzr dir.
829
 
        # 1) get the network name to use.
830
 
        if self._custom_format:
831
 
            network_name = self._custom_format.network_name()
832
 
        elif self._network_name:
833
 
            network_name = self._network_name
834
 
        else:
835
 
            # Select the current bzrlib default and ask for that.
836
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
837
 
            reference_format = reference_bzrdir_format.repository_format
838
 
            network_name = reference_format.network_name()
839
 
        # 2) try direct creation via RPC
840
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
841
 
        verb = 'BzrDir.create_repository'
842
 
        if shared:
843
 
            shared_str = 'True'
844
 
        else:
845
 
            shared_str = 'False'
846
 
        try:
847
 
            response = a_bzrdir._call(verb, path, network_name, shared_str)
848
 
        except errors.UnknownSmartMethod:
849
 
            # Fallback - use vfs methods
850
 
            medium._remember_remote_is_before((1, 13))
851
 
            return self._vfs_initialize(a_bzrdir, shared)
852
 
        else:
853
 
            # Turn the response into a RemoteRepository object.
854
 
            format = response_tuple_to_repo_format(response[1:])
855
 
            # Used to support creating a real format instance when needed.
856
 
            format._creating_bzrdir = a_bzrdir
857
 
            remote_repo = RemoteRepository(a_bzrdir, format)
858
 
            format._creating_repo = remote_repo
859
 
            return remote_repo
860
 
 
 
250
        return a_bzrdir.create_repository(shared=shared)
 
251
    
861
252
    def open(self, a_bzrdir):
862
253
        if not isinstance(a_bzrdir, RemoteBzrDir):
863
254
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
864
255
        return a_bzrdir.open_repository()
865
256
 
866
 
    def _ensure_real(self):
867
 
        if self._custom_format is None:
868
 
            self._custom_format = _mod_repository.network_format_registry.get(
869
 
                self._network_name)
870
 
 
871
 
    @property
872
 
    def _fetch_order(self):
873
 
        self._ensure_real()
874
 
        return self._custom_format._fetch_order
875
 
 
876
 
    @property
877
 
    def _fetch_uses_deltas(self):
878
 
        self._ensure_real()
879
 
        return self._custom_format._fetch_uses_deltas
880
 
 
881
 
    @property
882
 
    def _fetch_reconcile(self):
883
 
        self._ensure_real()
884
 
        return self._custom_format._fetch_reconcile
885
 
 
886
257
    def get_format_description(self):
887
 
        self._ensure_real()
888
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
258
        return 'bzr remote repository'
889
259
 
890
260
    def __eq__(self, other):
891
 
        return self.__class__ is other.__class__
892
 
 
893
 
    def network_name(self):
894
 
        if self._network_name:
895
 
            return self._network_name
896
 
        self._creating_repo._ensure_real()
897
 
        return self._creating_repo._real_repository._format.network_name()
898
 
 
899
 
    @property
900
 
    def pack_compresses(self):
901
 
        self._ensure_real()
902
 
        return self._custom_format.pack_compresses
903
 
 
904
 
    @property
905
 
    def _serializer(self):
906
 
        self._ensure_real()
907
 
        return self._custom_format._serializer
908
 
 
909
 
 
910
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
911
 
    controldir.ControlComponent):
 
261
        return self.__class__ == other.__class__
 
262
 
 
263
    def check_conversion_target(self, target_format):
 
264
        if self.rich_root_data and not target_format.rich_root_data:
 
265
            raise errors.BadConversionTarget(
 
266
                'Does not support rich root data.', target_format)
 
267
        if (self.supports_tree_reference and
 
268
            not getattr(target_format, 'supports_tree_reference', False)):
 
269
            raise errors.BadConversionTarget(
 
270
                'Does not support nested trees', target_format)
 
271
 
 
272
 
 
273
class RemoteRepository(object):
912
274
    """Repository accessed over rpc.
913
275
 
914
276
    For the moment most operations are performed using local transport-backed
917
279
 
918
280
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
919
281
        """Create a RemoteRepository instance.
920
 
 
 
282
        
921
283
        :param remote_bzrdir: The bzrdir hosting this repository.
922
284
        :param format: The RemoteFormat object to use.
923
285
        :param real_repository: If not None, a local implementation of the
940
302
        self._lock_token = None
941
303
        self._lock_count = 0
942
304
        self._leave_lock = False
943
 
        # Cache of revision parents; misses are cached during read locks, and
944
 
        # write locks when no _real_repository has been set.
945
 
        self._unstacked_provider = graph.CachingParentsProvider(
946
 
            get_parent_map=self._get_parent_map_rpc)
947
 
        self._unstacked_provider.disable_cache()
 
305
        # A cache of looked up revision parent data; reset at unlock time.
 
306
        self._parents_map = None
 
307
        if 'hpss' in debug.debug_flags:
 
308
            self._requested_parents = None
948
309
        # For tests:
949
310
        # These depend on the actual remote format, so force them off for
950
311
        # maximum compatibility. XXX: In future these should depend on the
957
318
        # Additional places to query for data.
958
319
        self._fallback_repositories = []
959
320
 
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
321
    def __str__(self):
972
322
        return "%s(%s)" % (self.__class__.__name__, self.base)
973
323
 
974
324
    __repr__ = __str__
975
325
 
976
 
    def abort_write_group(self, suppress_errors=False):
 
326
    def abort_write_group(self):
977
327
        """Complete a write group on the decorated repository.
978
 
 
979
 
        Smart methods perform operations in a single step so this API
 
328
        
 
329
        Smart methods peform operations in a single step so this api
980
330
        is not really applicable except as a compatibility thunk
981
331
        for older plugins that don't use e.g. the CommitBuilder
982
332
        facility.
983
 
 
984
 
        :param suppress_errors: see Repository.abort_write_group.
985
 
        """
986
 
        self._ensure_real()
987
 
        return self._real_repository.abort_write_group(
988
 
            suppress_errors=suppress_errors)
989
 
 
990
 
    @property
991
 
    def chk_bytes(self):
992
 
        """Decorate the real repository for now.
993
 
 
994
 
        In the long term a full blown network facility is needed to avoid
995
 
        creating a real repository object locally.
996
 
        """
997
 
        self._ensure_real()
998
 
        return self._real_repository.chk_bytes
 
333
        """
 
334
        self._ensure_real()
 
335
        return self._real_repository.abort_write_group()
999
336
 
1000
337
    def commit_write_group(self):
1001
338
        """Complete a write group on the decorated repository.
1002
 
 
1003
 
        Smart methods perform operations in a single step so this API
 
339
        
 
340
        Smart methods peform operations in a single step so this api
1004
341
        is not really applicable except as a compatibility thunk
1005
342
        for older plugins that don't use e.g. the CommitBuilder
1006
343
        facility.
1008
345
        self._ensure_real()
1009
346
        return self._real_repository.commit_write_group()
1010
347
 
1011
 
    def resume_write_group(self, tokens):
1012
 
        self._ensure_real()
1013
 
        return self._real_repository.resume_write_group(tokens)
1014
 
 
1015
 
    def suspend_write_group(self):
1016
 
        self._ensure_real()
1017
 
        return self._real_repository.suspend_write_group()
1018
 
 
1019
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1020
 
        self._ensure_real()
1021
 
        return self._real_repository.get_missing_parent_inventories(
1022
 
            check_for_missing_texts=check_for_missing_texts)
1023
 
 
1024
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
1025
 
        self._ensure_real()
1026
 
        return self._real_repository.get_rev_id_for_revno(
1027
 
            revno, known_pair)
1028
 
 
1029
 
    def get_rev_id_for_revno(self, revno, known_pair):
1030
 
        """See Repository.get_rev_id_for_revno."""
1031
 
        path = self.bzrdir._path_for_remote_call(self._client)
1032
 
        try:
1033
 
            if self._client._medium._is_remote_before((1, 17)):
1034
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
1035
 
            response = self._call(
1036
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
1037
 
        except errors.UnknownSmartMethod:
1038
 
            self._client._medium._remember_remote_is_before((1, 17))
1039
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
1040
 
        if response[0] == 'ok':
1041
 
            return True, response[1]
1042
 
        elif response[0] == 'history-incomplete':
1043
 
            known_pair = response[1:3]
1044
 
            for fallback in self._fallback_repositories:
1045
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
1046
 
                if found:
1047
 
                    return True, result
1048
 
                else:
1049
 
                    known_pair = result
1050
 
            # Not found in any fallbacks
1051
 
            return False, known_pair
1052
 
        else:
1053
 
            raise errors.UnexpectedSmartServerResponse(response)
1054
 
 
1055
348
    def _ensure_real(self):
1056
349
        """Ensure that there is a _real_repository set.
1057
350
 
1058
351
        Used before calls to self._real_repository.
1059
 
 
1060
 
        Note that _ensure_real causes many roundtrips to the server which are
1061
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
1062
 
        perform complex operations (such as accessing parent data, streaming
1063
 
        revisions etc). Adding calls to _ensure_real should only be done when
1064
 
        bringing up new functionality, adding fallbacks for smart methods that
1065
 
        require a fallback path, and never to replace an existing smart method
1066
 
        invocation. If in doubt chat to the bzr network team.
1067
352
        """
1068
353
        if self._real_repository is None:
1069
 
            if 'hpssvfs' in debug.debug_flags:
1070
 
                import traceback
1071
 
                warning('VFS Repository access triggered\n%s',
1072
 
                    ''.join(traceback.format_stack()))
1073
 
            self._unstacked_provider.missing_keys.clear()
1074
354
            self.bzrdir._ensure_real()
1075
355
            self._set_real_repository(
1076
356
                self.bzrdir._real_bzrdir.open_repository())
1081
361
    def find_text_key_references(self):
1082
362
        """Find the text key references within the repository.
1083
363
 
 
364
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
365
        revision_ids. Each altered file-ids has the exact revision_ids that
 
366
        altered it listed explicitly.
1084
367
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1085
368
            to whether they were referred to by the inventory of the
1086
369
            revision_id that they contain. The inventory texts from all present
1100
383
        self._ensure_real()
1101
384
        return self._real_repository._generate_text_key_index()
1102
385
 
 
386
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
387
    def get_revision_graph(self, revision_id=None):
 
388
        """See Repository.get_revision_graph()."""
 
389
        return self._get_revision_graph(revision_id)
 
390
 
1103
391
    def _get_revision_graph(self, revision_id):
1104
392
        """Private method for using with old (< 1.2) servers to fallback."""
1105
393
        if revision_id is None:
1106
394
            revision_id = ''
1107
 
        elif _mod_revision.is_null(revision_id):
 
395
        elif revision.is_null(revision_id):
1108
396
            return {}
1109
397
 
1110
398
        path = self.bzrdir._path_for_remote_call(self._client)
1111
 
        response = self._call_expecting_body(
1112
 
            'Repository.get_revision_graph', path, revision_id)
 
399
        try:
 
400
            response = self._client.call_expecting_body(
 
401
                'Repository.get_revision_graph', path, revision_id)
 
402
        except errors.ErrorFromSmartServer, err:
 
403
            self._translate_error(err)
1113
404
        response_tuple, response_handler = response
1114
405
        if response_tuple[0] != 'ok':
1115
406
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1122
413
        for line in lines:
1123
414
            d = tuple(line.split())
1124
415
            revision_graph[d[0]] = d[1:]
1125
 
 
 
416
            
1126
417
        return revision_graph
1127
418
 
1128
 
    def _get_sink(self):
1129
 
        """See Repository._get_sink()."""
1130
 
        return RemoteStreamSink(self)
1131
 
 
1132
 
    def _get_source(self, to_format):
1133
 
        """Return a source for streaming from this repository."""
1134
 
        return RemoteStreamSource(self, to_format)
1135
 
 
1136
 
    @needs_read_lock
1137
 
    def get_file_graph(self):
1138
 
        return graph.Graph(self.texts)
1139
 
 
1140
 
    @needs_read_lock
1141
419
    def has_revision(self, revision_id):
1142
 
        """True if this repository has a copy of the revision."""
1143
 
        # Copy of bzrlib.repository.Repository.has_revision
1144
 
        return revision_id in self.has_revisions((revision_id,))
 
420
        """See Repository.has_revision()."""
 
421
        if revision_id == NULL_REVISION:
 
422
            # The null revision is always present.
 
423
            return True
 
424
        path = self.bzrdir._path_for_remote_call(self._client)
 
425
        response = self._client.call(
 
426
            'Repository.has_revision', path, revision_id)
 
427
        if response[0] not in ('yes', 'no'):
 
428
            raise errors.UnexpectedSmartServerResponse(response)
 
429
        if response[0] == 'yes':
 
430
            return True
 
431
        for fallback_repo in self._fallback_repositories:
 
432
            if fallback_repo.has_revision(revision_id):
 
433
                return True
 
434
        return False
1145
435
 
1146
 
    @needs_read_lock
1147
436
    def has_revisions(self, revision_ids):
1148
 
        """Probe to find out the presence of multiple revisions.
1149
 
 
1150
 
        :param revision_ids: An iterable of revision_ids.
1151
 
        :return: A set of the revision_ids that were present.
1152
 
        """
1153
 
        # Copy of bzrlib.repository.Repository.has_revisions
1154
 
        parent_map = self.get_parent_map(revision_ids)
1155
 
        result = set(parent_map)
1156
 
        if _mod_revision.NULL_REVISION in revision_ids:
1157
 
            result.add(_mod_revision.NULL_REVISION)
 
437
        """See Repository.has_revisions()."""
 
438
        # FIXME: This does many roundtrips, particularly when there are
 
439
        # fallback repositories.  -- mbp 20080905
 
440
        result = set()
 
441
        for revision_id in revision_ids:
 
442
            if self.has_revision(revision_id):
 
443
                result.add(revision_id)
1158
444
        return result
1159
445
 
1160
 
    def _has_same_fallbacks(self, other_repo):
1161
 
        """Returns true if the repositories have the same fallbacks."""
1162
 
        # XXX: copied from Repository; it should be unified into a base class
1163
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
1164
 
        my_fb = self._fallback_repositories
1165
 
        other_fb = other_repo._fallback_repositories
1166
 
        if len(my_fb) != len(other_fb):
1167
 
            return False
1168
 
        for f, g in zip(my_fb, other_fb):
1169
 
            if not f.has_same_location(g):
1170
 
                return False
1171
 
        return True
1172
 
 
1173
446
    def has_same_location(self, other):
1174
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
1175
 
        # one; unfortunately the tests rely on slightly different behaviour at
1176
 
        # present -- mbp 20090710
1177
 
        return (self.__class__ is other.__class__ and
 
447
        return (self.__class__ == other.__class__ and
1178
448
                self.bzrdir.transport.base == other.bzrdir.transport.base)
1179
 
 
 
449
        
1180
450
    def get_graph(self, other_repository=None):
1181
451
        """Return the graph for this repository format"""
1182
 
        parents_provider = self._make_parents_provider(other_repository)
 
452
        parents_provider = self
 
453
        if (other_repository is not None and
 
454
            other_repository.bzrdir.transport.base !=
 
455
            self.bzrdir.transport.base):
 
456
            parents_provider = graph._StackedParentsProvider(
 
457
                [parents_provider, other_repository._make_parents_provider()])
1183
458
        return graph.Graph(parents_provider)
1184
459
 
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
460
    def gather_stats(self, revid=None, committers=None):
1195
461
        """See Repository.gather_stats()."""
1196
462
        path = self.bzrdir._path_for_remote_call(self._client)
1197
463
        # revid can be None to indicate no revisions, not just NULL_REVISION
1198
 
        if revid is None or _mod_revision.is_null(revid):
 
464
        if revid is None or revision.is_null(revid):
1199
465
            fmt_revid = ''
1200
466
        else:
1201
467
            fmt_revid = revid
1203
469
            fmt_committers = 'no'
1204
470
        else:
1205
471
            fmt_committers = 'yes'
1206
 
        response_tuple, response_handler = self._call_expecting_body(
 
472
        response_tuple, response_handler = self._client.call_expecting_body(
1207
473
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
1208
474
        if response_tuple[0] != 'ok':
1209
475
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1248
514
    def is_shared(self):
1249
515
        """See Repository.is_shared()."""
1250
516
        path = self.bzrdir._path_for_remote_call(self._client)
1251
 
        response = self._call('Repository.is_shared', path)
 
517
        response = self._client.call('Repository.is_shared', path)
1252
518
        if response[0] not in ('yes', 'no'):
1253
519
            raise SmartProtocolError('unexpected response code %s' % (response,))
1254
520
        return response[0] == 'yes'
1256
522
    def is_write_locked(self):
1257
523
        return self._lock_mode == 'w'
1258
524
 
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
525
    def lock_read(self):
1265
 
        """Lock the repository for read operations.
1266
 
 
1267
 
        :return: A bzrlib.lock.LogicalLockResult.
1268
 
        """
1269
526
        # wrong eventually - want a local lock cache context
1270
527
        if not self._lock_mode:
1271
 
            self._note_lock('r')
1272
528
            self._lock_mode = 'r'
1273
529
            self._lock_count = 1
1274
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
530
            self._parents_map = {}
 
531
            if 'hpss' in debug.debug_flags:
 
532
                self._requested_parents = set()
1275
533
            if self._real_repository is not None:
1276
534
                self._real_repository.lock_read()
1277
 
            for repo in self._fallback_repositories:
1278
 
                repo.lock_read()
1279
535
        else:
1280
536
            self._lock_count += 1
1281
 
        return lock.LogicalLockResult(self.unlock)
1282
537
 
1283
538
    def _remote_lock_write(self, token):
1284
539
        path = self.bzrdir._path_for_remote_call(self._client)
1285
540
        if token is None:
1286
541
            token = ''
1287
 
        err_context = {'token': token}
1288
 
        response = self._call('Repository.lock_write', path, token,
1289
 
                              **err_context)
 
542
        try:
 
543
            response = self._client.call('Repository.lock_write', path, token)
 
544
        except errors.ErrorFromSmartServer, err:
 
545
            self._translate_error(err, token=token)
 
546
 
1290
547
        if response[0] == 'ok':
1291
548
            ok, token = response
1292
549
            return token
1295
552
 
1296
553
    def lock_write(self, token=None, _skip_rpc=False):
1297
554
        if not self._lock_mode:
1298
 
            self._note_lock('w')
1299
555
            if _skip_rpc:
1300
556
                if self._lock_token is not None:
1301
557
                    if token != self._lock_token:
1315
571
                self._leave_lock = False
1316
572
            self._lock_mode = 'w'
1317
573
            self._lock_count = 1
1318
 
            cache_misses = self._real_repository is None
1319
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1320
 
            for repo in self._fallback_repositories:
1321
 
                # Writes don't affect fallback repos
1322
 
                repo.lock_read()
 
574
            self._parents_map = {}
 
575
            if 'hpss' in debug.debug_flags:
 
576
                self._requested_parents = set()
1323
577
        elif self._lock_mode == 'r':
1324
578
            raise errors.ReadOnlyError(self)
1325
579
        else:
1326
580
            self._lock_count += 1
1327
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
581
        return self._lock_token or None
1328
582
 
1329
583
    def leave_lock_in_place(self):
1330
584
        if not self._lock_token:
1343
597
            implemented operations.
1344
598
        """
1345
599
        if self._real_repository is not None:
1346
 
            # Replacing an already set real repository.
1347
 
            # We cannot do this [currently] if the repository is locked -
1348
 
            # synchronised state might be lost.
1349
 
            if self.is_locked():
1350
 
                raise AssertionError('_real_repository is already set')
 
600
            raise AssertionError('_real_repository is already set')
1351
601
        if isinstance(repository, RemoteRepository):
1352
602
            raise AssertionError()
1353
603
        self._real_repository = repository
1354
 
        # three code paths happen here:
1355
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1356
 
        # up stacking. In this case self._fallback_repositories is [], and the
1357
 
        # real repo is already setup. Preserve the real repo and
1358
 
        # RemoteRepository.add_fallback_repository will avoid adding
1359
 
        # duplicates.
1360
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1361
 
        # ensure_real is triggered from a branch, the real repository to
1362
 
        # set already has a matching list with separate instances, but
1363
 
        # as they are also RemoteRepositories we don't worry about making the
1364
 
        # lists be identical.
1365
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1366
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1367
 
        # and need to populate it.
1368
 
        if (self._fallback_repositories and
1369
 
            len(self._real_repository._fallback_repositories) !=
1370
 
            len(self._fallback_repositories)):
1371
 
            if len(self._real_repository._fallback_repositories):
1372
 
                raise AssertionError(
1373
 
                    "cannot cleanly remove existing _fallback_repositories")
1374
604
        for fb in self._fallback_repositories:
1375
605
            self._real_repository.add_fallback_repository(fb)
1376
606
        if self._lock_mode == 'w':
1382
612
 
1383
613
    def start_write_group(self):
1384
614
        """Start a write group on the decorated repository.
1385
 
 
1386
 
        Smart methods perform operations in a single step so this API
 
615
        
 
616
        Smart methods peform operations in a single step so this api
1387
617
        is not really applicable except as a compatibility thunk
1388
618
        for older plugins that don't use e.g. the CommitBuilder
1389
619
        facility.
1396
626
        if not token:
1397
627
            # with no token the remote repository is not persistently locked.
1398
628
            return
1399
 
        err_context = {'token': token}
1400
 
        response = self._call('Repository.unlock', path, token,
1401
 
                              **err_context)
 
629
        try:
 
630
            response = self._client.call('Repository.unlock', path, token)
 
631
        except errors.ErrorFromSmartServer, err:
 
632
            self._translate_error(err, token=token)
1402
633
        if response == ('ok',):
1403
634
            return
1404
635
        else:
1405
636
            raise errors.UnexpectedSmartServerResponse(response)
1406
637
 
1407
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1408
638
    def unlock(self):
1409
 
        if not self._lock_count:
1410
 
            return lock.cant_unlock_not_held(self)
1411
639
        self._lock_count -= 1
1412
640
        if self._lock_count > 0:
1413
641
            return
1414
 
        self._unstacked_provider.disable_cache()
 
642
        self._parents_map = None
 
643
        if 'hpss' in debug.debug_flags:
 
644
            self._requested_parents = None
1415
645
        old_mode = self._lock_mode
1416
646
        self._lock_mode = None
1417
647
        try:
1427
657
            # problem releasing the vfs-based lock.
1428
658
            if old_mode == 'w':
1429
659
                # Only write-locked repositories need to make a remote method
1430
 
                # call to perform the unlock.
 
660
                # call to perfom the unlock.
1431
661
                old_token = self._lock_token
1432
662
                self._lock_token = None
1433
663
                if not self._leave_lock:
1434
664
                    self._unlock(old_token)
1435
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1436
 
        # self._leave_lock
1437
 
        for repo in self._fallback_repositories:
1438
 
            repo.unlock()
1439
665
 
1440
666
    def break_lock(self):
1441
667
        # should hand off to the network
1444
670
 
1445
671
    def _get_tarball(self, compression):
1446
672
        """Return a TemporaryFile containing a repository tarball.
1447
 
 
 
673
        
1448
674
        Returns None if the server does not support sending tarballs.
1449
675
        """
1450
676
        import tempfile
1451
677
        path = self.bzrdir._path_for_remote_call(self._client)
1452
678
        try:
1453
 
            response, protocol = self._call_expecting_body(
 
679
            response, protocol = self._client.call_expecting_body(
1454
680
                'Repository.tarball', path, compression)
1455
681
        except errors.UnknownSmartMethod:
1456
682
            protocol.cancel_read_body()
1484
710
 
1485
711
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1486
712
                           timezone=None, committer=None, revprops=None,
1487
 
                           revision_id=None, lossy=False):
 
713
                           revision_id=None):
1488
714
        # FIXME: It ought to be possible to call this without immediately
1489
715
        # triggering _ensure_real.  For now it's the easiest thing to do.
1490
716
        self._ensure_real()
1491
717
        real_repo = self._real_repository
1492
718
        builder = real_repo.get_commit_builder(branch, parents,
1493
719
                config, timestamp=timestamp, timezone=timezone,
1494
 
                committer=committer, revprops=revprops,
1495
 
                revision_id=revision_id, lossy=lossy)
 
720
                committer=committer, revprops=revprops, revision_id=revision_id)
1496
721
        return builder
1497
722
 
1498
723
    def add_fallback_repository(self, repository):
1499
724
        """Add a repository to use for looking up data not held locally.
1500
 
 
 
725
        
1501
726
        :param repository: A repository.
1502
727
        """
1503
 
        if not self._format.supports_external_lookups:
1504
 
            raise errors.UnstackableRepositoryFormat(
1505
 
                self._format.network_name(), self.base)
 
728
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
729
        # unconditionally - however, a _real_repository will usually exist,
 
730
        # and may raise an error if it's not accommodated by the underlying
 
731
        # format.  Eventually we should check when opening the repository
 
732
        # whether it's willing to allow them or not.
 
733
        #
1506
734
        # We need to accumulate additional repositories here, to pass them in
1507
735
        # on various RPC's.
1508
 
        #
1509
 
        if self.is_locked():
1510
 
            # We will call fallback.unlock() when we transition to the unlocked
1511
 
            # state, so always add a lock here. If a caller passes us a locked
1512
 
            # repository, they are responsible for unlocking it later.
1513
 
            repository.lock_read()
1514
 
        self._check_fallback_repository(repository)
1515
736
        self._fallback_repositories.append(repository)
1516
 
        # If self._real_repository was parameterised already (e.g. because a
1517
 
        # _real_branch had its get_stacked_on_url method called), then the
1518
 
        # repository to be added may already be in the _real_repositories list.
1519
 
        if self._real_repository is not None:
1520
 
            fallback_locations = [repo.user_url for repo in
1521
 
                self._real_repository._fallback_repositories]
1522
 
            if repository.user_url not in fallback_locations:
1523
 
                self._real_repository.add_fallback_repository(repository)
1524
 
 
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)
 
737
        # They are also seen by the fallback repository.  If it doesn't exist
 
738
        # yet they'll be added then.  This implicitly copies them.
 
739
        self._ensure_real()
1534
740
 
1535
741
    def add_inventory(self, revid, inv, parents):
1536
742
        self._ensure_real()
1537
743
        return self._real_repository.add_inventory(revid, inv, parents)
1538
744
 
1539
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1540
 
            parents, basis_inv=None, propagate_caches=False):
1541
 
        self._ensure_real()
1542
 
        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)
1545
 
 
1546
745
    def add_revision(self, rev_id, rev, inv=None, config=None):
1547
746
        self._ensure_real()
1548
747
        return self._real_repository.add_revision(
1553
752
        self._ensure_real()
1554
753
        return self._real_repository.get_inventory(revision_id)
1555
754
 
1556
 
    def iter_inventories(self, revision_ids, ordering=None):
 
755
    def iter_inventories(self, revision_ids):
1557
756
        self._ensure_real()
1558
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
757
        return self._real_repository.iter_inventories(revision_ids)
1559
758
 
1560
759
    @needs_read_lock
1561
760
    def get_revision(self, revision_id):
1576
775
        self._ensure_real()
1577
776
        return self._real_repository.make_working_trees()
1578
777
 
1579
 
    def refresh_data(self):
1580
 
        """Re-read any data needed to synchronise with disk.
1581
 
 
1582
 
        This method is intended to be called after another repository instance
1583
 
        (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.
1589
 
        """
1590
 
        if self._real_repository is not None:
1591
 
            self._real_repository.refresh_data()
1592
 
 
1593
778
    def revision_ids_to_search_result(self, result_set):
1594
779
        """Convert a set of revision ids to a graph SearchResult."""
1595
780
        result_parents = set()
1604
789
        return result
1605
790
 
1606
791
    @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):
 
792
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1611
793
        """Return the revision ids that other has that this does not.
1612
 
 
 
794
        
1613
795
        These are returned in topological order.
1614
796
 
1615
797
        revision_id: only return revision ids included by revision_id.
1616
798
        """
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)
 
799
        return repository.InterRepository.get(
 
800
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1631
801
 
1632
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
1633
 
            fetch_spec=None):
1634
 
        # No base implementation to use as RemoteRepository is not a subclass
1635
 
        # of Repository; so this is a copy of Repository.fetch().
1636
 
        if fetch_spec is not None and revision_id is not None:
1637
 
            raise AssertionError(
1638
 
                "fetch_spec and revision_id are mutually exclusive.")
1639
 
        if self.is_in_write_group():
1640
 
            raise errors.InternalBzrError(
1641
 
                "May not fetch while in a write group.")
1642
 
        # fast path same-url fetch operations
1643
 
        if (self.has_same_location(source)
1644
 
            and fetch_spec is None
1645
 
            and self._has_same_fallbacks(source)):
 
802
    def fetch(self, source, revision_id=None, pb=None):
 
803
        if self.has_same_location(source):
1646
804
            # check that last_revision is in 'from' and then return a
1647
805
            # no-operation.
1648
806
            if (revision_id is not None and
1649
 
                not _mod_revision.is_null(revision_id)):
 
807
                not revision.is_null(revision_id)):
1650
808
                self.get_revision(revision_id)
1651
809
            return 0, []
1652
 
        # if there is no specific appropriate InterRepository, this will get
1653
 
        # the InterRepository base class, which raises an
1654
 
        # IncompatibleRepositories when asked to fetch.
1655
 
        inter = _mod_repository.InterRepository.get(source, self)
1656
 
        return inter.fetch(revision_id=revision_id,
1657
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
810
        self._ensure_real()
 
811
        return self._real_repository.fetch(
 
812
            source, revision_id=revision_id, pb=pb)
1658
813
 
1659
814
    def create_bundle(self, target, base, fileobj, format=None):
1660
815
        self._ensure_real()
1661
816
        self._real_repository.create_bundle(target, base, fileobj, format)
1662
817
 
1663
818
    @needs_read_lock
1664
 
    @symbol_versioning.deprecated_method(
1665
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1666
819
    def get_ancestry(self, revision_id, topo_sorted=True):
1667
820
        self._ensure_real()
1668
821
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1675
828
        self._ensure_real()
1676
829
        return self._real_repository._get_versioned_file_checker(
1677
830
            revisions, revision_versions_cache)
1678
 
 
 
831
        
1679
832
    def iter_files_bytes(self, desired_files):
1680
833
        """See Repository.iter_file_bytes.
1681
834
        """
1682
835
        self._ensure_real()
1683
836
        return self._real_repository.iter_files_bytes(desired_files)
1684
837
 
1685
 
    def get_parent_map(self, revision_ids):
 
838
    @property
 
839
    def _fetch_order(self):
 
840
        """Decorate the real repository for now.
 
841
 
 
842
        In the long term getting this back from the remote repository as part
 
843
        of open would be more efficient.
 
844
        """
 
845
        self._ensure_real()
 
846
        return self._real_repository._fetch_order
 
847
 
 
848
    @property
 
849
    def _fetch_uses_deltas(self):
 
850
        """Decorate the real repository for now.
 
851
 
 
852
        In the long term getting this back from the remote repository as part
 
853
        of open would be more efficient.
 
854
        """
 
855
        self._ensure_real()
 
856
        return self._real_repository._fetch_uses_deltas
 
857
 
 
858
    @property
 
859
    def _fetch_reconcile(self):
 
860
        """Decorate the real repository for now.
 
861
 
 
862
        In the long term getting this back from the remote repository as part
 
863
        of open would be more efficient.
 
864
        """
 
865
        self._ensure_real()
 
866
        return self._real_repository._fetch_reconcile
 
867
 
 
868
    def get_parent_map(self, keys):
1686
869
        """See bzrlib.Graph.get_parent_map()."""
1687
 
        return self._make_parents_provider().get_parent_map(revision_ids)
 
870
        # Hack to build up the caching logic.
 
871
        ancestry = self._parents_map
 
872
        if ancestry is None:
 
873
            # Repository is not locked, so there's no cache.
 
874
            missing_revisions = set(keys)
 
875
            ancestry = {}
 
876
        else:
 
877
            missing_revisions = set(key for key in keys if key not in ancestry)
 
878
        if missing_revisions:
 
879
            parent_map = self._get_parent_map(missing_revisions)
 
880
            if 'hpss' in debug.debug_flags:
 
881
                mutter('retransmitted revisions: %d of %d',
 
882
                        len(set(ancestry).intersection(parent_map)),
 
883
                        len(parent_map))
 
884
            ancestry.update(parent_map)
 
885
        present_keys = [k for k in keys if k in ancestry]
 
886
        if 'hpss' in debug.debug_flags:
 
887
            if self._requested_parents is not None and len(ancestry) != 0:
 
888
                self._requested_parents.update(present_keys)
 
889
                mutter('Current RemoteRepository graph hit rate: %d%%',
 
890
                    100.0 * len(self._requested_parents) / len(ancestry))
 
891
        return dict((k, ancestry[k]) for k in present_keys)
1688
892
 
1689
 
    def _get_parent_map_rpc(self, keys):
 
893
    def _get_parent_map(self, keys):
1690
894
        """Helper for get_parent_map that performs the RPC."""
1691
895
        medium = self._client._medium
1692
896
        if medium._is_remote_before((1, 2)):
1693
897
            # We already found out that the server can't understand
1694
898
            # Repository.get_parent_map requests, so just fetch the whole
1695
899
            # graph.
1696
 
            #
1697
 
            # Note that this reads the whole graph, when only some keys are
1698
 
            # wanted.  On this old server there's no way (?) to get them all
1699
 
            # in one go, and the user probably will have seen a warning about
1700
 
            # the server being old anyhow.
1701
 
            rg = self._get_revision_graph(None)
1702
 
            # There is an API discrepancy between get_parent_map and
 
900
            # XXX: Note that this will issue a deprecation warning. This is ok
 
901
            # :- its because we're working with a deprecated server anyway, and
 
902
            # the user will almost certainly have seen a warning about the
 
903
            # server version already.
 
904
            rg = self.get_revision_graph()
 
905
            # There is an api discrepency between get_parent_map and
1703
906
            # get_revision_graph. Specifically, a "key:()" pair in
1704
907
            # get_revision_graph just means a node has no parents. For
1705
908
            # "get_parent_map" it means the node is a ghost. So fix up the
1735
938
        # TODO: Manage this incrementally to avoid covering the same path
1736
939
        # repeatedly. (The server will have to on each request, but the less
1737
940
        # work done the better).
1738
 
        #
1739
 
        # Negative caching notes:
1740
 
        # new server sends missing when a request including the revid
1741
 
        # 'include-missing:' is present in the request.
1742
 
        # missing keys are serialised as missing:X, and we then call
1743
 
        # provider.note_missing(X) for-all X
1744
 
        parents_map = self._unstacked_provider.get_cached_map()
 
941
        parents_map = self._parents_map
1745
942
        if parents_map is None:
1746
943
            # Repository is not locked, so there's no cache.
1747
944
            parents_map = {}
1748
 
        # start_set is all the keys in the cache
1749
945
        start_set = set(parents_map)
1750
 
        # result set is all the references to keys in the cache
1751
946
        result_parents = set()
1752
947
        for parents in parents_map.itervalues():
1753
948
            result_parents.update(parents)
1754
949
        stop_keys = result_parents.difference(start_set)
1755
 
        # We don't need to send ghosts back to the server as a position to
1756
 
        # stop either.
1757
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1758
 
        key_count = len(parents_map)
1759
 
        if (NULL_REVISION in result_parents
1760
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1761
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1762
 
            # in our cache of "missing" keys we need to increment our key count
1763
 
            # by 1, because the reconsitituted SearchResult on the server will
1764
 
            # still consider NULL_REVISION to be an included key.
1765
 
            key_count += 1
1766
950
        included_keys = start_set.intersection(result_parents)
1767
951
        start_set.difference_update(included_keys)
1768
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
952
        recipe = (start_set, stop_keys, len(parents_map))
1769
953
        body = self._serialise_search_recipe(recipe)
1770
954
        path = self.bzrdir._path_for_remote_call(self._client)
1771
955
        for key in keys:
1773
957
                raise ValueError(
1774
958
                    "key %r not a plain string" % (key,))
1775
959
        verb = 'Repository.get_parent_map'
1776
 
        args = (path, 'include-missing:') + tuple(keys)
 
960
        args = (path,) + tuple(keys)
1777
961
        try:
1778
 
            response = self._call_with_body_bytes_expecting_body(
1779
 
                verb, args, body)
 
962
            response = self._client.call_with_body_bytes_expecting_body(
 
963
                verb, args, self._serialise_search_recipe(recipe))
1780
964
        except errors.UnknownSmartMethod:
1781
965
            # Server does not support this method, so get the whole graph.
1782
966
            # Worse, we have to force a disconnection, because the server now
1789
973
            # To avoid having to disconnect repeatedly, we keep track of the
1790
974
            # fact the server doesn't understand remote methods added in 1.2.
1791
975
            medium._remember_remote_is_before((1, 2))
1792
 
            # Recurse just once and we should use the fallback code.
1793
 
            return self._get_parent_map_rpc(keys)
 
976
            return self.get_revision_graph(None)
1794
977
        response_tuple, response_handler = response
1795
978
        if response_tuple[0] not in ['ok']:
1796
979
            response_handler.cancel_read_body()
1807
990
                if len(d) > 1:
1808
991
                    revision_graph[d[0]] = d[1:]
1809
992
                else:
1810
 
                    # No parents:
1811
 
                    if d[0].startswith('missing:'):
1812
 
                        revid = d[0][8:]
1813
 
                        self._unstacked_provider.note_missing_key(revid)
1814
 
                    else:
1815
 
                        # no parents - so give the Graph result
1816
 
                        # (NULL_REVISION,).
1817
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
993
                    # No parents - so give the Graph result (NULL_REVISION,).
 
994
                    revision_graph[d[0]] = (NULL_REVISION,)
1818
995
            return revision_graph
1819
996
 
1820
997
    @needs_read_lock
1823
1000
        return self._real_repository.get_signature_text(revision_id)
1824
1001
 
1825
1002
    @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)
 
1003
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1004
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1005
        self._ensure_real()
 
1006
        return self._real_repository.get_revision_graph_with_ghosts(
 
1007
            revision_ids=revision_ids)
 
1008
 
 
1009
    @needs_read_lock
 
1010
    def get_inventory_xml(self, revision_id):
 
1011
        self._ensure_real()
 
1012
        return self._real_repository.get_inventory_xml(revision_id)
 
1013
 
 
1014
    def deserialise_inventory(self, revision_id, xml):
 
1015
        self._ensure_real()
 
1016
        return self._real_repository.deserialise_inventory(revision_id, xml)
1829
1017
 
1830
1018
    def reconcile(self, other=None, thorough=False):
1831
1019
        self._ensure_real()
1832
1020
        return self._real_repository.reconcile(other=other, thorough=thorough)
1833
 
 
 
1021
        
1834
1022
    def all_revision_ids(self):
1835
1023
        self._ensure_real()
1836
1024
        return self._real_repository.all_revision_ids()
1837
 
 
1838
 
    @needs_read_lock
1839
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1840
 
        self._ensure_real()
1841
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1842
 
            specific_fileids=specific_fileids)
1843
 
 
1844
 
    @needs_read_lock
1845
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
1846
 
        self._ensure_real()
1847
 
        return self._real_repository.get_revision_delta(revision_id,
1848
 
            specific_fileids=specific_fileids)
 
1025
    
 
1026
    @needs_read_lock
 
1027
    def get_deltas_for_revisions(self, revisions):
 
1028
        self._ensure_real()
 
1029
        return self._real_repository.get_deltas_for_revisions(revisions)
 
1030
 
 
1031
    @needs_read_lock
 
1032
    def get_revision_delta(self, revision_id):
 
1033
        self._ensure_real()
 
1034
        return self._real_repository.get_revision_delta(revision_id)
1849
1035
 
1850
1036
    @needs_read_lock
1851
1037
    def revision_trees(self, revision_ids):
1858
1044
        return self._real_repository.get_revision_reconcile(revision_id)
1859
1045
 
1860
1046
    @needs_read_lock
1861
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1047
    def check(self, revision_ids=None):
1862
1048
        self._ensure_real()
1863
 
        return self._real_repository.check(revision_ids=revision_ids,
1864
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1049
        return self._real_repository.check(revision_ids=revision_ids)
1865
1050
 
1866
1051
    def copy_content_into(self, destination, revision_id=None):
1867
1052
        self._ensure_real()
1885
1070
            tmpdir = osutils.mkdtemp()
1886
1071
            try:
1887
1072
                _extract_tar(tar, tmpdir)
1888
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1073
                tmp_bzrdir = BzrDir.open(tmpdir)
1889
1074
                tmp_repo = tmp_bzrdir.open_repository()
1890
1075
                tmp_repo.copy_content_into(destination, revision_id)
1891
1076
            finally:
1907
1092
        return self._real_repository.inventories
1908
1093
 
1909
1094
    @needs_write_lock
1910
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1095
    def pack(self):
1911
1096
        """Compress the data within the repository.
1912
1097
 
1913
1098
        This is not currently implemented within the smart server.
1914
1099
        """
1915
1100
        self._ensure_real()
1916
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1101
        return self._real_repository.pack()
1917
1102
 
1918
1103
    @property
1919
1104
    def revisions(self):
1928
1113
        return self._real_repository.revisions
1929
1114
 
1930
1115
    def set_make_working_trees(self, new_value):
1931
 
        if new_value:
1932
 
            new_value_str = "True"
1933
 
        else:
1934
 
            new_value_str = "False"
1935
 
        path = self.bzrdir._path_for_remote_call(self._client)
1936
 
        try:
1937
 
            response = self._call(
1938
 
                'Repository.set_make_working_trees', path, new_value_str)
1939
 
        except errors.UnknownSmartMethod:
1940
 
            self._ensure_real()
1941
 
            self._real_repository.set_make_working_trees(new_value)
1942
 
        else:
1943
 
            if response[0] != 'ok':
1944
 
                raise errors.UnexpectedSmartServerResponse(response)
 
1116
        self._ensure_real()
 
1117
        self._real_repository.set_make_working_trees(new_value)
1945
1118
 
1946
1119
    @property
1947
1120
    def signatures(self):
1974
1147
        return self._real_repository.get_revisions(revision_ids)
1975
1148
 
1976
1149
    def supports_rich_root(self):
1977
 
        return self._format.rich_root_data
 
1150
        self._ensure_real()
 
1151
        return self._real_repository.supports_rich_root()
1978
1152
 
1979
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1980
1153
    def iter_reverse_revision_history(self, revision_id):
1981
1154
        self._ensure_real()
1982
1155
        return self._real_repository.iter_reverse_revision_history(revision_id)
1983
1156
 
1984
1157
    @property
1985
1158
    def _serializer(self):
1986
 
        return self._format._serializer
 
1159
        self._ensure_real()
 
1160
        return self._real_repository._serializer
1987
1161
 
1988
1162
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1989
1163
        self._ensure_real()
2003
1177
        return self._real_repository.item_keys_introduced_by(revision_ids,
2004
1178
            _files_pb=_files_pb)
2005
1179
 
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)
 
1180
    def revision_graph_can_have_wrong_parents(self):
 
1181
        # The answer depends on the remote repo format.
 
1182
        self._ensure_real()
 
1183
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1184
 
 
1185
    def _find_inconsistent_revision_parents(self):
 
1186
        self._ensure_real()
 
1187
        return self._real_repository._find_inconsistent_revision_parents()
2010
1188
 
2011
1189
    def _check_for_inconsistent_revision_parents(self):
2012
1190
        self._ensure_real()
2013
1191
        return self._real_repository._check_for_inconsistent_revision_parents()
2014
1192
 
2015
 
    def _make_parents_provider(self, other=None):
2016
 
        providers = [self._unstacked_provider]
2017
 
        if other is not None:
2018
 
            providers.insert(0, other)
2019
 
        return graph.StackedParentsProvider(_LazyListJoin(
2020
 
            providers, self._fallback_repositories))
 
1193
    def _make_parents_provider(self):
 
1194
        return self
2021
1195
 
2022
1196
    def _serialise_search_recipe(self, recipe):
2023
1197
        """Serialise a graph search recipe.
2025
1199
        :param recipe: A search recipe (start, stop, count).
2026
1200
        :return: Serialised bytes.
2027
1201
        """
2028
 
        start_keys = ' '.join(recipe[1])
2029
 
        stop_keys = ' '.join(recipe[2])
2030
 
        count = str(recipe[3])
 
1202
        start_keys = ' '.join(recipe[0])
 
1203
        stop_keys = ' '.join(recipe[1])
 
1204
        count = str(recipe[2])
2031
1205
        return '\n'.join((start_keys, stop_keys, count))
2032
1206
 
2033
 
    def _serialise_search_result(self, search_result):
2034
 
        parts = search_result.get_network_struct()
2035
 
        return '\n'.join(parts)
2036
 
 
2037
 
    def autopack(self):
2038
 
        path = self.bzrdir._path_for_remote_call(self._client)
2039
 
        try:
2040
 
            response = self._call('PackRepository.autopack', path)
2041
 
        except errors.UnknownSmartMethod:
2042
 
            self._ensure_real()
2043
 
            self._real_repository._pack_collection.autopack()
2044
 
            return
2045
 
        self.refresh_data()
2046
 
        if response[0] != 'ok':
2047
 
            raise errors.UnexpectedSmartServerResponse(response)
2048
 
 
2049
 
 
2050
 
class RemoteStreamSink(vf_repository.StreamSink):
2051
 
 
2052
 
    def _insert_real(self, stream, src_format, resume_tokens):
2053
 
        self.target_repo._ensure_real()
2054
 
        sink = self.target_repo._real_repository._get_sink()
2055
 
        result = sink.insert_stream(stream, src_format, resume_tokens)
2056
 
        if not result:
2057
 
            self.target_repo.autopack()
2058
 
        return result
2059
 
 
2060
 
    def insert_stream(self, stream, src_format, resume_tokens):
2061
 
        target = self.target_repo
2062
 
        target._unstacked_provider.missing_keys.clear()
2063
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2064
 
        if target._lock_token:
2065
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2066
 
            lock_args = (target._lock_token or '',)
2067
 
        else:
2068
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
2069
 
            lock_args = ()
2070
 
        client = target._client
2071
 
        medium = client._medium
2072
 
        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
2086
 
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2087
 
            try:
2088
 
                response = client.call_with_body_stream(
2089
 
                    (verb, path, '') + lock_args, byte_stream)
2090
 
            except errors.UnknownSmartMethod:
2091
 
                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)
2106
 
        byte_stream = smart_repo._stream_to_byte_stream(
2107
 
            stream, src_format)
2108
 
        resume_tokens = ' '.join(resume_tokens)
2109
 
        response = client.call_with_body_stream(
2110
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
2111
 
        if response[0][0] not in ('ok', 'missing-basis'):
2112
 
            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
 
        if response[0][0] == 'missing-basis':
2120
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2121
 
            resume_tokens = tokens
2122
 
            return resume_tokens, set(missing_keys)
2123
 
        else:
2124
 
            self.target_repo.refresh_data()
2125
 
            return [], set()
2126
 
 
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):
2169
 
    """Stream data from a remote server."""
2170
 
 
2171
 
    def get_stream(self, search):
2172
 
        if (self.from_repository._fallback_repositories and
2173
 
            self.to_format._fetch_order == 'topological'):
2174
 
            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)
2192
 
 
2193
 
    def _real_stream(self, repo, search):
2194
 
        """Get a stream for search from repo.
2195
 
        
2196
 
        This never called RemoteStreamSource.get_stream, and is a heler
2197
 
        for RemoteStreamSource._get_stream to allow getting a stream 
2198
 
        reliably whether fallback back because of old servers or trying
2199
 
        to stream from a non-RemoteRepository (which the stacked support
2200
 
        code will do).
2201
 
        """
2202
 
        source = repo._get_source(self.to_format)
2203
 
        if isinstance(source, RemoteStreamSource):
2204
 
            repo._ensure_real()
2205
 
            source = repo._real_repository._get_source(self.to_format)
2206
 
        return source.get_stream(search)
2207
 
 
2208
 
    def _get_stream(self, repo, search):
2209
 
        """Core worker to get a stream from repo for search.
2210
 
 
2211
 
        This is used by both get_stream and the stacking support logic. It
2212
 
        deliberately gets a stream for repo which does not need to be
2213
 
        self.from_repository. In the event that repo is not Remote, or
2214
 
        cannot do a smart stream, a fallback is made to the generic
2215
 
        repository._get_stream() interface, via self._real_stream.
2216
 
 
2217
 
        In the event of stacking, streams from _get_stream will not
2218
 
        contain all the data for search - this is normal (see get_stream).
2219
 
 
2220
 
        :param repo: A repository.
2221
 
        :param search: A search.
2222
 
        """
2223
 
        # Fallbacks may be non-smart
2224
 
        if not isinstance(repo, RemoteRepository):
2225
 
            return self._real_stream(repo, search)
2226
 
        client = repo._client
2227
 
        medium = client._medium
2228
 
        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:
2260
 
            return self._real_stream(repo, search)
2261
 
        if response_tuple[0] != 'ok':
2262
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2263
 
        byte_stream = response_handler.read_streamed_body()
2264
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2265
 
            self._record_counter)
2266
 
        if src_format.network_name() != repo._format.network_name():
2267
 
            raise AssertionError(
2268
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
2269
 
                src_format.network_name(), repo._format.network_name()))
2270
 
        return stream
2271
 
 
2272
 
    def missing_parents_chain(self, search, sources):
2273
 
        """Chain multiple streams together to handle stacking.
2274
 
 
2275
 
        :param search: The overall search to satisfy with streams.
2276
 
        :param sources: A list of Repository objects to query.
2277
 
        """
2278
 
        self.from_serialiser = self.from_repository._format._serializer
2279
 
        self.seen_revs = set()
2280
 
        self.referenced_revs = set()
2281
 
        # If there are heads in the search, or the key count is > 0, we are not
2282
 
        # done.
2283
 
        while not search.is_empty() and len(sources) > 1:
2284
 
            source = sources.pop(0)
2285
 
            stream = self._get_stream(source, search)
2286
 
            for kind, substream in stream:
2287
 
                if kind != 'revisions':
2288
 
                    yield kind, substream
2289
 
                else:
2290
 
                    yield kind, self.missing_parents_rev_handler(substream)
2291
 
            search = search.refine(self.seen_revs, self.referenced_revs)
2292
 
            self.seen_revs = set()
2293
 
            self.referenced_revs = set()
2294
 
        if not search.is_empty():
2295
 
            for kind, stream in self._get_stream(sources[0], search):
2296
 
                yield kind, stream
2297
 
 
2298
 
    def missing_parents_rev_handler(self, substream):
2299
 
        for content in substream:
2300
 
            revision_bytes = content.get_bytes_as('fulltext')
2301
 
            revision = self.from_serialiser.read_revision_from_string(
2302
 
                revision_bytes)
2303
 
            self.seen_revs.add(content.key[-1])
2304
 
            self.referenced_revs.update(revision.parent_ids)
2305
 
            yield content
2306
 
 
2307
1207
 
2308
1208
class RemoteBranchLockableFiles(LockableFiles):
2309
1209
    """A 'LockableFiles' implementation that talks to a smart server.
2310
 
 
 
1210
    
2311
1211
    This is not a public interface class.
2312
1212
    """
2313
1213
 
2327
1227
 
2328
1228
class RemoteBranchFormat(branch.BranchFormat):
2329
1229
 
2330
 
    def __init__(self, network_name=None):
2331
 
        super(RemoteBranchFormat, self).__init__()
2332
 
        self._matchingbzrdir = RemoteBzrDirFormat()
2333
 
        self._matchingbzrdir.set_branch_format(self)
2334
 
        self._custom_format = None
2335
 
        self._network_name = network_name
2336
 
 
2337
1230
    def __eq__(self, other):
2338
 
        return (isinstance(other, RemoteBranchFormat) and
 
1231
        return (isinstance(other, RemoteBranchFormat) and 
2339
1232
            self.__dict__ == other.__dict__)
2340
1233
 
2341
 
    def _ensure_real(self):
2342
 
        if self._custom_format is None:
2343
 
            self._custom_format = branch.network_format_registry.get(
2344
 
                self._network_name)
2345
 
 
2346
1234
    def get_format_description(self):
2347
 
        self._ensure_real()
2348
 
        return 'Remote: ' + self._custom_format.get_format_description()
2349
 
 
2350
 
    def network_name(self):
2351
 
        return self._network_name
2352
 
 
2353
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2354
 
        return a_bzrdir.open_branch(name=name, 
2355
 
            ignore_fallbacks=ignore_fallbacks)
2356
 
 
2357
 
    def _vfs_initialize(self, a_bzrdir, name):
2358
 
        # Initialisation when using a local bzrdir object, or a non-vfs init
2359
 
        # method is not available on the server.
2360
 
        # self._custom_format is always set - the start of initialize ensures
2361
 
        # that.
2362
 
        if isinstance(a_bzrdir, RemoteBzrDir):
2363
 
            a_bzrdir._ensure_real()
2364
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2365
 
                name)
2366
 
        else:
2367
 
            # We assume the bzrdir is parameterised; it may not be.
2368
 
            result = self._custom_format.initialize(a_bzrdir, name)
2369
 
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
 
            not isinstance(result, RemoteBranch)):
2371
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2372
 
                                  name=name)
2373
 
        return result
2374
 
 
2375
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2376
 
        # 1) get the network name to use.
2377
 
        if self._custom_format:
2378
 
            network_name = self._custom_format.network_name()
2379
 
        else:
2380
 
            # Select the current bzrlib default and ask for that.
2381
 
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2382
 
            reference_format = reference_bzrdir_format.get_branch_format()
2383
 
            self._custom_format = reference_format
2384
 
            network_name = reference_format.network_name()
2385
 
        # Being asked to create on a non RemoteBzrDir:
2386
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
2387
 
            return self._vfs_initialize(a_bzrdir, name=name)
2388
 
        medium = a_bzrdir._client._medium
2389
 
        if medium._is_remote_before((1, 13)):
2390
 
            return self._vfs_initialize(a_bzrdir, name=name)
2391
 
        # Creating on a remote bzr dir.
2392
 
        # 2) try direct creation via RPC
2393
 
        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
 
        verb = 'BzrDir.create_branch'
2398
 
        try:
2399
 
            response = a_bzrdir._call(verb, path, network_name)
2400
 
        except errors.UnknownSmartMethod:
2401
 
            # Fallback - use vfs methods
2402
 
            medium._remember_remote_is_before((1, 13))
2403
 
            return self._vfs_initialize(a_bzrdir, name=name)
2404
 
        if response[0] != 'ok':
2405
 
            raise errors.UnexpectedSmartServerResponse(response)
2406
 
        # Turn the response into a RemoteRepository object.
2407
 
        format = RemoteBranchFormat(network_name=response[1])
2408
 
        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
2420
 
        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)
2428
 
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
 
            format=format, setup_stacking=False, name=name)
2430
 
        # XXX: We know this is a new branch, so it must have revno 0, revid
2431
 
        # NULL_REVISION. Creating the branch locked would make this be unable
2432
 
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2433
 
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
2434
 
        return remote_branch
2435
 
 
2436
 
    def make_tags(self, branch):
2437
 
        self._ensure_real()
2438
 
        return self._custom_format.make_tags(branch)
 
1235
        return 'Remote BZR Branch'
 
1236
 
 
1237
    def get_format_string(self):
 
1238
        return 'Remote BZR Branch'
 
1239
 
 
1240
    def open(self, a_bzrdir):
 
1241
        return a_bzrdir.open_branch()
 
1242
 
 
1243
    def initialize(self, a_bzrdir):
 
1244
        return a_bzrdir.create_branch()
2439
1245
 
2440
1246
    def supports_tags(self):
2441
1247
        # Remote branches might support tags, but we won't know until we
2442
1248
        # access the real remote branch.
2443
 
        self._ensure_real()
2444
 
        return self._custom_format.supports_tags()
2445
 
 
2446
 
    def supports_stacking(self):
2447
 
        self._ensure_real()
2448
 
        return self._custom_format.supports_stacking()
2449
 
 
2450
 
    def supports_set_append_revisions_only(self):
2451
 
        self._ensure_real()
2452
 
        return self._custom_format.supports_set_append_revisions_only()
2453
 
 
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
 
 
2468
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1249
        return True
 
1250
 
 
1251
 
 
1252
class RemoteBranch(branch.Branch):
2469
1253
    """Branch stored on a server accessed by HPSS RPC.
2470
1254
 
2471
1255
    At the moment most operations are mapped down to simple file operations.
2472
1256
    """
2473
1257
 
2474
1258
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2475
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1259
        _client=None):
2476
1260
        """Create a RemoteBranch instance.
2477
1261
 
2478
1262
        :param real_branch: An optional local implementation of the branch
2479
1263
            format, usually accessing the data via the VFS.
2480
1264
        :param _client: Private parameter for testing.
2481
 
        :param format: A RemoteBranchFormat object, None to create one
2482
 
            automatically. If supplied it should have a network_name already
2483
 
            supplied.
2484
 
        :param setup_stacking: If True make an RPC call to determine the
2485
 
            stacked (or not) status of the branch. If False assume the branch
2486
 
            is not stacked.
2487
 
        :param name: Colocated branch name
2488
1265
        """
2489
1266
        # We intentionally don't call the parent class's __init__, because it
2490
1267
        # will try to assign to self.tags, which is a property in this subclass.
2491
1268
        # And the parent's __init__ doesn't do much anyway.
 
1269
        self._revision_id_to_revno_cache = None
 
1270
        self._revision_history_cache = None
 
1271
        self._last_revision_info_cache = None
2492
1272
        self.bzrdir = remote_bzrdir
2493
1273
        if _client is not None:
2494
1274
            self._client = _client
2507
1287
            self._real_branch.repository = self.repository
2508
1288
        else:
2509
1289
            self._real_branch = None
2510
 
        # Fill out expected attributes of branch for bzrlib API users.
2511
 
        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
 
1290
        # Fill out expected attributes of branch for bzrlib api users.
 
1291
        self._format = RemoteBranchFormat()
 
1292
        self.base = self.bzrdir.root_transport.base
2515
1293
        self._control_files = None
2516
1294
        self._lock_mode = None
2517
1295
        self._lock_token = None
2518
1296
        self._repo_lock_token = None
2519
1297
        self._lock_count = 0
2520
1298
        self._leave_lock = False
2521
 
        # Setup a format: note that we cannot call _ensure_real until all the
2522
 
        # attributes above are set: This code cannot be moved higher up in this
2523
 
        # function.
2524
 
        if format is None:
2525
 
            self._format = RemoteBranchFormat()
2526
 
            if real_branch is not None:
2527
 
                self._format._network_name = \
2528
 
                    self._real_branch._format.network_name()
2529
 
        else:
2530
 
            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
 
        if not self._format._network_name:
2535
 
            # Did not get from open_branchV2 - old server.
2536
 
            self._ensure_real()
2537
 
            self._format._network_name = \
2538
 
                self._real_branch._format.network_name()
2539
 
        self.tags = self._format.make_tags(self)
2540
1299
        # The base class init is not called, so we duplicate this:
2541
1300
        hooks = branch.Branch.hooks['open']
2542
1301
        for hook in hooks:
2543
1302
            hook(self)
2544
 
        self._is_stacked = False
2545
 
        if setup_stacking:
2546
 
            self._setup_stacking()
 
1303
        self._setup_stacking()
2547
1304
 
2548
1305
    def _setup_stacking(self):
2549
1306
        # configure stacking into the remote repository, by reading it from
2553
1310
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2554
1311
            errors.UnstackableRepositoryFormat), e:
2555
1312
            return
2556
 
        self._is_stacked = True
2557
 
        self._activate_fallback_location(fallback_url)
2558
 
 
2559
 
    def _get_config(self):
2560
 
        return RemoteBranchConfig(self)
 
1313
        # it's relative to this branch...
 
1314
        fallback_url = urlutils.join(self.base, fallback_url)
 
1315
        transports = [self.bzrdir.root_transport]
 
1316
        if self._real_branch is not None:
 
1317
            transports.append(self._real_branch._transport)
 
1318
        fallback_bzrdir = BzrDir.open(fallback_url, transports)
 
1319
        fallback_repo = fallback_bzrdir.open_repository()
 
1320
        self.repository.add_fallback_repository(fallback_repo)
2561
1321
 
2562
1322
    def _get_real_transport(self):
2563
1323
        # if we try vfs access, return the real branch's vfs transport
2581
1341
                raise AssertionError('smart server vfs must be enabled '
2582
1342
                    'to use vfs implementation')
2583
1343
            self.bzrdir._ensure_real()
2584
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2585
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1344
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2586
1345
            if self.repository._real_repository is None:
2587
1346
                # Give the remote repository the matching real repo.
2588
1347
                real_repo = self._real_branch.repository
2617
1376
        too, in fact doing so might harm performance.
2618
1377
        """
2619
1378
        super(RemoteBranch, self)._clear_cached_state()
2620
 
 
 
1379
        
2621
1380
    @property
2622
1381
    def control_files(self):
2623
1382
        # Defer actually creating RemoteBranchLockableFiles until its needed,
2647
1406
            stacking.
2648
1407
        """
2649
1408
        try:
2650
 
            # there may not be a repository yet, so we can't use
2651
 
            # self._translate_error, so we can't use self._call either.
2652
1409
            response = self._client.call('Branch.get_stacked_on_url',
2653
1410
                self._remote_path())
 
1411
            if response[0] != 'ok':
 
1412
                raise errors.UnexpectedSmartServerResponse(response)
 
1413
            return response[1]
2654
1414
        except errors.ErrorFromSmartServer, err:
2655
1415
            # there may not be a repository yet, so we can't call through
2656
1416
            # its _translate_error
2658
1418
        except errors.UnknownSmartMethod, err:
2659
1419
            self._ensure_real()
2660
1420
            return self._real_branch.get_stacked_on_url()
2661
 
        if response[0] != 'ok':
2662
 
            raise errors.UnexpectedSmartServerResponse(response)
2663
 
        return response[1]
2664
 
 
2665
 
    def set_stacked_on_url(self, url):
2666
 
        branch.Branch.set_stacked_on_url(self, url)
2667
 
        if not url:
2668
 
            self._is_stacked = False
2669
 
        else:
2670
 
            self._is_stacked = True
2671
 
 
2672
 
    def _vfs_get_tags_bytes(self):
2673
 
        self._ensure_real()
2674
 
        return self._real_branch._get_tags_bytes()
2675
 
 
2676
 
    @needs_read_lock
2677
 
    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
 
        medium = self._client._medium
2684
 
        if medium._is_remote_before((1, 13)):
2685
 
            return self._vfs_get_tags_bytes()
2686
 
        try:
2687
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
2688
 
        except errors.UnknownSmartMethod:
2689
 
            medium._remember_remote_is_before((1, 13))
2690
 
            return self._vfs_get_tags_bytes()
2691
 
        return response[0]
2692
 
 
2693
 
    def _vfs_set_tags_bytes(self, bytes):
2694
 
        self._ensure_real()
2695
 
        return self._real_branch._set_tags_bytes(bytes)
2696
 
 
2697
 
    def _set_tags_bytes(self, bytes):
2698
 
        if self.is_locked():
2699
 
            self._tags_bytes = bytes
2700
 
        medium = self._client._medium
2701
 
        if medium._is_remote_before((1, 18)):
2702
 
            self._vfs_set_tags_bytes(bytes)
2703
 
            return
2704
 
        try:
2705
 
            args = (
2706
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2707
 
            response = self._call_with_body_bytes(
2708
 
                'Branch.set_tags_bytes', args, bytes)
2709
 
        except errors.UnknownSmartMethod:
2710
 
            medium._remember_remote_is_before((1, 18))
2711
 
            self._vfs_set_tags_bytes(bytes)
2712
1421
 
2713
1422
    def lock_read(self):
2714
 
        """Lock the branch for read operations.
2715
 
 
2716
 
        :return: A bzrlib.lock.LogicalLockResult.
2717
 
        """
2718
1423
        self.repository.lock_read()
2719
1424
        if not self._lock_mode:
2720
 
            self._note_lock('r')
2721
1425
            self._lock_mode = 'r'
2722
1426
            self._lock_count = 1
2723
1427
            if self._real_branch is not None:
2724
1428
                self._real_branch.lock_read()
2725
1429
        else:
2726
1430
            self._lock_count += 1
2727
 
        return lock.LogicalLockResult(self.unlock)
2728
1431
 
2729
1432
    def _remote_lock_write(self, token):
2730
1433
        if token is None:
2731
1434
            branch_token = repo_token = ''
2732
1435
        else:
2733
1436
            branch_token = token
2734
 
            repo_token = self.repository.lock_write().repository_token
 
1437
            repo_token = self.repository.lock_write()
2735
1438
            self.repository.unlock()
2736
 
        err_context = {'token': token}
2737
1439
        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])
 
1440
            response = self._client.call(
 
1441
                'Branch.lock_write', self._remote_path(),
 
1442
                branch_token, repo_token or '')
 
1443
        except errors.ErrorFromSmartServer, err:
 
1444
            self._translate_error(err, token=token)
2747
1445
        if response[0] != 'ok':
2748
1446
            raise errors.UnexpectedSmartServerResponse(response)
2749
1447
        ok, branch_token, repo_token = response
2750
1448
        return branch_token, repo_token
2751
 
 
 
1449
            
2752
1450
    def lock_write(self, token=None):
2753
1451
        if not self._lock_mode:
2754
 
            self._note_lock('w')
2755
1452
            # Lock the branch and repo in one remote call.
2756
1453
            remote_tokens = self._remote_lock_write(token)
2757
1454
            self._lock_token, self._repo_lock_token = remote_tokens
2770
1467
            self._lock_mode = 'w'
2771
1468
            self._lock_count = 1
2772
1469
        elif self._lock_mode == 'r':
2773
 
            raise errors.ReadOnlyError(self)
 
1470
            raise errors.ReadOnlyTransaction
2774
1471
        else:
2775
1472
            if token is not None:
2776
1473
                # A token was given to lock_write, and we're relocking, so
2781
1478
            self._lock_count += 1
2782
1479
            # Re-lock the repository too.
2783
1480
            self.repository.lock_write(self._repo_lock_token)
2784
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
1481
        return self._lock_token or None
2785
1482
 
2786
1483
    def _unlock(self, branch_token, repo_token):
2787
 
        err_context = {'token': str((branch_token, repo_token))}
2788
 
        response = self._call(
2789
 
            'Branch.unlock', self._remote_path(), branch_token,
2790
 
            repo_token or '', **err_context)
 
1484
        try:
 
1485
            response = self._client.call('Branch.unlock', self._remote_path(), branch_token,
 
1486
                                         repo_token or '')
 
1487
        except errors.ErrorFromSmartServer, err:
 
1488
            self._translate_error(err, token=str((branch_token, repo_token)))
2791
1489
        if response == ('ok',):
2792
1490
            return
2793
1491
        raise errors.UnexpectedSmartServerResponse(response)
2794
1492
 
2795
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2796
1493
    def unlock(self):
2797
1494
        try:
2798
1495
            self._lock_count -= 1
2811
1508
                    self._real_branch.unlock()
2812
1509
                if mode != 'w':
2813
1510
                    # Only write-locked branched need to make a remote method
2814
 
                    # call to perform the unlock.
 
1511
                    # call to perfom the unlock.
2815
1512
                    return
2816
1513
                if not self._lock_token:
2817
1514
                    raise AssertionError('Locked, but no token!')
2838
1535
            raise NotImplementedError(self.dont_leave_lock_in_place)
2839
1536
        self._leave_lock = False
2840
1537
 
2841
 
    @needs_read_lock
2842
 
    def get_rev_id(self, revno, history=None):
2843
 
        if revno == 0:
2844
 
            return _mod_revision.NULL_REVISION
2845
 
        last_revision_info = self.last_revision_info()
2846
 
        ok, result = self.repository.get_rev_id_for_revno(
2847
 
            revno, last_revision_info)
2848
 
        if ok:
2849
 
            return result
2850
 
        missing_parent = result[1]
2851
 
        # Either the revision named by the server is missing, or its parent
2852
 
        # is.  Call get_parent_map to determine which, so that we report a
2853
 
        # useful error.
2854
 
        parent_map = self.repository.get_parent_map([missing_parent])
2855
 
        if missing_parent in parent_map:
2856
 
            missing_parent = parent_map[missing_parent]
2857
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2858
 
 
2859
 
    def _read_last_revision_info(self):
2860
 
        response = self._call('Branch.last_revision_info', self._remote_path())
 
1538
    def _last_revision_info(self):
 
1539
        response = self._client.call('Branch.last_revision_info', self._remote_path())
2861
1540
        if response[0] != 'ok':
2862
1541
            raise SmartProtocolError('unexpected response code %s' % (response,))
2863
1542
        revno = int(response[1])
2866
1545
 
2867
1546
    def _gen_revision_history(self):
2868
1547
        """See Branch._gen_revision_history()."""
2869
 
        if self._is_stacked:
2870
 
            self._ensure_real()
2871
 
            return self._real_branch._gen_revision_history()
2872
 
        response_tuple, response_handler = self._call_expecting_body(
 
1548
        response_tuple, response_handler = self._client.call_expecting_body(
2873
1549
            'Branch.revision_history', self._remote_path())
2874
1550
        if response_tuple[0] != 'ok':
2875
1551
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2883
1559
 
2884
1560
    def _set_last_revision_descendant(self, revision_id, other_branch,
2885
1561
            allow_diverged=False, allow_overwrite_descendant=False):
2886
 
        # This performs additional work to meet the hook contract; while its
2887
 
        # undesirable, we have to synthesise the revno to call the hook, and
2888
 
        # not calling the hook is worse as it means changes can't be prevented.
2889
 
        # Having calculated this though, we can't just call into
2890
 
        # set_last_revision_info as a simple call, because there is a set_rh
2891
 
        # hook that some folk may still be using.
2892
 
        old_revno, old_revid = self.last_revision_info()
2893
 
        history = self._lefthand_history(revision_id)
2894
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2895
 
        err_context = {'other_branch': other_branch}
2896
 
        response = self._call('Branch.set_last_revision_ex',
2897
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2898
 
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2899
 
            **err_context)
 
1562
        try:
 
1563
            response = self._client.call('Branch.set_last_revision_ex',
 
1564
                self._remote_path(), self._lock_token, self._repo_lock_token, revision_id,
 
1565
                int(allow_diverged), int(allow_overwrite_descendant))
 
1566
        except errors.ErrorFromSmartServer, err:
 
1567
            self._translate_error(err, other_branch=other_branch)
2900
1568
        self._clear_cached_state()
2901
1569
        if len(response) != 3 and response[0] != 'ok':
2902
1570
            raise errors.UnexpectedSmartServerResponse(response)
2903
1571
        new_revno, new_revision_id = response[1:]
2904
1572
        self._last_revision_info_cache = new_revno, new_revision_id
2905
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2906
1573
        if self._real_branch is not None:
2907
1574
            cache = new_revno, new_revision_id
2908
1575
            self._real_branch._last_revision_info_cache = cache
2909
1576
 
2910
1577
    def _set_last_revision(self, revision_id):
2911
 
        old_revno, old_revid = self.last_revision_info()
2912
 
        # This performs additional work to meet the hook contract; while its
2913
 
        # undesirable, we have to synthesise the revno to call the hook, and
2914
 
        # not calling the hook is worse as it means changes can't be prevented.
2915
 
        # Having calculated this though, we can't just call into
2916
 
        # set_last_revision_info as a simple call, because there is a set_rh
2917
 
        # hook that some folk may still be using.
2918
 
        history = self._lefthand_history(revision_id)
2919
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2920
1578
        self._clear_cached_state()
2921
 
        response = self._call('Branch.set_last_revision',
2922
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2923
 
            revision_id)
 
1579
        try:
 
1580
            response = self._client.call('Branch.set_last_revision',
 
1581
                self._remote_path(), self._lock_token, self._repo_lock_token, revision_id)
 
1582
        except errors.ErrorFromSmartServer, err:
 
1583
            self._translate_error(err)
2924
1584
        if response != ('ok',):
2925
1585
            raise errors.UnexpectedSmartServerResponse(response)
2926
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2927
1586
 
2928
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2929
1587
    @needs_write_lock
2930
1588
    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
1589
        # Send just the tip revision of the history; the server will generate
2937
1590
        # the full history from that.  If the revision doesn't exist in this
2938
1591
        # branch, NoSuchRevision will be raised.
2941
1594
        else:
2942
1595
            rev_id = rev_history[-1]
2943
1596
        self._set_last_revision(rev_id)
2944
 
        for hook in branch.Branch.hooks['set_rh']:
2945
 
            hook(self, rev_history)
2946
1597
        self._cache_revision_history(rev_history)
2947
1598
 
2948
 
    def _get_parent_location(self):
2949
 
        medium = self._client._medium
2950
 
        if medium._is_remote_before((1, 13)):
2951
 
            return self._vfs_get_parent_location()
2952
 
        try:
2953
 
            response = self._call('Branch.get_parent', self._remote_path())
2954
 
        except errors.UnknownSmartMethod:
2955
 
            medium._remember_remote_is_before((1, 13))
2956
 
            return self._vfs_get_parent_location()
2957
 
        if len(response) != 1:
2958
 
            raise errors.UnexpectedSmartServerResponse(response)
2959
 
        parent_location = response[0]
2960
 
        if parent_location == '':
2961
 
            return None
2962
 
        return parent_location
2963
 
 
2964
 
    def _vfs_get_parent_location(self):
2965
 
        self._ensure_real()
2966
 
        return self._real_branch._get_parent_location()
2967
 
 
2968
 
    def _set_parent_location(self, url):
2969
 
        medium = self._client._medium
2970
 
        if medium._is_remote_before((1, 15)):
2971
 
            return self._vfs_set_parent_location(url)
2972
 
        try:
2973
 
            call_url = url or ''
2974
 
            if type(call_url) is not str:
2975
 
                raise AssertionError('url must be a str or None (%s)' % url)
2976
 
            response = self._call('Branch.set_parent_location',
2977
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2978
 
                call_url)
2979
 
        except errors.UnknownSmartMethod:
2980
 
            medium._remember_remote_is_before((1, 15))
2981
 
            return self._vfs_set_parent_location(url)
2982
 
        if response != ():
2983
 
            raise errors.UnexpectedSmartServerResponse(response)
2984
 
 
2985
 
    def _vfs_set_parent_location(self, url):
2986
 
        self._ensure_real()
2987
 
        return self._real_branch._set_parent_location(url)
 
1599
    def get_parent(self):
 
1600
        self._ensure_real()
 
1601
        return self._real_branch.get_parent()
 
1602
        
 
1603
    def set_parent(self, url):
 
1604
        self._ensure_real()
 
1605
        return self._real_branch.set_parent(url)
 
1606
        
 
1607
    def set_stacked_on_url(self, stacked_location):
 
1608
        """Set the URL this branch is stacked against.
 
1609
 
 
1610
        :raises UnstackableBranchFormat: If the branch does not support
 
1611
            stacking.
 
1612
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1613
            stacking.
 
1614
        """
 
1615
        self._ensure_real()
 
1616
        return self._real_branch.set_stacked_on_url(stacked_location)
 
1617
 
 
1618
    def sprout(self, to_bzrdir, revision_id=None):
 
1619
        # Like Branch.sprout, except that it sprouts a branch in the default
 
1620
        # format, because RemoteBranches can't be created at arbitrary URLs.
 
1621
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
 
1622
        # to_bzrdir.create_branch...
 
1623
        self._ensure_real()
 
1624
        result = self._real_branch._format.initialize(to_bzrdir)
 
1625
        self.copy_content_into(result, revision_id=revision_id)
 
1626
        result.set_parent(self.bzrdir.root_transport.base)
 
1627
        return result
2988
1628
 
2989
1629
    @needs_write_lock
2990
1630
    def pull(self, source, overwrite=False, stop_revision=None,
2996
1636
            _override_hook_target=self, **kwargs)
2997
1637
 
2998
1638
    @needs_read_lock
2999
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
1639
    def push(self, target, overwrite=False, stop_revision=None):
3000
1640
        self._ensure_real()
3001
1641
        return self._real_branch.push(
3002
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
1642
            target, overwrite=overwrite, stop_revision=stop_revision,
3003
1643
            _override_hook_source_branch=self)
3004
1644
 
3005
1645
    def is_locked(self):
3012
1652
 
3013
1653
    @needs_write_lock
3014
1654
    def set_last_revision_info(self, revno, revision_id):
3015
 
        # XXX: These should be returned by the set_last_revision_info verb
3016
 
        old_revno, old_revid = self.last_revision_info()
3017
 
        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)
 
1655
        revision_id = ensure_null(revision_id)
3020
1656
        try:
3021
 
            response = self._call('Branch.set_last_revision_info',
3022
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
3023
 
                str(revno), revision_id)
 
1657
            response = self._client.call('Branch.set_last_revision_info',
 
1658
                self._remote_path(), self._lock_token, self._repo_lock_token, str(revno), revision_id)
3024
1659
        except errors.UnknownSmartMethod:
3025
1660
            self._ensure_real()
3026
1661
            self._clear_cached_state_of_remote_branch_only()
3027
1662
            self._real_branch.set_last_revision_info(revno, revision_id)
3028
1663
            self._last_revision_info_cache = revno, revision_id
3029
1664
            return
 
1665
        except errors.ErrorFromSmartServer, err:
 
1666
            self._translate_error(err)
3030
1667
        if response == ('ok',):
3031
1668
            self._clear_cached_state()
3032
1669
            self._last_revision_info_cache = revno, revision_id
3033
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3034
1670
            # Update the _real_branch's cache too.
3035
1671
            if self._real_branch is not None:
3036
1672
                cache = self._last_revision_info_cache
3043
1679
                                  other_branch=None):
3044
1680
        medium = self._client._medium
3045
1681
        if not medium._is_remote_before((1, 6)):
3046
 
            # Use a smart method for 1.6 and above servers
3047
1682
            try:
3048
1683
                self._set_last_revision_descendant(revision_id, other_branch,
3049
1684
                    allow_diverged=True, allow_overwrite_descendant=True)
3051
1686
            except errors.UnknownSmartMethod:
3052
1687
                medium._remember_remote_is_before((1, 6))
3053
1688
        self._clear_cached_state_of_remote_branch_only()
3054
 
        self._set_revision_history(self._lefthand_history(revision_id,
3055
 
            last_rev=last_rev,other_branch=other_branch))
 
1689
        self._ensure_real()
 
1690
        self._real_branch.generate_revision_history(
 
1691
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
1692
 
 
1693
    @property
 
1694
    def tags(self):
 
1695
        self._ensure_real()
 
1696
        return self._real_branch.tags
3056
1697
 
3057
1698
    def set_push_location(self, location):
3058
1699
        self._ensure_real()
3059
1700
        return self._real_branch.set_push_location(location)
3060
1701
 
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
 
 
3089
 
class RemoteConfig(object):
3090
 
    """A Config that reads and writes from smart verbs.
3091
 
 
3092
 
    It is a low-level object that considers config data to be name/value pairs
3093
 
    that may be associated with a section. Assigning meaning to the these
3094
 
    values is done at higher levels like bzrlib.config.TreeConfig.
3095
 
    """
3096
 
 
3097
 
    def get_option(self, name, section=None, default=None):
3098
 
        """Return the value associated with a named option.
3099
 
 
3100
 
        :param name: The name of the value
3101
 
        :param section: The section the option is in (if any)
3102
 
        :param default: The value to return if the value is not set
3103
 
        :return: The value or default value
3104
 
        """
3105
 
        try:
3106
 
            configobj = self._get_configobj()
3107
 
            section_obj = None
3108
 
            if section is None:
3109
 
                section_obj = configobj
3110
 
            else:
3111
 
                try:
3112
 
                    section_obj = configobj[section]
3113
 
                except KeyError:
3114
 
                    pass
3115
 
            if section_obj is None:
3116
 
                value = default
3117
 
            else:
3118
 
                value = section_obj.get(name, default)
3119
 
        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
3124
 
 
3125
 
    def _response_to_configobj(self, response):
3126
 
        if len(response[0]) and response[0][0] != 'ok':
3127
 
            raise errors.UnexpectedSmartServerResponse(response)
3128
 
        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
3133
 
 
3134
 
 
3135
 
class RemoteBranchConfig(RemoteConfig):
3136
 
    """A RemoteConfig for Branches."""
3137
 
 
3138
 
    def __init__(self, branch):
3139
 
        self._branch = branch
3140
 
 
3141
 
    def _get_configobj(self):
3142
 
        path = self._branch._remote_path()
3143
 
        response = self._branch._client.call_expecting_body(
3144
 
            'Branch.get_config_file', path)
3145
 
        return self._response_to_configobj(response)
3146
 
 
3147
 
    def set_option(self, value, name, section=None):
3148
 
        """Set the value associated with a named option.
3149
 
 
3150
 
        :param value: The value to set
3151
 
        :param name: The name of the value to set
3152
 
        :param section: The section the option is in (if any)
3153
 
        """
3154
 
        medium = self._branch._client._medium
3155
 
        if medium._is_remote_before((1, 14)):
3156
 
            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
 
        try:
3166
 
            path = self._branch._remote_path()
3167
 
            response = self._branch._client.call('Branch.set_config_option',
3168
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
3169
 
                value.encode('utf8'), name, section or '')
3170
 
        except errors.UnknownSmartMethod:
3171
 
            medium = self._branch._client._medium
3172
 
            medium._remember_remote_is_before((1, 14))
3173
 
            return self._vfs_set_option(value, name, section)
3174
 
        if response != ():
3175
 
            raise errors.UnexpectedSmartServerResponse(response)
3176
 
 
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
 
    def _real_object(self):
3203
 
        self._branch._ensure_real()
3204
 
        return self._branch._real_branch
3205
 
 
3206
 
    def _vfs_set_option(self, value, name, section=None):
3207
 
        return self._real_object()._get_config().set_option(
3208
 
            value, name, section)
3209
 
 
3210
 
 
3211
 
class RemoteBzrDirConfig(RemoteConfig):
3212
 
    """A RemoteConfig for BzrDirs."""
3213
 
 
3214
 
    def __init__(self, bzrdir):
3215
 
        self._bzrdir = bzrdir
3216
 
 
3217
 
    def _get_configobj(self):
3218
 
        medium = self._bzrdir._client._medium
3219
 
        verb = 'BzrDir.get_config_file'
3220
 
        if medium._is_remote_before((1, 15)):
3221
 
            raise errors.UnknownSmartMethod(verb)
3222
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
3223
 
        response = self._bzrdir._call_expecting_body(
3224
 
            verb, path)
3225
 
        return self._response_to_configobj(response)
3226
 
 
3227
 
    def _vfs_get_option(self, name, section, default):
3228
 
        return self._real_object()._get_config().get_option(
3229
 
            name, section, default)
3230
 
 
3231
 
    def set_option(self, value, name, section=None):
3232
 
        """Set the value associated with a named option.
3233
 
 
3234
 
        :param value: The value to set
3235
 
        :param name: The name of the value to set
3236
 
        :param section: The section the option is in (if any)
3237
 
        """
3238
 
        return self._real_object()._get_config().set_option(
3239
 
            value, name, section)
3240
 
 
3241
 
    def _real_object(self):
3242
 
        self._bzrdir._ensure_real()
3243
 
        return self._bzrdir._real_bzrdir
3244
 
 
 
1702
    @needs_write_lock
 
1703
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
1704
                         graph=None):
 
1705
        """See Branch.update_revisions."""
 
1706
        other.lock_read()
 
1707
        try:
 
1708
            if stop_revision is None:
 
1709
                stop_revision = other.last_revision()
 
1710
                if revision.is_null(stop_revision):
 
1711
                    # if there are no commits, we're done.
 
1712
                    return
 
1713
            self.fetch(other, stop_revision)
 
1714
 
 
1715
            if overwrite:
 
1716
                # Just unconditionally set the new revision.  We don't care if
 
1717
                # the branches have diverged.
 
1718
                self._set_last_revision(stop_revision)
 
1719
            else:
 
1720
                medium = self._client._medium
 
1721
                if not medium._is_remote_before((1, 6)):
 
1722
                    try:
 
1723
                        self._set_last_revision_descendant(stop_revision, other)
 
1724
                        return
 
1725
                    except errors.UnknownSmartMethod:
 
1726
                        medium._remember_remote_is_before((1, 6))
 
1727
                # Fallback for pre-1.6 servers: check for divergence
 
1728
                # client-side, then do _set_last_revision.
 
1729
                last_rev = revision.ensure_null(self.last_revision())
 
1730
                if graph is None:
 
1731
                    graph = self.repository.get_graph()
 
1732
                if self._check_if_descendant_or_diverged(
 
1733
                        stop_revision, last_rev, graph, other):
 
1734
                    # stop_revision is a descendant of last_rev, but we aren't
 
1735
                    # overwriting, so we're done.
 
1736
                    return
 
1737
                self._set_last_revision(stop_revision)
 
1738
        finally:
 
1739
            other.unlock()
3245
1740
 
3246
1741
 
3247
1742
def _extract_tar(tar, to_dir):
3262
1757
      - bzrdir
3263
1758
      - token
3264
1759
      - other_branch
3265
 
      - path
3266
1760
 
3267
1761
    If the error from the server doesn't match a known pattern, then
3268
1762
    UnknownErrorFromSmartServer is raised.
3270
1764
    def find(name):
3271
1765
        try:
3272
1766
            return context[name]
3273
 
        except KeyError, key_err:
3274
 
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
1767
        except KeyError, keyErr:
 
1768
            mutter('Missing key %r in context %r', keyErr.args[0], context)
3275
1769
            raise err
3276
 
    def get_path():
3277
 
        """Get the path from the context if present, otherwise use first error
3278
 
        arg.
3279
 
        """
3280
 
        try:
3281
 
            return context['path']
3282
 
        except KeyError, key_err:
3283
 
            try:
3284
 
                return err.error_args[0]
3285
 
            except IndexError, idx_err:
3286
 
                mutter(
3287
 
                    'Missing key %r in context %r', key_err.args[0], context)
3288
 
                raise err
3289
 
 
3290
1770
    if err.error_verb == 'NoSuchRevision':
3291
1771
        raise NoSuchRevision(find('branch'), err.error_args[0])
3292
1772
    elif err.error_verb == 'nosuchrevision':
3293
1773
        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)
 
1774
    elif err.error_tuple == ('nobranch',):
 
1775
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
3301
1776
    elif err.error_verb == 'norepository':
3302
1777
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
1778
    elif err.error_verb == 'LockContention':
 
1779
        raise errors.LockContention('(remote lock)')
3303
1780
    elif err.error_verb == 'UnlockableTransport':
3304
1781
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
1782
    elif err.error_verb == 'LockFailed':
 
1783
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3305
1784
    elif err.error_verb == 'TokenMismatch':
3306
1785
        raise errors.TokenMismatch(find('token'), '(remote token)')
3307
1786
    elif err.error_verb == 'Diverged':
3308
1787
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
3309
 
    elif err.error_verb == 'NotStacked':
3310
 
        raise errors.NotStacked(branch=find('branch'))
3311
 
    elif err.error_verb == 'PermissionDenied':
3312
 
        path = get_path()
3313
 
        if len(err.error_args) >= 2:
3314
 
            extra = err.error_args[1]
3315
 
        else:
3316
 
            extra = None
3317
 
        raise errors.PermissionDenied(path, extra=extra)
3318
 
    elif err.error_verb == 'ReadError':
3319
 
        path = get_path()
3320
 
        raise errors.ReadError(path)
3321
 
    elif err.error_verb == 'NoSuchFile':
3322
 
        path = get_path()
3323
 
        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
1788
    elif err.error_verb == 'TipChangeRejected':
3337
1789
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3338
1790
    elif err.error_verb == 'UnstackableBranchFormat':
3339
1791
        raise errors.UnstackableBranchFormat(*err.error_args)
3340
1792
    elif err.error_verb == 'UnstackableRepositoryFormat':
3341
1793
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3342
 
    elif err.error_verb == 'FileExists':
3343
 
        raise errors.FileExists(err.error_args[0])
3344
 
    elif err.error_verb == 'DirectoryNotEmpty':
3345
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
3346
 
    elif err.error_verb == 'ShortReadvError':
3347
 
        args = err.error_args
3348
 
        raise errors.ShortReadvError(
3349
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
3350
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
3351
 
        encoding = str(err.error_args[0]) # encoding must always be a string
3352
 
        val = err.error_args[1]
3353
 
        start = int(err.error_args[2])
3354
 
        end = int(err.error_args[3])
3355
 
        reason = str(err.error_args[4]) # reason must always be a string
3356
 
        if val.startswith('u:'):
3357
 
            val = val[2:].decode('utf-8')
3358
 
        elif val.startswith('s:'):
3359
 
            val = val[2:].decode('base64')
3360
 
        if err.error_verb == 'UnicodeDecodeError':
3361
 
            raise UnicodeDecodeError(encoding, val, start, end, reason)
3362
 
        elif err.error_verb == 'UnicodeEncodeError':
3363
 
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3364
 
    elif err.error_verb == 'ReadOnlyError':
3365
 
        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.")
 
1794
    elif err.error_verb == 'NotStacked':
 
1795
        raise errors.NotStacked(branch=find('branch'))
3369
1796
    raise errors.UnknownErrorFromSmartServer(err)