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