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