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