2 # Copyright(C) 2012 thomasv@gitorious
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU Affero General Public License as
6 # published by the Free Software Foundation, either version 3 of the
7 # License, or (at your option) any later version.
9 # This program is distributed in the hope that it will be useful, but
10 # WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Affero General Public License for more details.
14 # You should have received a copy of the GNU Affero General Public
15 # License along with this program. If not, see
16 # <http://www.gnu.org/licenses/agpl.html>.
19 from jsonrpclib import Fault
20 from jsonrpclib.jsonrpc import USE_UNIX_SOCKETS
21 import SimpleXMLRPCServer
40 sessions are identified with cookies
41 - each session has a buffer of responses to requests
44 from the processor point of view:
45 - the user only defines process() ; the rest is session management. thus sessions should not belong to processor
52 return ''.join(random.choice(string.ascii_uppercase + string.digits) for x in range(N))
57 def get_version(request):
59 if 'jsonrpc' in request.keys():
61 if 'id' in request.keys():
65 def validate_request(request):
66 if type(request) is not types.DictType:
68 -32600, 'Request must be {}, not %s.' % type(request)
71 rpcid = request.get('id', None)
72 version = get_version(request)
74 fault = Fault(-32600, 'Request %s invalid.' % request, rpcid=rpcid)
76 request.setdefault('params', [])
77 method = request.get('method', None)
78 params = request.get('params')
79 param_types = (types.ListType, types.DictType, types.TupleType)
80 if not method or type(method) not in types.StringTypes or \
81 type(params) not in param_types:
83 -32600, 'Invalid request parameters or method.', rpcid=rpcid
88 class StratumJSONRPCDispatcher(SimpleXMLRPCServer.SimpleXMLRPCDispatcher):
90 def __init__(self, encoding=None):
91 SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__(self,
95 def _marshaled_dispatch(self, session_id, data, dispatch_method = None):
98 request = jsonrpclib.loads(data)
100 fault = Fault(-32700, 'Request %s invalid. (%s)' % (data, e))
101 response = fault.response()
105 if type(request) is not types.ListType:
106 request = [ request ]
108 for req_entry in request:
109 result = validate_request(req_entry)
110 if type(result) is Fault:
111 responses.append(result.response())
114 session = self.sessions.get(session_id)
116 self.dispatcher.process(session, req_entry)
117 if req_entry['method'] == 'server.stop':
118 return json.dumps({'result':'ok'})
121 r = self.poll_session(session_id)
123 responses.append(json.dumps(item))
125 if len(responses) > 1:
126 response = '[%s]' % ','.join(responses)
127 elif len(responses) == 1:
128 response = responses[0]
136 class StratumJSONRPCRequestHandler(
137 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
140 if not self.is_rpc_path_valid():
145 c = self.headers.get('cookie')
147 if c[0:8]=='SESSION=':
148 #print "found cookie", c[8:]
151 if session_id is None:
152 session_id = self.server.create_session()
153 #print "setting cookie", session_id
155 data = json.dumps([])
156 response = self.server._marshaled_dispatch(session_id, data)
157 self.send_response(200)
159 self.send_response(500)
160 err_lines = traceback.format_exc().splitlines()
161 trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
162 fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
163 response = fault.response()
164 print "500", trace_string
169 self.send_header("Set-Cookie", "SESSION=%s"%session_id)
171 self.send_header("Content-type", "application/json-rpc")
172 self.send_header("Content-length", str(len(response)))
174 self.wfile.write(response)
176 self.connection.shutdown(1)
180 if not self.is_rpc_path_valid():
184 max_chunk_size = 10*1024*1024
185 size_remaining = int(self.headers["content-length"])
187 while size_remaining:
188 chunk_size = min(size_remaining, max_chunk_size)
189 L.append(self.rfile.read(chunk_size))
190 size_remaining -= len(L[-1])
194 c = self.headers.get('cookie')
196 if c[0:8]=='SESSION=':
197 print "found cookie", c[8:]
200 if session_id is None:
201 session_id = self.server.create_session()
202 print "setting cookie", session_id
204 response = self.server._marshaled_dispatch(session_id, data)
205 self.send_response(200)
207 self.send_response(500)
208 err_lines = traceback.format_exc().splitlines()
209 trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
210 fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
211 response = fault.response()
212 print "500", trace_string
217 self.send_header("Set-Cookie", "SESSION=%s"%session_id)
219 self.send_header("Content-type", "application/json-rpc")
220 self.send_header("Content-length", str(len(response)))
222 self.wfile.write(response)
224 self.connection.shutdown(1)
227 class StratumJSONRPCServer(SocketServer.TCPServer, StratumJSONRPCDispatcher):
229 allow_reuse_address = True
231 def __init__(self, addr, requestHandler=StratumJSONRPCRequestHandler,
232 logRequests=False, encoding=None, bind_and_activate=True,
233 address_family=socket.AF_INET):
234 self.logRequests = logRequests
235 StratumJSONRPCDispatcher.__init__(self, encoding)
236 # TCPServer.__init__ has an extra parameter on 2.6+, so
237 # check Python version and decide on how to call it
238 vi = sys.version_info
239 self.address_family = address_family
240 if USE_UNIX_SOCKETS and address_family == socket.AF_UNIX:
241 # Unix sockets can't be bound if they already exist in the
242 # filesystem. The convention of e.g. X11 is to unlink
243 # before binding again.
244 if os.path.exists(addr):
248 logging.warning("Could not unlink socket %s", addr)
249 # if python 2.5 and lower
250 if vi[0] < 3 and vi[1] < 6:
251 SocketServer.TCPServer.__init__(self, addr, requestHandler)
253 SocketServer.TCPServer.__init__(self, addr, requestHandler,
255 if fcntl is not None and hasattr(fcntl, 'FD_CLOEXEC'):
256 flags = fcntl.fcntl(self.fileno(), fcntl.F_GETFD)
257 flags |= fcntl.FD_CLOEXEC
258 fcntl.fcntl(self.fileno(), fcntl.F_SETFD, flags)
264 def create_session(self):
265 session_id = random_string(10)
266 self.sessions[session_id] = HttpSession(session_id)
269 def poll_session(self,session_id):
270 responses = self.sessions[session_id].pending_responses[:]
271 self.sessions[session_id].pending_responses = []
272 print "poll: %d responses"%len(responses)
276 from processor import Session
278 class HttpSession(Session):
280 def __init__(self, session_id):
281 Session.__init__(self)
282 self.pending_responses = []
283 print "new http session", session_id
285 def send_response(self, response):
286 raw_response = json.dumps(response)
287 self.pending_responses.append(response)
289 class HttpServer(threading.Thread):
290 def __init__(self, dispatcher, host, port):
291 self.shared = dispatcher.shared
292 self.dispatcher = dispatcher.request_dispatcher
293 threading.Thread.__init__(self)
297 self.lock = threading.Lock()
300 # see http://code.google.com/p/jsonrpclib/
301 from SocketServer import ThreadingMixIn
302 class StratumThreadedJSONRPCServer(ThreadingMixIn, StratumJSONRPCServer): pass
304 self.server = StratumThreadedJSONRPCServer(( self.host, self.port))
305 self.server.dispatcher = self.dispatcher
306 self.server.register_function(None, 'server.stop')
308 print "HTTP server started."
309 self.server.serve_forever()