cleaned up worker_interface - removed holds
[p2pool.git] / p2pool / bitcoin / worker_interface.py
1 from __future__ import division
2
3 import base64
4 import json
5 import random
6
7 from twisted.internet import defer
8 from twisted.python import log
9
10 import p2pool
11 from p2pool import data as p2pool_data
12 from p2pool.util import jsonrpc, deferred_resource, variable
13 from p2pool.bitcoin import getwork
14
15 def get_memory(request):
16     if request.getHeader('X-Miner-Extensions') is not None and 'workidentifier' in request.getHeader('X-Miner-Extensions').split(' '):
17         return 0
18     if request.getHeader('X-Work-Identifier') is not None:
19         return 0
20     user_agent = request.getHeader('User-Agent')
21     user_agent2 = '' if user_agent is None else user_agent.lower()
22     if 'java' in user_agent2 or 'diablominer' in user_agent2: return 0 # hopefully diablominer...
23     if 'cpuminer' in user_agent2: return 0
24     if 'tenebrix miner' in user_agent2: return 0
25     if 'ufasoft' in user_agent2: return 0 # not confirmed
26     if 'cgminer' in user_agent2: return 0
27     if 'jansson' in user_agent2: return 0 # a version of optimized scrypt miner, once in Wuala. works fine here
28     if 'poclbm' in user_agent2: return 1
29     if 'phoenix' in user_agent2: return 2
30     print 'Unknown miner User-Agent:', repr(user_agent)
31     return 0
32
33 def get_username(request):
34     try:
35         return base64.b64decode(request.getHeader('Authorization').split(' ', 1)[1]).split(':')[0]
36     except: # XXX
37         return None
38
39 def get_id(request):
40     return request.getClientIP(), request.getHeader('Authorization')
41
42 class LongPollingWorkerInterface(deferred_resource.DeferredResource):
43     def __init__(self, parent):
44         self.parent = parent
45     
46     @defer.inlineCallbacks
47     def render_GET(self, request):
48         request.setHeader('Content-Type', 'application/json')
49         request.setHeader('X-Long-Polling', '/long-polling')
50         request.setHeader('X-Roll-NTime', 'expire=60')
51         try:
52             try:
53                 request.write(json.dumps({
54                     'jsonrpc': '2.0',
55                     'id': 0,
56                     'result': (yield self.parent.getwork(request, long_poll=True)),
57                     'error': None,
58                 }))
59             except jsonrpc.Error:
60                 raise
61             except Exception:
62                 log.err(None, 'Squelched long polling error:')
63                 raise jsonrpc.Error(-32099, u'Unknown error')
64         except jsonrpc.Error, e:
65             request.write(json.dumps({
66                 'jsonrpc': '2.0',
67                 'id': 0,
68                 'result': None,
69                 'error': e._to_obj(),
70             }))
71     render_POST = render_GET
72
73 class WorkerInterface(jsonrpc.Server):
74     def __init__(self, compute, response_callback, new_work_event=variable.Event()):
75         jsonrpc.Server.__init__(self)
76         
77         self.compute = compute
78         self.response_callback = response_callback
79         self.new_work_event = new_work_event
80         
81         self.worker_views = {}
82         
83         self.putChild('long-polling', LongPollingWorkerInterface(self))
84         self.putChild('', self)
85     
86     @defer.inlineCallbacks
87     def rpc_getwork(self, request, data=None):
88         request.setHeader('X-Long-Polling', '/long-polling')
89         request.setHeader('X-Roll-NTime', 'expire=60')
90         
91         if data is not None:
92             defer.returnValue(self.response_callback(getwork.decode_data(data), request))
93         
94         defer.returnValue((yield self.getwork(request)))
95     
96     @defer.inlineCallbacks
97     def getwork(self, request, long_poll=False):
98         request_id = get_id(request)
99         memory = get_memory(request)
100         
101         id = random.randrange(10000)
102         if p2pool.DEBUG:
103             print 'POLL %i START long_poll=%r user_agent=%r x-work-identifier=%r user=%r' % (id, long_poll, request.getHeader('User-Agent'), request.getHeader('X-Work-Identifier'), get_username(request))
104         
105         if request_id not in self.worker_views:
106             self.worker_views[request_id] = variable.Variable((0, (None, None))) # times, (previous_block/-1, previous_block/-2)
107         
108         thought_times, thought_work = self.worker_views[request_id].value
109         
110         if long_poll and thought_times == self.new_work_event.times:
111             if p2pool.DEBUG:
112                 print 'POLL %i WAITING user=%r' % (id, get_username(request))
113             yield defer.DeferredList([self.new_work_event.get_deferred(), self.worker_views[request_id].changed.get_deferred()], fireOnOneCallback=True)
114         
115         res, identifier = self.compute(request)
116         
117         if thought_work[-1] is not None and self.new_work_event.times != thought_times and any(x is None or res.previous_block == x for x in thought_work[-memory or len(thought_work):]):
118             # clients won't believe the update
119             res = res.update(previous_block=random.randrange(2**256))
120             if p2pool.DEBUG:
121                 print 'POLL %i FAKED user=%r' % (id, get_username(request))
122         
123         self.worker_views[request_id].set((self.new_work_event.times if long_poll else thought_times, (thought_work[-1], res.previous_block)))
124         if p2pool.DEBUG:
125             print 'POLL %i END %s user=%r' % (id, p2pool_data.format_hash(identifier), get_username(request)) # XXX identifier is hack
126         
127         defer.returnValue(res.getwork(identifier=str(identifier)))