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 proxy_modes = ['socks4', 'socks5', 'http']
31 def pick_random_server():
32 return random.choice( filter_protocol(DEFAULT_SERVERS,'s') )
35 class Interface(threading.Thread):
38 def init_server(self, host, port, proxy=None, use_ssl=True):
42 self.use_ssl = use_ssl
43 self.poll_interval = 1
47 self.unanswered_requests = {}
48 self.pending_transactions_for_notifications= []
51 def queue_json_response(self, c):
54 # print_error( "<--",c )
57 error = c.get('error')
60 print_error("received error:", c)
61 if msg_id is not None:
63 method, params, callback = self.unanswered_requests.pop(msg_id)
64 callback(self,{'method':method, 'params':params, 'error':error, 'id':msg_id})
68 if msg_id is not None:
70 method, params, callback = self.unanswered_requests.pop(msg_id)
71 result = c.get('result')
75 method = c.get('method')
76 params = c.get('params')
78 if method == 'blockchain.numblocks.subscribe':
82 elif method == 'blockchain.headers.subscribe':
86 elif method == 'blockchain.address.subscribe':
92 for k,v in self.subscriptions.items():
93 if (method, params) in v:
97 print_error( "received unexpected notification", method, params)
98 print_error( self.subscriptions )
102 callback(self, {'method':method, 'params':params, 'result':result, 'id':msg_id})
105 def on_version(self, i, result):
106 self.server_version = result
109 def init_http(self, host, port, proxy=None, use_ssl=True):
110 self.init_server(host, port, proxy, use_ssl)
111 self.session_id = None
112 self.is_connected = True
113 self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
117 print_error("http init session failed")
118 self.is_connected = False
122 print_error('http session:',self.session_id)
123 self.is_connected = True
125 self.is_connected = False
128 self.is_connected = True
129 while self.is_connected:
133 time.sleep(self.poll_interval)
134 except socket.gaierror:
139 traceback.print_exc(file=sys.stdout)
142 self.is_connected = False
149 def send_http(self, messages, callback):
150 import urllib2, json, time, cookielib
151 print_error( "send_http", messages )
155 socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
156 socks.wrapmodule(urllib2)
158 cj = cookielib.CookieJar()
159 opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
160 urllib2.install_opener(opener)
167 if type(params) != type([]): params = [params]
168 data.append( { 'method':method, 'id':self.message_id, 'params':params } )
169 self.unanswered_requests[self.message_id] = method, params, callback
173 data_json = json.dumps(data)
179 headers = {'content-type': 'application/json'}
181 headers['cookie'] = 'SESSION=%s'%self.session_id
184 req = urllib2.Request(self.connection_msg, data_json, headers)
185 response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
189 for index, cookie in enumerate(cj):
190 if cookie.name=='SESSION':
191 self.session_id = cookie.value
193 response = response_stream.read()
194 self.bytes_received += len(response)
196 response = json.loads( response )
197 if type(response) is not type([]):
198 self.queue_json_response(response)
200 for item in response:
201 self.queue_json_response(item)
204 self.poll_interval = 1
206 if self.poll_interval < 15:
207 self.poll_interval += 1
208 #print self.poll_interval, response
210 self.rtime = time.time() - t1
211 self.is_connected = True
216 def init_tcp(self, host, port, proxy=None, use_ssl=True):
217 self.init_server(host, port, proxy, use_ssl)
220 self.connection_msg = "%s:%d"%(self.host,self.port)
221 if self.proxy is None:
222 s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
224 self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
226 s = socks.socksocket()
227 s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
230 s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23, do_handshake_on_connect=True)
233 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
236 s.connect(( self.host.encode('ascii'), int(self.port)))
238 #traceback.print_exc(file=sys.stdout)
239 print_error("failed to connect", host, port)
240 self.is_connected = False
246 self.is_connected = True
250 #if self.use_ssl: self.s.do_handshake()
252 while self.is_connected:
255 msg = self.s.recv(1024)
256 except socket.timeout:
260 except socket.error, err:
261 if err.errno in [11, 10035]:
262 print_error("socket errno", err.errno)
266 traceback.print_exc(file=sys.stdout)
270 # ping the server with server.version, as a real ping does not exist yet
271 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
275 self.bytes_received += len(msg)
277 self.is_connected = False
285 self.queue_json_response(c)
288 traceback.print_exc(file=sys.stdout)
290 self.is_connected = False
293 def send_tcp(self, messages, callback):
294 """return the ids of the requests that we sent"""
299 request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
300 self.unanswered_requests[self.message_id] = method, params, callback
301 ids.append(self.message_id)
303 # print "-->", request
305 out += request + '\n'
308 sent = self.s.send( out )
310 except socket.error,e:
311 if e[0] in (errno.EWOULDBLOCK,errno.EAGAIN):
312 print_error( "EAGAIN: retrying")
316 traceback.print_exc(file=sys.stdout)
317 # this happens when we get disconnected
318 print_error( "Not connected, cannot send" )
324 def __init__(self, config=None):
325 #self.server = random.choice(filter_protocol(DEFAULT_SERVERS, 's'))
329 from simple_config import SimpleConfig
330 config = SimpleConfig()
332 threading.Thread.__init__(self)
335 self.connect_event = threading.Event()
337 self.subscriptions = {}
338 self.lock = threading.Lock()
340 self.servers = {} # actual list from IRC
342 self.bytes_received = 0
343 self.is_connected = False
345 # init with None server, in case we are offline
346 self.init_server(None, None)
351 def init_interface(self):
352 if self.config.get('server'):
353 self.init_with_server(self.config)
355 if self.config.get('auto_cycle') is None:
356 self.config.set_key('auto_cycle', True, False)
358 if not self.is_connected:
359 self.connect_event.set()
362 self.connect_event.set()
365 def init_with_server(self, config):
367 s = config.get('server')
368 host, port, protocol = s.split(':')
371 self.protocol = protocol
372 proxy = self.parse_proxy_options(config.get('proxy'))
373 self.server = host + ':%d:%s'%(port, protocol)
375 #print protocol, host, port
377 self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
378 elif protocol in 'gh':
379 self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
381 raise BaseException('Unknown protocol: %s'%protocol)
384 def send(self, messages, callback):
387 for message in messages:
389 if m[-10:] == '.subscribe':
394 if self.subscriptions.get(callback) is None:
395 self.subscriptions[callback] = []
397 if message not in self.subscriptions[callback]:
398 self.subscriptions[callback].append(message)
400 if not self.is_connected:
403 if self.protocol in 'st':
405 out = self.send_tcp(messages, callback)
407 # do not use lock, http is synchronous
408 out = self.send_http(messages, callback)
413 def parse_proxy_options(self, s):
414 if type(s) == type({}): return s # fixme: type should be fixed
415 if type(s) != type(""): return None
416 if s.lower() == 'none': return None
417 proxy = { "mode":"socks5", "host":"localhost" }
420 if proxy_modes.count(args[n]) == 1:
421 proxy["mode"] = args[n]
424 proxy["host"] = args[n]
427 proxy["port"] = args[n]
429 proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
433 def set_server(self, server, proxy=None):
435 # raise an error if the format isnt correct
436 a,b,c = server.split(':')
440 if server != self.server or proxy != self.proxy:
441 print "changing server:", server, proxy
444 if self.is_connected and self.protocol in 'st' and self.s:
445 self.s.shutdown(socket.SHUT_RDWR)
447 self.is_connected = False # this exits the polling loop
448 self.trigger_callback('disconnecting') # for actively disconnecting
452 if self.is_connected and self.protocol in 'st' and self.s:
453 self.s.shutdown(socket.SHUT_RDWR)
457 def is_up_to_date(self):
458 return self.unanswered_requests == {}
461 def synchronous_get(self, requests, timeout=100000000):
462 # todo: use generators, unanswered_requests should be a list of arrays...
464 ids = self.send(requests, lambda i,r: queue.put(r))
468 r = queue.get(True, timeout)
472 res[_id] = r.get('result')
479 def start(self, queue):
481 threading.Thread.start(self)
485 self.init_interface()
486 if self.is_connected:
487 self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
489 self.run_tcp() if self.protocol in 'st' else self.run_http()
493 def change_status(self):
494 #print "change status", self.server, self.is_connected