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             return
 200
 201         if self.session_id:
 202             print_error('http session:',self.session_id)
 203             self.is_connected = True
 204
 205     def run_http(self):
 206         self.is_connected = True
 207         while self.is_connected:
 208             try:
 209                 if self.session_id:
 210                     self.poll()
 211                 time.sleep(self.poll_interval)
 212             except socket.gaierror:
 213                 break
 214             except socket.error:
 215                 break
 216             except:
 217                 traceback.print_exc(file=sys.stdout)
 218                 break
 219
 220         self.is_connected = False
 221
 222
 223     def poll(self):
 224         self.send([])
 225
 226
 227     def send_http(self, messages, channel='default'):
 228         import urllib2, json, time, cookielib
 229
 230         if self.proxy:
 231             import socks
 232             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
 233             socks.wrapmodule(urllib2)
 234
 235         cj = cookielib.CookieJar()
 236         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 237         urllib2.install_opener(opener)
 238
 239         t1 = time.time()
 240
 241         data = []
 242         for m in messages:
 243             method, params = m
 244             if type(params) != type([]): params = [params]
 245             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 246             self.unanswered_requests[self.message_id] = method, params, channel
 247             self.message_id += 1
 248
 249         if data:
 250             data_json = json.dumps(data)
 251         else:
 252             # poll with GET
 253             data_json = None
 254
 255
 256         headers = {'content-type': 'application/json'}
 257         if self.session_id:
 258             headers['cookie'] = 'SESSION=%s'%self.session_id
 259
 260         try:
 261             req = urllib2.Request(self.connection_msg, data_json, headers)
 262             response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
 263         except:
 264             return
 265
 266         for index, cookie in enumerate(cj):
 267             if cookie.name=='SESSION':
 268                 self.session_id = cookie.value
 269
 270         response = response_stream.read()
 271         self.bytes_received += len(response)
 272         if response:
 273             response = json.loads( response )
 274             if type(response) is not type([]):
 275                 self.queue_json_response(response)
 276             else:
 277                 for item in response:
 278                     self.queue_json_response(item)
 279
 280         if response:
 281             self.poll_interval = 1
 282         else:
 283             if self.poll_interval < 15:
 284                 self.poll_interval += 1
 285         #print self.poll_interval, response
 286
 287         self.rtime = time.time() - t1
 288         self.is_connected = True
 289
 290
 291
 292
 293     def init_tcp(self, host, port, proxy=None, use_ssl=True):
 294         self.init_server(host, port, proxy, use_ssl)
 295
 296         global proxy_modes
 297         self.connection_msg = "%s:%d"%(self.host,self.port)
 298         if self.proxy is None:
 299             s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
 300         else:
 301             self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
 302             import socks
 303             s = socks.socksocket()
 304             s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
 305
 306         if self.use_ssl:
 307             s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
 308
 309         s.settimeout(2)
 310         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 311
 312         try:
 313             s.connect(( self.host.encode('ascii'), int(self.port)))
 314             s.settimeout(60)
 315             self.s = s
 316             self.is_connected = True
 317         except:
 318             self.is_connected = False
 319             self.s = None
 320
 321
 322     def run_tcp(self):
 323         try:
 324             out = ''
 325             while self.is_connected:
 326
 327                 try:
 328                     timeout = False
 329                     msg = self.s.recv(1024)
 330                 except socket.timeout:
 331                     timeout = True
 332                 except ssl.SSLError:
 333                     timeout = True
 334
 335                 if timeout:
 336                     # ping the server with server.version, as a real ping does not exist yet
 337                     self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
 338                     continue
 339
 340                 out += msg
 341                 self.bytes_received += len(msg)
 342                 if msg == '':
 343                     self.is_connected = False
 344
 345                 while True:
 346                     s = out.find('\n')
 347                     if s==-1: break
 348                     c = out[0:s]
 349                     out = out[s+1:]
 350                     c = json.loads(c)
 351                     self.queue_json_response(c)
 352
 353         except:
 354             traceback.print_exc(file=sys.stdout)
 355
 356         self.is_connected = False
 357
 358
 359     def send_tcp(self, messages, channel='default'):
 360         """return the ids of the requests that we sent"""
 361         out = ''
 362         ids = []
 363         for m in messages:
 364             method, params = m
 365             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 366             self.unanswered_requests[self.message_id] = method, params, channel
 367             ids.append(self.message_id)
 368             # uncomment to debug
 369             # print "-->",request
 370             self.message_id += 1
 371             out += request + '\n'
 372         while out:
 373             try:
 374                 sent = self.s.send( out )
 375                 out = out[sent:]
 376             except:
 377                 # this happens when we get disconnected
 378                 print_error( "Not connected, cannot send" )
 379                 return None
 380         return ids
 381
 382
 383
 384     def __init__(self, config=None, loop=False):
 385         self.server = None
 386         self.proxy = None
 387
 388         if config is None:
 389             from simple_config import SimpleConfig
 390             config = SimpleConfig()
 391
 392         threading.Thread.__init__(self)
 393         self.daemon = True
 394         self.loop = loop
 395         self.config = config
 396         self.connect_event = threading.Event()
 397
 398         self.subscriptions = {}
 399         self.responses = {}
 400         self.responses['default'] = Queue.Queue()
 401
 402         self.callbacks = {}
 403         self.lock = threading.Lock()
 404
 405         self.servers = {} # actual list from IRC
 406         self.rtime = 0
 407         self.bytes_received = 0
 408         self.is_connected = False
 409
 410
 411
 412     def init_interface(self):
 413         if self.config.get('server'):
 414             self.init_with_server(self.config)
 415         else:
 416             if self.config.get('auto_cycle') is None:
 417                 self.config.set_key('auto_cycle', True, False)
 418
 419         if not self.is_connected and self.config.get('auto_cycle'):
 420             print_msg("Using random server...")
 421             servers_tcp = DEFAULT_SERVERS[:]
 422             servers_http = DEFAULT_HTTP_SERVERS[:]
 423             while servers_tcp or servers_http:
 424                 if servers_tcp:
 425                     server = random.choice( servers_tcp )
 426                     servers_tcp.remove(server)
 427                 else:
 428                     # try HTTP if we can't get a TCP connection
 429                     server = random.choice( servers_http )
 430                     servers_http.remove(server)
 431                 print server
 432                 self.config.set_key('server', server, False)
 433                 self.init_with_server(self.config)
 434                 if self.is_connected: break
 435
 436             if not self.is_connected:
 437                 print 'no server available'
 438                 self.connect_event.set() # to finish start
 439                 self.server = 'ecdsa.org:50001:t'
 440                 self.proxy = None
 441                 return
 442
 443         self.connect_event.set()
 444         if self.is_connected:
 445             self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
 446             self.send([('server.banner',[])])
 447             self.trigger_callback('connected')
 448         else:
 449             self.trigger_callback('notconnected')
 450             #print_error("Failed to connect " + self.connection_msg)
 451
 452
 453     def init_with_server(self, config):
 454
 455         s = config.get('server')
 456         host, port, protocol = s.split(':')
 457         port = int(port)
 458
 459         self.protocol = protocol
 460         proxy = self.parse_proxy_options(config.get('proxy'))
 461         self.server = host + ':%d:%s'%(port, protocol)
 462
 463         #print protocol, host, port
 464         if protocol in 'st':
 465             self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
 466         elif protocol in 'gh':
 467             self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
 468         else:
 469             raise BaseException('Unknown protocol: %s'%protocol)
 470
 471
 472     def send(self, messages, channel='default'):
 473
 474         sub = []
 475         for message in messages:
 476             m, v = message
 477             if m[-10:] == '.subscribe':
 478                 sub.append(message)
 479
 480         if sub:
 481             with self.lock:
 482                 if self.subscriptions.get(channel) is None:
 483                     self.subscriptions[channel] = []
 484                 for message in sub:
 485                     if message not in self.subscriptions[channel]:
 486                         self.subscriptions[channel].append(message)
 487
 488         if not self.is_connected:
 489             return
 490
 491         if self.protocol in 'st':
 492             with self.lock:
 493                 out = self.send_tcp(messages, channel)
 494         else:
 495             # do not use lock, http is synchronous
 496             out = self.send_http(messages, channel)
 497
 498         return out
 499
 500     def resend_subscriptions(self):
 501         for channel, messages in self.subscriptions.items():
 502             if messages:
 503                 self.send(messages, channel)
 504
 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_list(self):
 550         plist = {}
 551         if not self.servers:
 552             servers_list = {}
 553             for x in DEFAULT_SERVERS:
 554                 h,port,protocol = x.split(':')
 555                 servers_list[h] = {'ports':[(protocol,port)]}
 556         else:
 557             servers_list = self.servers
 558
 559         for _host, v in servers_list.items():
 560             pp = v['ports']
 561             z = {}
 562             for item2 in pp:
 563                 _protocol, _port = item2
 564                 z[_protocol] = _port
 565             plist[_host] = z
 566
 567         return plist, servers_list
 568
 569
 570     def is_empty(self, channel):
 571         q = self.responses.get(channel)
 572         if q:
 573             return q.empty()
 574         else:
 575             return True
 576
 577
 578     def get_pending_requests(self, channel):
 579         result = []
 580         with self.lock:
 581             for k, v in self.unanswered_requests.items():
 582                 a, b, c = v
 583                 if c == channel: result.append(k)
 584         return result
 585
 586     def is_up_to_date(self, channel):
 587         return self.is_empty(channel) and not self.get_pending_requests(channel)
 588
 589
 590     def synchronous_get(self, requests, timeout=100000000):
 591         # todo: use generators, unanswered_requests should be a list of arrays...
 592         ids = self.send(requests)
 593         id2 = ids[:]
 594         res = {}
 595         while ids:
 596             r = self.responses['default'].get(True, timeout)
 597             _id = r.get('id')
 598             if _id in ids:
 599                 ids.remove(_id)
 600                 res[_id] = r.get('result')
 601         out = []
 602         for _id in id2:
 603             out.append(res[_id])
 604         return out
 605
 606
 607     def start(self, wait=True):
 608         threading.Thread.start(self)
 609         if wait:
 610             # wait until connection is established
 611             self.connect_event.wait()
 612             if not self.is_connected:
 613                 return False
 614         return True
 615
 616     def run(self):
 617         while True:
 618             self.init_interface()
 619             if self.is_connected:
 620                 self.resend_subscriptions()
 621                 self.run_tcp() if self.protocol in 'st' else self.run_http()
 622
 623             self.trigger_callback('disconnected')
 624
 625             if not self.loop: break
 626             time.sleep(5)
 627
 628
 629