synchronous_get batch method for interface
[electrum-nvc.git] / lib / interface.py
index 1097831..9edfff0 100644 (file)
@@ -23,54 +23,46 @@ import threading, traceback, sys, time, json, Queue
 from version import ELECTRUM_VERSION
 from util import print_error
 
+
 DEFAULT_TIMEOUT = 5
-DEFAULT_SERVERS = [ 'ecdsa.org:50001:t', 
-                    'electrum.novit.ro:50001:t', 
-                    'electrum.bytesized-hosting.com:50001:t']  # list of default servers
-
-proxy_modes = ['none', 'socks4', 'socks5', 'http' ]
-
-def replace_keys(obj, old_key, new_key):
-    if isinstance(obj, dict):
-        if old_key in obj:
-            obj[new_key] = obj[old_key]
-            del obj[old_key]
-        for elem in obj.itervalues():
-            replace_keys(elem, old_key, new_key)
-    elif isinstance(obj, list):
-        for elem in obj:
-            replace_keys(elem, old_key, new_key)
-
-def old_to_new(d):
-    replace_keys(d, 'blk_hash', 'block_hash')
-    replace_keys(d, 'pos', 'index')
-    replace_keys(d, 'nTime', 'timestamp')
-    replace_keys(d, 'is_in', 'is_input')
-    replace_keys(d, 'raw_scriptPubKey', 'raw_output_script')
-
-def parse_proxy_options(s):
-    proxy = { "mode":"socks5", "host":"localhost" }
-    args = s.split(':')
-    n = 0
-    if proxy_modes.count(args[n]) == 1:
-        proxy["mode"] = args[n]
-        n += 1
-    if len(args) > n:
-        proxy["host"] = args[n]
-        n += 1
-    if len(args) > n:
-        proxy["port"] = args[n]
-    else:
-        proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
-    return proxy
-
-class Interface(threading.Thread):
-    def __init__(self, host, port, proxy):
+DEFAULT_SERVERS = [ 
+    'electrum.novit.ro:50001:t', 
+    'electrum.pdmc.net:50001:t',
+    #'ecdsa.org:50002:s',
+    'electrum.bitcoins.sk:50001:t',
+    'uncle-enzo.info:50001:t',
+    'electrum.bytesized-hosting.com:50001:t',
+    'california.stratum.bitcoin.cz:50001:t',
+    'electrum.bitfoo.org:50001:t'
+    ]
+
+proxy_modes = ['socks4', 'socks5', 'http']
+
+
+def pick_random_server():
+    return random_choice( DEFAULT_SERVERS )
+
+def pick_random_interface():
+    servers = DEFAULT_SERVERS
+    while servers:
+        server = random.choice( servers )
+        servers.remove(server)
+        i = Interface({'server':server})
+        if i.is_connected:
+            return i
+    raise BaseException('no server available')
+
+
+
+class InterfaceAncestor(threading.Thread):
+
+    def __init__(self, host, port, proxy=None, use_ssl=True):
         threading.Thread.__init__(self)
         self.daemon = True
         self.host = host
         self.port = port
         self.proxy = proxy
+        self.use_ssl = use_ssl
 
         self.servers = [] # actual list from IRC
         self.rtime = 0
@@ -84,8 +76,6 @@ class Interface(threading.Thread):
         self.responses = Queue.Queue()
         self.unanswered_requests = {}
 
-    def init_socket(self):
-        pass
 
     def poke(self):
         # push a fake response so that the getting thread exits its loop
@@ -120,7 +110,7 @@ class Interface(threading.Thread):
                 result = params[1]
                 params = [addr]
 
-        self.responses.put({'method':method, 'params':params, 'result':result})
+        self.responses.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
 
 
 
@@ -133,27 +123,18 @@ class Interface(threading.Thread):
 
 
 
-class PollingInterface(Interface):
+
+class HttpStratumInterface(InterfaceAncestor):
     """ non-persistent connection. synchronous calls"""
 
-    def __init__(self, host, port, proxy):
-        Interface.__init__(self, host, port, proxy)
+    def __init__(self, host, port, proxy=None, use_ssl=True):
+        InterfaceAncestor.__init__(self, host, port, proxy, use_ssl)
         self.session_id = None
+        self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
 
     def get_history(self, address):
         self.send([('blockchain.address.get_history', [address] )])
 
-    def poll(self):
-        pass
-        #if is_new or wallet.remote_url:
-        #    self.was_updated = True
-        #    is_new = wallet.synchronize()
-        #    wallet.update_tx_history()
-        #    wallet.save()
-        #    return is_new
-        #else:
-        #    return False
-
     def run(self):
         self.is_connected = True
         while self.is_connected:
@@ -173,25 +154,17 @@ class PollingInterface(Interface):
         self.poke()
 
                 
-
-
-
-
-
-
-
-class HttpStratumInterface(PollingInterface):
-
     def poll(self):
         self.send([])
 
     def send(self, messages):
         import urllib2, json, time, cookielib
         
-        if self.proxy["mode"] != "none":
+        if self.proxy:
             import socks
             socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
             socks.wrapmodule(urllib2)
+
         cj = cookielib.CookieJar()
         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
         urllib2.install_opener(opener)
@@ -212,12 +185,12 @@ class HttpStratumInterface(PollingInterface):
             # poll with GET
             data_json = None 
 
-        host = 'http://%s:%d'%( self.host, self.port )
+            
         headers = {'content-type': 'application/json'}
         if self.session_id:
             headers['cookie'] = 'SESSION=%s'%self.session_id
 
-        req = urllib2.Request(host, data_json, headers)
+        req = urllib2.Request(self.connection_msg, data_json, headers)
         response_stream = urllib2.urlopen(req)
 
         for index, cookie in enumerate(cj):
@@ -247,31 +220,40 @@ class HttpStratumInterface(PollingInterface):
 
 
 
-class TcpStratumInterface(Interface):
+class TcpStratumInterface(InterfaceAncestor):
     """json-rpc over persistent TCP connection, asynchronous"""
 
-    def __init__(self, host, port, proxy):
-        Interface.__init__(self, host, port, proxy)
+    def __init__(self, host, port, proxy=None, use_ssl=True):
+        InterfaceAncestor.__init__(self, host, port, proxy, use_ssl)
+        self.init_socket()
 
     def init_socket(self):
+        import ssl
         global proxy_modes
-        if self.proxy["mode"] == "none":
-            self.s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
+        self.connection_msg = "%s:%d"%(self.host,self.port)
+        if self.proxy is None:
+            s = socket.socket( socket.AF_INET, socket.SOCK_STREAM )
         else:
+            self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
             import socks
-            self.s = socks.socksocket()
-            print "Using Proxy", self.proxy
-            self.s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
-        self.s.settimeout(60)
-        self.s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+            s = socks.socksocket()
+            s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
+
+        if self.use_ssl:
+            s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
+            
+        s.settimeout(2)
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+
         try:
-            self.s.connect(( self.host.encode('ascii'), int(self.port)))
+            s.connect(( self.host.encode('ascii'), int(self.port)))
+            s.settimeout(60)
+            self.s = s
             self.is_connected = True
             self.send([('server.version', [ELECTRUM_VERSION])])
-            print "Connected to %s:%d"%(self.host,self.port)
         except:
             self.is_connected = False
-            print_error("Not connected")
+            self.s = None
 
     def run(self):
         try:
@@ -304,59 +286,146 @@ class TcpStratumInterface(Interface):
         self.poke()
 
     def send(self, messages):
+        """return the ids of the requests that we sent"""
         out = ''
+        ids = []
         for m in messages:
             method, params = m 
             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
             self.unanswered_requests[self.message_id] = method, params
-
+            ids.append(self.message_id)
             # uncomment to debug
             # print "-->",request
-
             self.message_id += 1
             out += request + '\n'
-
         while out:
             sent = self.s.send( out )
             out = out[sent:]
+        return ids
 
     def get_history(self, addr):
         self.send([('blockchain.address.get_history', [addr])])
 
 
 
+class Interface(TcpStratumInterface, HttpStratumInterface):
+    
+    def __init__(self, config = None):
+
+        if config is None:
+            from simple_config import SimpleConfig
+            config = SimpleConfig()
+            
+        s = config.get('server')
+        host, port, protocol = s.split(':')
+        port = int(port)
+
+        self.protocol = protocol
+        proxy = self.parse_proxy_options(config.get('proxy'))
+        self.server = host + ':%d:%s'%(port, protocol)
+
+        #print protocol, host, port
+        if protocol in 'st':
+            TcpStratumInterface.__init__(self, host, port, proxy, use_ssl=(protocol=='s'))
+        elif protocol in 'gh':
+            HttpStratumInterface.__init__(self, host, port, proxy, use_ssl=(protocol=='g'))
+        else:
+            raise BaseException('Unknown protocol: %s'%protocol)
+
+
+    def run(self):
+        if self.protocol  in 'st':
+            TcpStratumInterface.run(self)
+        else:
+            HttpStratumInterface.run(self)
+
+    def send(self, messages):
+        if self.protocol in 'st':
+            return TcpStratumInterface.send(self, messages)
+        else:
+            return HttpStratumInterface.send(self, messages)
+
+
+    def parse_proxy_options(self, s):
+        if type(s) == type({}): return s  # fixme: type should be fixed
+        if type(s) != type(""): return None  
+        if s.lower() == 'none': return None
+        proxy = { "mode":"socks5", "host":"localhost" }
+        args = s.split(':')
+        n = 0
+        if proxy_modes.count(args[n]) == 1:
+            proxy["mode"] = args[n]
+            n += 1
+        if len(args) > n:
+            proxy["host"] = args[n]
+            n += 1
+        if len(args) > n:
+            proxy["port"] = args[n]
+        else:
+            proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
+        return proxy
+
+
+    def set_server(self, server, proxy=None):
+        # raise an error if the format isnt correct
+        a,b,c = server.split(':')
+        b = int(b)
+        assert c in 'stgh'
+        # set the server
+        if server != self.server or proxy != self.proxy:
+            print "changing server:", server, proxy
+            self.server = server
+            self.proxy = proxy
+            self.is_connected = False  # this exits the polling loop
+            self.poke()
+
+
+    def is_up_to_date(self):
+        return self.responses.empty() and not self.unanswered_requests
+
+
+    def synchronous_get(self, requests, timeout=100000000):
+        # todo: use generators, unanswered_requests should be a list of arrays...
+        ids = self.send(requests)
+        id2 = ids[:]
+        res = {}
+        while ids:
+            r = self.responses.get(True, timeout)
+            _id = r.get('id')
+            if _id in ids:
+                ids.remove(_id)
+                res[_id] = r.get('result')
+        out = []
+        for _id in id2:
+            out.append(res[_id])
+        return out
+
+
 
 
 class WalletSynchronizer(threading.Thread):
 
-    def __init__(self, wallet, loop=False, servers_loaded_callback=None, proxy=None):
+    def __init__(self, wallet, config, loop=False, servers_loaded_callback=None):
         threading.Thread.__init__(self)
         self.daemon = True
         self.wallet = wallet
         self.loop = loop
-        self.proxy = proxy
+        self.config = config
         self.init_interface()
         self.servers_loaded_callback = servers_loaded_callback
 
     def init_interface(self):
-        try:
-            host, port, protocol = self.wallet.server.split(':')
-            port = int(port)
-        except:
-            self.wallet.pick_random_server()
-            host, port, protocol = self.wallet.server.split(':')
-            port = int(port)
+        if self.config.get('server'):
+            self.interface = Interface(self.config)
+        else:
+            print "Using random server..."
+            self.interface = pick_random_interface()
 
-        #print protocol, host, port
-        if protocol == 't':
-            InterfaceClass = TcpStratumInterface
-        elif protocol == 'h':
-            InterfaceClass = HttpStratumInterface
+        if self.interface.is_connected:
+            print "Connected to " + self.interface.connection_msg
         else:
-            print_error("Error: Unknown protocol")
-            InterfaceClass = TcpStratumInterface
+            print_error("Failed to connect " + self.interface.connection_msg)
 
-        self.interface = InterfaceClass(host, port, self.proxy)
         self.wallet.interface = self.interface
 
     def handle_response(self, r):
@@ -380,7 +449,7 @@ class WalletSynchronizer(threading.Thread):
                 version = None
                 if len(item) > 2:
                     for v in item[2]:
-                        if re.match("[th]\d+", v):
+                        if re.match("[stgh]\d+", v):
                             ports.append((v[0], v[1:]))
                         if re.match("v(.?)+", v):
                             version = v[1:]
@@ -417,7 +486,6 @@ class WalletSynchronizer(threading.Thread):
 
 
     def start_interface(self):
-        self.interface.init_socket()
         self.interface.start()
         if self.interface.is_connected:
             self.wallet.start_session(self.interface)
@@ -433,7 +501,7 @@ class WalletSynchronizer(threading.Thread):
                 if new_addresses:
                     self.interface.subscribe(new_addresses)
 
-                if self.wallet.is_up_to_date():
+                if self.interface.is_up_to_date():
                     if not self.wallet.up_to_date:
                         self.wallet.up_to_date = True
                         self.wallet.was_updated = True
@@ -461,5 +529,3 @@ class WalletSynchronizer(threading.Thread):
             else:
                 break
 
-
-