jsonrpcserver.py

   1 # Eloipool - Python Bitcoin pool server
   2 # Copyright (C) 2011-2012  Luke Dashjr <luke-jr+eloipool@utopios.org>
   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,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import httpserver
  18 import json
  19 import logging
  20 import networkserver
  21 import socket
  22 from time import time
  23 import traceback
  24
  25 WithinLongpoll = httpserver.AsyncRequest
  26
  27 class _SentJSONError(BaseException):
  28         def __init__(self, rv):
  29                 self.rv = rv
  30
  31 class JSONRPCHandler(httpserver.HTTPHandler):
  32         default_quirks = {
  33                 'NELH': None,  # FIXME: identify which clients have a problem with this
  34         }
  35
  36         LPHeaders = {
  37                 'X-Long-Polling': None,
  38         }
  39
  40         logger = logging.getLogger('JSONRPCHandler')
  41
  42         def sendReply(self, status=200, body=b'', headers=None):
  43                 headers = dict(headers) if headers else {}
  44                 if status == 200:
  45                         headers.setdefault('Content-Type', 'application/json')
  46                         headers.setdefault('X-Long-Polling', '/LP')
  47                         headers.setdefault('X-Roll-NTime', 'expire=120')
  48                 elif body and body[0] == 123:  # b'{'
  49                         headers.setdefault('Content-Type', 'application/json')
  50                 return super().sendReply(status, body, headers)
  51
  52         def fmtError(self, reason = '', code = 100):
  53                 reason = json.dumps(reason)
  54                 reason = r'{"result":null,"id":null,"error":{"name":"JSONRPCError","code":%d,"message":%s}}' % (code, reason)
  55                 reason = reason.encode('utf8')
  56                 return reason
  57
  58         def doError(self, reason = '', code = 100):
  59                 reason = self.fmtError(reason, code)
  60                 return self.sendReply(500, reason)
  61
  62         def checkAuthentication(self, un, pw):
  63                 return bool(un)
  64
  65         _MidstateNotAdv = (b'phoenix', b'poclbm', b'gminor')
  66         def doHeader_user_agent(self, value):
  67                 self.reqinfo['UA'] = value
  68                 quirks = self.quirks
  69                 (UA, v, *x) = value.split(b'/', 1) + [None]
  70                 try:
  71                         if v[0] == b'v': v = v[1:]
  72                         v = tuple(map(int, v.split(b'.'))) + (0,0,0)
  73                 except:
  74                         pass
  75                 if UA in self._MidstateNotAdv:
  76                         quirks['midstate'] = None
  77                         if UA == b'phoenix':
  78                                 if v[0] < 2 and v[1] < 8 and v[2] < 1:
  79                                         quirks['NELH'] = None
  80
  81         def doHeader_x_minimum_wait(self, value):
  82                 self.reqinfo['MinWait'] = int(value)
  83
  84         def doHeader_x_mining_extensions(self, value):
  85                 self.extensions = value.decode('ascii').lower().split(' ')
  86
  87         def doLongpoll(self, *a):
  88                 timeNow = time()
  89
  90                 self._LP = True
  91                 self._LPCall = a
  92                 if 'NELH' not in self.quirks:
  93                         # [NOT No] Early Longpoll Headers
  94                         self.sendReply(200, body=None, headers=self.LPHeaders)
  95                         self.push(b"1\r\n{\r\n")
  96                         self.changeTask(self._chunkedKA, timeNow + 45)
  97                 else:
  98                         self.changeTask(None)
  99
 100                 waitTime = self.reqinfo.get('MinWait', 15)  # TODO: make default configurable
 101                 self.waitTime = waitTime + timeNow
 102
 103                 totfromme = self.LPTrack()
 104                 self.server._LPClients[id(self)] = self
 105                 self.logger.debug("New LP client; %d total; %d from %s" % (len(self.server._LPClients), totfromme, self.addr[0]))
 106
 107                 raise WithinLongpoll
 108
 109         def _chunkedKA(self):
 110                 # Keepalive via chunked transfer encoding
 111                 self.push(b"1\r\n \r\n")
 112                 self.changeTask(self._chunkedKA, time() + 45)
 113
 114         def LPTrack(self):
 115                 myip = self.addr[0]
 116                 if myip not in self.server.LPTracking:
 117                         self.server.LPTracking[myip] = 0
 118                 self.server.LPTracking[myip] += 1
 119                 return self.server.LPTracking[myip]
 120
 121         def LPUntrack(self):
 122                 self.server.LPTracking[self.addr[0]] -= 1
 123
 124         def cleanupLP(self):
 125                 # Called when the connection is closed
 126                 if not self._LP:
 127                         return
 128                 self.changeTask(None)
 129                 try:
 130                         del self.server._LPClients[id(self)]
 131                 except KeyError:
 132                         pass
 133                 self.LPUntrack()
 134
 135         def wakeLongpoll(self):
 136                 now = time()
 137                 if now < self.waitTime:
 138                         self.changeTask(self.wakeLongpoll, self.waitTime)
 139                         return
 140                 else:
 141                         self.changeTask(None)
 142
 143                 self.LPUntrack()
 144
 145                 rv = self._doJSON_i(*self._LPCall, longpoll=True)
 146                 if 'NELH' not in self.quirks:
 147                         rv = rv[1:]  # strip the '{' we already sent
 148                         self.push(('%x' % len(rv)).encode('utf8') + b"\r\n" + rv + b"\r\n0\r\n\r\n")
 149                 else:
 150                         self.sendReply(200, body=rv, headers=self.LPHeaders)
 151
 152                 self.reset_request()
 153
 154         def _doJSON_i(self, reqid, method, params, longpoll = False):
 155                 try:
 156                         rv = getattr(self, method)(*params)
 157                 except Exception as e:
 158                         self.logger.error(("Error during JSON-RPC call: %s%s\n" % (method, params)) + traceback.format_exc())
 159                         efun = self.fmtError if longpoll else self.doError
 160                         return efun(r'Service error: %s' % (e,))
 161                 if rv is None:
 162                         # response was already sent (eg, authentication request)
 163                         return
 164                 try:
 165                         rv.setdefault('submitold', True)
 166                 except:
 167                         pass
 168                 rv = {'id': reqid, 'error': None, 'result': rv}
 169                 try:
 170                         rv = json.dumps(rv)
 171                 except:
 172                         efun = self.fmtError if longpoll else self.doError
 173                         return efun(r'Error encoding reply in JSON')
 174                 rv = rv.encode('utf8')
 175                 return rv if longpoll else self.sendReply(200, rv, headers=self._JSONHeaders)
 176
 177         def doJSON(self, data, longpoll = False):
 178                 # TODO: handle JSON errors
 179                 data = data.decode('utf8')
 180                 if longpoll and not data:
 181                         return self.doLongpoll(1, 'doJSON_getwork', ())
 182                 try:
 183                         data = json.loads(data)
 184                         method = 'doJSON_' + str(data['method']).lower()
 185                 except ValueError:
 186                         return self.doError(r'Parse error')
 187                 except TypeError:
 188                         return self.doError(r'Bad call')
 189                 if not hasattr(self, method):
 190                         return self.doError(r'Procedure not found')
 191                 # TODO: handle errors as JSON-RPC
 192                 self._JSONHeaders = {}
 193                 params = data.setdefault('params', ())
 194                 procfun = self._doJSON_i
 195                 if longpoll and not params:
 196                         procfun = self.doLongpoll
 197                 return procfun(data['id'], method, params)
 198
 199         def handle_close(self):
 200                 self.cleanupLP()
 201                 super().handle_close()
 202
 203         def handle_request(self):
 204                 if not self.Username:
 205                         return self.doAuthenticate()
 206                 if not self.method in (b'GET', b'POST'):
 207                         return self.sendReply(405)
 208                 if not self.path in (b'/', b'/LP', b'/LP/'):
 209                         return self.sendReply(404)
 210                 try:
 211                         data = b''.join(self.incoming)
 212                         return self.doJSON(data, self.path[:3] == b'/LP')
 213                 except socket.error:
 214                         raise
 215                 except WithinLongpoll:
 216                         raise
 217                 except:
 218                         self.logger.error(traceback.format_exc())
 219                         return self.doError('uncaught error')
 220
 221         def reset_request(self):
 222                 self._LP = False
 223                 super().reset_request()
 224
 225 setattr(JSONRPCHandler, 'doHeader_user-agent', JSONRPCHandler.doHeader_user_agent);
 226 setattr(JSONRPCHandler, 'doHeader_x-minimum-wait', JSONRPCHandler.doHeader_x_minimum_wait);
 227 setattr(JSONRPCHandler, 'doHeader_x-mining-extensions', JSONRPCHandler.doHeader_x_mining_extensions);
 228
 229 JSONRPCListener = networkserver.NetworkListener
 230
 231 class JSONRPCServer(networkserver.AsyncSocketServer):
 232         logger = logging.getLogger('JSONRPCServer')
 233
 234         waker = True
 235
 236         def __init__(self, *a, **ka):
 237                 ka.setdefault('RequestHandlerClass', JSONRPCHandler)
 238                 super().__init__(*a, **ka)
 239
 240                 self.SecretUser = None
 241
 242                 self.LPRequest = False
 243                 self._LPClients = {}
 244                 self._LPWaitTime = time() + 15
 245
 246                 self.LPTracking = {}
 247
 248         def pre_schedule(self):
 249                 if self.LPRequest == 1:
 250                         self._LPsch()
 251
 252         def wakeLongpoll(self):
 253                 if self.LPRequest:
 254                         self.logger.info('Ignoring longpoll attempt while another is waiting')
 255                         return
 256                 self.LPRequest = 1
 257                 self.wakeup()
 258
 259         def _LPsch(self):
 260                 now = time()
 261                 if self._LPWaitTime > now:
 262                         delay = self._LPWaitTime - now
 263                         self.logger.info('Waiting %.3g seconds to longpoll' % (delay,))
 264                         self.schedule(self._actualLP, self._LPWaitTime)
 265                         self.LPRequest = 2
 266                 else:
 267                         self._actualLP()
 268
 269         def _actualLP(self):
 270                 self.LPRequest = False
 271                 C = tuple(self._LPClients.values())
 272                 self._LPClients = {}
 273                 if not C:
 274                         self.logger.info('Nobody to longpoll')
 275                         return
 276                 OC = len(C)
 277                 self.logger.debug("%d clients to wake up..." % (OC,))
 278
 279                 now = time()
 280
 281                 for ic in C:
 282                         try:
 283                                 ic.wakeLongpoll()
 284                         except socket.error:
 285                                 OC -= 1
 286                                 # Ignore socket errors; let the main event loop take care of them later
 287                         except:
 288                                 OC -= 1
 289                                 self.logger.debug('Error waking longpoll handler:\n' + traceback.format_exc())
 290
 291                 self._LPWaitTime = time()
 292                 self.logger.info('Longpoll woke up %d clients in %.3f seconds' % (OC, self._LPWaitTime - now))
 293                 self._LPWaitTime += 5  # TODO: make configurable: minimum time between longpolls
 294
 295         def TopLPers(self, n = 0x10):
 296                 tmp = list(self.LPTracking.keys())
 297                 tmp.sort(key=lambda k: self.LPTracking[k])
 298                 for jerk in map(lambda k: (k, self.LPTracking[k]), tmp[-n:]):
 299                         print(jerk)