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