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
28 DEFAULT_PORTS = {'t':'50001', 's':'50002', 'h':'8081', 'g':'8082'}
30 'electrum.bitcoin.cz:50002:s',
31 'electrum.novit.ro:50002:s',
32 'electrum.be:50002:s',
33 'electrum.bysh.me:50002:s',
34 'electrum.pdmc.net:50002:s',
35 'electrum.no-ip.org:50002:s',
37 'electra.datemas.de:50002:s',
38 'electrum.datemas.de:50002:s',
39 'electrum.mooo.com:50002:s',
40 'btcback.com:50002:s',
41 'electrum.bitcoins.sk:50002:s',
42 'btc.stytt.com:50002:s',
43 'electrum.stepkrav.pw:50002:s',
44 'btc.it-zone.org:110:s'
47 # add only port 80 servers here
48 DEFAULT_HTTP_SERVERS = [
49 'electrum.no-ip.org:80:h'
52 proxy_modes = ['socks4', 'socks5', 'http']
55 def pick_random_server():
56 return random.choice( DEFAULT_SERVERS )
61 class Interface(threading.Thread):
63 def register_callback(self, event, callback):
65 if not self.callbacks.get(event):
66 self.callbacks[event] = []
67 self.callbacks[event].append(callback)
69 def trigger_callback(self, event):
71 callbacks = self.callbacks.get(event,[])[:]
73 [callback() for callback in callbacks]
75 def init_server(self, host, port, proxy=None, use_ssl=True):
79 self.use_ssl = use_ssl
80 self.poll_interval = 1
84 self.unanswered_requests = {}
89 def queue_json_response(self, c):
92 # print_error( "<--",c )
95 error = c.get('error')
98 print_error("received error:", c)
99 if msg_id is not None:
101 method, params, channel = self.unanswered_requests.pop(msg_id)
102 response_queue = self.responses[channel]
103 response_queue.put({'method':method, 'params':params, 'error':error, 'id':msg_id})
107 if msg_id is not None:
109 method, params, channel = self.unanswered_requests.pop(msg_id)
110 result = c.get('result')
112 if method == 'server.version':
113 self.server_version = result
115 elif method == 'server.banner':
117 self.trigger_callback('banner')
119 elif method == 'server.peers.subscribe':
129 if re.match("[stgh]\d*", v):
130 protocol, port = v[0], v[1:]
131 if port == '': port = DEFAULT_PORTS[protocol]
132 ports.append((protocol, port))
133 elif re.match("v(.?)+", v):
135 elif re.match("p\d*", v):
136 pruning_level = v[1:]
137 if pruning_level == '': pruning_level = '0'
139 is_recent = float(version)>=float(PROTOCOL_VERSION)
142 if ports and is_recent:
143 servers[host] = {'ports':ports, 'pruning':pruning_level}
144 self.servers = servers
145 self.trigger_callback('peers')
148 # notification: find the channel(s)
149 method = c.get('method')
150 params = c.get('params')
152 if method == 'blockchain.numblocks.subscribe':
156 elif method == 'blockchain.headers.subscribe':
160 elif method == 'blockchain.address.subscribe':
166 for k,v in self.subscriptions.items():
167 if (method, params) in v:
171 print_error( "received unexpected notification", method, params)
172 print_error( self.subscriptions )
175 response_queue = self.responses[channel]
176 response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
180 def get_response(self, channel='default', block=True, timeout=10000000000):
181 return self.responses[channel].get(block, timeout)
183 def register_channel(self, channel):
185 self.responses[channel] = Queue.Queue()
187 def poke(self, channel):
188 self.responses[channel].put(None)
191 def init_http(self, host, port, proxy=None, use_ssl=True):
192 self.init_server(host, port, proxy, use_ssl)
193 self.session_id = None
194 self.is_connected = True
195 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
199 print_error("http init session failed")
200 self.is_connected = False
204 print_error('http session:',self.session_id)
205 self.is_connected = True
207 self.is_connected = False
210 self.is_connected = True
211 while self.is_connected:
215 time.sleep(self.poll_interval)
216 except socket.gaierror:
221 traceback.print_exc(file=sys.stdout)
224 self.is_connected = False
231 def send_http(self, messages, channel='default'):
232 import urllib2, json, time, cookielib
233 print_error( "send_http", messages )
237 socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
238 socks.wrapmodule(urllib2)
240 cj = cookielib.CookieJar()
241 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
242 urllib2.install_opener(opener)
249 if type(params) != type([]): params = [params]
250 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
251 self.unanswered_requests[self.message_id] = method, params, channel
255 data_json = json.dumps(data)
261 headers = {'content-type': 'application/json'}
263 headers['cookie'] = 'SESSION=%s'%self.session_id
266 req = urllib2.Request(self.connection_msg, data_json, headers)
267 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
271 for index, cookie in enumerate(cj):
272 if cookie.name=='SESSION':
273 self.session_id = cookie.value
275 response = response_stream.read()
276 self.bytes_received += len(response)
278 response = json.loads( response )
279 if type(response) is not type([]):
280 self.queue_json_response(response)
282 for item in response:
283 self.queue_json_response(item)
286 self.poll_interval = 1
288 if self.poll_interval < 15:
289 self.poll_interval += 1
290 #print self.poll_interval, response
292 self.rtime = time.time() - t1
293 self.is_connected = True
298 def init_tcp(self, host, port, proxy=None, use_ssl=True):
299 self.init_server(host, port, proxy, use_ssl)
302 self.connection_msg = "%s:%d"%(self.host,self.port)
303 if self.proxy is None:
304 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
306 self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
308 s = socks.socksocket()
309 s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
312 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
315 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
318 s.connect(( self.host.encode('ascii'), int(self.port)))
321 self.is_connected = True
323 self.is_connected = False
330 while self.is_connected:
334 msg = self.s.recv(1024)
335 except socket.timeout:
341 # ping the server with server.version, as a real ping does not exist yet
342 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
346 self.bytes_received += len(msg)
348 self.is_connected = False
356 self.queue_json_response(c)
359 traceback.print_exc(file=sys.stdout)
361 self.is_connected = False
364 def send_tcp(self, messages, channel='default'):
365 """return the ids of the requests that we sent"""
370 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
371 self.unanswered_requests[self.message_id] = method, params, channel
372 ids.append(self.message_id)
374 # print "-->",request
376 out += request + '\n'
379 sent = self.s.send( out )
382 # this happens when we get disconnected
383 print_error( "Not connected, cannot send" )
389 def __init__(self, config=None, loop=False):
390 self.server = random.choice(DEFAULT_SERVERS[:])
394 from simple_config import SimpleConfig
395 config = SimpleConfig()
397 threading.Thread.__init__(self)
401 self.connect_event = threading.Event()
403 self.subscriptions = {}
405 self.responses['default'] = Queue.Queue()
408 self.lock = threading.Lock()
410 self.servers = {} # actual list from IRC
412 self.bytes_received = 0
413 self.is_connected = False
417 def init_interface(self):
418 if self.config.get('server'):
419 self.init_with_server(self.config)
421 if self.config.get('auto_cycle') is None:
422 self.config.set_key('auto_cycle', True, False)
424 if not self.is_connected and self.config.get('auto_cycle'):
425 print_msg("Using random server...")
426 servers_tcp = DEFAULT_SERVERS[:]
427 servers_http = DEFAULT_HTTP_SERVERS[:]
428 while servers_tcp or servers_http:
430 server = random.choice( servers_tcp )
431 servers_tcp.remove(server)
433 # try HTTP if we can't get a TCP connection
434 server = random.choice( servers_http )
435 servers_http.remove(server)
437 self.config.set_key('server', server, False)
438 self.init_with_server(self.config)
439 if self.is_connected: break
441 if not self.is_connected:
442 print 'no server available'
443 self.connect_event.set() # to finish start
444 self.server = 'ecdsa.org:50001:t'
448 self.connect_event.set()
449 if self.is_connected:
450 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
451 self.send([('server.banner',[])])
452 self.trigger_callback('connected')
454 self.trigger_callback('notconnected')
455 #print_error("Failed to connect " + self.connection_msg)
458 def init_with_server(self, config):
460 s = config.get('server')
461 host, port, protocol = s.split(':')
464 self.protocol = protocol
465 proxy = self.parse_proxy_options(config.get('proxy'))
466 self.server = host + ':%d:%s'%(port, protocol)
468 #print protocol, host, port
470 self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
471 elif protocol in 'gh':
472 self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
474 raise BaseException('Unknown protocol: %s'%protocol)
477 def send(self, messages, channel='default'):
480 for message in messages:
482 if m[-10:] == '.subscribe':
487 if self.subscriptions.get(channel) is None:
488 self.subscriptions[channel] = []
490 if message not in self.subscriptions[channel]:
491 self.subscriptions[channel].append(message)
493 if not self.is_connected:
496 if self.protocol in 'st':
498 out = self.send_tcp(messages, channel)
500 # do not use lock, http is synchronous
501 out = self.send_http(messages, channel)
505 def resend_subscriptions(self):
506 for channel, messages in self.subscriptions.items():
508 self.send(messages, channel)
512 def parse_proxy_options(self, s):
513 if type(s) == type({}): return s # fixme: type should be fixed
514 if type(s) != type(""): return None
515 if s.lower() == 'none': return None
516 proxy = { "mode":"socks5", "host":"localhost" }
519 if proxy_modes.count(args[n]) == 1:
520 proxy["mode"] = args[n]
523 proxy["host"] = args[n]
526 proxy["port"] = args[n]
528 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
532 def set_server(self, server, proxy=None):
533 # raise an error if the format isnt correct
534 a,b,c = server.split(':')
538 if server != self.server or proxy != self.proxy:
539 print "changing server:", server, proxy
542 if self.is_connected and self.protocol in 'st' and self.s:
543 self.s.shutdown(socket.SHUT_RDWR)
545 self.is_connected = False # this exits the polling loop
546 self.trigger_callback('disconnecting') # for actively disconnecting
549 if self.is_connected and self.protocol in 'st' and self.s:
550 self.s.shutdown(socket.SHUT_RDWR)
554 def get_servers_list(self):
558 for x in DEFAULT_SERVERS:
559 h,port,protocol = x.split(':')
560 servers_list[h] = {'ports':[(protocol,port)]}
562 servers_list = self.servers
564 for _host, v in servers_list.items():
568 _protocol, _port = item2
572 return plist, servers_list
575 def is_empty(self, channel):
576 q = self.responses.get(channel)
583 def get_pending_requests(self, channel):
586 for k, v in self.unanswered_requests.items():
588 if c == channel: result.append(k)
591 def is_up_to_date(self, channel):
592 return self.is_empty(channel) and not self.get_pending_requests(channel)
595 def synchronous_get(self, requests, timeout=100000000):
596 # todo: use generators, unanswered_requests should be a list of arrays...
597 ids = self.send(requests)
601 r = self.responses['default'].get(True, timeout)
605 res[_id] = r.get('result')
612 def start(self, wait=True):
613 threading.Thread.start(self)
615 # wait until connection is established
616 self.connect_event.wait()
617 if not self.is_connected:
623 self.init_interface()
624 if self.is_connected:
625 self.resend_subscriptions()
626 self.run_tcp() if self.protocol in 'st' else self.run_http()
628 self.trigger_callback('disconnected')
630 if not self.loop: break