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