← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

  • Committer: Robert Collins
  • Date: 2007-07-04 08:08:13 UTC
  • mfrom: (2572 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2587.
  • Revision ID: robertc@robertcollins.net-20070704080813-wzebx0r88fvwj5rq
Merge 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
from urlparse import urlparse
 
18
 
 
19
from bzrlib.smart import protocol
 
20
from bzrlib.urlutils import unescape
 
21
 
 
22
 
 
23
class _SmartClient(object):
 
24
 
 
25
    def __init__(self, medium):
 
26
        self._medium = medium
 
27
 
 
28
    def call(self, method, *args):
 
29
        """Call a method on the remote server."""
 
30
        result, protocol = self.call_expecting_body(method, *args)
 
31
        protocol.cancel_read_body()
 
32
        return result
 
33
 
 
34
    def call_expecting_body(self, method, *args):
 
35
        """Call a method and return the result and the protocol object.
 
36
        
 
37
        The body can be read like so::
 
38
 
 
39
            result, smart_protocol = smart_client.call_expecting_body(...)
 
40
            body = smart_protocol.read_body_bytes()
 
41
        """
 
42
        request = self._medium.get_request()
 
43
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
44
        smart_protocol.call(method, *args)
 
45
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
 
46
 
 
47
    def call_with_body_bytes(self, method, args, body):
 
48
        """Call a method on the remote server with body bytes."""
 
49
        if type(method) is not str:
 
50
            raise TypeError('method must be a byte string, not %r' % (method,))
 
51
        for arg in args:
 
52
            if type(arg) is not str:
 
53
                raise TypeError('args must be byte strings, not %r' % (args,))
 
54
        if type(body) is not str:
 
55
            raise TypeError('body must be byte string, not %r' % (body,))
 
56
        request = self._medium.get_request()
 
57
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
58
        smart_protocol.call_with_body_bytes((method, ) + args, body)
 
59
        return smart_protocol.read_response_tuple()
 
60
 
 
61
    def remote_path_from_transport(self, transport):
 
62
        """Convert transport into a path suitable for using in a request.
 
63
        
 
64
        Note that the resulting remote path doesn't encode the host name or
 
65
        anything but path, so it is only safe to use it in requests sent over
 
66
        the medium from the matching transport.
 
67
        """
 
68
        return unescape(urlparse(transport.base)[2]).encode('utf8')