← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

  • Committer: Martin Pool
  • Date: 2006-03-21 12:26:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1621.
  • Revision ID: mbp@sourcefrog.net-20060321122654-514047ed65795a17
New developer commands 'weave-list' and 'weave-join'.

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, shared_medium):
26
 
        self._shared_medium = shared_medium
27
 
 
28
 
    def get_smart_medium(self):
29
 
        return self._shared_medium.connection
30
 
 
31
 
    def call(self, method, *args):
32
 
        """Call a method on the remote server."""
33
 
        result, protocol = self.call_expecting_body(method, *args)
34
 
        protocol.cancel_read_body()
35
 
        return result
36
 
 
37
 
    def call_expecting_body(self, method, *args):
38
 
        """Call a method and return the result and the protocol object.
39
 
        
40
 
        The body can be read like so::
41
 
 
42
 
            result, smart_protocol = smart_client.call_expecting_body(...)
43
 
            body = smart_protocol.read_body_bytes()
44
 
        """
45
 
        request = self.get_smart_medium().get_request()
46
 
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
47
 
        smart_protocol.call(method, *args)
48
 
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
49
 
 
50
 
    def call_with_body_bytes(self, method, args, body):
51
 
        """Call a method on the remote server with body bytes."""
52
 
        if type(method) is not str:
53
 
            raise TypeError('method must be a byte string, not %r' % (method,))
54
 
        for arg in args:
55
 
            if type(arg) is not str:
56
 
                raise TypeError('args must be byte strings, not %r' % (args,))
57
 
        if type(body) is not str:
58
 
            raise TypeError('body must be byte string, not %r' % (body,))
59
 
        request = self.get_smart_medium().get_request()
60
 
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
61
 
        smart_protocol.call_with_body_bytes((method, ) + args, body)
62
 
        return smart_protocol.read_response_tuple()
63
 
 
64
 
    def remote_path_from_transport(self, transport):
65
 
        """Convert transport into a path suitable for using in a request.
66
 
        
67
 
        Note that the resulting remote path doesn't encode the host name or
68
 
        anything but path, so it is only safe to use it in requests sent over
69
 
        the medium from the matching transport.
70
 
        """
71
 
        return unescape(urlparse(transport.base)[2]).encode('utf8')