3 # Electrum - lightweight Bitcoin client
4 # Copyright (C) 2011 thomasv@gitorious
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 import random, ast, re, errno, os
21 import threading, traceback, sys, time, json, Queue
26 from version import ELECTRUM_VERSION, PROTOCOL_VERSION
27 from util import print_error, print_msg
31 proxy_modes = ['socks4', 'socks5', 'http']
34 class Interface(threading.Thread):
37 def __init__(self, config=None):
40 from simple_config import SimpleConfig
41 config = SimpleConfig()
43 threading.Thread.__init__(self)
46 self.connect_event = threading.Event()
48 self.subscriptions = {}
49 self.lock = threading.Lock()
52 self.bytes_received = 0
53 self.is_connected = False
54 self.poll_interval = 1
58 self.unanswered_requests = {}
59 self.pending_transactions_for_notifications= []
62 s = config.get('server')
63 host, port, protocol = s.split(':')
66 if protocol not in 'ghst':
67 raise BaseException('Unknown protocol: %s'%protocol)
71 self.protocol = protocol
72 self.use_ssl = ( protocol in 'sg' )
73 self.proxy = self.parse_proxy_options(config.get('proxy'))
75 self.proxy_mode = proxy_modes.index(self.proxy["mode"]) + 1
76 self.server = host + ':%d:%s'%(port, protocol)
80 def queue_json_response(self, c):
83 # print_error( "<--",c )
86 error = c.get('error')
89 print_error("received error:", c)
90 if msg_id is not None:
92 method, params, callback = self.unanswered_requests.pop(msg_id)
93 callback(self,{'method':method, 'params':params, 'error':error, 'id':msg_id})
97 if msg_id is not None:
99 method, params, callback = self.unanswered_requests.pop(msg_id)
100 result = c.get('result')
104 method = c.get('method')
105 params = c.get('params')
107 if method == 'blockchain.numblocks.subscribe':
111 elif method == 'blockchain.headers.subscribe':
115 elif method == 'blockchain.address.subscribe':
121 for k,v in self.subscriptions.items():
122 if (method, params) in v:
126 print_error( "received unexpected notification", method, params)
127 print_error( self.subscriptions )
131 callback(self, {'method':method, 'params':params, 'result':result, 'id':msg_id})
134 def on_version(self, i, result):
135 self.server_version = result
138 def init_http(self, host, port, proxy=None, use_ssl=True):
139 self.session_id = None
140 self.is_connected = True
141 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
145 print_error("http init session failed")
146 self.is_connected = False
150 print_error('http session:',self.session_id)
151 self.is_connected = True
153 self.is_connected = False
156 self.is_connected = True
157 while self.is_connected:
161 time.sleep(self.poll_interval)
162 except socket.gaierror:
167 traceback.print_exc(file=sys.stdout)
170 self.is_connected = False
177 def send_http(self, messages, callback):
178 import urllib2, json, time, cookielib
179 print_error( "send_http", messages )
182 socks.setdefaultproxy(self.proxy_mode, self.proxy["host"], int(self.proxy["port"]) )
183 socks.wrapmodule(urllib2)
185 cj = cookielib.CookieJar()
186 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
187 urllib2.install_opener(opener)
194 if type(params) != type([]): params = [params]
195 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
196 self.unanswered_requests[self.message_id] = method, params, callback
200 data_json = json.dumps(data)
206 headers = {'content-type': 'application/json'}
208 headers['cookie'] = 'SESSION=%s'%self.session_id
211 req = urllib2.Request(self.connection_msg, data_json, headers)
212 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
216 for index, cookie in enumerate(cj):
217 if cookie.name=='SESSION':
218 self.session_id = cookie.value
220 response = response_stream.read()
221 self.bytes_received += len(response)
223 response = json.loads( response )
224 if type(response) is not type([]):
225 self.queue_json_response(response)
227 for item in response:
228 self.queue_json_response(item)
231 self.poll_interval = 1
233 if self.poll_interval < 15:
234 self.poll_interval += 1
235 #print self.poll_interval, response
237 self.rtime = time.time() - t1
238 self.is_connected = True
245 if self.proxy is not None:
247 socks.setdefaultproxy(self.proxy_mode, self.proxy["host"], int(self.proxy["port"]))
248 socket.socket = socks.socksocket
249 # prevent dns leaks, see http://stackoverflow.com/questions/13184205/dns-over-proxy
250 def getaddrinfo(*args):
251 return [(socket.AF_INET, socket.SOCK_STREAM, 6, '', (args[0], args[1]))]
252 socket.getaddrinfo = getaddrinfo
255 cert_path = os.path.join( self.config.get('path'), 'certs', self.host)
256 if not os.path.exists(cert_path):
257 # get server certificate.
258 # Do not use ssl.get_server_certificate because it does not work with proxy
259 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
261 s.connect((self.host, self.port))
263 print_error("failed to connect", self.host, self.port)
266 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv3, cert_reqs=ssl.CERT_NONE, ca_certs=None)
267 dercert = s.getpeercert(True)
269 cert = ssl.DER_cert_to_PEM_cert(dercert)
271 with open(cert_path,"w") as f:
275 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
277 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
280 s.connect(( self.host.encode('ascii'), int(self.port)))
282 print_error("failed to connect", self.host, self.port)
287 s = ssl.wrap_socket(s,
288 ssl_version=ssl.PROTOCOL_SSLv3,
289 cert_reqs=ssl.CERT_REQUIRED,
291 do_handshake_on_connect=True)
292 except ssl.SSLError, e:
293 print_error("SSL error:", self.host, e)
296 traceback.print_exc(file=sys.stdout)
297 print_error("wrap_socket failed", self.host)
300 # hostname verification (disabled)
301 if self.use_ssl and False:
302 from backports.ssl_match_hostname import match_hostname, CertificateError
304 match_hostname(s.getpeercert(), self.host)
305 print_error("hostname matches", self.host)
306 except CertificateError, ce:
307 print_error("hostname does not match", self.host, s.getpeercert())
312 self.is_connected = True
313 print_error("connected to", self.host, self.port)
318 #if self.use_ssl: self.s.do_handshake()
320 while self.is_connected:
323 msg = self.s.recv(1024)
324 except socket.timeout:
328 except socket.error, err:
329 if err.errno in [11, 10035]:
330 print_error("socket errno", err.errno)
334 traceback.print_exc(file=sys.stdout)
338 # ping the server with server.version, as a real ping does not exist yet
339 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
343 self.bytes_received += len(msg)
345 self.is_connected = False
353 self.queue_json_response(c)
356 traceback.print_exc(file=sys.stdout)
358 self.is_connected = False
361 def send_tcp(self, messages, callback):
362 """return the ids of the requests that we sent"""
367 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
368 self.unanswered_requests[self.message_id] = method, params, callback
369 ids.append(self.message_id)
371 # print "-->", request
373 out += request + '\n'
376 sent = self.s.send( out )
378 except socket.error,e:
379 if e[0] in (errno.EWOULDBLOCK,errno.EAGAIN):
380 print_error( "EAGAIN: retrying")
384 traceback.print_exc(file=sys.stdout)
385 # this happens when we get disconnected
386 print_error( "Not connected, cannot send" )
394 def start_interface(self):
396 if self.protocol in 'st':
398 elif self.protocol in 'gh':
401 self.connect_event.set()
405 def stop_subscriptions(self):
406 for callback in self.subscriptions.keys():
408 self.subscriptions = {}
411 def send(self, messages, callback):
414 for message in messages:
416 if m[-10:] == '.subscribe':
421 if self.subscriptions.get(callback) is None:
422 self.subscriptions[callback] = []
424 if message not in self.subscriptions[callback]:
425 self.subscriptions[callback].append(message)
427 if not self.is_connected:
430 if self.protocol in 'st':
432 out = self.send_tcp(messages, callback)
434 # do not use lock, http is synchronous
435 out = self.send_http(messages, callback)
440 def parse_proxy_options(self, s):
441 if type(s) == type({}): return s # fixme: type should be fixed
442 if type(s) != type(""): return None
443 if s.lower() == 'none': return None
444 proxy = { "mode":"socks5", "host":"localhost" }
447 if proxy_modes.count(args[n]) == 1:
448 proxy["mode"] = args[n]
451 proxy["host"] = args[n]
454 proxy["port"] = args[n]
456 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
462 if self.is_connected and self.protocol in 'st' and self.s:
463 self.s.shutdown(socket.SHUT_RDWR)
467 def is_up_to_date(self):
468 return self.unanswered_requests == {}
471 def synchronous_get(self, requests, timeout=100000000):
472 # todo: use generators, unanswered_requests should be a list of arrays...
473 queue = Queue.Queue()
474 ids = self.send(requests, lambda i,r: queue.put(r))
478 r = queue.get(True, timeout)
482 res[_id] = r.get('result')
489 def start(self, queue):
491 threading.Thread.start(self)
495 self.start_interface()
496 if self.is_connected:
497 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
499 self.run_tcp() if self.protocol in 'st' else self.run_http()
503 def change_status(self):
504 #print "change status", self.server, self.is_connected
509 if __name__ == "__main__":
512 i = Interface({'server':'btc.it-zone.org:50002:s', 'path':'/extra/key/wallet', 'verbose':True})