use named callbacks with the interface
[electrum-nvc.git] / lib / interface.py
index 83722de..7f3b4eb 100644 (file)
@@ -23,55 +23,47 @@ 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', 
-                    'uncle-enzo.info: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
+DEFAULT_SERVERS = [ 
+    'electrum.novit.ro:50001:t', 
+    'electrum.pdmc.net:50001:t',
+    'ecdsa.org:50001:t',
+    'electrum.bitcoins.sk:50001:t',
+    'uncle-enzo.info:50001:t',
+    'electrum.bytesized-hosting.com:50001:t',
+    'electrum.bitcoin.cz:50001:t',
+    'electrum.bitfoo.org:50001:t'
+    ]
+
+proxy_modes = ['socks4', 'socks5', 'http']
+
+
+def pick_random_server():
+    return random.choice( DEFAULT_SERVERS )
+
+
+
 
 class Interface(threading.Thread):
-    def __init__(self, host, port, debug_server, proxy):
-        threading.Thread.__init__(self)
-        self.daemon = True
+
+    def register_callback(self, event, callback):
+        with self.lock:
+            self.callbacks[event] = callback
+
+    def trigger_callback(self, event):
+        with self.lock:
+            callback = self.callbacks.get(event)
+        if callback:
+            callback()
+            
+
+
+    def init_server(self, host, port, proxy=None, use_ssl=True):
         self.host = host
         self.port = port
         self.proxy = proxy
+        self.use_ssl = use_ssl
 
         self.servers = [] # actual list from IRC
         self.rtime = 0
@@ -82,22 +74,14 @@ class Interface(threading.Thread):
 
         #json
         self.message_id = 0
-        self.responses = Queue.Queue()
         self.unanswered_requests = {}
 
-        self.debug_server = debug_server
 
-    def init_socket(self):
-        pass
-
-    def poke(self):
-        # push a fake response so that the getting thread exits its loop
-        self.responses.put(None)
 
     def queue_json_response(self, c):
 
-        if self.debug_server:
-          print "<--",c
+        # uncomment to debug
+        # print "<--",c
 
         msg_id = c.get('id')
         error = c.get('error')
@@ -107,12 +91,19 @@ class Interface(threading.Thread):
             return
 
         if msg_id is not None:
-            method, params = self.unanswered_requests.pop(msg_id)
+            with self.lock: 
+                method, params, channel = self.unanswered_requests.pop(msg_id)
             result = c.get('result')
         else:
-            # notification
+            # notification. we should find the channel(s)..
             method = c.get('method')
             params = c.get('params')
+            with self.lock:
+                for k,v in self.subscriptions.items():
+                    if (method, params) in v:
+                        channel = k
+                else:
+                    raise
 
             if method == 'blockchain.numblocks.subscribe':
                 result = params[0]
@@ -123,42 +114,30 @@ class Interface(threading.Thread):
                 result = params[1]
                 params = [addr]
 
-        self.responses.put({'method':method, 'params':params, 'result':result})
-
+                
+        response_queue = self.responses[channel]
+        response_queue.put({'method':method, 'params':params, 'result':result, 'id':msg_id})
 
 
-    def subscribe(self, addresses):
-        messages = []
-        for addr in addresses:
-            messages.append(('blockchain.address.subscribe', [addr]))
-        self.send(messages)
 
+    def get_response(self, channel='default', block=True, timeout=10000000000):
+        return self.responses[channel].get(block, timeout)
 
+    def register_channel(self, channel):
+        with self.lock:
+            self.responses[channel] = Queue.Queue()
 
+    def poke(self, channel):
+        self.responses[channel].put(None)
 
-class PollingInterface(Interface):
-    """ non-persistent connection. synchronous calls"""
 
-    def __init__(self, host, port, debug_server, proxy):
-        Interface.__init__(self, host, port, debug_server, proxy)
+    def init_http(self, host, port, proxy=None, use_ssl=True):
+        self.init_server(host, port, proxy, use_ssl)
         self.session_id = None
-        self.debug_server = debug_server
+        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):
+    def run_http(self):
         self.is_connected = True
         while self.is_connected:
             try:
@@ -174,28 +153,20 @@ class PollingInterface(Interface):
                 break
             
         self.is_connected = False
-        self.poke()
 
                 
-
-
-
-
-
-
-
-class HttpStratumInterface(PollingInterface):
-
     def poll(self):
         self.send([])
 
-    def send(self, messages):
+
+    def send_http(self, messages, channel='default'):
         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)
@@ -207,7 +178,7 @@ class HttpStratumInterface(PollingInterface):
             method, params = m
             if type(params) != type([]): params = [params]
             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
-            self.unanswered_requests[self.message_id] = method, params
+            self.unanswered_requests[self.message_id] = method, params, channel
             self.message_id += 1
 
         if data:
@@ -216,12 +187,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):
@@ -251,39 +222,43 @@ class HttpStratumInterface(PollingInterface):
 
 
 
-class TcpStratumInterface(Interface):
-    """json-rpc over persistent TCP connection, asynchronous"""
+    def init_tcp(self, host, port, proxy=None, use_ssl=True):
+        self.init_server(host, port, proxy, use_ssl)
 
-    def __init__(self, host, port, debug_server, proxy):
-        Interface.__init__(self, host, port, debug_server, proxy)
-        self.debug_server = debug_server
-
-    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):
+
+    def run_tcp(self):
         try:
             out = ''
             while self.is_connected:
                 try: msg = self.s.recv(1024)
                 except socket.timeout:
+                    print "timeout"
                     # ping the server with server.version, as a real ping does not exist yet
                     self.send([('server.version', [ELECTRUM_VERSION])])
                     continue
@@ -305,167 +280,205 @@ class TcpStratumInterface(Interface):
             traceback.print_exc(file=sys.stdout)
 
         self.is_connected = False
-        print "Poking"
-        self.poke()
 
-    def send(self, messages):
+
+    def send_tcp(self, messages, channel='default'):
+        """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
-
-            if self.debug_server:
-              print "-->",request
-
+            self.unanswered_requests[self.message_id] = method, params, channel
+            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:]
-
-    def get_history(self, addr):
-        self.send([('blockchain.address.get_history', [addr])])
-
+        return ids
 
 
 
+    def __init__(self, config=None, loop=False):
 
-class WalletSynchronizer(threading.Thread):
+        if config is None:
+            from simple_config import SimpleConfig
+            config = SimpleConfig()
 
-    def __init__(self, wallet, loop=False, servers_loaded_callback=None, proxy=None):
         threading.Thread.__init__(self)
         self.daemon = True
-        self.wallet = wallet
         self.loop = loop
-        self.proxy = proxy
+        self.config = config
+
+        self.subscriptions = {}
+        self.responses = {}
+        self.responses['default'] = Queue.Queue()
+
+        self.callbacks = {}
+        self.lock = threading.Lock()
         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.init_with_server(self.config)
+        else:
+            print "Using random server..."
+            servers = DEFAULT_SERVERS
+            while servers:
+                server = random.choice( servers )
+                servers.remove(server)
+                self.config.set_key('server', server, False)
+                self.init_with_server(self.config)
+                if self.is_connected: break
+
+            if not servers:
+                raise BaseException('no server available')
+
+        if self.is_connected:
+            self.send([('server.version', [ELECTRUM_VERSION])])
+            self.trigger_callback('connected')
+        else:
+            self.trigger_callback('notconnected')
+            #print_error("Failed to connect " + self.connection_msg)
+
+
+    def init_with_server(self, config):
+            
+        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 == 't':
-            InterfaceClass = TcpStratumInterface
-        elif protocol == 'h':
-            InterfaceClass = HttpStratumInterface
+        if protocol in 'st':
+            self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
+        elif protocol in 'gh':
+            self.init_http(host, port, proxy, use_ssl=(protocol=='g'))
         else:
-            print_error("Error: Unknown protocol")
-            InterfaceClass = TcpStratumInterface
+            raise BaseException('Unknown protocol: %s'%protocol)
 
-        self.interface = InterfaceClass(host, port, self.wallet.debug_server, self.proxy)
-        self.wallet.interface = self.interface
 
-    def handle_response(self, r):
-        if r is None:
-            return
+    def send(self, messages, channel='default'):
 
-        method = r['method']
-        params = r['params']
-        result = r['result']
-
-        if method == 'server.banner':
-            self.wallet.banner = result
-            self.wallet.was_updated = True
-
-        elif method == 'server.peers.subscribe':
-            servers = []
-            for item in result:
-                s = []
-                host = item[1]
-                ports = []
-                version = None
-                if len(item) > 2:
-                    for v in item[2]:
-                        if re.match("[th]\d+", v):
-                            ports.append((v[0], v[1:]))
-                        if re.match("v(.?)+", v):
-                            version = v[1:]
-                if ports and version:
-                    servers.append((host, ports))
-            self.interface.servers = servers
-            # servers_loaded_callback is None for commands, but should
-            # NEVER be None when using the GUI.
-            if self.servers_loaded_callback is not None:
-                self.servers_loaded_callback()
-
-        elif method == 'blockchain.address.subscribe':
-            addr = params[0]
-            self.wallet.receive_status_callback(addr, result)
-                            
-        elif method == 'blockchain.address.get_history':
-            addr = params[0]
-            self.wallet.receive_history_callback(addr, result)
-            self.wallet.was_updated = True
-
-        elif method == 'blockchain.transaction.broadcast':
-            self.wallet.tx_result = result
-            self.wallet.tx_event.set()
-
-        elif method == 'blockchain.numblocks.subscribe':
-            self.wallet.blocks = result
-            self.wallet.was_updated = True
-
-        elif method == 'server.version':
-            pass
+        sub = []
+        for message in messages:
+            m, v = message
+            if m[-10:] == '.subscribe':
+                sub.append(message)
 
+        if sub:
+            with self.lock:
+                if self.subscriptions.get(channel) is None: 
+                    self.subscriptions[channel] = []
+                self.subscriptions[channel] += sub
+
+        if self.protocol in 'st':
+            with self.lock:
+                out = self.send_tcp(messages, channel)
+        else:
+            # do not use lock, http is synchronous
+            out = self.send_http(messages, channel)
+
+        return out
+
+    def resend_subscriptions(self):
+        for channel, messages in self.subscriptions.items():
+            if messages:
+                self.send(messages, channel)
+
+
+
+    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:
-            print_error("Error: Unknown message:" + method + ", " + params + ", " + result)
+            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
+            if self.protocol in 'st':
+                self.s.shutdown(socket.SHUT_RDWR)
+                self.s.close()
+            self.is_connected = False  # this exits the polling loop
+
+
+    def is_empty(self, channel):
+        q = self.responses.get(channel)
+        if q: 
+            return q.empty()
+        else:
+            return True
+
+
+    def get_pending_requests(self, channel):
+        result = []
+        with self.lock:
+            for k, v in self.unanswered_requests.items():
+                a, b, c = v
+                if c == channel: result.append(k)
+        return result
+
+    def is_up_to_date(self, channel):
+        return self.is_empty(channel) and not self.get_pending_requests(channel)
 
 
-    def start_interface(self):
-        self.interface.init_socket()
-        self.interface.start()
-        if self.interface.is_connected:
-            self.wallet.start_session(self.interface)
+    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['default'].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
 
 
 
     def run(self):
-        import socket, time
-        self.start_interface()
         while True:
-            while self.interface.is_connected:
-                new_addresses = self.wallet.synchronize()
-                if new_addresses:
-                    self.interface.subscribe(new_addresses)
-
-                if self.wallet.is_up_to_date():
-                    if not self.wallet.up_to_date:
-                        self.wallet.up_to_date = True
-                        self.wallet.was_updated = True
-                        self.wallet.up_to_date_event.set()
-                else:
-                    if self.wallet.up_to_date:
-                        self.wallet.up_to_date = False
-                        self.wallet.was_updated = True
-
-                if self.wallet.was_updated:
-                    self.wallet.trigger_callbacks()
-                    self.wallet.was_updated = False
-
-                response = self.interface.responses.get()
-                self.handle_response(response)
-
-            self.wallet.trigger_callbacks()
-            if self.loop:
-                time.sleep(5)
-                # Server has been changed. Copy callback for new interface.
-                self.proxy = self.interface.proxy
-                self.init_interface()
-                self.start_interface()
-                continue
-            else:
-                break
+            self.run_tcp() if self.protocol in 'st' else self.run_http()
+            self.trigger_callback('disconnected')
+            if not self.loop: break
+
+            time.sleep(5)
+            self.init_interface()
+            self.resend_subscriptions()