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