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'}
31 'the9ull.homelinux.org': {'h': '8082', 't': '50001'},
32 'electrum.coinwallet.me': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
33 'electrum.dynaloop.net': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
34 'electrum.koh.ms': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
35 'electrum.novit.ro': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
36 'electrum.stepkrav.pw': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
37 'ecdsa.org': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
38 'electrum.mooo.com': {'h': '8081', 't': '50001'},
39 'electrum.bitcoins.sk': {'h': '8081', 's': '50002', 't': '50001', 'g': '8'},
40 'electrum.no-ip.org': {'h': '80', 's': '50002', 't': '50001', 'g': '443'},
41 'electrum.drollette.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
42 'btc.it-zone.org': {'h': '80', 's': '110', 't': '50001', 'g': '443'},
43 'electrum.yacoin.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
44 'electrum.be': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'}
49 def filter_protocol(servers, p):
51 for k, protocols in servers.items():
53 l.append( ':'.join([k, protocols[p], p]) )
58 proxy_modes = ['socks4', 'socks5', 'http']
61 def pick_random_server():
62 return random.choice( filter_protocol(DEFAULT_SERVERS,'s') )
67 class Interface(threading.Thread):
69 def register_callback(self, event, callback):
71 if not self.callbacks.get(event):
72 self.callbacks[event] = []
73 self.callbacks[event].append(callback)
75 def trigger_callback(self, event):
77 callbacks = self.callbacks.get(event,[])[:]
79 [callback() for callback in callbacks]
81 def init_server(self, host, port, proxy=None, use_ssl=True):
85 self.use_ssl = use_ssl
86 self.poll_interval = 1
90 self.unanswered_requests = {}
93 self.pending_transactions_for_notifications= []
96 def parse_servers(self, result):
97 """ parse servers list into dict format"""
107 if re.match("[stgh]\d*", v):
108 protocol, port = v[0], v[1:]
109 if port == '': port = DEFAULT_PORTS[protocol]
111 elif re.match("v(.?)+", v):
113 elif re.match("p\d*", v):
114 pruning_level = v[1:]
115 if pruning_level == '': pruning_level = '0'
117 is_recent = float(version)>=float(PROTOCOL_VERSION)
121 if out and is_recent:
122 out['pruning'] = pruning_level
128 def queue_json_response(self, c):
131 # print_error( "<--",c )
134 error = c.get('error')
137 print_error("received error:", c)
138 if msg_id is not None:
140 method, params, channel = self.unanswered_requests.pop(msg_id)
141 response_queue = self.responses[channel]
142 response_queue.put({'method':method, 'params':params, 'error':error, 'id':msg_id})
146 if msg_id is not None:
148 method, params, channel = self.unanswered_requests.pop(msg_id)
149 result = c.get('result')
151 if method == 'server.version':
152 self.server_version = result
154 elif method == 'server.banner':
156 self.trigger_callback('banner')
158 elif method == 'server.peers.subscribe':
159 self.servers = self.parse_servers(result)
160 self.trigger_callback('peers')
163 # notification: find the channel(s)
164 method = c.get('method')
165 params = c.get('params')
167 if method == 'blockchain.numblocks.subscribe':
171 elif method == 'blockchain.headers.subscribe':
175 elif method == 'blockchain.address.subscribe':
181 for k,v in self.subscriptions.items():
182 if (method, params) in v:
186 print_error( "received unexpected notification", method, params)
187 print_error( self.subscriptions )
190 response_queue = self.responses[channel]
191 response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
195 def get_response(self, channel='default', block=True, timeout=10000000000):
196 return self.responses[channel].get(block, timeout)
198 def register_channel(self, channel):
200 self.responses[channel] = Queue.Queue()
202 def poke(self, channel):
203 self.responses[channel].put(None)
206 def init_http(self, host, port, proxy=None, use_ssl=True):
207 self.init_server(host, port, proxy, use_ssl)
208 self.session_id = None
209 self.is_connected = True
210 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
214 print_error("http init session failed")
215 self.is_connected = False
219 print_error('http session:',self.session_id)
220 self.is_connected = True
222 self.is_connected = False
225 self.is_connected = True
226 while self.is_connected:
230 time.sleep(self.poll_interval)
231 except socket.gaierror:
236 traceback.print_exc(file=sys.stdout)
239 self.is_connected = False
246 def send_http(self, messages, channel='default'):
247 import urllib2, json, time, cookielib
248 print_error( "send_http", messages )
252 socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
253 socks.wrapmodule(urllib2)
255 cj = cookielib.CookieJar()
256 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
257 urllib2.install_opener(opener)
264 if type(params) != type([]): params = [params]
265 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
266 self.unanswered_requests[self.message_id] = method, params, channel
270 data_json = json.dumps(data)
276 headers = {'content-type': 'application/json'}
278 headers['cookie'] = 'SESSION=%s'%self.session_id
281 req = urllib2.Request(self.connection_msg, data_json, headers)
282 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
286 for index, cookie in enumerate(cj):
287 if cookie.name=='SESSION':
288 self.session_id = cookie.value
290 response = response_stream.read()
291 self.bytes_received += len(response)
293 response = json.loads( response )
294 if type(response) is not type([]):
295 self.queue_json_response(response)
297 for item in response:
298 self.queue_json_response(item)
301 self.poll_interval = 1
303 if self.poll_interval < 15:
304 self.poll_interval += 1
305 #print self.poll_interval, response
307 self.rtime = time.time() - t1
308 self.is_connected = True
313 def init_tcp(self, host, port, proxy=None, use_ssl=True):
314 self.init_server(host, port, proxy, use_ssl)
317 self.connection_msg = "%s:%d"%(self.host,self.port)
318 if self.proxy is None:
319 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
321 self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
323 s = socks.socksocket()
324 s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
327 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23, do_handshake_on_connect=True)
330 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
333 s.connect(( self.host.encode('ascii'), int(self.port)))
335 #traceback.print_exc(file=sys.stdout)
336 print_error("failed to connect", host, port)
337 self.is_connected = False
343 self.is_connected = True
347 #if self.use_ssl: self.s.do_handshake()
349 while self.is_connected:
352 msg = self.s.recv(1024)
353 except socket.timeout:
357 except socket.error, err:
358 if err.errno in [11, 10035]:
359 print_error("socket errno", err.errno)
363 traceback.print_exc(file=sys.stdout)
367 # ping the server with server.version, as a real ping does not exist yet
368 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
372 self.bytes_received += len(msg)
374 self.is_connected = False
382 self.queue_json_response(c)
385 traceback.print_exc(file=sys.stdout)
387 self.is_connected = False
390 def send_tcp(self, messages, channel='default'):
391 """return the ids of the requests that we sent"""
396 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
397 self.unanswered_requests[self.message_id] = method, params, channel
398 ids.append(self.message_id)
400 # print "-->", request
402 out += request + '\n'
405 sent = self.s.send( out )
408 # this happens when we get disconnected
409 print_error( "Not connected, cannot send" )
415 def __init__(self, config=None, loop=False):
416 self.server = random.choice(filter_protocol(DEFAULT_SERVERS, 's'))
420 from simple_config import SimpleConfig
421 config = SimpleConfig()
423 threading.Thread.__init__(self)
427 self.connect_event = threading.Event()
429 self.subscriptions = {}
431 self.responses['default'] = Queue.Queue()
434 self.lock = threading.Lock()
436 self.servers = {} # actual list from IRC
438 self.bytes_received = 0
439 self.is_connected = False
441 # init with None server, in case we are offline
442 self.init_server(None, None)
447 def init_interface(self):
448 if self.config.get('server'):
449 self.init_with_server(self.config)
451 if self.config.get('auto_cycle') is None:
452 self.config.set_key('auto_cycle', True, False)
454 if not self.is_connected and self.config.get('auto_cycle'):
455 print_msg("Using random server...")
456 servers = filter_protocol(DEFAULT_SERVERS, 's')
458 server = random.choice( servers )
459 servers.remove(server)
461 self.config.set_key('server', server, False)
462 self.init_with_server(self.config)
463 if self.is_connected: break
465 if not self.is_connected:
466 print 'no server available'
467 self.connect_event.set() # to finish start
468 self.server = 'ecdsa.org:50001:t'
472 self.connect_event.set()
473 if self.is_connected:
474 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
475 self.send([('server.banner',[])])
476 self.trigger_callback('connected')
478 self.trigger_callback('notconnected')
479 #print_error("Failed to connect " + self.connection_msg)
482 def init_with_server(self, config):
484 s = config.get('server')
485 host, port, protocol = s.split(':')
488 self.protocol = protocol
489 proxy = self.parse_proxy_options(config.get('proxy'))
490 self.server = host + ':%d:%s'%(port, protocol)
492 #print protocol, host, port
494 self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
495 elif protocol in 'gh':
496 self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
498 raise BaseException('Unknown protocol: %s'%protocol)
501 def send(self, messages, channel='default'):
504 for message in messages:
506 if m[-10:] == '.subscribe':
511 if self.subscriptions.get(channel) is None:
512 self.subscriptions[channel] = []
514 if message not in self.subscriptions[channel]:
515 self.subscriptions[channel].append(message)
517 if not self.is_connected:
520 if self.protocol in 'st':
522 out = self.send_tcp(messages, channel)
524 # do not use lock, http is synchronous
525 out = self.send_http(messages, channel)
529 def resend_subscriptions(self):
530 for channel, messages in self.subscriptions.items():
532 self.send(messages, channel)
536 def parse_proxy_options(self, s):
537 if type(s) == type({}): return s # fixme: type should be fixed
538 if type(s) != type(""): return None
539 if s.lower() == 'none': return None
540 proxy = { "mode":"socks5", "host":"localhost" }
543 if proxy_modes.count(args[n]) == 1:
544 proxy["mode"] = args[n]
547 proxy["host"] = args[n]
550 proxy["port"] = args[n]
552 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
556 def set_server(self, server, proxy=None):
557 # raise an error if the format isnt correct
558 a,b,c = server.split(':')
562 if server != self.server or proxy != self.proxy:
563 print "changing server:", server, proxy
566 if self.is_connected and self.protocol in 'st' and self.s:
567 self.s.shutdown(socket.SHUT_RDWR)
569 self.is_connected = False # this exits the polling loop
570 self.trigger_callback('disconnecting') # for actively disconnecting
573 if self.is_connected and self.protocol in 'st' and self.s:
574 self.s.shutdown(socket.SHUT_RDWR)
578 def get_servers(self):
580 return DEFAULT_SERVERS
585 def is_empty(self, channel):
586 q = self.responses.get(channel)
593 def get_pending_requests(self, channel):
596 for k, v in self.unanswered_requests.items():
598 if c == channel: result.append(k)
601 def is_up_to_date(self, channel):
602 return self.is_empty(channel) and not self.get_pending_requests(channel)
605 def synchronous_get(self, requests, timeout=100000000):
606 # todo: use generators, unanswered_requests should be a list of arrays...
607 ids = self.send(requests)
611 r = self.responses['default'].get(True, timeout)
615 res[_id] = r.get('result')
622 def start(self, wait=True):
623 threading.Thread.start(self)
625 # wait until connection is established
626 self.connect_event.wait()
627 if not self.is_connected:
633 self.init_interface()
634 if self.is_connected:
635 self.resend_subscriptions()
636 self.run_tcp() if self.protocol in 'st' else self.run_http()
638 self.trigger_callback('disconnected')
640 if not self.loop: break