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