← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-30 23:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2259.
  • Revision ID: bialix@ukr.net-20070130230535-kx1rd478rtigyc3v
standalone installer: win98 support

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 urlutils
22
 
 
23
 
 
24
 
class _SmartClient(object):
25
 
 
26
 
    def __init__(self, shared_connection):
27
 
        """Constructor.
28
 
 
29
 
        :param shared_connection: a bzrlib.transport._SharedConnection
30
 
        """
31
 
        self._shared_connection = shared_connection
32
 
 
33
 
    def get_smart_medium(self):
34
 
        return self._shared_connection.connection
35
 
 
36
 
    def call(self, method, *args):
37
 
        """Call a method on the remote server."""
38
 
        result, protocol = self.call_expecting_body(method, *args)
39
 
        protocol.cancel_read_body()
40
 
        return result
41
 
 
42
 
    def call_expecting_body(self, method, *args):
43
 
        """Call a method and return the result and the protocol object.
44
 
        
45
 
        The body can be read like so::
46
 
 
47
 
            result, smart_protocol = smart_client.call_expecting_body(...)
48
 
            body = smart_protocol.read_body_bytes()
49
 
        """
50
 
        request = self.get_smart_medium().get_request()
51
 
        smart_protocol = protocol.SmartClientRequestProtocolTwo(request)
52
 
        smart_protocol.call(method, *args)
53
 
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
54
 
 
55
 
    def call_with_body_bytes(self, method, args, body):
56
 
        """Call a method on the remote server with body bytes."""
57
 
        if type(method) is not str:
58
 
            raise TypeError('method must be a byte string, not %r' % (method,))
59
 
        for arg in args:
60
 
            if type(arg) is not str:
61
 
                raise TypeError('args must be byte strings, not %r' % (args,))
62
 
        if type(body) is not str:
63
 
            raise TypeError('body must be byte string, not %r' % (body,))
64
 
        request = self.get_smart_medium().get_request()
65
 
        smart_protocol = protocol.SmartClientRequestProtocolOne(request)
66
 
        smart_protocol.call_with_body_bytes((method, ) + args, body)
67
 
        return smart_protocol.read_response_tuple()
68
 
 
69
 
    def call_with_body_bytes_expecting_body(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 = self.get_smart_medium().get_request()
79
 
        smart_protocol = protocol.SmartClientRequestProtocolTwo(request)
80
 
        smart_protocol.call_with_body_bytes((method, ) + args, body)
81
 
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
82
 
 
83
 
    def remote_path_from_transport(self, transport):
84
 
        """Convert transport into a path suitable for using in a request.
85
 
        
86
 
        Note that the resulting remote path doesn't encode the host name or
87
 
        anything but path, so it is only safe to use it in requests sent over
88
 
        the medium from the matching transport.
89
 
        """
90
 
        base = self._shared_connection.base
91
 
        if base.startswith('bzr+http://') or base.startswith('bzr+https://'):
92
 
            medium_base = self._shared_connection.base
93
 
        else:
94
 
            medium_base = urlutils.join(self._shared_connection.base, '/')
95
 
            
96
 
        rel_url = urlutils.relative_url(medium_base, transport.base)
97
 
        return urllib.unquote(rel_url)