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