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