jsonrpcserver.py

# Eloipool - Python Bitcoin pool server
# Copyright (C) 2011-2013  Luke Dashjr <luke-jr+eloipool@utopios.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from binascii import b2a_hex
import httpserver
import json
import logging
import networkserver
import socket
from time import time
import traceback

WithinLongpoll = httpserver.AsyncRequest

class _SentJSONError(BaseException):
	def __init__(self, rv):
		self.rv = rv

class JSONRPCHandler(httpserver.HTTPHandler):
	default_quirks = {
		'NELH': None,  # FIXME: identify which clients have a problem with this
	}
	
	LPHeaders = {
		'X-Long-Polling': None,
	}
	
	JSONRPCURIs = (b'/', b'/LP', b'/LP/')
	
	logger = logging.getLogger('JSONRPCHandler')
	
	def final_init(server):
		pass
	
	def __init__(self, *a, **ka):
		super().__init__(*a, **ka)
		self.UA = None
	
	def sendReply(self, status=200, body=b'', headers=None, *a, **ka):
		headers = dict(headers) if headers else {}
		if body and body[0] == 123:  # b'{'
			headers.setdefault('Content-Type', 'application/json')
		if status == 200 and self.path in self.JSONRPCURIs:
			if not body:
				headers.setdefault('Content-Type', 'application/json')
			headers.setdefault('X-Long-Polling', '/LP')
		return super().sendReply(status, body, headers, *a, **ka)
	
	def fmtError(self, reason = '', code = 100):
		reason = json.dumps(reason)
		reason = r'{"result":null,"id":null,"error":{"name":"JSONRPCError","code":%d,"message":%s}}' % (code, reason)
		reason = reason.encode('utf8')
		return reason
	
	def doError(self, reason = '', code = 100):
		reason = self.fmtError(reason, code)
		return self.sendReply(500, reason)
	
	_MidstateNotAdv = (b'phoenix', b'poclbm', b'gminor')
	def doHeader_user_agent(self, value):
		self.reqinfo['UA'] = value
		self.UA = value.decode('latin-1')  # technically ASCII, but latin-1 ignores errors
		quirks = self.quirks
		(UA, v, *x) = value.split(b'/', 1) + [None]
		
		# Temporary HACK to keep working with older gmp-proxy
		# NOTE: This will go away someday.
		if UA == b'AuthServiceProxy':
			# SubmitBlock Boolean
			quirks['SBB'] = None
		
		try:
			if v[0] == b'v': v = v[1:]
			v = tuple(map(int, v.split(b'.'))) + (0,0,0)
		except:
			pass
		if UA in self._MidstateNotAdv:
			if UA == b'phoenix':
				if v != (1, 50, 0):
					quirks['midstate'] = None
				if v[0] < 2 and v[1] < 8 and v[2] < 1:
					quirks['NELH'] = None
			else:
				quirks['midstate'] = None
	
	def doHeader_x_minimum_wait(self, value):
		self.reqinfo['MinWait'] = int(value)
	
	def doHeader_x_mining_extensions(self, value):
		self.extensions = value.decode('ascii').lower().split(' ')
	
	def processLP(self, lpid):
		lpw = self.server.LPId
		if isinstance(lpid, str):
			if lpw != lpid:
				return
		self.doLongpoll()
	
	def doLongpoll(self, *a):
		timeNow = time()
		
		self._LP = True
		self._LPCall = a
		if 'NELH' not in self.quirks:
			# [NOT No] Early Longpoll Headers
			self.sendReply(200, body=None, headers=self.LPHeaders)
			self.push(b"1\r\n{\r\n")
			self.changeTask(self._chunkedKA, timeNow + 45)
		else:
			self.changeTask(None)
		
		waitTime = self.reqinfo.get('MinWait', 15)  # TODO: make default configurable
		self.waitTime = waitTime + timeNow
		
		totfromme = self.LPTrack()
		self.server._LPClients[id(self)] = self
		self.logger.debug("New LP client; %d total; %d from %s" % (len(self.server._LPClients), totfromme, self.remoteHost))
		
		raise WithinLongpoll
	
	def _chunkedKA(self):
		# Keepalive via chunked transfer encoding
		self.push(b"1\r\n \r\n")
		self.changeTask(self._chunkedKA, time() + 45)
	
	def LPTrack(self):
		myip = self.remoteHost
		if myip not in self.server.LPTracking:
			self.server.LPTracking[myip] = 0
		self.server.LPTracking[myip] += 1
		
		myuser = self.Username
		if myuser not in self.server.LPTrackingByUser:
			self.server.LPTrackingByUser[myuser] = 0
		self.server.LPTrackingByUser[myuser] += 1
		
		return self.server.LPTracking[myip]
	
	def LPUntrack(self):
		self.server.LPTracking[self.remoteHost] -= 1
		self.server.LPTrackingByUser[self.Username] -= 1
	
	def cleanupLP(self):
		# Called when the connection is closed
		if not self._LP:
			return
		self.changeTask(None)
		try:
			del self.server._LPClients[id(self)]
		except KeyError:
			pass
		self.LPUntrack()
	
	def wakeLongpoll(self, wantClear = False):
		now = time()
		if now < self.waitTime:
			self.changeTask(lambda: self.wakeLongpoll(wantClear), self.waitTime)
			return
		else:
			self.changeTask(None)
		
		self.LPUntrack()
		
		self.server.tls.wantClear = wantClear
		try:
			rv = self._doJSON_i(*self._LPCall, longpoll=True)
		except WithinLongpoll:
			# Not sure why this would happen right now, but handle it sanely...
			return
		finally:
			self.server.tls.wantClear = False
		if 'NELH' not in self.quirks:
			rv = rv[1:]  # strip the '{' we already sent
			self.push(('%x' % len(rv)).encode('utf8') + b"\r\n" + rv + b"\r\n0\r\n\r\n")
			self.reset_request()
			return
		
		try:
			self.sendReply(200, body=rv, headers=self.LPHeaders, tryCompression=False)
			raise httpserver.RequestNotHandled
		except httpserver.RequestHandled:
			# Expected
			pass
		finally:
			self.reset_request()
	
	def _doJSON_i(self, reqid, method, params, longpoll = False):
		try:
			rv = getattr(self, method)(*params)
		except WithinLongpoll:
			self._LPCall = (reqid, method, params)
			raise
		except Exception as e:
			self.logger.error(("Error during JSON-RPC call (UA=%s, IP=%s): %s%s\n" % (self.reqinfo.get('UA'), self.remoteHost, method, params)) + traceback.format_exc())
			efun = self.fmtError if longpoll else self.doError
			return efun(r'Service error: %s' % (e,))
		rv = {'id': reqid, 'error': None, 'result': rv}
		try:
			rv = json.dumps(rv)
		except:
			efun = self.fmtError if longpoll else self.doError
			return efun(r'Error encoding reply in JSON')
		rv = rv.encode('utf8')
		return rv if longpoll else self.sendReply(200, rv, headers=self._JSONHeaders)
	
	def doJSON(self, data, longpoll = False):
		# TODO: handle JSON errors
		try:
			data = data.decode('utf8')
		except UnicodeDecodeError as e:
			return self.doError(str(e))
		if longpoll and not data:
			self.JSONRPCId = jsonid = 1
			self.JSONRPCMethod = 'getwork'
			self._JSONHeaders = {}
			return self.doLongpoll(1, 'doJSON_getwork', ())
		try:
			data = json.loads(data)
			method = str(data['method']).lower()
			self.JSONRPCId = jsonid = data['id']
			self.JSONRPCMethod = method
			method = 'doJSON_' + method
		except ValueError:
			return self.doError(r'Parse error')
		except TypeError:
			return self.doError(r'Bad call')
		if not hasattr(self, method):
			return self.doError(r'Procedure not found')
		# TODO: handle errors as JSON-RPC
		self._JSONHeaders = {}
		params = data.setdefault('params', ())
		procfun = self._doJSON_i
		if longpoll and not params:
			procfun = self.doLongpoll
		return procfun(jsonid, method, params)
	
	def handle_close(self):
		self.cleanupLP()
		super().handle_close()
	
	def handle_request(self):
		if not self.method in (b'GET', b'POST'):
			return self.sendReply(405)
		if not self.path in self.JSONRPCURIs:
			if isinstance(self.path, bytes) and self.path[:5] == b'/src/':
				return self.handle_src_request()
			return self.sendReply(404)
		if not self.Username:
			return self.doAuthenticate()
		try:
			data = b''.join(self.incoming)
			return self.doJSON(data, self.path[:3] == b'/LP')
		except socket.error:
			raise
		except WithinLongpoll:
			raise
		except httpserver.RequestHandled:
			raise
		except:
			self.logger.error(traceback.format_exc())
			return self.doError('uncaught error')
	
	def reset_request(self):
		self._LP = False
		self.JSONRPCMethod = None
		super().reset_request()
	
setattr(JSONRPCHandler, 'doHeader_user-agent', JSONRPCHandler.doHeader_user_agent);
setattr(JSONRPCHandler, 'doHeader_x-minimum-wait', JSONRPCHandler.doHeader_x_minimum_wait);
setattr(JSONRPCHandler, 'doHeader_x-mining-extensions', JSONRPCHandler.doHeader_x_mining_extensions);

JSONRPCListener = networkserver.NetworkListener

class JSONRPCServer(networkserver.AsyncSocketServer):
	logger = logging.getLogger('JSONRPCServer')
	
	waker = True
	
	def __init__(self, *a, **ka):
		ka.setdefault('RequestHandlerClass', JSONRPCHandler)
		super().__init__(*a, **ka)
		
		self.SecretUser = None
		self.ShareTarget = 0x00000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff
		
		self._LPId = 0
		self.LPId = '%d' % (time(),)
		self.LPRequest = False
		self._LPClients = {}
		self._LPWaitTime = time() + 15
		
		self.LPTracking = {}
		self.LPTrackingByUser = {}
	
	def checkAuthentication(self, username, password):
		return True
	
	def final_init(self):
		JSONRPCHandler.final_init(self)
	
	def pre_schedule(self):
		if self.LPRequest == 1:
			self._LPsch()
	
	def wakeLongpoll(self, wantClear = False):
		if self.LPRequest:
			self.logger.info('Ignoring longpoll attempt while another is waiting')
			return
		self._LPId += 1
		self.LPId = '%d %d' % (time(), self._LPId)
		self._LPWantClear = wantClear
		self.LPRequest = 1
		self.wakeup()
	
	def _LPsch(self):
		now = time()
		if self._LPWaitTime > now:
			delay = self._LPWaitTime - now
			self.logger.info('Waiting %.3g seconds to longpoll' % (delay,))
			self.schedule(self._actualLP, self._LPWaitTime)
			self.LPRequest = 2
		else:
			self._actualLP()
	
	def _actualLP(self):
		self.LPRequest = False
		C = tuple(self._LPClients.values())
		self._LPClients = {}
		if not C:
			self.logger.info('Nobody to longpoll')
			return
		OC = len(C)
		self.logger.debug("%d clients to wake up..." % (OC,))
		
		now = time()
		
		for ic in C:
			self.lastHandler = ic
			try:
				ic.wakeLongpoll(self._LPWantClear)
			except socket.error:
				OC -= 1
				# Ignore socket errors; let the main event loop take care of them later
			except:
				OC -= 1
				self.logger.debug('Error waking longpoll handler:\n' + traceback.format_exc())
		
		self._LPWaitTime = time()
		self.logger.info('Longpoll woke up %d clients in %.3f seconds' % (OC, self._LPWaitTime - now))
		self._LPWaitTime += 5  # TODO: make configurable: minimum time between longpolls
	
	def TopLPers(self, n = 0x10):
		tmp = list(self.LPTracking.keys())
		tmp.sort(key=lambda k: self.LPTracking[k])
		for jerk in map(lambda k: (k, self.LPTracking[k]), tmp[-n:]):
			print(jerk)
	
	def TopLPersByUser(self, n = 0x10):
		tmp = list(self.LPTrackingByUser.keys())
		tmp.sort(key=lambda k: self.LPTrackingByUser[k])
		for jerk in map(lambda k: (k, self.LPTrackingByUser[k]), tmp[-n:]):
			print(jerk)