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