transports/stratum_http.py

   1 #!/usr/bin/env python
   2 # Copyright(C) 2012 thomasv@gitorious
   3
   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.
   8 #
   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.
  13 #
  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>.
  17
  18 import jsonrpclib
  19 from jsonrpclib import Fault
  20 from jsonrpclib.jsonrpc import USE_UNIX_SOCKETS
  21 import SimpleXMLRPCServer
  22 import SocketServer
  23 import socket
  24 import logging
  25 import os
  26 import types
  27 import traceback
  28 import sys, threading
  29
  30 try:
  31     import fcntl
  32 except ImportError:
  33     # For Windows
  34     fcntl = None
  35
  36 import json
  37
  38
  39 """
  40 sessions are identified with cookies
  41  - each session has a buffer of responses to requests
  42
  43
  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
  46
  47 """
  48
  49
  50 from processor import random_string
  51
  52
  53 def get_version(request):
  54     # must be a dict
  55     if 'jsonrpc' in request.keys():
  56         return 2.0
  57     if 'id' in request.keys():
  58         return 1.0
  59     return None
  60
  61 def validate_request(request):
  62     if type(request) is not types.DictType:
  63         fault = Fault(
  64             -32600, 'Request must be {}, not %s.' % type(request)
  65         )
  66         return fault
  67     rpcid = request.get('id', None)
  68     version = get_version(request)
  69     if not version:
  70         fault = Fault(-32600, 'Request %s invalid.' % request, rpcid=rpcid)
  71         return fault
  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:
  78         fault = Fault(
  79             -32600, 'Invalid request parameters or method.', rpcid=rpcid
  80         )
  81         return fault
  82     return True
  83
  84 class StratumJSONRPCDispatcher(SimpleXMLRPCServer.SimpleXMLRPCDispatcher):
  85
  86     def __init__(self, encoding=None):
  87         SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__(self,
  88                                         allow_none=True,
  89                                         encoding=encoding)
  90
  91     def _marshaled_dispatch(self, session_id, data, dispatch_method = None):
  92         response = None
  93         try:
  94             request = jsonrpclib.loads(data)
  95         except Exception, e:
  96             fault = Fault(-32700, 'Request %s invalid. (%s)' % (data, e))
  97             response = fault.response()
  98             return response
  99
 100         responses = []
 101         if type(request) is not types.ListType:
 102             request = [ request ]
 103
 104         for req_entry in request:
 105             result = validate_request(req_entry)
 106             if type(result) is Fault:
 107                 responses.append(result.response())
 108                 continue
 109
 110             session = self.sessions.get(session_id)
 111             self.dispatcher.process(session, req_entry)
 112
 113             if req_entry['method'] == 'server.stop':
 114                 return json.dumps({'result':'ok'})
 115
 116         r = self.poll_session(session_id)
 117         for item in r:
 118             responses.append(json.dumps(item))
 119
 120         if len(responses) > 1:
 121             response = '[%s]' % ','.join(responses)
 122         elif len(responses) == 1:
 123             response = responses[0]
 124         else:
 125             response = ''
 126
 127         return response
 128
 129
 130
 131 class StratumJSONRPCRequestHandler(
 132         SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
 133
 134     def do_GET(self):
 135         if not self.is_rpc_path_valid():
 136             self.report_404()
 137             return
 138         try:
 139             session_id = None
 140             c = self.headers.get('cookie')
 141             if c:
 142                 if c[0:8]=='SESSION=':
 143                     #print "found cookie", c[8:]
 144                     session_id = c[8:]
 145
 146             if session_id is None:
 147                 session_id = self.server.create_session()
 148                 #print "setting cookie", session_id
 149
 150             data = json.dumps([])
 151             response = self.server._marshaled_dispatch(session_id, data)
 152             self.send_response(200)
 153         except Exception, e:
 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
 160         if response == None:
 161             response = ''
 162
 163         if session_id:
 164             self.send_header("Set-Cookie", "SESSION=%s"%session_id)
 165
 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)))
 169         self.end_headers()
 170         self.wfile.write(response)
 171         self.wfile.flush()
 172         self.connection.shutdown(1)
 173
 174
 175     def do_POST(self):
 176         if not self.is_rpc_path_valid():
 177             self.report_404()
 178             return
 179         try:
 180             max_chunk_size = 10*1024*1024
 181             size_remaining = int(self.headers["content-length"])
 182             L = []
 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])
 187             data = ''.join(L)
 188
 189             session_id = None
 190             c = self.headers.get('cookie')
 191             if c:
 192                 if c[0:8]=='SESSION=':
 193                     #print "found cookie", c[8:]
 194                     session_id = c[8:]
 195
 196             if session_id is None:
 197                 session_id = self.server.create_session()
 198                 #print "setting cookie", session_id
 199
 200             response = self.server._marshaled_dispatch(session_id, data)
 201             self.send_response(200)
 202         except Exception, e:
 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
 209         if response == None:
 210             response = ''
 211
 212         if session_id:
 213             self.send_header("Set-Cookie", "SESSION=%s"%session_id)
 214
 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)))
 218         self.end_headers()
 219         self.wfile.write(response)
 220         self.wfile.flush()
 221         self.connection.shutdown(1)
 222
 223
 224 class StratumJSONRPCServer(SocketServer.TCPServer, StratumJSONRPCDispatcher):
 225
 226     allow_reuse_address = True
 227
 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):
 242                 try:
 243                     os.unlink(addr)
 244                 except OSError:
 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)
 249         else:
 250             SocketServer.TCPServer.__init__(self, addr, requestHandler,
 251                 bind_and_activate)
 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)
 256
 257         self.sessions = {}
 258
 259
 260     def create_session(self):
 261         session_id = random_string(10)
 262         self.sessions[session_id] = HttpSession(session_id)
 263         return session_id
 264
 265     def poll_session(self, session_id):
 266         q = self.sessions[session_id].pending_responses
 267         responses = []
 268         while not q.empty():
 269             r = q.get()
 270             responses.append(r)
 271         #print "poll: %d responses"%len(responses)
 272         return responses
 273
 274
 275 from processor import Session
 276 import Queue
 277
 278 class HttpSession(Session):
 279
 280     def __init__(self, session_id):
 281         Session.__init__(self)
 282         self.pending_responses = Queue.Queue()
 283         self.address = session_id
 284         self.name = "HTTP session"
 285
 286     def send_response(self, response):
 287         raw_response = json.dumps(response)
 288         self.pending_responses.put(response)
 289
 290 class HttpServer(threading.Thread):
 291     def __init__(self, dispatcher, host, port):
 292         self.shared = dispatcher.shared
 293         self.dispatcher = dispatcher.request_dispatcher
 294         threading.Thread.__init__(self)
 295         self.daemon = True
 296         self.host = host
 297         self.port = port
 298         self.lock = threading.Lock()
 299
 300     def run(self):
 301         # see http://code.google.com/p/jsonrpclib/
 302         from SocketServer import ThreadingMixIn
 303         class StratumThreadedJSONRPCServer(ThreadingMixIn, StratumJSONRPCServer): pass
 304
 305         self.server = StratumThreadedJSONRPCServer(( self.host, self.port))
 306         self.server.dispatcher = self.dispatcher
 307         self.server.register_function(None, 'server.stop')
 308         self.server.register_function(None, 'server.info')
 309
 310         print "HTTP server started."
 311         self.server.serve_forever()
 312