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