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 processLP(self, lpid):
 103                 lpw = self.server.LPId
 104                 if isinstance(lpid, str):
 105                         if lpw != lpid:
 106                                 return
 107                 self.doLongpoll()
 108
 109         def doLongpoll(self, *a):
 110                 timeNow = time()
 111
 112                 self._LP = True
 113                 self._LPCall = a
 114                 if 'NELH' not in self.quirks:
 115                         # [NOT No] Early Longpoll Headers
 116                         self.sendReply(200, body=None, headers=self.LPHeaders)
 117                         self.push(b"1\r\n{\r\n")
 118                         self.changeTask(self._chunkedKA, timeNow + 45)
 119                 else:
 120                         self.changeTask(None)
 121
 122                 waitTime = self.reqinfo.get('MinWait', 15)  # TODO: make default configurable
 123                 self.waitTime = waitTime + timeNow
 124
 125                 totfromme = self.LPTrack()
 126                 self.server._LPClients[id(self)] = self
 127                 self.logger.debug("New LP client; %d total; %d from %s" % (len(self.server._LPClients), totfromme, self.remoteHost))
 128
 129                 raise WithinLongpoll
 130
 131         def _chunkedKA(self):
 132                 # Keepalive via chunked transfer encoding
 133                 self.push(b"1\r\n \r\n")
 134                 self.changeTask(self._chunkedKA, time() + 45)
 135
 136         def LPTrack(self):
 137                 myip = self.remoteHost
 138                 if myip not in self.server.LPTracking:
 139                         self.server.LPTracking[myip] = 0
 140                 self.server.LPTracking[myip] += 1
 141                 return self.server.LPTracking[myip]
 142
 143         def LPUntrack(self):
 144                 self.server.LPTracking[self.remoteHost] -= 1
 145
 146         def cleanupLP(self):
 147                 # Called when the connection is closed
 148                 if not self._LP:
 149                         return
 150                 self.changeTask(None)
 151                 try:
 152                         del self.server._LPClients[id(self)]
 153                 except KeyError:
 154                         pass
 155                 self.LPUntrack()
 156
 157         def wakeLongpoll(self):
 158                 now = time()
 159                 if now < self.waitTime:
 160                         self.changeTask(self.wakeLongpoll, self.waitTime)
 161                         return
 162                 else:
 163                         self.changeTask(None)
 164
 165                 self.LPUntrack()
 166
 167                 rv = self._doJSON_i(*self._LPCall, longpoll=True)
 168                 if 'NELH' not in self.quirks:
 169                         rv = rv[1:]  # strip the '{' we already sent
 170                         self.push(('%x' % len(rv)).encode('utf8') + b"\r\n" + rv + b"\r\n0\r\n\r\n")
 171                         self.reset_request()
 172                         return
 173
 174                 try:
 175                         self.sendReply(200, body=rv, headers=self.LPHeaders)
 176                         raise httpserver.RequestNotHandled
 177                 except httpserver.RequestHandled:
 178                         # Expected
 179                         pass
 180                 finally:
 181                         self.reset_request()
 182
 183         def _doJSON_i(self, reqid, method, params, longpoll = False):
 184                 try:
 185                         rv = getattr(self, method)(*params)
 186                 except WithinLongpoll:
 187                         self._LPCall = (reqid, method, params)
 188                         raise
 189                 except Exception as e:
 190                         self.logger.error(("Error during JSON-RPC call: %s%s\n" % (method, params)) + traceback.format_exc())
 191                         efun = self.fmtError if longpoll else self.doError
 192                         return efun(r'Service error: %s' % (e,))
 193                 try:
 194                         rv.setdefault('submitold', True)
 195                 except:
 196                         pass
 197                 rv = {'id': reqid, 'error': None, 'result': rv}
 198                 try:
 199                         rv = json.dumps(rv)
 200                 except:
 201                         efun = self.fmtError if longpoll else self.doError
 202                         return efun(r'Error encoding reply in JSON')
 203                 rv = rv.encode('utf8')
 204                 return rv if longpoll else self.sendReply(200, rv, headers=self._JSONHeaders)
 205
 206         def doJSON(self, data, longpoll = False):
 207                 # TODO: handle JSON errors
 208                 data = data.decode('utf8')
 209                 if longpoll and not data:
 210                         self.JSONRPCId = jsonid = 1
 211                         self.JSONRPCMethod = 'getwork'
 212                         self._JSONHeaders = {}
 213                         return self.doLongpoll(1, 'doJSON_getwork', ())
 214                 try:
 215                         data = json.loads(data)
 216                         method = str(data['method']).lower()
 217                         self.JSONRPCId = jsonid = data['id']
 218                         self.JSONRPCMethod = method
 219                         method = 'doJSON_' + method
 220                 except ValueError:
 221                         return self.doError(r'Parse error')
 222                 except TypeError:
 223                         return self.doError(r'Bad call')
 224                 if not hasattr(self, method):
 225                         return self.doError(r'Procedure not found')
 226                 # TODO: handle errors as JSON-RPC
 227                 self._JSONHeaders = {}
 228                 params = data.setdefault('params', ())
 229                 procfun = self._doJSON_i
 230                 if longpoll and not params:
 231                         procfun = self.doLongpoll
 232                 return procfun(jsonid, method, params)
 233
 234         def handle_close(self):
 235                 self.cleanupLP()
 236                 super().handle_close()
 237
 238         def handle_request(self):
 239                 if not self.method in (b'GET', b'POST'):
 240                         return self.sendReply(405)
 241                 if not self.path in self.JSONRPCURIs:
 242                         if isinstance(self.path, bytes) and self.path[:5] == b'/src/':
 243                                 return self.handle_src_request()
 244                         return self.sendReply(404)
 245                 if not self.Username:
 246                         return self.doAuthenticate()
 247                 try:
 248                         data = b''.join(self.incoming)
 249                         return self.doJSON(data, self.path[:3] == b'/LP')
 250                 except socket.error:
 251                         raise
 252                 except WithinLongpoll:
 253                         raise
 254                 except httpserver.RequestHandled:
 255                         raise
 256                 except:
 257                         self.logger.error(traceback.format_exc())
 258                         return self.doError('uncaught error')
 259
 260         def reset_request(self):
 261                 self._LP = False
 262                 self.JSONRPCMethod = None
 263                 super().reset_request()
 264
 265 setattr(JSONRPCHandler, 'doHeader_user-agent', JSONRPCHandler.doHeader_user_agent);
 266 setattr(JSONRPCHandler, 'doHeader_x-minimum-wait', JSONRPCHandler.doHeader_x_minimum_wait);
 267 setattr(JSONRPCHandler, 'doHeader_x-mining-extensions', JSONRPCHandler.doHeader_x_mining_extensions);
 268
 269 JSONRPCListener = networkserver.NetworkListener
 270
 271 class JSONRPCServer(networkserver.AsyncSocketServer):
 272         logger = logging.getLogger('JSONRPCServer')
 273
 274         waker = True
 275
 276         def __init__(self, *a, **ka):
 277                 ka.setdefault('RequestHandlerClass', JSONRPCHandler)
 278                 super().__init__(*a, **ka)
 279
 280                 self.SecretUser = None
 281
 282                 self._LPId = 0
 283                 self.LPId = '%d' % (time(),)
 284                 self.LPRequest = False
 285                 self._LPClients = {}
 286                 self._LPWaitTime = time() + 15
 287
 288                 self.LPTracking = {}
 289
 290         def pre_schedule(self):
 291                 if self.LPRequest == 1:
 292                         self._LPsch()
 293
 294         def wakeLongpoll(self):
 295                 if self.LPRequest:
 296                         self.logger.info('Ignoring longpoll attempt while another is waiting')
 297                         return
 298                 self.LPRequest = 1
 299                 self._LPId += 1
 300                 self.LPId = '%d %d' % (time(), self._LPId)
 301                 self.wakeup()
 302
 303         def _LPsch(self):
 304                 now = time()
 305                 if self._LPWaitTime > now:
 306                         delay = self._LPWaitTime - now
 307                         self.logger.info('Waiting %.3g seconds to longpoll' % (delay,))
 308                         self.schedule(self._actualLP, self._LPWaitTime)
 309                         self.LPRequest = 2
 310                 else:
 311                         self._actualLP()
 312
 313         def _actualLP(self):
 314                 self.LPRequest = False
 315                 C = tuple(self._LPClients.values())
 316                 self._LPClients = {}
 317                 if not C:
 318                         self.logger.info('Nobody to longpoll')
 319                         return
 320                 OC = len(C)
 321                 self.logger.debug("%d clients to wake up..." % (OC,))
 322
 323                 now = time()
 324
 325                 for ic in C:
 326                         try:
 327                                 ic.wakeLongpoll()
 328                         except socket.error:
 329                                 OC -= 1
 330                                 # Ignore socket errors; let the main event loop take care of them later
 331                         except:
 332                                 OC -= 1
 333                                 self.logger.debug('Error waking longpoll handler:\n' + traceback.format_exc())
 334
 335                 self._LPWaitTime = time()
 336                 self.logger.info('Longpoll woke up %d clients in %.3f seconds' % (OC, self._LPWaitTime - now))
 337                 self._LPWaitTime += 5  # TODO: make configurable: minimum time between longpolls
 338
 339         def TopLPers(self, n = 0x10):
 340                 tmp = list(self.LPTracking.keys())
 341                 tmp.sort(key=lambda k: self.LPTracking[k])
 342                 for jerk in map(lambda k: (k, self.LPTracking[k]), tmp[-n:]):
 343                         print(jerk)