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 = [ 'electrum.novit.ro:50001:t',
  29                     'electrum.bytesized-hosting.com:50001:t']  # list of default servers
  30
  31 proxy_modes = ['socks4', 'socks5', 'http']
  32
  33 def pick_random_server():
  34     print "using random server"
  35     return random.choice( DEFAULT_SERVERS )
  36
  37
  38
  39
  40
  41
  42 class InterfaceAncestor(threading.Thread):
  43
  44     def __init__(self, host, port, proxy=None):
  45         threading.Thread.__init__(self)
  46         self.daemon = True
  47         self.host = host
  48         self.port = port
  49         self.proxy = proxy
  50
  51         self.servers = [] # actual list from IRC
  52         self.rtime = 0
  53         self.bytes_received = 0
  54
  55         self.is_connected = True
  56         self.poll_interval = 1
  57
  58         #json
  59         self.message_id = 0
  60         self.responses = Queue.Queue()
  61         self.unanswered_requests = {}
  62
  63     def init_socket(self):
  64         pass
  65
  66     def poke(self):
  67         # push a fake response so that the getting thread exits its loop
  68         self.responses.put(None)
  69
  70     def queue_json_response(self, c):
  71
  72         # uncomment to debug
  73         # print "<--",c
  74
  75         msg_id = c.get('id')
  76         error = c.get('error')
  77
  78         if error:
  79             print "received error:", c
  80             return
  81
  82         if msg_id is not None:
  83             method, params = self.unanswered_requests.pop(msg_id)
  84             result = c.get('result')
  85         else:
  86             # notification
  87             method = c.get('method')
  88             params = c.get('params')
  89
  90             if method == 'blockchain.numblocks.subscribe':
  91                 result = params[0]
  92                 params = []
  93
  94             elif method == 'blockchain.address.subscribe':
  95                 addr = params[0]
  96                 result = params[1]
  97                 params = [addr]
  98
  99         self.responses.put({'method':method, 'params':params, 'result':result})
 100
 101
 102
 103     def subscribe(self, addresses):
 104         messages = []
 105         for addr in addresses:
 106             messages.append(('blockchain.address.subscribe', [addr]))
 107         self.send(messages)
 108
 109
 110
 111
 112
 113 class HttpStratumInterface(InterfaceAncestor):
 114     """ non-persistent connection. synchronous calls"""
 115
 116     def __init__(self, host, port, proxy=None):
 117         InterfaceAncestor.__init__(self, host, port, proxy)
 118         self.session_id = None
 119
 120     def get_history(self, address):
 121         self.send([('blockchain.address.get_history', [address] )])
 122
 123     def run(self):
 124         self.is_connected = True
 125         while self.is_connected:
 126             try:
 127                 if self.session_id:
 128                     self.poll()
 129                 time.sleep(self.poll_interval)
 130             except socket.gaierror:
 131                 break
 132             except socket.error:
 133                 break
 134             except:
 135                 traceback.print_exc(file=sys.stdout)
 136                 break
 137
 138         self.is_connected = False
 139         self.poke()
 140
 141
 142     def poll(self):
 143         self.send([])
 144
 145     def send(self, messages):
 146         import urllib2, json, time, cookielib
 147
 148         if self.proxy:
 149             import socks
 150             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 151             socks.wrapmodule(urllib2)
 152
 153         cj = cookielib.CookieJar()
 154         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 155         urllib2.install_opener(opener)
 156
 157         t1 = time.time()
 158
 159         data = []
 160         for m in messages:
 161             method, params = m
 162             if type(params) != type([]): params = [params]
 163             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 164             self.unanswered_requests[self.message_id] = method, params
 165             self.message_id += 1
 166
 167         if data:
 168             data_json = json.dumps(data)
 169         else:
 170             # poll with GET
 171             data_json = None
 172
 173         host = 'http://%s:%d'%( self.host, self.port )
 174         headers = {'content-type': 'application/json'}
 175         if self.session_id:
 176             headers['cookie'] = 'SESSION=%s'%self.session_id
 177
 178         req = urllib2.Request(host, data_json, headers)
 179         response_stream = urllib2.urlopen(req)
 180
 181         for index, cookie in enumerate(cj):
 182             if cookie.name=='SESSION':
 183                 self.session_id = cookie.value
 184
 185         response = response_stream.read()
 186         self.bytes_received += len(response)
 187         if response:
 188             response = json.loads( response )
 189             if type(response) is not type([]):
 190                 self.queue_json_response(response)
 191             else:
 192                 for item in response:
 193                     self.queue_json_response(item)
 194
 195         if response:
 196             self.poll_interval = 1
 197         else:
 198             if self.poll_interval < 15:
 199                 self.poll_interval += 1
 200         #print self.poll_interval, response
 201
 202         self.rtime = time.time() - t1
 203         self.is_connected = True
 204
 205
 206
 207
 208 class TcpStratumInterface(InterfaceAncestor):
 209     """json-rpc over persistent TCP connection, asynchronous"""
 210
 211     def __init__(self, host, port, proxy=None):
 212         InterfaceAncestor.__init__(self, host, port, proxy)
 213
 214     def init_socket(self):
 215         global proxy_modes
 216         connection_msg = "%s:%d"%(self.host,self.port)
 217         if self.proxy is None:
 218             self.s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
 219         else:
 220             connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
 221             import socks
 222             self.s = socks.socksocket()
 223             self.s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 224         self.s.settimeout(60)
 225         self.s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 226         try:
 227             self.s.connect(( self.host.encode('ascii'), int(self.port)))
 228             self.is_connected = True
 229             self.send([('server.version', [ELECTRUM_VERSION])])
 230             print "Connected to " + connection_msg
 231         except:
 232             self.is_connected = False
 233             print_error("Failed to connect" + connection_msg)
 234
 235     def run(self):
 236         try:
 237             out = ''
 238             while self.is_connected:
 239                 try: msg = self.s.recv(1024)
 240                 except socket.timeout:
 241                     # ping the server with server.version, as a real ping does not exist yet
 242                     self.send([('server.version', [ELECTRUM_VERSION])])
 243                     continue
 244                 out += msg
 245                 self.bytes_received += len(msg)
 246                 if msg == '':
 247                     self.is_connected = False
 248                     print "Disconnected."
 249
 250                 while True:
 251                     s = out.find('\n')
 252                     if s==-1: break
 253                     c = out[0:s]
 254                     out = out[s+1:]
 255                     c = json.loads(c)
 256                     self.queue_json_response(c)
 257
 258         except:
 259             traceback.print_exc(file=sys.stdout)
 260
 261         self.is_connected = False
 262         print "Poking"
 263         self.poke()
 264
 265     def send(self, messages):
 266         out = ''
 267         for m in messages:
 268             method, params = m
 269             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 270             self.unanswered_requests[self.message_id] = method, params
 271
 272             # uncomment to debug
 273             # print "-->",request
 274
 275             self.message_id += 1
 276             out += request + '\n'
 277
 278         while out:
 279             sent = self.s.send( out )
 280             out = out[sent:]
 281
 282     def get_history(self, addr):
 283         self.send([('blockchain.address.get_history', [addr])])
 284
 285
 286
 287 class Interface(TcpStratumInterface, HttpStratumInterface):
 288
 289     def __init__(self, config):
 290
 291         try:
 292             s = config.get('server')
 293             host, port, protocol = s.split(':')
 294             port = int(port)
 295         except:
 296             s = pick_random_server()
 297             host, port, protocol = s.split(':')
 298             port = int(port)
 299
 300         self.protocol = protocol
 301         proxy = self.parse_proxy_options(config.get('proxy'))
 302         self.server = host + ':%d:%s'%(port, protocol)
 303
 304         #print protocol, host, port
 305         if protocol == 't':
 306             TcpStratumInterface.__init__(self, host, port, proxy)
 307         elif protocol == 'h':
 308             HttpStratumInterface.__init__(self, host, port, proxy)
 309         else:
 310             print_error("Error: Unknown protocol")
 311             TcpStratumInterface.__init__(self, host, port, proxy)
 312
 313
 314     def run(self):
 315         if self.protocol == 't':
 316             TcpStratumInterface.run(self)
 317         else:
 318             HttpStratumInterface.run(self)
 319
 320     def send(self, messages):
 321         if self.protocol == 't':
 322             TcpStratumInterface.send(self, messages)
 323         else:
 324             HttpStratumInterface.send(self, messages)
 325
 326
 327     def parse_proxy_options(self, s):
 328         if type(s) == type({}): return s  # fixme: type should be fixed
 329         if type(s) != type(""): return None
 330         if s.lower() == 'none': return None
 331         proxy = { "mode":"socks5", "host":"localhost" }
 332         args = s.split(':')
 333         n = 0
 334         if proxy_modes.count(args[n]) == 1:
 335             proxy["mode"] = args[n]
 336             n += 1
 337         if len(args) > n:
 338             proxy["host"] = args[n]
 339             n += 1
 340         if len(args) > n:
 341             proxy["port"] = args[n]
 342         else:
 343             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 344         return proxy
 345
 346
 347     def set_server(self, server, proxy=None):
 348         # raise an error if the format isnt correct
 349         a,b,c = server.split(':')
 350         b = int(b)
 351         assert c in ['t', 'h']
 352         # set the server
 353         if server != self.server or proxy != self.proxy:
 354             print "changing server:", server, proxy
 355             self.server = server
 356             self.proxy = proxy
 357             self.is_connected = False  # this exits the polling loop
 358             self.poke()
 359
 360
 361
 362
 363
 364
 365 class WalletSynchronizer(threading.Thread):
 366
 367     def __init__(self, wallet, config, loop=False, servers_loaded_callback=None):
 368         threading.Thread.__init__(self)
 369         self.daemon = True
 370         self.wallet = wallet
 371         self.loop = loop
 372         self.config = config
 373         self.init_interface()
 374         self.servers_loaded_callback = servers_loaded_callback
 375
 376     def init_interface(self):
 377         self.interface = Interface(self.config)
 378         self.wallet.interface = self.interface
 379
 380     def handle_response(self, r):
 381         if r is None:
 382             return
 383
 384         method = r['method']
 385         params = r['params']
 386         result = r['result']
 387
 388         if method == 'server.banner':
 389             self.wallet.banner = result
 390             self.wallet.was_updated = True
 391
 392         elif method == 'server.peers.subscribe':
 393             servers = []
 394             for item in result:
 395                 s = []
 396                 host = item[1]
 397                 ports = []
 398                 version = None
 399                 if len(item) > 2:
 400                     for v in item[2]:
 401                         if re.match("[th]\d+", v):
 402                             ports.append((v[0], v[1:]))
 403                         if re.match("v(.?)+", v):
 404                             version = v[1:]
 405                 if ports and version:
 406                     servers.append((host, ports))
 407             self.interface.servers = servers
 408             # servers_loaded_callback is None for commands, but should
 409             # NEVER be None when using the GUI.
 410             if self.servers_loaded_callback is not None:
 411                 self.servers_loaded_callback()
 412
 413         elif method == 'blockchain.address.subscribe':
 414             addr = params[0]
 415             self.wallet.receive_status_callback(addr, result)
 416
 417         elif method == 'blockchain.address.get_history':
 418             addr = params[0]
 419             self.wallet.receive_history_callback(addr, result)
 420             self.wallet.was_updated = True
 421
 422         elif method == 'blockchain.transaction.broadcast':
 423             self.wallet.tx_result = result
 424             self.wallet.tx_event.set()
 425
 426         elif method == 'blockchain.numblocks.subscribe':
 427             self.wallet.blocks = result
 428             self.wallet.was_updated = True
 429
 430         elif method == 'server.version':
 431             pass
 432
 433         else:
 434             print_error("Error: Unknown message:" + method + ", " + params + ", " + result)
 435
 436
 437     def start_interface(self):
 438         self.interface.init_socket()
 439         self.interface.start()
 440         if self.interface.is_connected:
 441             self.wallet.start_session(self.interface)
 442
 443
 444
 445     def run(self):
 446         import socket, time
 447         self.start_interface()
 448         while True:
 449             while self.interface.is_connected:
 450                 new_addresses = self.wallet.synchronize()
 451                 if new_addresses:
 452                     self.interface.subscribe(new_addresses)
 453
 454                 if self.wallet.is_up_to_date():
 455                     if not self.wallet.up_to_date:
 456                         self.wallet.up_to_date = True
 457                         self.wallet.was_updated = True
 458                         self.wallet.up_to_date_event.set()
 459                 else:
 460                     if self.wallet.up_to_date:
 461                         self.wallet.up_to_date = False
 462                         self.wallet.was_updated = True
 463
 464                 if self.wallet.was_updated:
 465                     self.wallet.trigger_callbacks()
 466                     self.wallet.was_updated = False
 467
 468                 response = self.interface.responses.get()
 469                 self.handle_response(response)
 470
 471             self.wallet.trigger_callbacks()
 472             if self.loop:
 473                 time.sleep(5)
 474                 # Server has been changed. Copy callback for new interface.
 475                 self.proxy = self.interface.proxy
 476                 self.init_interface()
 477                 self.start_interface()
 478                 continue
 479             else:
 480                 break
 481
 482
 483