blob: c9fe369e2553a05e411339d724be074ce30cfb0d [file] [log] [blame]
Guido van Rossum07a272d1995-04-10 11:40:52 +00001"""RPC Client module."""
2
3import sys
4import socket
5import pickle
Georg Brandl1a3284e2007-12-02 09:40:06 +00006import builtins
Guido van Rossum07a272d1995-04-10 11:40:52 +00007import os
8
9
10# Default verbosity (0 = silent, 1 = print connections, 2 = print requests too)
11VERBOSE = 1
12
13
14class Client:
Tim Peterse6ddc8b2004-07-18 05:56:09 +000015
16 """RPC Client class. No need to derive a class -- it's fully generic."""
17
18 def __init__(self, address, verbose = VERBOSE):
19 self._pre_init(address, verbose)
20 self._post_init()
21
22 def _pre_init(self, address, verbose = VERBOSE):
23 if type(address) == type(0):
24 address = ('', address)
25 self._address = address
26 self._verbose = verbose
Collin Winter6f2df4d2007-07-17 20:59:35 +000027 if self._verbose: print("Connecting to %s ..." % repr(address))
Tim Peterse6ddc8b2004-07-18 05:56:09 +000028 self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
29 self._socket.connect(address)
Collin Winter6f2df4d2007-07-17 20:59:35 +000030 if self._verbose: print("Connected.")
Tim Peterse6ddc8b2004-07-18 05:56:09 +000031 self._lastid = 0 # Last id for which a reply has been received
32 self._nextid = 1 # Id of next request
33 self._replies = {} # Unprocessed replies
34 self._rf = self._socket.makefile('r')
35 self._wf = self._socket.makefile('w')
36
37 def _post_init(self):
38 self._methods = self._call('.methods')
39
40 def __del__(self):
41 self._close()
42
43 def _close(self):
44 if self._rf: self._rf.close()
45 self._rf = None
46 if self._wf: self._wf.close()
47 self._wf = None
48 if self._socket: self._socket.close()
49 self._socket = None
50
51 def __getattr__(self, name):
52 if name in self._methods:
53 method = _stub(self, name)
54 setattr(self, name, method) # XXX circular reference
55 return method
Collin Winter6f2df4d2007-07-17 20:59:35 +000056 raise AttributeError(name)
Tim Peterse6ddc8b2004-07-18 05:56:09 +000057
58 def _setverbose(self, verbose):
59 self._verbose = verbose
60
61 def _call(self, name, *args):
62 return self._vcall(name, args)
63
64 def _vcall(self, name, args):
65 return self._recv(self._vsend(name, args))
66
67 def _send(self, name, *args):
68 return self._vsend(name, args)
69
70 def _send_noreply(self, name, *args):
71 return self._vsend(name, args, 0)
72
73 def _vsend_noreply(self, name, args):
74 return self._vsend(name, args, 0)
75
76 def _vsend(self, name, args, wantreply = 1):
77 id = self._nextid
78 self._nextid = id+1
79 if not wantreply: id = -id
80 request = (name, args, id)
Collin Winter6f2df4d2007-07-17 20:59:35 +000081 if self._verbose > 1: print("sending request: %s" % repr(request))
Tim Peterse6ddc8b2004-07-18 05:56:09 +000082 wp = pickle.Pickler(self._wf)
83 wp.dump(request)
84 return id
85
86 def _recv(self, id):
87 exception, value, rid = self._vrecv(id)
88 if rid != id:
Collin Winter6f2df4d2007-07-17 20:59:35 +000089 raise RuntimeError("request/reply id mismatch: %d/%d" % (id, rid))
Tim Peterse6ddc8b2004-07-18 05:56:09 +000090 if exception is None:
91 return value
92 x = exception
Georg Brandl1a3284e2007-12-02 09:40:06 +000093 if hasattr(builtins, exception):
94 x = getattr(builtins, exception)
Tim Peterse6ddc8b2004-07-18 05:56:09 +000095 elif exception in ('posix.error', 'mac.error'):
96 x = os.error
97 if x == exception:
98 exception = x
Collin Winter6f2df4d2007-07-17 20:59:35 +000099 raise exception(value)
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000100
101 def _vrecv(self, id):
102 self._flush()
Collin Winter6f2df4d2007-07-17 20:59:35 +0000103 if id in self._replies:
104 if self._verbose > 1: print("retrieving previous reply, id = %d" % id)
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000105 reply = self._replies[id]
106 del self._replies[id]
107 return reply
108 aid = abs(id)
109 while 1:
Collin Winter6f2df4d2007-07-17 20:59:35 +0000110 if self._verbose > 1: print("waiting for reply, id = %d" % id)
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000111 rp = pickle.Unpickler(self._rf)
112 reply = rp.load()
113 del rp
Collin Winter6f2df4d2007-07-17 20:59:35 +0000114 if self._verbose > 1: print("got reply: %s" % repr(reply))
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000115 rid = reply[2]
116 arid = abs(rid)
117 if arid == aid:
Collin Winter6f2df4d2007-07-17 20:59:35 +0000118 if self._verbose > 1: print("got it")
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000119 return reply
120 self._replies[rid] = reply
121 if arid > aid:
Collin Winter6f2df4d2007-07-17 20:59:35 +0000122 if self._verbose > 1: print("got higher id, assume all ok")
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000123 return (None, None, id)
124
125 def _flush(self):
126 self._wf.flush()
Guido van Rossum07a272d1995-04-10 11:40:52 +0000127
128
Guido van Rossum45babef1995-06-21 01:00:17 +0000129from security import Security
130
131
132class SecureClient(Client, Security):
133
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000134 def __init__(self, *args):
Neal Norwitzd9108552006-03-17 08:00:19 +0000135 self._pre_init(*args)
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000136 Security.__init__(self)
137 self._wf.flush()
138 line = self._rf.readline()
Neal Norwitzd9108552006-03-17 08:00:19 +0000139 challenge = int(line.strip())
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000140 response = self._encode_challenge(challenge)
Collin Winter6f2df4d2007-07-17 20:59:35 +0000141 line = repr(int(response))
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000142 if line[-1] in 'Ll': line = line[:-1]
143 self._wf.write(line + '\n')
144 self._wf.flush()
145 self._post_init()
Guido van Rossum45babef1995-06-21 01:00:17 +0000146
Guido van Rossum07a272d1995-04-10 11:40:52 +0000147class _stub:
Guido van Rossum07a272d1995-04-10 11:40:52 +0000148
Tim Peterse6ddc8b2004-07-18 05:56:09 +0000149 """Helper class for Client -- each instance serves as a method of the client."""
150
151 def __init__(self, client, name):
152 self._client = client
153 self._name = name
154
155 def __call__(self, *args):
156 return self._client._vcall(self._name, args)