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