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, PROTOCOL_VERSION
  24 from util import print_error, print_msg
  25
  26
  27 DEFAULT_TIMEOUT = 5
  28 DEFAULT_PORTS = {'t':'50001', 's':'50002', 'h':'8081', 'g':'8082'}
  29
  30 DEFAULT_SERVERS = {
  31     'electrum.thecoinwillprevail.com': {'h': '8081', 's': '50002', 't': '50001'},
  32     'the9ull.homelinux.org': {'h': '8082', 't': '50001'},
  33     'electra.datemas.de': {'h': '8081', 's': '50002', 't': '50001', 'g': '808'},
  34     'electrum.datemas.de': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
  35     'ecdsa.org': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
  36     'electrum.mooo.com': {'h': '8081', 't': '50001'},
  37     'btcback.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
  38     'electrum.bitcoins.sk': {'h': '8081', 's': '50002', 't': '50001', 'g': '8'},
  39     'electrum.no-ip.org': {'h': '80', 's': '50002', 't': '50001', 'g': '443'},
  40     'electrum.drollette.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
  41     'btc.it-zone.org': {'h': '80', 's': '110', 't': '50001', 'g': '443'},
  42     'electrum.yacoin.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
  43     'electrum.be': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'}
  44 }
  45
  46
  47
  48 def filter_protocol(servers, p):
  49     l = []
  50     for k, protocols in servers.items():
  51         if p in protocols:
  52             l.append( ':'.join([k, protocols[p], p]) )
  53     return l
  54
  55
  56
  57 proxy_modes = ['socks4', 'socks5', 'http']
  58
  59
  60 def pick_random_server():
  61     return random.choice( filter_protocol(DEFAULT_SERVERS,'s') )
  62
  63
  64
  65
  66 class Interface(threading.Thread):
  67
  68     def register_callback(self, event, callback):
  69         with self.lock:
  70             if not self.callbacks.get(event):
  71                 self.callbacks[event] = []
  72             self.callbacks[event].append(callback)
  73
  74     def trigger_callback(self, event):
  75         with self.lock:
  76             callbacks = self.callbacks.get(event,[])[:]
  77         if callbacks:
  78             [callback() for callback in callbacks]
  79
  80     def init_server(self, host, port, proxy=None, use_ssl=True):
  81         self.host = host
  82         self.port = port
  83         self.proxy = proxy
  84         self.use_ssl = use_ssl
  85         self.poll_interval = 1
  86
  87         #json
  88         self.message_id = 0
  89         self.unanswered_requests = {}
  90         #banner
  91         self.banner = ''
  92
  93
  94     def queue_json_response(self, c):
  95
  96         # uncomment to debug
  97         # print_error( "<--",c )
  98
  99         msg_id = c.get('id')
 100         error = c.get('error')
 101
 102         if error:
 103             print_error("received error:", c)
 104             if msg_id is not None:
 105                 with self.lock:
 106                     method, params, channel = self.unanswered_requests.pop(msg_id)
 107                 response_queue = self.responses[channel]
 108                 response_queue.put({'method':method, 'params':params, 'error':error, 'id':msg_id})
 109
 110             return
 111
 112         if msg_id is not None:
 113             with self.lock:
 114                 method, params, channel = self.unanswered_requests.pop(msg_id)
 115             result = c.get('result')
 116
 117             if method == 'server.version':
 118                 self.server_version = result
 119
 120             elif method == 'server.banner':
 121                 self.banner = result
 122                 self.trigger_callback('banner')
 123
 124             elif method == 'server.peers.subscribe':
 125                 servers = {}
 126                 for item in result:
 127
 128                     host = item[1]
 129                     out = {}
 130
 131                     version = None
 132                     pruning_level = '-'
 133                     if len(item) > 2:
 134                         for v in item[2]:
 135                             if re.match("[stgh]\d*", v):
 136                                 protocol, port = v[0], v[1:]
 137                                 if port == '': port = DEFAULT_PORTS[protocol]
 138                                 out[protocol] = port
 139                             elif re.match("v(.?)+", v):
 140                                 version = v[1:]
 141                             elif re.match("p\d*", v):
 142                                 pruning_level = v[1:]
 143                                 if pruning_level == '': pruning_level = '0'
 144                     try:
 145                         is_recent = float(version)>=float(PROTOCOL_VERSION)
 146                     except:
 147                         is_recent = False
 148
 149                     if out and is_recent:
 150                         out['pruning'] = pruning_level
 151                         servers[host] = out
 152
 153                 self.servers = servers
 154                 self.trigger_callback('peers')
 155
 156         else:
 157             # notification: find the channel(s)
 158             method = c.get('method')
 159             params = c.get('params')
 160
 161             if method == 'blockchain.numblocks.subscribe':
 162                 result = params[0]
 163                 params = []
 164
 165             elif method == 'blockchain.headers.subscribe':
 166                 result = params[0]
 167                 params = []
 168
 169             elif method == 'blockchain.address.subscribe':
 170                 addr = params[0]
 171                 result = params[1]
 172                 params = [addr]
 173
 174             with self.lock:
 175                 for k,v in self.subscriptions.items():
 176                     if (method, params) in v:
 177                         channel = k
 178                         break
 179                 else:
 180                     print_error( "received unexpected notification", method, params)
 181                     print_error( self.subscriptions )
 182                     return
 183
 184         response_queue = self.responses[channel]
 185         response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
 186
 187
 188
 189     def get_response(self, channel='default', block=True, timeout=10000000000):
 190         return self.responses[channel].get(block, timeout)
 191
 192     def register_channel(self, channel):
 193         with self.lock:
 194             self.responses[channel] = Queue.Queue()
 195
 196     def poke(self, channel):
 197         self.responses[channel].put(None)
 198
 199
 200     def init_http(self, host, port, proxy=None, use_ssl=True):
 201         self.init_server(host, port, proxy, use_ssl)
 202         self.session_id = None
 203         self.is_connected = True
 204         self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
 205         try:
 206             self.poll()
 207         except:
 208             print_error("http init session failed")
 209             self.is_connected = False
 210             return
 211
 212         if self.session_id:
 213             print_error('http session:',self.session_id)
 214             self.is_connected = True
 215         else:
 216             self.is_connected = False
 217
 218     def run_http(self):
 219         self.is_connected = True
 220         while self.is_connected:
 221             try:
 222                 if self.session_id:
 223                     self.poll()
 224                 time.sleep(self.poll_interval)
 225             except socket.gaierror:
 226                 break
 227             except socket.error:
 228                 break
 229             except:
 230                 traceback.print_exc(file=sys.stdout)
 231                 break
 232
 233         self.is_connected = False
 234
 235
 236     def poll(self):
 237         self.send([])
 238
 239
 240     def send_http(self, messages, channel='default'):
 241         import urllib2, json, time, cookielib
 242         print_error( "send_http", messages )
 243
 244         if self.proxy:
 245             import socks
 246             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
 247             socks.wrapmodule(urllib2)
 248
 249         cj = cookielib.CookieJar()
 250         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 251         urllib2.install_opener(opener)
 252
 253         t1 = time.time()
 254
 255         data = []
 256         for m in messages:
 257             method, params = m
 258             if type(params) != type([]): params = [params]
 259             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 260             self.unanswered_requests[self.message_id] = method, params, channel
 261             self.message_id += 1
 262
 263         if data:
 264             data_json = json.dumps(data)
 265         else:
 266             # poll with GET
 267             data_json = None
 268
 269
 270         headers = {'content-type': 'application/json'}
 271         if self.session_id:
 272             headers['cookie'] = 'SESSION=%s'%self.session_id
 273
 274         try:
 275             req = urllib2.Request(self.connection_msg, data_json, headers)
 276             response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
 277         except:
 278             return
 279
 280         for index, cookie in enumerate(cj):
 281             if cookie.name=='SESSION':
 282                 self.session_id = cookie.value
 283
 284         response = response_stream.read()
 285         self.bytes_received += len(response)
 286         if response:
 287             response = json.loads( response )
 288             if type(response) is not type([]):
 289                 self.queue_json_response(response)
 290             else:
 291                 for item in response:
 292                     self.queue_json_response(item)
 293
 294         if response:
 295             self.poll_interval = 1
 296         else:
 297             if self.poll_interval < 15:
 298                 self.poll_interval += 1
 299         #print self.poll_interval, response
 300
 301         self.rtime = time.time() - t1
 302         self.is_connected = True
 303
 304
 305
 306
 307     def init_tcp(self, host, port, proxy=None, use_ssl=True):
 308         self.init_server(host, port, proxy, use_ssl)
 309
 310         global proxy_modes
 311         self.connection_msg = "%s:%d"%(self.host,self.port)
 312         if self.proxy is None:
 313             s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
 314         else:
 315             self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
 316             import socks
 317             s = socks.socksocket()
 318             s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
 319
 320         if self.use_ssl:
 321             s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23, do_handshake_on_connect=True)
 322
 323         s.settimeout(2)
 324         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 325
 326         try:
 327             s.connect(( self.host.encode('ascii'), int(self.port)))
 328         except:
 329             traceback.print_exc(file=sys.stdout)
 330             self.is_connected = False
 331             self.s = None
 332             return
 333
 334         s.settimeout(60)
 335         self.s = s
 336         self.is_connected = True
 337
 338     def run_tcp(self):
 339         try:
 340             #if self.use_ssl: self.s.do_handshake()
 341             out = ''
 342             while self.is_connected:
 343                 try:
 344                     timeout = False
 345                     msg = self.s.recv(1024)
 346                 except socket.timeout:
 347                     timeout = True
 348                 except ssl.SSLError:
 349                     timeout = True
 350                 except socket.error, err:
 351                     if err.errno in [11, 10035]:
 352                         print_error("socket errno", err.errno)
 353                         time.sleep(0.1)
 354                         continue
 355                     else:
 356                         traceback.print_exc(file=sys.stdout)
 357                         raise
 358
 359                 if timeout:
 360                     # ping the server with server.version, as a real ping does not exist yet
 361                     self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
 362                     continue
 363
 364                 out += msg
 365                 self.bytes_received += len(msg)
 366                 if msg == '':
 367                     self.is_connected = False
 368
 369                 while True:
 370                     s = out.find('\n')
 371                     if s==-1: break
 372                     c = out[0:s]
 373                     out = out[s+1:]
 374                     c = json.loads(c)
 375                     self.queue_json_response(c)
 376
 377         except:
 378             traceback.print_exc(file=sys.stdout)
 379
 380         self.is_connected = False
 381
 382
 383     def send_tcp(self, messages, channel='default'):
 384         """return the ids of the requests that we sent"""
 385         out = ''
 386         ids = []
 387         for m in messages:
 388             method, params = m
 389             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 390             self.unanswered_requests[self.message_id] = method, params, channel
 391             ids.append(self.message_id)
 392             # uncomment to debug
 393             # print "-->",request
 394             self.message_id += 1
 395             out += request + '\n'
 396         while out:
 397             try:
 398                 sent = self.s.send( out )
 399                 out = out[sent:]
 400             except:
 401                 # this happens when we get disconnected
 402                 print_error( "Not connected, cannot send" )
 403                 return None
 404         return ids
 405
 406
 407
 408     def __init__(self, config=None, loop=False):
 409         self.server = random.choice(filter_protocol(DEFAULT_SERVERS, 's'))
 410         self.proxy = None
 411
 412         if config is None:
 413             from simple_config import SimpleConfig
 414             config = SimpleConfig()
 415
 416         threading.Thread.__init__(self)
 417         self.daemon = True
 418         self.loop = loop
 419         self.config = config
 420         self.connect_event = threading.Event()
 421
 422         self.subscriptions = {}
 423         self.responses = {}
 424         self.responses['default'] = Queue.Queue()
 425
 426         self.callbacks = {}
 427         self.lock = threading.Lock()
 428
 429         self.servers = {} # actual list from IRC
 430         self.rtime = 0
 431         self.bytes_received = 0
 432         self.is_connected = False
 433
 434
 435
 436     def init_interface(self):
 437         if self.config.get('server'):
 438             self.init_with_server(self.config)
 439         else:
 440             if self.config.get('auto_cycle') is None:
 441                 self.config.set_key('auto_cycle', True, False)
 442
 443         if not self.is_connected and self.config.get('auto_cycle'):
 444             print_msg("Using random server...")
 445             servers = filter_protocol(DEFAULT_SERVERS, 's')
 446             while servers:
 447                 server = random.choice( servers )
 448                 servers.remove(server)
 449                 print server
 450                 self.config.set_key('server', server, False)
 451                 self.init_with_server(self.config)
 452                 if self.is_connected: break
 453
 454             if not self.is_connected:
 455                 print 'no server available'
 456                 self.connect_event.set() # to finish start
 457                 self.server = 'ecdsa.org:50001:t'
 458                 self.proxy = None
 459                 return
 460
 461         self.connect_event.set()
 462         if self.is_connected:
 463             self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
 464             self.send([('server.banner',[])])
 465             self.trigger_callback('connected')
 466         else:
 467             self.trigger_callback('notconnected')
 468             #print_error("Failed to connect " + self.connection_msg)
 469
 470
 471     def init_with_server(self, config):
 472
 473         s = config.get('server')
 474         host, port, protocol = s.split(':')
 475         port = int(port)
 476
 477         self.protocol = protocol
 478         proxy = self.parse_proxy_options(config.get('proxy'))
 479         self.server = host + ':%d:%s'%(port, protocol)
 480
 481         #print protocol, host, port
 482         if protocol in 'st':
 483             self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
 484         elif protocol in 'gh':
 485             self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
 486         else:
 487             raise BaseException('Unknown protocol: %s'%protocol)
 488
 489
 490     def send(self, messages, channel='default'):
 491
 492         sub = []
 493         for message in messages:
 494             m, v = message
 495             if m[-10:] == '.subscribe':
 496                 sub.append(message)
 497
 498         if sub:
 499             with self.lock:
 500                 if self.subscriptions.get(channel) is None:
 501                     self.subscriptions[channel] = []
 502                 for message in sub:
 503                     if message not in self.subscriptions[channel]:
 504                         self.subscriptions[channel].append(message)
 505
 506         if not self.is_connected:
 507             return
 508
 509         if self.protocol in 'st':
 510             with self.lock:
 511                 out = self.send_tcp(messages, channel)
 512         else:
 513             # do not use lock, http is synchronous
 514             out = self.send_http(messages, channel)
 515
 516         return out
 517
 518     def resend_subscriptions(self):
 519         for channel, messages in self.subscriptions.items():
 520             if messages:
 521                 self.send(messages, channel)
 522
 523
 524
 525     def parse_proxy_options(self, s):
 526         if type(s) == type({}): return s  # fixme: type should be fixed
 527         if type(s) != type(""): return None
 528         if s.lower() == 'none': return None
 529         proxy = { "mode":"socks5", "host":"localhost" }
 530         args = s.split(':')
 531         n = 0
 532         if proxy_modes.count(args[n]) == 1:
 533             proxy["mode"] = args[n]
 534             n += 1
 535         if len(args) > n:
 536             proxy["host"] = args[n]
 537             n += 1
 538         if len(args) > n:
 539             proxy["port"] = args[n]
 540         else:
 541             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 542         return proxy
 543
 544
 545     def set_server(self, server, proxy=None):
 546         # raise an error if the format isnt correct
 547         a,b,c = server.split(':')
 548         b = int(b)
 549         assert c in 'stgh'
 550         # set the server
 551         if server != self.server or proxy != self.proxy:
 552             print "changing server:", server, proxy
 553             self.server = server
 554             self.proxy = proxy
 555             if self.is_connected and self.protocol in 'st' and self.s:
 556                 self.s.shutdown(socket.SHUT_RDWR)
 557                 self.s.close()
 558             self.is_connected = False  # this exits the polling loop
 559             self.trigger_callback('disconnecting') # for actively disconnecting
 560
 561     def stop(self):
 562         if self.is_connected and self.protocol in 'st' and self.s:
 563             self.s.shutdown(socket.SHUT_RDWR)
 564             self.s.close()
 565
 566
 567     def get_servers(self):
 568         if not self.servers:
 569             return DEFAULT_SERVERS
 570         else:
 571             return self.servers
 572
 573
 574     def is_empty(self, channel):
 575         q = self.responses.get(channel)
 576         if q:
 577             return q.empty()
 578         else:
 579             return True
 580
 581
 582     def get_pending_requests(self, channel):
 583         result = []
 584         with self.lock:
 585             for k, v in self.unanswered_requests.items():
 586                 a, b, c = v
 587                 if c == channel: result.append(k)
 588         return result
 589
 590     def is_up_to_date(self, channel):
 591         return self.is_empty(channel) and not self.get_pending_requests(channel)
 592
 593
 594     def synchronous_get(self, requests, timeout=100000000):
 595         # todo: use generators, unanswered_requests should be a list of arrays...
 596         ids = self.send(requests)
 597         id2 = ids[:]
 598         res = {}
 599         while ids:
 600             r = self.responses['default'].get(True, timeout)
 601             _id = r.get('id')
 602             if _id in ids:
 603                 ids.remove(_id)
 604                 res[_id] = r.get('result')
 605         out = []
 606         for _id in id2:
 607             out.append(res[_id])
 608         return out
 609
 610
 611     def start(self, wait=True):
 612         threading.Thread.start(self)
 613         if wait:
 614             # wait until connection is established
 615             self.connect_event.wait()
 616             if not self.is_connected:
 617                 return False
 618         return True
 619
 620     def run(self):
 621         while True:
 622             self.init_interface()
 623             if self.is_connected:
 624                 self.resend_subscriptions()
 625                 self.run_tcp() if self.protocol in 'st' else self.run_http()
 626
 627             self.trigger_callback('disconnected')
 628
 629             if not self.loop: break
 630             time.sleep(5)
 631
 632
 633