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