lib/interface.py

   1 #!/usr/bin/env python
   2 #
   3 # Electrum - lightweight Bitcoin client
   4 # Copyright (C) 2011 thomasv@gitorious
   5 #
   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.
  10 #
  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.
  15 #
  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/>.
  18
  19
  20 import random, socket, ast, re
  21 import threading, traceback, sys, time, json, Queue
  22
  23 from version import ELECTRUM_VERSION
  24 from util import print_error
  25
  26
  27 DEFAULT_TIMEOUT = 5
  28 DEFAULT_SERVERS = [
  29     'electrum.novit.ro:50001:t',
  30     'electrum.pdmc.net:50001:t',
  31     'ecdsa.org:50001:t',
  32     'electrum.bitcoins.sk:50001:t',
  33     'uncle-enzo.info:50001:t',
  34     'electrum.bytesized-hosting.com:50001:t',
  35     'electrum.bitcoin.cz:50001:t',
  36     'electrum.bitfoo.org:50001:t'
  37     ]
  38
  39 proxy_modes = ['socks4', 'socks5', 'http']
  40
  41
  42 def pick_random_server():
  43     return random.choice( DEFAULT_SERVERS )
  44
  45
  46
  47
  48 class Interface(threading.Thread):
  49
  50     def register_callback(self, event, callback):
  51         with self.lock:
  52             if not self.callbacks.get(event):
  53                 self.callbacks[event] = []
  54             self.callbacks[event].append(callback)
  55
  56     def trigger_callback(self, event):
  57         with self.lock:
  58             callbacks = self.callbacks.get(event,[])[:]
  59         if callbacks:
  60             [callback() for callback in callbacks]
  61
  62     def init_server(self, host, port, proxy=None, use_ssl=True):
  63         self.host = host
  64         self.port = port
  65         self.proxy = proxy
  66         self.use_ssl = use_ssl
  67         self.poll_interval = 1
  68
  69         #json
  70         self.message_id = 0
  71         self.unanswered_requests = {}
  72
  73
  74
  75     def queue_json_response(self, c):
  76
  77         # uncomment to debug
  78         # print "<--",c
  79
  80         msg_id = c.get('id')
  81         error = c.get('error')
  82
  83         if error:
  84             print "received error:", c
  85             return
  86
  87         if msg_id is not None:
  88             with self.lock:
  89                 method, params, channel = self.unanswered_requests.pop(msg_id)
  90             result = c.get('result')
  91         else:
  92             # notification. we should find the channel(s)..
  93             method = c.get('method')
  94             params = c.get('params')
  95             with self.lock:
  96                 for k,v in self.subscriptions.items():
  97                     if (method, params) in v:
  98                         channel = k
  99                 else:
 100                     print "received unexpected notification", method, params
 101                     return
 102
 103             if method == 'blockchain.numblocks.subscribe':
 104                 result = params[0]
 105                 params = []
 106
 107             elif method == 'blockchain.address.subscribe':
 108                 addr = params[0]
 109                 result = params[1]
 110                 params = [addr]
 111
 112
 113         response_queue = self.responses[channel]
 114         response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
 115
 116
 117
 118     def get_response(self, channel='default', block=True, timeout=10000000000):
 119         return self.responses[channel].get(block, timeout)
 120
 121     def register_channel(self, channel):
 122         with self.lock:
 123             self.responses[channel] = Queue.Queue()
 124
 125     def poke(self, channel):
 126         self.responses[channel].put(None)
 127
 128
 129     def init_http(self, host, port, proxy=None, use_ssl=True):
 130         self.init_server(host, port, proxy, use_ssl)
 131         self.session_id = None
 132         self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
 133         self.is_connected = True
 134
 135     def run_http(self):
 136         self.is_connected = True
 137         while self.is_connected:
 138             try:
 139                 if self.session_id:
 140                     self.poll()
 141                 time.sleep(self.poll_interval)
 142             except socket.gaierror:
 143                 break
 144             except socket.error:
 145                 break
 146             except:
 147                 traceback.print_exc(file=sys.stdout)
 148                 break
 149
 150         self.is_connected = False
 151
 152
 153     def poll(self):
 154         self.send([])
 155
 156
 157     def send_http(self, messages, channel='default'):
 158         import urllib2, json, time, cookielib
 159
 160         if self.proxy:
 161             import socks
 162             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 163             socks.wrapmodule(urllib2)
 164
 165         cj = cookielib.CookieJar()
 166         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 167         urllib2.install_opener(opener)
 168
 169         t1 = time.time()
 170
 171         data = []
 172         for m in messages:
 173             method, params = m
 174             if type(params) != type([]): params = [params]
 175             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 176             self.unanswered_requests[self.message_id] = method, params, channel
 177             self.message_id += 1
 178
 179         if data:
 180             data_json = json.dumps(data)
 181         else:
 182             # poll with GET
 183             data_json = None
 184
 185
 186         headers = {'content-type': 'application/json'}
 187         if self.session_id:
 188             headers['cookie'] = 'SESSION=%s'%self.session_id
 189
 190         req = urllib2.Request(self.connection_msg, data_json, headers)
 191         response_stream = urllib2.urlopen(req)
 192
 193         for index, cookie in enumerate(cj):
 194             if cookie.name=='SESSION':
 195                 self.session_id = cookie.value
 196
 197         response = response_stream.read()
 198         self.bytes_received += len(response)
 199         if response:
 200             response = json.loads( response )
 201             if type(response) is not type([]):
 202                 self.queue_json_response(response)
 203             else:
 204                 for item in response:
 205                     self.queue_json_response(item)
 206
 207         if response:
 208             self.poll_interval = 1
 209         else:
 210             if self.poll_interval < 15:
 211                 self.poll_interval += 1
 212         #print self.poll_interval, response
 213
 214         self.rtime = time.time() - t1
 215         self.is_connected = True
 216
 217
 218
 219
 220     def init_tcp(self, host, port, proxy=None, use_ssl=True):
 221         self.init_server(host, port, proxy, use_ssl)
 222
 223         import ssl
 224         global proxy_modes
 225         self.connection_msg = "%s:%d"%(self.host,self.port)
 226         if self.proxy is None:
 227             s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
 228         else:
 229             self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
 230             import socks
 231             s = socks.socksocket()
 232             s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 233
 234         if self.use_ssl:
 235             s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
 236
 237         s.settimeout(2)
 238         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 239
 240         try:
 241             s.connect(( self.host.encode('ascii'), int(self.port)))
 242             s.settimeout(60)
 243             self.s = s
 244             self.is_connected = True
 245         except:
 246             self.is_connected = False
 247             self.s = None
 248
 249
 250     def run_tcp(self):
 251         try:
 252             out = ''
 253             while self.is_connected:
 254                 try: msg = self.s.recv(1024)
 255                 except socket.timeout:
 256                     print "timeout"
 257                     # ping the server with server.version, as a real ping does not exist yet
 258                     self.send([('server.version', [ELECTRUM_VERSION])])
 259                     continue
 260                 out += msg
 261                 self.bytes_received += len(msg)
 262                 if msg == '':
 263                     self.is_connected = False
 264
 265                 while True:
 266                     s = out.find('\n')
 267                     if s==-1: break
 268                     c = out[0:s]
 269                     out = out[s+1:]
 270                     c = json.loads(c)
 271                     self.queue_json_response(c)
 272
 273         except:
 274             traceback.print_exc(file=sys.stdout)
 275
 276         self.is_connected = False
 277
 278
 279     def send_tcp(self, messages, channel='default'):
 280         """return the ids of the requests that we sent"""
 281         out = ''
 282         ids = []
 283         for m in messages:
 284             method, params = m
 285             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 286             self.unanswered_requests[self.message_id] = method, params, channel
 287             ids.append(self.message_id)
 288             # uncomment to debug
 289             # print "-->",request
 290             self.message_id += 1
 291             out += request + '\n'
 292         while out:
 293             try:
 294                 sent = self.s.send( out )
 295                 out = out[sent:]
 296             except:
 297                 # this happens when we get disconnected
 298                 print "Not connected, cannot send"
 299                 return None
 300         return ids
 301
 302
 303
 304     def __init__(self, config=None, loop=False):
 305
 306         if config is None:
 307             from simple_config import SimpleConfig
 308             config = SimpleConfig()
 309
 310         threading.Thread.__init__(self)
 311         self.daemon = True
 312         self.loop = loop
 313         self.config = config
 314         self.connect_event = threading.Event()
 315
 316         self.subscriptions = {}
 317         self.responses = {}
 318         self.responses['default'] = Queue.Queue()
 319
 320         self.callbacks = {}
 321         self.lock = threading.Lock()
 322
 323         self.servers = [] # actual list from IRC
 324         self.rtime = 0
 325         self.bytes_received = 0
 326
 327
 328
 329     def init_interface(self):
 330         if self.config.get('server'):
 331             self.init_with_server(self.config)
 332         else:
 333             print "Using random server..."
 334             servers = DEFAULT_SERVERS
 335             while servers:
 336                 server = random.choice( servers )
 337                 servers.remove(server)
 338                 self.config.set_key('server', server, False)
 339                 self.init_with_server(self.config)
 340                 if self.is_connected: break
 341
 342             if not servers:
 343                 print 'no server available'
 344                 self.is_connected = False
 345                 self.connect_event.set() # to finish start
 346                 self.server = 'ecdsa.org:50001:t'
 347                 self.proxy = None
 348                 return
 349
 350         self.connect_event.set()
 351         if self.is_connected:
 352             self.send([('server.version', [ELECTRUM_VERSION])])
 353             self.trigger_callback('connected')
 354         else:
 355             self.trigger_callback('notconnected')
 356             #print_error("Failed to connect " + self.connection_msg)
 357
 358
 359     def init_with_server(self, config):
 360
 361         s = config.get('server')
 362         host, port, protocol = s.split(':')
 363         port = int(port)
 364
 365         self.protocol = protocol
 366         proxy = self.parse_proxy_options(config.get('proxy'))
 367         self.server = host + ':%d:%s'%(port, protocol)
 368
 369         #print protocol, host, port
 370         if protocol in 'st':
 371             self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
 372         elif protocol in 'gh':
 373             self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
 374         else:
 375             raise BaseException('Unknown protocol: %s'%protocol)
 376
 377
 378     def send(self, messages, channel='default'):
 379
 380         sub = []
 381         for message in messages:
 382             m, v = message
 383             if m[-10:] == '.subscribe':
 384                 sub.append(message)
 385
 386         if sub:
 387             with self.lock:
 388                 if self.subscriptions.get(channel) is None:
 389                     self.subscriptions[channel] = []
 390                 self.subscriptions[channel] += sub
 391
 392         if self.protocol in 'st':
 393             with self.lock:
 394                 out = self.send_tcp(messages, channel)
 395         else:
 396             # do not use lock, http is synchronous
 397             out = self.send_http(messages, channel)
 398
 399         return out
 400
 401     def resend_subscriptions(self):
 402         for channel, messages in self.subscriptions.items():
 403             if messages:
 404                 self.send(messages, channel)
 405
 406
 407
 408     def parse_proxy_options(self, s):
 409         if type(s) == type({}): return s  # fixme: type should be fixed
 410         if type(s) != type(""): return None
 411         if s.lower() == 'none': return None
 412         proxy = { "mode":"socks5", "host":"localhost" }
 413         args = s.split(':')
 414         n = 0
 415         if proxy_modes.count(args[n]) == 1:
 416             proxy["mode"] = args[n]
 417             n += 1
 418         if len(args) > n:
 419             proxy["host"] = args[n]
 420             n += 1
 421         if len(args) > n:
 422             proxy["port"] = args[n]
 423         else:
 424             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 425         return proxy
 426
 427
 428     def set_server(self, server, proxy=None):
 429         # raise an error if the format isnt correct
 430         a,b,c = server.split(':')
 431         b = int(b)
 432         assert c in 'stgh'
 433         # set the server
 434         if server != self.server or proxy != self.proxy:
 435             print "changing server:", server, proxy
 436             self.server = server
 437             self.proxy = proxy
 438             if self.protocol in 'st':
 439                 self.s.shutdown(socket.SHUT_RDWR)
 440                 self.s.close()
 441             self.is_connected = False  # this exits the polling loop
 442             self.trigger_callback('disconnecting') # for actively disconnecting
 443
 444     def is_empty(self, channel):
 445         q = self.responses.get(channel)
 446         if q:
 447             return q.empty()
 448         else:
 449             return True
 450
 451
 452     def get_pending_requests(self, channel):
 453         result = []
 454         with self.lock:
 455             for k, v in self.unanswered_requests.items():
 456                 a, b, c = v
 457                 if c == channel: result.append(k)
 458         return result
 459
 460     def is_up_to_date(self, channel):
 461         return self.is_empty(channel) and not self.get_pending_requests(channel)
 462
 463
 464     def synchronous_get(self, requests, timeout=100000000):
 465         # todo: use generators, unanswered_requests should be a list of arrays...
 466         ids = self.send(requests)
 467         id2 = ids[:]
 468         res = {}
 469         while ids:
 470             r = self.responses['default'].get(True, timeout)
 471             _id = r.get('id')
 472             if _id in ids:
 473                 ids.remove(_id)
 474                 res[_id] = r.get('result')
 475         out = []
 476         for _id in id2:
 477             out.append(res[_id])
 478         return out
 479
 480
 481     def start(self):
 482         threading.Thread.start(self)
 483         # wait until connection is established
 484         self.connect_event.wait()
 485
 486     def run(self):
 487         while True:
 488             self.init_interface()
 489             if self.is_connected:
 490                 self.resend_subscriptions()
 491                 self.run_tcp() if self.protocol in 'st' else self.run_http()
 492
 493             self.trigger_callback('disconnected')
 494
 495             if not self.loop: break
 496             time.sleep(5)
 497
 498
 499