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
50 from processor import random_string
53 def get_version(request):
55 if 'jsonrpc' in request.keys():
57 if 'id' in request.keys():
61 def validate_request(request):
62 if type(request) is not types.DictType:
64 -32600, 'Request must be {}, not %s.' % type(request)
67 rpcid = request.get('id', None)
68 version = get_version(request)
70 fault = Fault(-32600, 'Request %s invalid.' % request, rpcid=rpcid)
72 request.setdefault('params', [])
73 method = request.get('method', None)
74 params = request.get('params')
75 param_types = (types.ListType, types.DictType, types.TupleType)
76 if not method or type(method) not in types.StringTypes or \
77 type(params) not in param_types:
79 -32600, 'Invalid request parameters or method.', rpcid=rpcid
84 class StratumJSONRPCDispatcher(SimpleXMLRPCServer.SimpleXMLRPCDispatcher):
86 def __init__(self, encoding=None):
87 SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__(self,
91 def _marshaled_dispatch(self, session_id, data, dispatch_method = None):
94 request = jsonrpclib.loads(data)
96 fault = Fault(-32700, 'Request %s invalid. (%s)' % (data, e))
97 response = fault.response()
101 if type(request) is not types.ListType:
102 request = [ request ]
104 for req_entry in request:
105 result = validate_request(req_entry)
106 if type(result) is Fault:
107 responses.append(result.response())
110 session = self.dispatcher.get_session_by_address(session_id)
111 self.dispatcher.process(session, req_entry)
113 if req_entry['method'] == 'server.stop':
114 return json.dumps({'result':'ok'})
116 r = self.poll_session(session_id)
118 responses.append(json.dumps(item))
120 if len(responses) > 1:
121 response = '[%s]' % ','.join(responses)
122 elif len(responses) == 1:
123 response = responses[0]
131 class StratumJSONRPCRequestHandler(
132 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
135 if not self.is_rpc_path_valid():
140 c = self.headers.get('cookie')
142 if c[0:8]=='SESSION=':
143 #print "found cookie", c[8:]
146 if session_id is None:
147 session_id = self.server.create_session()
148 #print "setting cookie", session_id
150 data = json.dumps([])
151 response = self.server._marshaled_dispatch(session_id, data)
152 self.send_response(200)
154 self.send_response(500)
155 err_lines = traceback.format_exc().splitlines()
156 trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
157 fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
158 response = fault.response()
159 print "500", trace_string
164 self.send_header("Set-Cookie", "SESSION=%s"%session_id)
166 self.send_header("Content-type", "application/json-rpc")
167 self.send_header("Access-Control-Allow-Origin", "*")
168 self.send_header("Content-length", str(len(response)))
170 self.wfile.write(response)
172 self.connection.shutdown(1)
176 if not self.is_rpc_path_valid():
180 max_chunk_size = 10*1024*1024
181 size_remaining = int(self.headers["content-length"])
183 while size_remaining:
184 chunk_size = min(size_remaining, max_chunk_size)
185 L.append(self.rfile.read(chunk_size))
186 size_remaining -= len(L[-1])
190 c = self.headers.get('cookie')
192 if c[0:8]=='SESSION=':
193 #print "found cookie", c[8:]
196 if session_id is None:
197 session_id = self.server.create_session()
198 #print "setting cookie", session_id
200 response = self.server._marshaled_dispatch(session_id, data)
201 self.send_response(200)
203 self.send_response(500)
204 err_lines = traceback.format_exc().splitlines()
205 trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
206 fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
207 response = fault.response()
208 print "500", trace_string
213 self.send_header("Set-Cookie", "SESSION=%s"%session_id)
215 self.send_header("Content-type", "application/json-rpc")
216 self.send_header("Access-Control-Allow-Origin", "*")
217 self.send_header("Content-length", str(len(response)))
219 self.wfile.write(response)
221 self.connection.shutdown(1)
224 class StratumJSONRPCServer(SocketServer.TCPServer, StratumJSONRPCDispatcher):
226 allow_reuse_address = True
228 def __init__(self, addr, requestHandler=StratumJSONRPCRequestHandler,
229 logRequests=False, encoding=None, bind_and_activate=True,
230 address_family=socket.AF_INET):
231 self.logRequests = logRequests
232 StratumJSONRPCDispatcher.__init__(self, encoding)
233 # TCPServer.__init__ has an extra parameter on 2.6+, so
234 # check Python version and decide on how to call it
235 vi = sys.version_info
236 self.address_family = address_family
237 if USE_UNIX_SOCKETS and address_family == socket.AF_UNIX:
238 # Unix sockets can't be bound if they already exist in the
239 # filesystem. The convention of e.g. X11 is to unlink
240 # before binding again.
241 if os.path.exists(addr):
245 logging.warning("Could not unlink socket %s", addr)
246 # if python 2.5 and lower
247 if vi[0] < 3 and vi[1] < 6:
248 SocketServer.TCPServer.__init__(self, addr, requestHandler)
250 SocketServer.TCPServer.__init__(self, addr, requestHandler,
252 if fcntl is not None and hasattr(fcntl, 'FD_CLOEXEC'):
253 flags = fcntl.fcntl(self.fileno(), fcntl.F_GETFD)
254 flags |= fcntl.FD_CLOEXEC
255 fcntl.fcntl(self.fileno(), fcntl.F_SETFD, flags)
259 def create_session(self):
260 session_id = random_string(10)
261 session = HttpSession(session_id)
262 self.dispatcher.add_session(session)
265 def poll_session(self, session_id):
266 session = self.dispatcher.get_session_by_address(session_id)
267 q = session.pending_responses
272 #print "poll: %d responses"%len(responses)
276 from processor import Session
279 class HttpSession(Session):
281 def __init__(self, session_id):
282 Session.__init__(self)
283 self.pending_responses = Queue.Queue()
284 self.address = session_id
285 self.name = "HTTP session"
287 def send_response(self, response):
288 raw_response = json.dumps(response)
289 self.pending_responses.put(response)
291 class HttpServer(threading.Thread):
292 def __init__(self, dispatcher, host, port):
293 self.shared = dispatcher.shared
294 self.dispatcher = dispatcher.request_dispatcher
295 threading.Thread.__init__(self)
299 self.lock = threading.Lock()
302 # see http://code.google.com/p/jsonrpclib/
303 from SocketServer import ThreadingMixIn
304 class StratumThreadedJSONRPCServer(ThreadingMixIn, StratumJSONRPCServer): pass
306 self.server = StratumThreadedJSONRPCServer(( self.host, self.port))
307 self.server.dispatcher = self.dispatcher
308 self.server.register_function(None, 'server.stop')
309 self.server.register_function(None, 'server.info')
311 print "HTTP server started."
312 self.server.serve_forever()