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, errno
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):
71 def init_server(self, host, port, proxy=None, use_ssl=True):
75 self.use_ssl = use_ssl
76 self.poll_interval = 1
80 self.unanswered_requests = {}
83 self.pending_transactions_for_notifications= []
86 def parse_servers(self, result):
87 """ parse servers list into dict format"""
97 if re.match("[stgh]\d*", v):
98 protocol, port = v[0], v[1:]
99 if port == '': port = DEFAULT_PORTS[protocol]
101 elif re.match("v(.?)+", v):
103 elif re.match("p\d*", v):
104 pruning_level = v[1:]
105 if pruning_level == '': pruning_level = '0'
107 is_recent = float(version)>=float(PROTOCOL_VERSION)
111 if out and is_recent:
112 out['pruning'] = pruning_level
118 def queue_json_response(self, c):
121 # print_error( "<--",c )
124 error = c.get('error')
127 print_error("received error:", c)
128 if msg_id is not None:
130 method, params, channel = self.unanswered_requests.pop(msg_id)
131 response_queue = self.responses[channel]
132 response_queue.put((self,{'method':method, 'params':params, 'error':error, 'id':msg_id}))
136 if msg_id is not None:
138 method, params, channel = self.unanswered_requests.pop(msg_id)
139 result = c.get('result')
141 if method == 'server.version':
142 self.server_version = result
144 elif method == 'server.banner':
146 self.network.trigger_callback('banner')
148 elif method == 'server.peers.subscribe':
149 self.servers = self.parse_servers(result)
150 self.network.trigger_callback('peers')
153 # notification: find the channel(s)
154 method = c.get('method')
155 params = c.get('params')
157 if method == 'blockchain.numblocks.subscribe':
161 elif method == 'blockchain.headers.subscribe':
165 elif method == 'blockchain.address.subscribe':
171 for k,v in self.subscriptions.items():
172 if (method, params) in v:
176 print_error( "received unexpected notification", method, params)
177 print_error( self.subscriptions )
180 response_queue = self.responses[channel]
181 response_queue.put((self, {'method':method, 'params':params, 'result':result, 'id':msg_id}))
185 def get_response(self, channel='default', block=True, timeout=10000000000):
186 ir = self.responses[channel].get(block, timeout)
190 def register_channel(self, channel, queue=None):
192 queue = Queue.Queue()
194 self.responses[channel] = queue
196 def poke(self, channel):
197 self.responses[channel].put(None)
200 def init_http(self, host, port, proxy=None, use_ssl=True):
201 self.init_server(host, port, proxy, use_ssl)
202 self.session_id = None
203 self.is_connected = True
204 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
208 print_error("http init session failed")
209 self.is_connected = False
213 print_error('http session:',self.session_id)
214 self.is_connected = True
216 self.is_connected = False
219 self.is_connected = True
220 while self.is_connected:
224 time.sleep(self.poll_interval)
225 except socket.gaierror:
230 traceback.print_exc(file=sys.stdout)
233 self.is_connected = False
240 def send_http(self, messages, channel='default'):
241 import urllib2, json, time, cookielib
242 print_error( "send_http", messages )
246 socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
247 socks.wrapmodule(urllib2)
249 cj = cookielib.CookieJar()
250 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
251 urllib2.install_opener(opener)
258 if type(params) != type([]): params = [params]
259 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
260 self.unanswered_requests[self.message_id] = method, params, channel
264 data_json = json.dumps(data)
270 headers = {'content-type': 'application/json'}
272 headers['cookie'] = 'SESSION=%s'%self.session_id
275 req = urllib2.Request(self.connection_msg, data_json, headers)
276 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
280 for index, cookie in enumerate(cj):
281 if cookie.name=='SESSION':
282 self.session_id = cookie.value
284 response = response_stream.read()
285 self.bytes_received += len(response)
287 response = json.loads( response )
288 if type(response) is not type([]):
289 self.queue_json_response(response)
291 for item in response:
292 self.queue_json_response(item)
295 self.poll_interval = 1
297 if self.poll_interval < 15:
298 self.poll_interval += 1
299 #print self.poll_interval, response
301 self.rtime = time.time() - t1
302 self.is_connected = True
307 def init_tcp(self, host, port, proxy=None, use_ssl=True):
308 self.init_server(host, port, proxy, use_ssl)
311 self.connection_msg = "%s:%d"%(self.host,self.port)
312 if self.proxy is None:
313 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
315 self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
317 s = socks.socksocket()
318 s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
321 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23, do_handshake_on_connect=True)
324 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
327 s.connect(( self.host.encode('ascii'), int(self.port)))
329 #traceback.print_exc(file=sys.stdout)
330 print_error("failed to connect", host, port)
331 self.is_connected = False
337 self.is_connected = True
341 #if self.use_ssl: self.s.do_handshake()
343 while self.is_connected:
346 msg = self.s.recv(1024)
347 except socket.timeout:
351 except socket.error, err:
352 if err.errno in [11, 10035]:
353 print_error("socket errno", err.errno)
357 traceback.print_exc(file=sys.stdout)
361 # ping the server with server.version, as a real ping does not exist yet
362 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
366 self.bytes_received += len(msg)
368 self.is_connected = False
376 self.queue_json_response(c)
379 traceback.print_exc(file=sys.stdout)
381 self.is_connected = False
384 def send_tcp(self, messages, channel='default'):
385 """return the ids of the requests that we sent"""
390 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
391 self.unanswered_requests[self.message_id] = method, params, channel
392 ids.append(self.message_id)
394 # print "-->", request
396 out += request + '\n'
399 sent = self.s.send( out )
401 except socket.error,e:
402 if e[0] in (errno.EWOULDBLOCK,errno.EAGAIN):
403 print_error( "EAGAIN: retrying")
407 traceback.print_exc(file=sys.stdout)
408 # this happens when we get disconnected
409 print_error( "Not connected, cannot send" )
415 def __init__(self, config=None):
416 self.server = random.choice(filter_protocol(DEFAULT_SERVERS, 's'))
420 from simple_config import SimpleConfig
421 config = SimpleConfig()
423 threading.Thread.__init__(self)
426 self.connect_event = threading.Event()
428 self.subscriptions = {}
430 self.responses['default'] = Queue.Queue()
432 self.lock = threading.Lock()
434 self.servers = {} # actual list from IRC
436 self.bytes_received = 0
437 self.is_connected = False
439 # init with None server, in case we are offline
440 self.init_server(None, None)
445 def init_interface(self):
446 if self.config.get('server'):
447 self.init_with_server(self.config)
449 if self.config.get('auto_cycle') is None:
450 self.config.set_key('auto_cycle', True, False)
452 if not self.is_connected:
453 self.connect_event.set()
456 self.connect_event.set()
459 def init_with_server(self, config):
461 s = config.get('server')
462 host, port, protocol = s.split(':')
465 self.protocol = protocol
466 proxy = self.parse_proxy_options(config.get('proxy'))
467 self.server = host + ':%d:%s'%(port, protocol)
469 #print protocol, host, port
471 self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
472 elif protocol in 'gh':
473 self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
475 raise BaseException('Unknown protocol: %s'%protocol)
478 def send(self, messages, channel='default'):
481 for message in messages:
483 if m[-10:] == '.subscribe':
488 if self.subscriptions.get(channel) is None:
489 self.subscriptions[channel] = []
491 if message not in self.subscriptions[channel]:
492 self.subscriptions[channel].append(message)
494 if not self.is_connected:
497 if self.protocol in 'st':
499 out = self.send_tcp(messages, channel)
501 # do not use lock, http is synchronous
502 out = self.send_http(messages, channel)
507 def parse_proxy_options(self, s):
508 if type(s) == type({}): return s # fixme: type should be fixed
509 if type(s) != type(""): return None
510 if s.lower() == 'none': return None
511 proxy = { "mode":"socks5", "host":"localhost" }
514 if proxy_modes.count(args[n]) == 1:
515 proxy["mode"] = args[n]
518 proxy["host"] = args[n]
521 proxy["port"] = args[n]
523 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
527 def set_server(self, server, proxy=None):
528 # raise an error if the format isnt correct
529 a,b,c = server.split(':')
533 if server != self.server or proxy != self.proxy:
534 print "changing server:", server, proxy
537 if self.is_connected and self.protocol in 'st' and self.s:
538 self.s.shutdown(socket.SHUT_RDWR)
540 self.is_connected = False # this exits the polling loop
541 self.trigger_callback('disconnecting') # for actively disconnecting
544 if self.is_connected and self.protocol in 'st' and self.s:
545 self.s.shutdown(socket.SHUT_RDWR)
549 def get_servers(self):
551 return DEFAULT_SERVERS
556 def is_empty(self, channel):
557 q = self.responses.get(channel)
564 def get_pending_requests(self, channel):
567 for k, v in self.unanswered_requests.items():
569 if c == channel: result.append(k)
572 def is_up_to_date(self, channel):
573 return self.is_empty(channel) and not self.get_pending_requests(channel)
576 def synchronous_get(self, requests, timeout=100000000):
577 # todo: use generators, unanswered_requests should be a list of arrays...
578 ids = self.send(requests)
582 r = self.responses['default'].get(True, timeout)
586 res[_id] = r.get('result')
593 def start(self, queue):
595 threading.Thread.start(self)
600 self.init_interface()
601 if self.is_connected:
602 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
604 self.run_tcp() if self.protocol in 'st' else self.run_http()
607 def change_status(self):
608 #print "change status", self.server, self.is_connected