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