← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

  • Committer: Andrew Bennetts
  • Date: 2008-04-07 08:17:38 UTC
  • mto: This revision was merged to the branch mainline in revision 3349.
  • Revision ID: andrew.bennetts@canonical.com-20080407081738-yx4c53pvqfif313d
SmartClientRequestProtocol*.read_response_tuple can now raise UnknownSmartMethod.  Callers no longer need to do their own ad hoc unknown smart method error detection.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/client.py
 
1
# Copyright (C) 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import urllib
 
18
from urlparse import urlparse
 
19
 
 
20
from bzrlib.smart import protocol
 
21
from bzrlib import (
 
22
    errors,
 
23
    urlutils,
 
24
    )
 
25
 
 
26
 
 
27
class _SmartClient(object):
 
28
 
 
29
    def __init__(self, shared_connection):
 
30
        """Constructor.
 
31
 
 
32
        :param shared_connection: a bzrlib.transport._SharedConnection
 
33
        """
 
34
        self._shared_connection = shared_connection
 
35
 
 
36
    def get_smart_medium(self):
 
37
        return self._shared_connection.connection
 
38
 
 
39
    def call(self, method, *args):
 
40
        """Call a method on the remote server."""
 
41
        result, protocol = self.call_expecting_body(method, *args)
 
42
        protocol.cancel_read_body()
 
43
        return result
 
44
 
 
45
    def call_expecting_body(self, method, *args):
 
46
        """Call a method and return the result and the protocol object.
 
47
        
 
48
        The body can be read like so::
 
49
 
 
50
            result, smart_protocol = smart_client.call_expecting_body(...)
 
51
            body = smart_protocol.read_body_bytes()
 
52
        """
 
53
        request = self.get_smart_medium().get_request()
 
54
        smart_protocol = protocol.SmartClientRequestProtocolTwo(request)
 
55
        smart_protocol.call(method, *args)
 
56
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
 
57
 
 
58
    def call_with_body_bytes(self, method, args, body):
 
59
        """Call a method on the remote server with body bytes."""
 
60
        if type(method) is not str:
 
61
            raise TypeError('method must be a byte string, not %r' % (method,))
 
62
        for arg in args:
 
63
            if type(arg) is not str:
 
64
                raise TypeError('args must be byte strings, not %r' % (args,))
 
65
        if type(body) is not str:
 
66
            raise TypeError('body must be byte string, not %r' % (body,))
 
67
        request = self.get_smart_medium().get_request()
 
68
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
69
        smart_protocol.call_with_body_bytes((method, ) + args, body)
 
70
        return smart_protocol.read_response_tuple()
 
71
 
 
72
    def call_with_body_bytes_expecting_body(self, method, args, body):
 
73
        """Call a method on the remote server with body bytes."""
 
74
        if type(method) is not str:
 
75
            raise TypeError('method must be a byte string, not %r' % (method,))
 
76
        for arg in args:
 
77
            if type(arg) is not str:
 
78
                raise TypeError('args must be byte strings, not %r' % (args,))
 
79
        if type(body) is not str:
 
80
            raise TypeError('body must be byte string, not %r' % (body,))
 
81
        request = self.get_smart_medium().get_request()
 
82
        smart_protocol = protocol.SmartClientRequestProtocolTwo(request)
 
83
        smart_protocol.call_with_body_bytes((method, ) + args, body)
 
84
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
 
85
 
 
86
    def remote_path_from_transport(self, transport):
 
87
        """Convert transport into a path suitable for using in a request.
 
88
        
 
89
        Note that the resulting remote path doesn't encode the host name or
 
90
        anything but path, so it is only safe to use it in requests sent over
 
91
        the medium from the matching transport.
 
92
        """
 
93
        base = self._shared_connection.base
 
94
        if base.startswith('bzr+http://') or base.startswith('bzr+https://'):
 
95
            medium_base = self._shared_connection.base
 
96
        else:
 
97
            medium_base = urlutils.join(self._shared_connection.base, '/')
 
98
            
 
99
        rel_url = urlutils.relative_url(medium_base, transport.base)
 
100
        return urllib.unquote(rel_url)
 
101