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