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