/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

Merge from bzr.dev.

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
 
 
19
from bzrlib.smart import message, protocol
 
20
from bzrlib import urlutils
 
21
 
 
22
 
 
23
class _SmartClient(object):
 
24
 
 
25
    def __init__(self, medium, base):
 
26
        """Constructor.
 
27
 
 
28
        :param medium: a SmartClientMedium
 
29
        :param base: a URL
 
30
        """
 
31
        self._medium = medium
 
32
        self._base = base
 
33
 
 
34
    def _build_client_protocol(self):
 
35
        version = self._medium.protocol_version()
 
36
        request = self._medium.get_request()
 
37
        if version == 3:
 
38
            request_encoder = protocol.ProtocolThreeRequester(request)
 
39
            response_handler = message.ConventionalResponseHandler()
 
40
            response_proto = protocol.ProtocolThreeDecoder(response_handler)
 
41
            response_handler.setProtoAndMediumRequest(response_proto, request)
 
42
        elif version == 2:
 
43
            request_encoder = protocol.SmartClientRequestProtocolTwo(request)
 
44
            response_handler = request_encoder
 
45
        else:
 
46
            request_encoder = protocol.SmartClientRequestProtocolOne(request)
 
47
            response_handler = request_encoder
 
48
        return request_encoder, response_handler
 
49
 
 
50
    def call(self, method, *args):
 
51
        """Call a method on the remote server."""
 
52
        result, protocol = self.call_expecting_body(method, *args)
 
53
        protocol.cancel_read_body()
 
54
        return result
 
55
 
 
56
    def call_expecting_body(self, method, *args):
 
57
        """Call a method and return the result and the protocol object.
 
58
        
 
59
        The body can be read like so::
 
60
 
 
61
            result, smart_protocol = smart_client.call_expecting_body(...)
 
62
            body = smart_protocol.read_body_bytes()
 
63
        """
 
64
        request_encoder, response_handler = self._build_client_protocol()
 
65
        request_encoder.call(method, *args)
 
66
        return (response_handler.read_response_tuple(expect_body=True),
 
67
                response_handler)
 
68
 
 
69
    def call_with_body_bytes(self, method, args, body):
 
70
        """Call a method on the remote server with body bytes."""
 
71
        if type(method) is not str:
 
72
            raise TypeError('method must be a byte string, not %r' % (method,))
 
73
        for arg in args:
 
74
            if type(arg) is not str:
 
75
                raise TypeError('args must be byte strings, not %r' % (args,))
 
76
        if type(body) is not str:
 
77
            raise TypeError('body must be byte string, not %r' % (body,))
 
78
        request_encoder, response_handler = self._build_client_protocol()
 
79
        request_encoder.call_with_body_bytes((method, ) + args, body)
 
80
        return response_handler.read_response_tuple()
 
81
 
 
82
    def call_with_body_bytes_expecting_body(self, method, args, body):
 
83
        """Call a method on the remote server with body bytes."""
 
84
        if type(method) is not str:
 
85
            raise TypeError('method must be a byte string, not %r' % (method,))
 
86
        for arg in args:
 
87
            if type(arg) is not str:
 
88
                raise TypeError('args must be byte strings, not %r' % (args,))
 
89
        if type(body) is not str:
 
90
            raise TypeError('body must be byte string, not %r' % (body,))
 
91
        request_encoder, response_handler = self._build_client_protocol()
 
92
        request_encoder.call_with_body_bytes((method, ) + args, body)
 
93
        return (response_handler.read_response_tuple(expect_body=True),
 
94
                response_handler)
 
95
 
 
96
    def call_with_body_readv_array(self, args, body):
 
97
        request_encoder, response_handler = self._build_client_protocol()
 
98
        request_encoder.call_with_body_readv_array(args, body)
 
99
        return (response_handler.read_response_tuple(expect_body=True),
 
100
                response_handler)
 
101
 
 
102
    def remote_path_from_transport(self, transport):
 
103
        """Convert transport into a path suitable for using in a request.
 
104
        
 
105
        Note that the resulting remote path doesn't encode the host name or
 
106
        anything but path, so it is only safe to use it in requests sent over
 
107
        the medium from the matching transport.
 
108
        """
 
109
        base = self._base
 
110
        if (base.startswith('bzr+http://') or base.startswith('bzr+https://')
 
111
            or base.startswith('http://') or base.startswith('https://')):
 
112
            medium_base = self._base
 
113
        else:
 
114
            medium_base = urlutils.join(self._base, '/')
 
115
            
 
116
        rel_url = urlutils.relative_url(medium_base, transport.base)
 
117
        return urllib.unquote(rel_url)
 
118