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         JSONRPCURIs = (b'/', b'/LP', b'/LP/')
  41
  42         logger = logging.getLogger('JSONRPCHandler')
  43
  44         def sendReply(self, status=200, body=b'', headers=None):
  45                 headers = dict(headers) if headers else {}
  46                 if body and body[0] == 123:  # b'{'
  47                         headers.setdefault('Content-Type', 'application/json')
  48                 if status == 200 and self.path in self.JSONRPCURIs:
  49                         if not body:
  50                                 headers.setdefault('Content-Type', 'application/json')
  51                         headers.setdefault('X-Long-Polling', '/LP')
  52                         if self.JSONRPCMethod == 'getwork':
  53                                 # FIXME: Move this to jsonrpc_getwork somehow
  54                                 headers.setdefault('X-Roll-NTime', 'expire=120')
  55                 return super().sendReply(status, body, headers)
  56
  57         def fmtError(self, reason = '', code = 100):
  58                 reason = json.dumps(reason)
  59                 reason = r'{"result":null,"id":null,"error":{"name":"JSONRPCError","code":%d,"message":%s}}' % (code, reason)
  60                 reason = reason.encode('utf8')
  61                 return reason
  62
  63         def doError(self, reason = '', code = 100):
  64                 reason = self.fmtError(reason, code)
  65                 return self.sendReply(500, reason)
  66
  67         def checkAuthentication(self, un, pw):
  68                 return bool(un)
  69
  70         _MidstateNotAdv = (b'phoenix', b'poclbm', b'gminor')
  71         def doHeader_user_agent(self, value):
  72                 self.reqinfo['UA'] = value
  73                 quirks = self.quirks
  74                 (UA, v, *x) = value.split(b'/', 1) + [None]
  75
  76                 # Temporary HACK to keep working with older gmp-proxy
  77                 # NOTE: This will go away someday.
  78                 if UA == b'AuthServiceProxy':
  79                         # SubmitBlock Boolean
  80                         quirks['SBB'] = None
  81
  82                 try:
  83                         if v[0] == b'v': v = v[1:]
  84                         v = tuple(map(int, v.split(b'.'))) + (0,0,0)
  85                 except:
  86                         pass
  87                 if UA in self._MidstateNotAdv:
  88                         if UA == b'phoenix':
  89                                 if v != (1, 50, 0):
  90                                         quirks['midstate'] = None
  91                                 if v[0] < 2 and v[1] < 8 and v[2] < 1:
  92                                         quirks['NELH'] = None
  93                         else:
  94                                 quirks['midstate'] = None
  95
  96         def doHeader_x_minimum_wait(self, value):
  97                 self.reqinfo['MinWait'] = int(value)
  98
  99         def doHeader_x_mining_extensions(self, value):
 100                 self.extensions = value.decode('ascii').lower().split(' ')
 101
 102         def doLongpoll(self, *a):
 103                 timeNow = time()
 104
 105                 self._LP = True
 106                 self._LPCall = a
 107                 if 'NELH' not in self.quirks:
 108                         # [NOT No] Early Longpoll Headers
 109                         self.sendReply(200, body=None, headers=self.LPHeaders)
 110                         self.push(b"1\r\n{\r\n")
 111                         self.changeTask(self._chunkedKA, timeNow + 45)
 112                 else:
 113                         self.changeTask(None)
 114
 115                 waitTime = self.reqinfo.get('MinWait', 15)  # TODO: make default configurable
 116                 self.waitTime = waitTime + timeNow
 117
 118                 totfromme = self.LPTrack()
 119                 self.server._LPClients[id(self)] = self
 120                 self.logger.debug("New LP client; %d total; %d from %s" % (len(self.server._LPClients), totfromme, self.remoteHost))
 121
 122                 raise WithinLongpoll
 123
 124         def _chunkedKA(self):
 125                 # Keepalive via chunked transfer encoding
 126                 self.push(b"1\r\n \r\n")
 127                 self.changeTask(self._chunkedKA, time() + 45)
 128
 129         def LPTrack(self):
 130                 myip = self.remoteHost
 131                 if myip not in self.server.LPTracking:
 132                         self.server.LPTracking[myip] = 0
 133                 self.server.LPTracking[myip] += 1
 134                 return self.server.LPTracking[myip]
 135
 136         def LPUntrack(self):
 137                 self.server.LPTracking[self.remoteHost] -= 1
 138
 139         def cleanupLP(self):
 140                 # Called when the connection is closed
 141                 if not self._LP:
 142                         return
 143                 self.changeTask(None)
 144                 try:
 145                         del self.server._LPClients[id(self)]
 146                 except KeyError:
 147                         pass
 148                 self.LPUntrack()
 149
 150         def wakeLongpoll(self):
 151                 now = time()
 152                 if now < self.waitTime:
 153                         self.changeTask(self.wakeLongpoll, self.waitTime)
 154                         return
 155                 else:
 156                         self.changeTask(None)
 157
 158                 self.LPUntrack()
 159
 160                 rv = self._doJSON_i(*self._LPCall, longpoll=True)
 161                 if 'NELH' not in self.quirks:
 162                         rv = rv[1:]  # strip the '{' we already sent
 163                         self.push(('%x' % len(rv)).encode('utf8') + b"\r\n" + rv + b"\r\n0\r\n\r\n")
 164                         self.reset_request()
 165                         return
 166
 167                 try:
 168                         self.sendReply(200, body=rv, headers=self.LPHeaders)
 169                         raise httpserver.RequestNotHandled
 170                 except httpserver.RequestHandled:
 171                         # Expected
 172                         pass
 173                 finally:
 174                         self.reset_request()
 175
 176         def _doJSON_i(self, reqid, method, params, longpoll = False):
 177                 try:
 178                         rv = getattr(self, method)(*params)
 179                 except Exception as e:
 180                         self.logger.error(("Error during JSON-RPC call: %s%s\n" % (method, params)) + traceback.format_exc())
 181                         efun = self.fmtError if longpoll else self.doError
 182                         return efun(r'Service error: %s' % (e,))
 183                 try:
 184                         rv.setdefault('submitold', True)
 185                 except:
 186                         pass
 187                 rv = {'id': reqid, 'error': None, 'result': rv}
 188                 try:
 189                         rv = json.dumps(rv)
 190                 except:
 191                         efun = self.fmtError if longpoll else self.doError
 192                         return efun(r'Error encoding reply in JSON')
 193                 rv = rv.encode('utf8')
 194                 return rv if longpoll else self.sendReply(200, rv, headers=self._JSONHeaders)
 195
 196         def doJSON(self, data, longpoll = False):
 197                 # TODO: handle JSON errors
 198                 data = data.decode('utf8')
 199                 if longpoll and not data:
 200                         self.JSONRPCMethod = 'getwork'
 201                         self._JSONHeaders = {}
 202                         return self.doLongpoll(1, 'doJSON_getwork', ())
 203                 try:
 204                         data = json.loads(data)
 205                         method = str(data['method']).lower()
 206                         self.JSONRPCMethod = method
 207                         method = 'doJSON_' + method
 208                 except ValueError:
 209                         return self.doError(r'Parse error')
 210                 except TypeError:
 211                         return self.doError(r'Bad call')
 212                 if not hasattr(self, method):
 213                         return self.doError(r'Procedure not found')
 214                 # TODO: handle errors as JSON-RPC
 215                 self._JSONHeaders = {}
 216                 params = data.setdefault('params', ())
 217                 procfun = self._doJSON_i
 218                 if longpoll and not params:
 219                         procfun = self.doLongpoll
 220                 return procfun(data['id'], method, params)
 221
 222         def handle_close(self):
 223                 self.cleanupLP()
 224                 super().handle_close()
 225
 226         def handle_request(self):
 227                 if not self.method in (b'GET', b'POST'):
 228                         return self.sendReply(405)
 229                 if not self.path in self.JSONRPCURIs:
 230                         if self.path[:5] == b'/src/':
 231                                 return self.handle_src_request()
 232                         return self.sendReply(404)
 233                 if not self.Username:
 234                         return self.doAuthenticate()
 235                 try:
 236                         data = b''.join(self.incoming)
 237                         return self.doJSON(data, self.path[:3] == b'/LP')
 238                 except socket.error:
 239                         raise
 240                 except WithinLongpoll:
 241                         raise
 242                 except httpserver.RequestHandled:
 243                         raise
 244                 except:
 245                         self.logger.error(traceback.format_exc())
 246                         return self.doError('uncaught error')
 247
 248         def reset_request(self):
 249                 self._LP = False
 250                 self.JSONRPCMethod = None
 251                 super().reset_request()
 252
 253 setattr(JSONRPCHandler, 'doHeader_user-agent', JSONRPCHandler.doHeader_user_agent);
 254 setattr(JSONRPCHandler, 'doHeader_x-minimum-wait', JSONRPCHandler.doHeader_x_minimum_wait);
 255 setattr(JSONRPCHandler, 'doHeader_x-mining-extensions', JSONRPCHandler.doHeader_x_mining_extensions);
 256
 257 JSONRPCListener = networkserver.NetworkListener
 258
 259 class JSONRPCServer(networkserver.AsyncSocketServer):
 260         logger = logging.getLogger('JSONRPCServer')
 261
 262         waker = True
 263
 264         def __init__(self, *a, **ka):
 265                 ka.setdefault('RequestHandlerClass', JSONRPCHandler)
 266                 super().__init__(*a, **ka)
 267
 268                 self.SecretUser = None
 269
 270                 self.LPRequest = False
 271                 self._LPClients = {}
 272                 self._LPWaitTime = time() + 15
 273
 274                 self.LPTracking = {}
 275
 276         def pre_schedule(self):
 277                 if self.LPRequest == 1:
 278                         self._LPsch()
 279
 280         def wakeLongpoll(self):
 281                 if self.LPRequest:
 282                         self.logger.info('Ignoring longpoll attempt while another is waiting')
 283                         return
 284                 self.LPRequest = 1
 285                 self.wakeup()
 286
 287         def _LPsch(self):
 288                 now = time()
 289                 if self._LPWaitTime > now:
 290                         delay = self._LPWaitTime - now
 291                         self.logger.info('Waiting %.3g seconds to longpoll' % (delay,))
 292                         self.schedule(self._actualLP, self._LPWaitTime)
 293                         self.LPRequest = 2
 294                 else:
 295                         self._actualLP()
 296
 297         def _actualLP(self):
 298                 self.LPRequest = False
 299                 C = tuple(self._LPClients.values())
 300                 self._LPClients = {}
 301                 if not C:
 302                         self.logger.info('Nobody to longpoll')
 303                         return
 304                 OC = len(C)
 305                 self.logger.debug("%d clients to wake up..." % (OC,))
 306
 307                 now = time()
 308
 309                 for ic in C:
 310                         try:
 311                                 ic.wakeLongpoll()
 312                         except socket.error:
 313                                 OC -= 1
 314                                 # Ignore socket errors; let the main event loop take care of them later
 315                         except:
 316                                 OC -= 1
 317                                 self.logger.debug('Error waking longpoll handler:\n' + traceback.format_exc())
 318
 319                 self._LPWaitTime = time()
 320                 self.logger.info('Longpoll woke up %d clients in %.3f seconds' % (OC, self._LPWaitTime - now))
 321                 self._LPWaitTime += 5  # TODO: make configurable: minimum time between longpolls
 322
 323         def TopLPers(self, n = 0x10):
 324                 tmp = list(self.LPTracking.keys())
 325                 tmp.sort(key=lambda k: self.LPTracking[k])
 326                 for jerk in map(lambda k: (k, self.LPTracking[k]), tmp[-n:]):
 327                         print(jerk)