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:50001:t',
  32     'electrum.bitcoins.sk:50001:t',
  33     'uncle-enzo.info:50001:t',
  34     'electrum.bytesized-hosting.com:50001:t',
  35     'electrum.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
  46
  47
  48 class Interface(threading.Thread):
  49
  50     def register_callback(self, update_callback):
  51         with self.lock:
  52             self.update_callbacks.append(update_callback)
  53
  54     def trigger_callbacks(self):
  55         with self.lock:
  56             callbacks = self.update_callbacks[:]
  57         [update() for update in callbacks]
  58
  59
  60     def init_server(self, host, port, proxy=None, use_ssl=True):
  61         self.host = host
  62         self.port = port
  63         self.proxy = proxy
  64         self.use_ssl = use_ssl
  65
  66         self.servers = [] # actual list from IRC
  67         self.rtime = 0
  68         self.bytes_received = 0
  69
  70         self.is_connected = True
  71         self.poll_interval = 1
  72
  73         #json
  74         self.message_id = 0
  75         self.unanswered_requests = {}
  76
  77
  78
  79     def queue_json_response(self, c):
  80
  81         # uncomment to debug
  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             with self.lock:
  93                 method, params, channel = self.unanswered_requests.pop(msg_id)
  94             result = c.get('result')
  95         else:
  96             # notification. we should find the channel(s)..
  97             method = c.get('method')
  98             params = c.get('params')
  99             with self.lock:
 100                 for k,v in self.subscriptions.items():
 101                     if (method, params) in v:
 102                         channel = k
 103                 else:
 104                     raise
 105
 106             if method == 'blockchain.numblocks.subscribe':
 107                 result = params[0]
 108                 params = []
 109
 110             elif method == 'blockchain.address.subscribe':
 111                 addr = params[0]
 112                 result = params[1]
 113                 params = [addr]
 114
 115         response_queue = self.responses[channel]
 116         response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
 117
 118
 119
 120     def get_response(self, channel='default', block=True, timeout=10000000000):
 121         return self.responses[channel].get(block, timeout)
 122
 123     def register_channel(self, channel):
 124         with self.lock:
 125             self.responses[channel] = Queue.Queue()
 126
 127     def poke(self, channel):
 128         self.responses[channel].put(None)
 129
 130
 131     def init_http(self, host, port, proxy=None, use_ssl=True):
 132         self.init_server(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
 137     def run_http(self):
 138         self.is_connected = True
 139         while self.is_connected:
 140             try:
 141                 if self.session_id:
 142                     self.poll()
 143                 time.sleep(self.poll_interval)
 144             except socket.gaierror:
 145                 break
 146             except socket.error:
 147                 break
 148             except:
 149                 traceback.print_exc(file=sys.stdout)
 150                 break
 151
 152         self.is_connected = False
 153
 154
 155     def poll(self):
 156         self.send([])
 157
 158
 159     def send_http(self, messages, channel='default'):
 160         import urllib2, json, time, cookielib
 161
 162         if self.proxy:
 163             import socks
 164             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 165             socks.wrapmodule(urllib2)
 166
 167         cj = cookielib.CookieJar()
 168         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 169         urllib2.install_opener(opener)
 170
 171         t1 = time.time()
 172
 173         data = []
 174         for m in messages:
 175             method, params = m
 176             if type(params) != type([]): params = [params]
 177             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 178             self.unanswered_requests[self.message_id] = method, params, channel
 179             self.message_id += 1
 180
 181         if data:
 182             data_json = json.dumps(data)
 183         else:
 184             # poll with GET
 185             data_json = None
 186
 187
 188         headers = {'content-type': 'application/json'}
 189         if self.session_id:
 190             headers['cookie'] = 'SESSION=%s'%self.session_id
 191
 192         req = urllib2.Request(self.connection_msg, data_json, headers)
 193         response_stream = urllib2.urlopen(req)
 194
 195         for index, cookie in enumerate(cj):
 196             if cookie.name=='SESSION':
 197                 self.session_id = cookie.value
 198
 199         response = response_stream.read()
 200         self.bytes_received += len(response)
 201         if response:
 202             response = json.loads( response )
 203             if type(response) is not type([]):
 204                 self.queue_json_response(response)
 205             else:
 206                 for item in response:
 207                     self.queue_json_response(item)
 208
 209         if response:
 210             self.poll_interval = 1
 211         else:
 212             if self.poll_interval < 15:
 213                 self.poll_interval += 1
 214         #print self.poll_interval, response
 215
 216         self.rtime = time.time() - t1
 217         self.is_connected = True
 218
 219
 220
 221
 222     def init_tcp(self, host, port, proxy=None, use_ssl=True):
 223         self.init_server(host, port, proxy, use_ssl)
 224
 225         import ssl
 226         global proxy_modes
 227         self.connection_msg = "%s:%d"%(self.host,self.port)
 228         if self.proxy is None:
 229             s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
 230         else:
 231             self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
 232             import socks
 233             s = socks.socksocket()
 234             s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
 235
 236         if self.use_ssl:
 237             s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
 238
 239         s.settimeout(2)
 240         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 241
 242         try:
 243             s.connect(( self.host.encode('ascii'), int(self.port)))
 244             s.settimeout(60)
 245             self.s = s
 246             self.is_connected = True
 247         except:
 248             self.is_connected = False
 249             self.s = None
 250
 251
 252     def run_tcp(self):
 253         try:
 254             out = ''
 255             while self.is_connected:
 256                 try: msg = self.s.recv(1024)
 257                 except socket.timeout:
 258                     print "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
 281
 282     def send_tcp(self, messages, channel='default'):
 283         """return the ids of the requests that we sent"""
 284         out = ''
 285         ids = []
 286         for m in messages:
 287             method, params = m
 288             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 289             self.unanswered_requests[self.message_id] = method, params, channel
 290             ids.append(self.message_id)
 291             # uncomment to debug
 292             # print "-->",request
 293             self.message_id += 1
 294             out += request + '\n'
 295         while out:
 296             sent = self.s.send( out )
 297             out = out[sent:]
 298         return ids
 299
 300
 301
 302     def __init__(self, config=None, loop=False, servers_loaded_callback=None):
 303
 304         if config is None:
 305             from simple_config import SimpleConfig
 306             config = SimpleConfig()
 307
 308         threading.Thread.__init__(self)
 309         self.daemon = True
 310         self.loop = loop
 311         self.config = config
 312         self.servers_loaded_callback = servers_loaded_callback
 313
 314         self.subscriptions = {}
 315         self.responses = {}
 316         self.responses['default'] = Queue.Queue()
 317
 318         self.update_callbacks = []
 319         self.lock = threading.Lock()
 320         self.init_interface()
 321
 322
 323
 324     def init_interface(self):
 325         if self.config.get('server'):
 326             self.init_with_server(self.config)
 327         else:
 328             print "Using random server..."
 329             servers = DEFAULT_SERVERS
 330             while servers:
 331                 server = random.choice( servers )
 332                 servers.remove(server)
 333                 self.config.set_key('server', server, False)
 334                 self.init_with_server(self.config)
 335                 if self.is_connected: break
 336
 337             if not servers:
 338                 raise BaseException('no server available')
 339
 340         if self.is_connected:
 341             print "Connected to " + self.connection_msg
 342             self.send([('server.version', [ELECTRUM_VERSION])])
 343             #self.send([('server.banner',[])], 'synchronizer')
 344         else:
 345             print_error("Failed to connect " + self.connection_msg)
 346
 347
 348     def init_with_server(self, config):
 349
 350         s = config.get('server')
 351         host, port, protocol = s.split(':')
 352         port = int(port)
 353
 354         self.protocol = protocol
 355         proxy = self.parse_proxy_options(config.get('proxy'))
 356         self.server = host + ':%d:%s'%(port, protocol)
 357
 358         #print protocol, host, port
 359         if protocol in 'st':
 360             self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
 361         elif protocol in 'gh':
 362             self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
 363         else:
 364             raise BaseException('Unknown protocol: %s'%protocol)
 365
 366
 367     def send(self, messages, channel='default'):
 368
 369         sub = []
 370         for message in messages:
 371             m, v = message
 372             if m[-10:] == '.subscribe':
 373                 sub.append(message)
 374
 375         if sub:
 376             with self.lock:
 377                 if self.subscriptions.get(channel) is None:
 378                     self.subscriptions[channel] = []
 379                 self.subscriptions[channel] += sub
 380
 381         if self.protocol in 'st':
 382             with self.lock:
 383                 out = self.send_tcp(messages, channel)
 384         else:
 385             # do not use lock, http is synchronous
 386             out = self.send_http(messages, channel)
 387
 388         return out
 389
 390     def resend_subscriptions(self):
 391         for channel, messages in self.subscriptions.items():
 392             if messages:
 393                 self.send(messages, channel)
 394
 395
 396
 397     def parse_proxy_options(self, s):
 398         if type(s) == type({}): return s  # fixme: type should be fixed
 399         if type(s) != type(""): return None
 400         if s.lower() == 'none': return None
 401         proxy = { "mode":"socks5", "host":"localhost" }
 402         args = s.split(':')
 403         n = 0
 404         if proxy_modes.count(args[n]) == 1:
 405             proxy["mode"] = args[n]
 406             n += 1
 407         if len(args) > n:
 408             proxy["host"] = args[n]
 409             n += 1
 410         if len(args) > n:
 411             proxy["port"] = args[n]
 412         else:
 413             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 414         return proxy
 415
 416
 417     def set_server(self, server, proxy=None):
 418         # raise an error if the format isnt correct
 419         a,b,c = server.split(':')
 420         b = int(b)
 421         assert c in 'stgh'
 422         # set the server
 423         if server != self.server or proxy != self.proxy:
 424             print "changing server:", server, proxy
 425             self.server = server
 426             self.proxy = proxy
 427             if self.protocol in 'st':
 428                 self.s.shutdown(socket.SHUT_RDWR)
 429                 self.s.close()
 430             self.is_connected = False  # this exits the polling loop
 431
 432
 433     def is_empty(self, channel):
 434         q = self.responses.get(channel)
 435         if q:
 436             return q.empty()
 437         else:
 438             return True
 439
 440
 441     def get_pending_requests(self, channel):
 442         result = []
 443         with self.lock:
 444             for k, v in self.unanswered_requests.items():
 445                 a, b, c = v
 446                 if c == channel: result.append(k)
 447         return result
 448
 449     def is_up_to_date(self, channel):
 450         return self.is_empty(channel) and not self.get_pending_requests(channel)
 451
 452
 453     def synchronous_get(self, requests, timeout=100000000):
 454         # todo: use generators, unanswered_requests should be a list of arrays...
 455         ids = self.send(requests)
 456         id2 = ids[:]
 457         res = {}
 458         while ids:
 459             r = self.responses['default'].get(True, timeout)
 460             _id = r.get('id')
 461             if _id in ids:
 462                 ids.remove(_id)
 463                 res[_id] = r.get('result')
 464         out = []
 465         for _id in id2:
 466             out.append(res[_id])
 467         return out
 468
 469
 470
 471     def run(self):
 472         while True:
 473             self.run_tcp() if self.protocol in 'st' else self.run_http()
 474             self.trigger_callbacks()
 475             if not self.loop: break
 476
 477             time.sleep(5)
 478             self.init_interface()
 479             self.resend_subscriptions()
 480
 481
 482