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         session = self.dispatcher.get_session_by_address(session_id)
 101         if not session:
 102             return 'Error: session not found'
 103
 104         responses = []
 105         if type(request) is not types.ListType:
 106             request = [ request ]
 107
 108         for req_entry in request:
 109             result = validate_request(req_entry)
 110             if type(result) is Fault:
 111                 responses.append(result.response())
 112                 continue
 113
 114             self.dispatcher.process(session, req_entry)
 115
 116             if req_entry['method'] == 'server.stop':
 117                 return json.dumps({'result':'ok'})
 118
 119         r = self.poll_session(session)
 120         for item in r:
 121             responses.append(json.dumps(item))
 122
 123         if len(responses) > 1:
 124             response = '[%s]' % ','.join(responses)
 125         elif len(responses) == 1:
 126             response = responses[0]
 127         else:
 128             response = ''
 129
 130         return response
 131
 132
 133
 134 class StratumJSONRPCRequestHandler(
 135         SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
 136
 137     def do_GET(self):
 138         if not self.is_rpc_path_valid():
 139             self.report_404()
 140             return
 141         try:
 142             session_id = None
 143             c = self.headers.get('cookie')
 144             if c:
 145                 if c[0:8]=='SESSION=':
 146                     #print "found cookie", c[8:]
 147                     session_id = c[8:]
 148
 149             if session_id is None:
 150                 session_id = self.server.create_session()
 151                 #print "setting cookie", session_id
 152
 153             data = json.dumps([])
 154             response = self.server._marshaled_dispatch(session_id, data)
 155             self.send_response(200)
 156         except Exception, e:
 157             self.send_response(500)
 158             err_lines = traceback.format_exc().splitlines()
 159             trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
 160             fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
 161             response = fault.response()
 162             print "500", trace_string
 163         if response == None:
 164             response = ''
 165
 166         if session_id:
 167             self.send_header("Set-Cookie", "SESSION=%s"%session_id)
 168
 169         self.send_header("Content-type", "application/json-rpc")
 170         self.send_header("Access-Control-Allow-Origin", "*")
 171         self.send_header("Content-length", str(len(response)))
 172         self.end_headers()
 173         self.wfile.write(response)
 174         self.wfile.flush()
 175         self.connection.shutdown(1)
 176
 177
 178     def do_POST(self):
 179         if not self.is_rpc_path_valid():
 180             self.report_404()
 181             return
 182         try:
 183             max_chunk_size = 10*1024*1024
 184             size_remaining = int(self.headers["content-length"])
 185             L = []
 186             while size_remaining:
 187                 chunk_size = min(size_remaining, max_chunk_size)
 188                 L.append(self.rfile.read(chunk_size))
 189                 size_remaining -= len(L[-1])
 190             data = ''.join(L)
 191
 192             session_id = None
 193             c = self.headers.get('cookie')
 194             if c:
 195                 if c[0:8]=='SESSION=':
 196                     #print "found cookie", c[8:]
 197                     session_id = c[8:]
 198
 199             if session_id is None:
 200                 session_id = self.server.create_session()
 201                 #print "setting cookie", session_id
 202
 203             response = self.server._marshaled_dispatch(session_id, data)
 204             self.send_response(200)
 205         except Exception, e:
 206             self.send_response(500)
 207             err_lines = traceback.format_exc().splitlines()
 208             trace_string = '%s | %s' % (err_lines[-3], err_lines[-1])
 209             fault = jsonrpclib.Fault(-32603, 'Server error: %s' % trace_string)
 210             response = fault.response()
 211             print "500", trace_string
 212         if response == None:
 213             response = ''
 214
 215         if session_id:
 216             self.send_header("Set-Cookie", "SESSION=%s"%session_id)
 217
 218         self.send_header("Content-type", "application/json-rpc")
 219         self.send_header("Access-Control-Allow-Origin", "*")
 220         self.send_header("Content-length", str(len(response)))
 221         self.end_headers()
 222         self.wfile.write(response)
 223         self.wfile.flush()
 224         self.connection.shutdown(1)
 225
 226
 227 class StratumJSONRPCServer(SocketServer.TCPServer, StratumJSONRPCDispatcher):
 228
 229     allow_reuse_address = True
 230
 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):
 245                 try:
 246                     os.unlink(addr)
 247                 except OSError:
 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)
 252         else:
 253             SocketServer.TCPServer.__init__(self, addr, requestHandler,
 254                 bind_and_activate)
 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)
 259
 260
 261
 262     def create_session(self):
 263         session_id = random_string(10)
 264         session = HttpSession(session_id)
 265         self.dispatcher.add_session(session)
 266         return session_id
 267
 268     def poll_session(self, session):
 269         q = session.pending_responses
 270         responses = []
 271         while not q.empty():
 272             r = q.get()
 273             responses.append(r)
 274         #print "poll: %d responses"%len(responses)
 275         return responses
 276
 277
 278 from processor import Session
 279 import Queue
 280
 281 class HttpSession(Session):
 282
 283     def __init__(self, session_id):
 284         Session.__init__(self)
 285         self.pending_responses = Queue.Queue()
 286         self.address = session_id
 287         self.name = "HTTP session"
 288
 289     def send_response(self, response):
 290         raw_response = json.dumps(response)
 291         self.pending_responses.put(response)
 292
 293 class HttpServer(threading.Thread):
 294     def __init__(self, dispatcher, host, port):
 295         self.shared = dispatcher.shared
 296         self.dispatcher = dispatcher.request_dispatcher
 297         threading.Thread.__init__(self)
 298         self.daemon = True
 299         self.host = host
 300         self.port = port
 301         self.lock = threading.Lock()
 302
 303     def run(self):
 304         # see http://code.google.com/p/jsonrpclib/
 305         from SocketServer import ThreadingMixIn
 306         class StratumThreadedJSONRPCServer(ThreadingMixIn, StratumJSONRPCServer): pass
 307
 308         self.server = StratumThreadedJSONRPCServer(( self.host, self.port))
 309         self.server.dispatcher = self.dispatcher
 310         self.server.register_function(None, 'server.stop')
 311         self.server.register_function(None, 'server.info')
 312
 313         print "HTTP server started."
 314         self.server.serve_forever()
 315