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