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