-
Notifications
You must be signed in to change notification settings - Fork 27
/
RPCProtocol.py
418 lines (352 loc) · 13.5 KB
/
RPCProtocol.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# Copyright (C) 2011 by jedi95 <jedi95@gmail.com> and
# CFSworks <CFSworks@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import urlparse
import json
import sys
import httplib
import socket
from twisted.internet import defer, reactor, error, threads
from twisted.python import failure
from ClientBase import ClientBase, AssignedWork
class ServerMessage(Exception): pass
class HTTPBase(object):
connection = None
timeout = None
__lock = None
__response = None
def __makeResponse(self, *args, **kwargs):
# This function exists as a workaround: If the connection is closed,
# we also want to kill the response to allow the socket to die, but
# httplib doesn't keep the response hanging around at all, so we need
# to intercept its creation (hence this function) and store it.
self.__response = httplib.HTTPResponse(*args, **kwargs)
return self.__response
def doRequest(self, *args):
if self.__lock is None:
self.__lock = defer.DeferredLock()
return self.__lock.run(threads.deferToThread, self._doRequest, *args)
def closeConnection(self):
if self.connection is not None:
if self.connection.sock is not None:
self.connection.sock.shutdown(socket.SHUT_RDWR)
self.connection.close()
if self.__response is not None:
self.__response.close()
self.connection = None
self.__response = None
def _doRequest(self, url, *args):
if self.connection is None:
connectionClass = (httplib.HTTPSConnection
if url.scheme.lower() == 'https' else
httplib.HTTPConnection)
self.connection = connectionClass(url.hostname,
url.port,
timeout=self.timeout)
# Intercept the creation of the response class (see above)
self.connection.response_class = self.__makeResponse
self.connection.connect()
self.connection.sock.setsockopt(socket.SOL_TCP,
socket.TCP_NODELAY, 1)
self.connection.sock.setsockopt(socket.SOL_SOCKET,
socket.SO_KEEPALIVE, 1)
try:
self.connection.request(*args)
return self.connection.getresponse()
except (httplib.HTTPException, socket.error):
self.closeConnection()
raise
class RPCPoller(HTTPBase):
"""Polls the root's chosen bitcoind or pool RPC server for work."""
timeout = 5
def __init__(self, root):
self.root = root
self.askInterval = None
self.askCall = None
self.currentAsk = None
def setInterval(self, interval):
"""Change the interval at which to poll the getwork() function."""
self.askInterval = interval
self._startCall()
def _startCall(self):
self._stopCall()
if self.root.disconnected:
return
if self.askInterval:
self.askCall = reactor.callLater(self.askInterval, self.ask)
else:
self.askCall = None
def _stopCall(self):
if self.askCall:
try:
self.askCall.cancel()
except (error.AlreadyCancelled, error.AlreadyCalled):
pass
self.askCall = None
def ask(self):
"""Run a getwork request immediately."""
if self.currentAsk and not self.currentAsk.called:
return
self._stopCall()
self.currentAsk = self.call('getwork')
def errback(failure):
try:
if failure.check(ServerMessage):
self.root.runCallback('msg', failure.getErrorMessage())
else:
self.root.runCallback('debug', failure.getErrorMessage())
self.root._failure()
finally:
self._startCall()
self.currentAsk.addErrback(errback)
def callback(x):
try:
try:
(headers, result) = x
except TypeError:
return
self.root.handleWork(result)
self.root.handleHeaders(headers)
finally:
self._startCall()
self.currentAsk.addCallback(callback)
@defer.inlineCallbacks
def call(self, method, params=[]):
"""Call the specified remote function."""
body = json.dumps({'method': method, 'params': params, 'id': 1})
path = self.root.url.path or '/'
if self.root.url.query:
path += '?' + self.root.url.query
response = yield self.doRequest(
self.root.url,
'POST',
path,
body,
{
'Authorization': self.root.auth,
'User-Agent': self.root.version,
'Content-Type': 'application/json'
})
data = response.read()
result = self.parse(data)
defer.returnValue((dict(response.getheaders()), result))
@classmethod
def parse(cls, data):
"""Attempt to load JSON-RPC data."""
response = json.loads(data)
try:
message = response['error']['message']
except (KeyError, TypeError):
pass
else:
raise ServerMessage(message)
return response.get('result')
class LongPoller(HTTPBase):
"""Polls a long poll URL, reporting any parsed work results to the
callback function.
"""
timeout = 300
def __init__(self, url, root):
self.url = url
self.root = root
self.polling = False
def start(self):
"""Begin requesting data from the LP server, if we aren't already..."""
if self.polling:
return
self.polling = True
self._request()
def _request(self):
if self.polling:
path = self.url.path or '/'
if self.url.query:
path += '?' + self.url.query
d = self.doRequest(
self.url,
'GET',
path,
None,
{
'Authorization': self.root.auth,
'User-Agent': self.root.version
})
d.addBoth(self._requestComplete)
def stop(self):
"""Stop polling. This LongPoller probably shouldn't be reused."""
self.polling = False
self.closeConnection()
def _requestComplete(self, response):
try:
if not self.polling:
return
if isinstance(response, failure.Failure):
return
data = response.read()
try:
result = RPCPoller.parse(data)
except ValueError:
return
except ServerMessage:
exctype, value = sys.exc_info()[:2]
self.root.runCallback('msg', str(value))
return
finally:
self._request()
self.root.handleWork(result, True)
class RPCClient(ClientBase):
"""The actual root of the whole RPC client system."""
def __init__(self, handler, url):
self.handler = handler
self.url = url
self.params = {}
for param in url.params.split('&'):
s = param.split('=',1)
if len(s) == 2:
self.params[s[0]] = s[1]
self.auth = 'Basic ' + ('%s:%s' % (
url.username, url.password)).encode('base64').strip()
self.version = 'RPCClient/1.8'
self.poller = RPCPoller(self)
self.longPoller = None # Gets created later...
self.disconnected = False
self.saidConnected = False
self.block = None
def connect(self):
"""Begin communicating with the server..."""
self.poller.ask()
def disconnect(self):
"""Cease server communications immediately. The client might be
reusable, but it's probably best not to try.
"""
self._deactivateCallbacks()
self.disconnected = True
self.poller.setInterval(None)
self.poller.closeConnection()
if self.longPoller:
self.longPoller.stop()
self.longPoller = None
def setMeta(self, var, value):
"""RPC clients do not support meta. Ignore."""
def setVersion(self, shortname, longname=None, version=None, author=None):
if version is not None:
self.version = '%s/%s' % (shortname, version)
else:
self.version = shortname
def requestWork(self):
"""Application needs work right now. Ask immediately."""
self.poller.ask()
def sendResult(self, result):
"""Sends a result to the server, returning a Deferred that fires with
a bool to indicate whether or not the work was accepted.
"""
# Must be a 128-byte response, but the last 48 are typically ignored.
result += '\x00'*48
d = self.poller.call('getwork', [result.encode('hex')])
def errback(*ignored):
return False # ANY error while turning in work is a Bad Thing(TM).
#we need to return the result, not the headers
def callback(x):
try:
(headers, accepted) = x
except TypeError:
self.runCallback('debug',
"TypeError in RPC sendResult callback")
return False
if (not accepted):
self.handleRejectReason(headers)
return accepted
d.addErrback(errback)
d.addCallback(callback)
return d
#if the server sends a reason for reject then print that
def handleRejectReason(self, headers):
reason = headers.get('x-reject-reason')
if reason is not None:
self.runCallback('debug', "Reject reason: " + str(reason))
def useAskrate(self, variable):
defaults = {'askrate': 10, 'retryrate': 15, 'lpaskrate': 0}
try:
askrate = int(self.params[variable])
except (KeyError, ValueError):
askrate = defaults.get(variable, 10)
self.poller.setInterval(askrate)
def handleWork(self, work, pushed=False):
if work is None:
return;
if not self.saidConnected:
self.saidConnected = True
self.runCallback('connect')
self.useAskrate('askrate')
if 'block' in work:
try:
block = int(work['block'])
except (TypeError, ValueError):
pass
else:
if self.block != block:
self.block = block
self.runCallback('block', block)
aw = AssignedWork()
aw.data = work['data'].decode('hex')[:80]
aw.target = work['target'].decode('hex')
aw.mask = work.get('mask', 32)
if pushed:
self.runCallback('push', aw)
self.runCallback('work', aw)
def handleHeaders(self, headers):
try:
block = int(headers['x-blocknum'])
except (KeyError, ValueError):
pass
else:
if self.block != block:
self.block = block
self.runCallback('block', block)
longpoll = headers.get('x-long-polling')
if longpoll:
lpParsed = urlparse.urlparse(longpoll)
lpURL = urlparse.ParseResult(
lpParsed.scheme or self.url.scheme,
lpParsed.netloc or self.url.netloc,
lpParsed.path, lpParsed.query, '', '')
if self.longPoller and self.longPoller.url != lpURL:
self.longPoller.stop()
self.longPoller = None
if not self.longPoller:
self.longPoller = LongPoller(lpURL, self)
self.longPoller.start()
self.useAskrate('lpaskrate')
self.runCallback('longpoll', True)
elif self.longPoller:
self.longPoller.stop()
self.longPoller = None
self.useAskrate('askrate')
self.runCallback('longpoll', False)
def _failure(self):
if self.saidConnected:
self.saidConnected = False
self.runCallback('disconnect')
else:
self.runCallback('failure')
self.useAskrate('retryrate')
if self.longPoller:
self.longPoller.stop()
self.longPoller = None
self.runCallback('longpoll', False)