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