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