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             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 "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. we should 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.address.subscribe':
 101                 addr = params[0]
 102                 result = params[1]
 103                 params = [addr]
 104
 105             with self.lock:
 106                 for k,v in self.subscriptions.items():
 107                     if (method, params) in v:
 108                         channel = k
 109                         break
 110                 else:
 111                     print "received unexpected notification", method, params
 112                     print self.subscriptions
 113                     return
 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         self.is_connected = True
 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
 267                 while True:
 268                     s = out.find('\n')
 269                     if s==-1: break
 270                     c = out[0:s]
 271                     out = out[s+1:]
 272                     c = json.loads(c)
 273                     self.queue_json_response(c)
 274
 275         except:
 276             traceback.print_exc(file=sys.stdout)
 277
 278         self.is_connected = False
 279
 280
 281     def send_tcp(self, messages, channel='default'):
 282         """return the ids of the requests that we sent"""
 283         out = ''
 284         ids = []
 285         for m in messages:
 286             method, params = m
 287             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 288             self.unanswered_requests[self.message_id] = method, params, channel
 289             ids.append(self.message_id)
 290             # uncomment to debug
 291             # print "-->",request
 292             self.message_id += 1
 293             out += request + '\n'
 294         while out:
 295             try:
 296                 sent = self.s.send( out )
 297                 out = out[sent:]
 298             except:
 299                 # this happens when we get disconnected
 300                 print "Not connected, cannot send"
 301                 return None
 302         return ids
 303
 304
 305
 306     def __init__(self, config=None, loop=False):
 307
 308         if config is None:
 309             from simple_config import SimpleConfig
 310             config = SimpleConfig()
 311
 312         threading.Thread.__init__(self)
 313         self.daemon = True
 314         self.loop = loop
 315         self.config = config
 316         self.connect_event = threading.Event()
 317
 318         self.subscriptions = {}
 319         self.responses = {}
 320         self.responses['default'] = Queue.Queue()
 321
 322         self.callbacks = {}
 323         self.lock = threading.Lock()
 324
 325         self.servers = [] # actual list from IRC
 326         self.rtime = 0
 327         self.bytes_received = 0
 328
 329
 330
 331     def init_interface(self):
 332         if self.config.get('server'):
 333             self.init_with_server(self.config)
 334         else:
 335             print "Using random server..."
 336             servers = DEFAULT_SERVERS[:]
 337             while servers:
 338                 server = random.choice( servers )
 339                 servers.remove(server)
 340                 self.config.set_key('server', server, False)
 341                 self.init_with_server(self.config)
 342                 if self.is_connected: break
 343
 344             if not servers:
 345                 print 'no server available'
 346                 self.is_connected = False
 347                 self.connect_event.set() # to finish start
 348                 self.server = 'ecdsa.org:50001:t'
 349                 self.proxy = None
 350                 return
 351
 352         self.connect_event.set()
 353         if self.is_connected:
 354             self.send([('server.version', [ELECTRUM_VERSION])])
 355             self.trigger_callback('connected')
 356         else:
 357             self.trigger_callback('notconnected')
 358             #print_error("Failed to connect " + self.connection_msg)
 359
 360
 361     def init_with_server(self, config):
 362
 363         s = config.get('server')
 364         host, port, protocol = s.split(':')
 365         port = int(port)
 366
 367         self.protocol = protocol
 368         proxy = self.parse_proxy_options(config.get('proxy'))
 369         self.server = host + ':%d:%s'%(port, protocol)
 370
 371         #print protocol, host, port
 372         if protocol in 'st':
 373             self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
 374         elif protocol in 'gh':
 375             self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
 376         else:
 377             raise BaseException('Unknown protocol: %s'%protocol)
 378
 379
 380     def send(self, messages, channel='default'):
 381
 382         sub = []
 383         for message in messages:
 384             m, v = message
 385             if m[-10:] == '.subscribe':
 386                 sub.append(message)
 387
 388         if sub:
 389             with self.lock:
 390                 if self.subscriptions.get(channel) is None:
 391                     self.subscriptions[channel] = []
 392                 self.subscriptions[channel] += sub
 393
 394         if self.protocol in 'st':
 395             with self.lock:
 396                 out = self.send_tcp(messages, channel)
 397         else:
 398             # do not use lock, http is synchronous
 399             out = self.send_http(messages, channel)
 400
 401         return out
 402
 403     def resend_subscriptions(self):
 404         for channel, messages in self.subscriptions.items():
 405             if messages:
 406                 self.send(messages, channel)
 407
 408
 409
 410     def parse_proxy_options(self, s):
 411         if type(s) == type({}): return s  # fixme: type should be fixed
 412         if type(s) != type(""): return None
 413         if s.lower() == 'none': return None
 414         proxy = { "mode":"socks5", "host":"localhost" }
 415         args = s.split(':')
 416         n = 0
 417         if proxy_modes.count(args[n]) == 1:
 418             proxy["mode"] = args[n]
 419             n += 1
 420         if len(args) > n:
 421             proxy["host"] = args[n]
 422             n += 1
 423         if len(args) > n:
 424             proxy["port"] = args[n]
 425         else:
 426             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 427         return proxy
 428
 429
 430     def set_server(self, server, proxy=None):
 431         # raise an error if the format isnt correct
 432         a,b,c = server.split(':')
 433         b = int(b)
 434         assert c in 'stgh'
 435         # set the server
 436         if server != self.server or proxy != self.proxy:
 437             print "changing server:", server, proxy
 438             self.server = server
 439             self.proxy = proxy
 440             if self.protocol in 'st':
 441                 self.s.shutdown(socket.SHUT_RDWR)
 442                 self.s.close()
 443             self.is_connected = False  # this exits the polling loop
 444             self.trigger_callback('disconnecting') # for actively disconnecting
 445
 446     def is_empty(self, channel):
 447         q = self.responses.get(channel)
 448         if q:
 449             return q.empty()
 450         else:
 451             return True
 452
 453
 454     def get_pending_requests(self, channel):
 455         result = []
 456         with self.lock:
 457             for k, v in self.unanswered_requests.items():
 458                 a, b, c = v
 459                 if c == channel: result.append(k)
 460         return result
 461
 462     def is_up_to_date(self, channel):
 463         return self.is_empty(channel) and not self.get_pending_requests(channel)
 464
 465
 466     def synchronous_get(self, requests, timeout=100000000):
 467         # todo: use generators, unanswered_requests should be a list of arrays...
 468         ids = self.send(requests)
 469         id2 = ids[:]
 470         res = {}
 471         while ids:
 472             r = self.responses['default'].get(True, timeout)
 473             _id = r.get('id')
 474             if _id in ids:
 475                 ids.remove(_id)
 476                 res[_id] = r.get('result')
 477         out = []
 478         for _id in id2:
 479             out.append(res[_id])
 480         return out
 481
 482
 483     def start(self):
 484         threading.Thread.start(self)
 485         # wait until connection is established
 486         self.connect_event.wait()
 487
 488     def run(self):
 489         while True:
 490             self.init_interface()
 491             if self.is_connected:
 492                 self.resend_subscriptions()
 493                 self.run_tcp() if self.protocol in 'st' else self.run_http()
 494
 495             self.trigger_callback('disconnected')
 496
 497             if not self.loop: break
 498             time.sleep(5)
 499
 500
 501