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