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, socket, ast, re, ssl
21 import threading, traceback, sys, time, json, Queue
23 from version import ELECTRUM_VERSION, PROTOCOL_VERSION
24 from util import print_error, print_msg
29 #'electrum.bitcoins.sk:50001:t',
30 #'uncle-enzo.info:50001:t',
31 #'electrum.bitfoo.org:50001:t',
32 #'webbtc.net:50001:t',
33 'electrum.bitcoin.cz:50001:t',
34 'electrum.novit.ro:50001:t',
35 'electrum.be:50001:t',
36 'electrum.bysh.me:50001:t',
37 'electrum.pdmc.net:50001:t',
38 'electrum.no-ip.org:50001:t',
42 # add only port 80 servers here
43 DEFAULT_HTTP_SERVERS = [
44 'electrum.no-ip.org:80:h'
47 proxy_modes = ['socks4', 'socks5', 'http']
50 def pick_random_server():
51 return random.choice( DEFAULT_SERVERS )
56 class Interface(threading.Thread):
58 def register_callback(self, event, callback):
60 if not self.callbacks.get(event):
61 self.callbacks[event] = []
62 self.callbacks[event].append(callback)
64 def trigger_callback(self, event):
66 callbacks = self.callbacks.get(event,[])[:]
68 [callback() for callback in callbacks]
70 def init_server(self, host, port, proxy=None, use_ssl=True):
74 self.use_ssl = use_ssl
75 self.poll_interval = 1
79 self.unanswered_requests = {}
83 def queue_json_response(self, c):
86 # print_error( "<--",c )
89 error = c.get('error')
92 print_error("received error:", c)
93 if msg_id is not None:
95 method, params, channel = self.unanswered_requests.pop(msg_id)
96 response_queue = self.responses[channel]
97 response_queue.put({'method':method, 'params':params, 'error':error, 'id':msg_id})
101 if msg_id is not None:
103 method, params, channel = self.unanswered_requests.pop(msg_id)
104 result = c.get('result')
106 if method == 'server.version':
107 self.server_version = result
109 elif method == 'server.peers.subscribe':
119 if re.match("[stgh]\d+", v):
120 ports.append((v[0], v[1:]))
121 elif re.match("v(.?)+", v):
126 is_recent = float(version)>=float(PROTOCOL_VERSION)
129 if ports and is_recent:
130 servers[host] = {'ports':ports, 'pruning':pruning}
131 self.servers = servers
132 self.trigger_callback('peers')
135 # notification: find the channel(s)
136 method = c.get('method')
137 params = c.get('params')
139 if method == 'blockchain.numblocks.subscribe':
143 elif method == 'blockchain.headers.subscribe':
147 elif method == 'blockchain.address.subscribe':
153 for k,v in self.subscriptions.items():
154 if (method, params) in v:
158 print_error( "received unexpected notification", method, params)
159 print_error( self.subscriptions )
162 response_queue = self.responses[channel]
163 response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
167 def get_response(self, channel='default', block=True, timeout=10000000000):
168 return self.responses[channel].get(block, timeout)
170 def register_channel(self, channel):
172 self.responses[channel] = Queue.Queue()
174 def poke(self, channel):
175 self.responses[channel].put(None)
178 def init_http(self, host, port, proxy=None, use_ssl=True):
179 self.init_server(host, port, proxy, use_ssl)
180 self.session_id = None
181 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
188 print_error('http session:',self.session_id)
189 self.is_connected = True
192 self.is_connected = True
193 while self.is_connected:
197 time.sleep(self.poll_interval)
198 except socket.gaierror:
203 traceback.print_exc(file=sys.stdout)
206 self.is_connected = False
213 def send_http(self, messages, channel='default'):
214 import urllib2, json, time, cookielib
218 socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
219 socks.wrapmodule(urllib2)
221 cj = cookielib.CookieJar()
222 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
223 urllib2.install_opener(opener)
230 if type(params) != type([]): params = [params]
231 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
232 self.unanswered_requests[self.message_id] = method, params, channel
236 data_json = json.dumps(data)
242 headers = {'content-type': 'application/json'}
244 headers['cookie'] = 'SESSION=%s'%self.session_id
247 req = urllib2.Request(self.connection_msg, data_json, headers)
248 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
252 for index, cookie in enumerate(cj):
253 if cookie.name=='SESSION':
254 self.session_id = cookie.value
256 response = response_stream.read()
257 self.bytes_received += len(response)
259 response = json.loads( response )
260 if type(response) is not type([]):
261 self.queue_json_response(response)
263 for item in response:
264 self.queue_json_response(item)
267 self.poll_interval = 1
269 if self.poll_interval < 15:
270 self.poll_interval += 1
271 #print self.poll_interval, response
273 self.rtime = time.time() - t1
274 self.is_connected = True
279 def init_tcp(self, host, port, proxy=None, use_ssl=True):
280 self.init_server(host, port, proxy, use_ssl)
283 self.connection_msg = "%s:%d"%(self.host,self.port)
284 if self.proxy is None:
285 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
287 self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
289 s = socks.socksocket()
290 s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
293 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
296 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
299 s.connect(( self.host.encode('ascii'), int(self.port)))
302 self.is_connected = True
304 self.is_connected = False
311 while self.is_connected:
315 msg = self.s.recv(1024)
316 except socket.timeout:
322 # ping the server with server.version, as a real ping does not exist yet
323 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
327 self.bytes_received += len(msg)
329 self.is_connected = False
337 self.queue_json_response(c)
340 traceback.print_exc(file=sys.stdout)
342 self.is_connected = False
345 def send_tcp(self, messages, channel='default'):
346 """return the ids of the requests that we sent"""
351 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
352 self.unanswered_requests[self.message_id] = method, params, channel
353 ids.append(self.message_id)
355 # print "-->",request
357 out += request + '\n'
360 sent = self.s.send( out )
363 # this happens when we get disconnected
364 print_error( "Not connected, cannot send" )
370 def __init__(self, config=None, loop=False):
375 from simple_config import SimpleConfig
376 config = SimpleConfig()
378 threading.Thread.__init__(self)
382 self.connect_event = threading.Event()
384 self.subscriptions = {}
386 self.responses['default'] = Queue.Queue()
389 self.lock = threading.Lock()
391 self.servers = {} # actual list from IRC
393 self.bytes_received = 0
394 self.is_connected = False
398 def init_interface(self):
399 if self.config.get('server'):
400 self.init_with_server(self.config)
402 if self.config.get('auto_cycle') is None:
403 self.config.set_key('auto_cycle', True, False)
405 if not self.is_connected and self.config.get('auto_cycle'):
406 print_msg("Using random server...")
407 servers_tcp = DEFAULT_SERVERS[:]
408 servers_http = DEFAULT_HTTP_SERVERS[:]
409 while servers_tcp or servers_http:
411 server = random.choice( servers_tcp )
412 servers_tcp.remove(server)
414 # try HTTP if we can't get a TCP connection
415 server = random.choice( servers_http )
416 servers_http.remove(server)
418 self.config.set_key('server', server, False)
419 self.init_with_server(self.config)
420 if self.is_connected: break
422 if not self.is_connected:
423 print 'no server available'
424 self.connect_event.set() # to finish start
425 self.server = 'ecdsa.org:50001:t'
429 self.connect_event.set()
430 if self.is_connected:
431 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
432 self.trigger_callback('connected')
434 self.trigger_callback('notconnected')
435 #print_error("Failed to connect " + self.connection_msg)
438 def init_with_server(self, config):
440 s = config.get('server')
441 host, port, protocol = s.split(':')
444 self.protocol = protocol
445 proxy = self.parse_proxy_options(config.get('proxy'))
446 self.server = host + ':%d:%s'%(port, protocol)
448 #print protocol, host, port
450 self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
451 elif protocol in 'gh':
452 self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
454 raise BaseException('Unknown protocol: %s'%protocol)
457 def send(self, messages, channel='default'):
460 for message in messages:
462 if m[-10:] == '.subscribe':
467 if self.subscriptions.get(channel) is None:
468 self.subscriptions[channel] = []
470 if message not in self.subscriptions[channel]:
471 self.subscriptions[channel].append(message)
473 if self.protocol in 'st':
475 out = self.send_tcp(messages, channel)
477 # do not use lock, http is synchronous
478 out = self.send_http(messages, channel)
482 def resend_subscriptions(self):
483 for channel, messages in self.subscriptions.items():
485 self.send(messages, channel)
489 def parse_proxy_options(self, s):
490 if type(s) == type({}): return s # fixme: type should be fixed
491 if type(s) != type(""): return None
492 if s.lower() == 'none': return None
493 proxy = { "mode":"socks5", "host":"localhost" }
496 if proxy_modes.count(args[n]) == 1:
497 proxy["mode"] = args[n]
500 proxy["host"] = args[n]
503 proxy["port"] = args[n]
505 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
509 def set_server(self, server, proxy=None):
510 # raise an error if the format isnt correct
511 a,b,c = server.split(':')
515 if server != self.server or proxy != self.proxy:
516 print "changing server:", server, proxy
519 if self.protocol in 'st' and self.s:
520 self.s.shutdown(socket.SHUT_RDWR)
522 self.is_connected = False # this exits the polling loop
523 self.trigger_callback('disconnecting') # for actively disconnecting
526 if self.protocol in 'st' and self.s:
527 self.s.shutdown(socket.SHUT_RDWR)
531 def get_servers_list(self):
535 for x in DEFAULT_SERVERS:
536 h,port,protocol = x.split(':')
537 servers_list[h] = {'ports':[(protocol,port)]}
539 servers_list = self.servers
541 for _host, v in servers_list.items():
545 _protocol, _port = item2
549 return plist, servers_list
552 def is_empty(self, channel):
553 q = self.responses.get(channel)
560 def get_pending_requests(self, channel):
563 for k, v in self.unanswered_requests.items():
565 if c == channel: result.append(k)
568 def is_up_to_date(self, channel):
569 return self.is_empty(channel) and not self.get_pending_requests(channel)
572 def synchronous_get(self, requests, timeout=100000000):
573 # todo: use generators, unanswered_requests should be a list of arrays...
574 ids = self.send(requests)
578 r = self.responses['default'].get(True, timeout)
582 res[_id] = r.get('result')
591 self.init_interface()
592 if self.is_connected:
593 self.resend_subscriptions()
594 self.run_tcp() if self.protocol in 'st' else self.run_http()
596 self.trigger_callback('disconnected')
598 if not self.loop: break