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