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