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