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