separate blockchain and network
[electrum-nvc.git] / lib / interface.py
index 1240720..faf165c 100644 (file)
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
-import random, socket, ast, re
+import random, socket, ast, re, ssl, errno
 import threading, traceback, sys, time, json, Queue
 
-from version import ELECTRUM_VERSION
-from util import print_error
+from version import ELECTRUM_VERSION, PROTOCOL_VERSION
+from util import print_error, print_msg
 
 
 DEFAULT_TIMEOUT = 5
-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'
-    ]
+DEFAULT_PORTS = {'t':'50001', 's':'50002', 'h':'8081', 'g':'8082'}
+
+DEFAULT_SERVERS = {
+    'the9ull.homelinux.org': {'h': '8082', 't': '50001'},
+    'electrum.coinwallet.me': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.dynaloop.net': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.koh.ms': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.novit.ro': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.stepkrav.pw': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'ecdsa.org': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.mooo.com': {'h': '8081', 't': '50001'},
+    'electrum.bitcoins.sk': {'h': '8081', 's': '50002', 't': '50001', 'g': '8'},
+    'electrum.no-ip.org': {'h': '80', 's': '50002', 't': '50001', 'g': '443'},
+    'electrum.drollette.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'btc.it-zone.org': {'h': '80', 's': '110', 't': '50001', 'g': '443'},
+    'electrum.yacoin.com': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'},
+    'electrum.be': {'h': '8081', 's': '50002', 't': '50001', 'g': '8082'}
+}
+
+
+
+def filter_protocol(servers, p):
+    l = []
+    for k, protocols in servers.items():
+        if p in protocols:
+            l.append( ':'.join([k, protocols[p], p]) )
+    return l
+    
+
 
 proxy_modes = ['socks4', 'socks5', 'http']
 
 
 def pick_random_server():
-    return random_choice( DEFAULT_SERVERS )
+    return random.choice( filter_protocol(DEFAULT_SERVERS,'s') )
 
-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):
+class Interface(threading.Thread):
 
-    def __init__(self, host, port, proxy=None, use_ssl=True):
-        threading.Thread.__init__(self)
-        self.daemon = True
+
+    def register_callback(self, event, callback):
+        with self.lock:
+            if not self.callbacks.get(event):
+                self.callbacks[event] = []
+            self.callbacks[event].append(callback)
+
+
+    def trigger_callback(self, event):
+        with self.lock:
+            callbacks = self.callbacks.get(event,[])[:]
+        if callbacks:
+            [callback() for callback in callbacks]
+
+
+    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
-        self.bytes_received = 0
-
-        self.is_connected = True
         self.poll_interval = 1
 
         #json
         self.message_id = 0
-        self.responses = Queue.Queue()
         self.unanswered_requests = {}
+        #banner
+        self.banner = ''
+        self.pending_transactions_for_notifications= []
+
+
+    def parse_servers(self, result):
+        """ parse servers list into dict format"""
+
+        servers = {}
+        for item in result:
+            host = item[1]
+            out = {}
+            version = None
+            pruning_level = '-'
+            if len(item) > 2:
+                for v in item[2]:
+                    if re.match("[stgh]\d*", v):
+                        protocol, port = v[0], v[1:]
+                        if port == '': port = DEFAULT_PORTS[protocol]
+                        out[protocol] = port
+                    elif re.match("v(.?)+", v):
+                        version = v[1:]
+                    elif re.match("p\d*", v):
+                        pruning_level = v[1:]
+                    if pruning_level == '': pruning_level = '0'
+            try: 
+                is_recent = float(version)>=float(PROTOCOL_VERSION)
+            except:
+                is_recent = False
+
+            if out and is_recent:
+                out['pruning'] = pruning_level
+                servers[host] = out
 
+        return servers
 
-    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):
 
         # uncomment to debug
-        # print "<--",c
+        # print_error( "<--",c )
 
         msg_id = c.get('id')
         error = c.get('error')
         
         if error:
-            print "received error:", c
+            print_error("received error:", c)
+            if msg_id is not None:
+                with self.lock: 
+                    method, params, channel = self.unanswered_requests.pop(msg_id)
+                response_queue = self.responses[channel]
+                response_queue.put({'method':method, 'params':params, 'error':error, 'id':msg_id})
+
             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')
+
+            if method == 'server.version':
+                self.server_version = result
+
+            elif method == 'server.banner':
+                self.banner = result
+                self.trigger_callback('banner')
+
+            elif method == 'server.peers.subscribe':
+                self.servers = self.parse_servers(result)
+                self.trigger_callback('peers')
+
         else:
-            # notification
+            # notification: find the channel(s)
             method = c.get('method')
             params = c.get('params')
 
@@ -105,37 +171,63 @@ class InterfaceAncestor(threading.Thread):
                 result = params[0]
                 params = []
 
+            elif method == 'blockchain.headers.subscribe':
+                result = params[0]
+                params = []
+
             elif method == 'blockchain.address.subscribe':
                 addr = params[0]
                 result = params[1]
                 params = [addr]
 
-        self.responses.put({'method':method, 'params':params, 'result':result})
-
-
+            with self.lock:
+                for k,v in self.subscriptions.items():
+                    if (method, params) in v:
+                        channel = k
+                        break
+                else:
+                    print_error( "received unexpected notification", method, params)
+                    print_error( self.subscriptions )
+                    return
+                
+        response_queue = self.responses[channel]
+        response_queue.put((self, {'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):
+        i, r = self.responses[channel].get(block, timeout)
+        return r
 
+    def register_channel(self, channel, queue=None):
+        if queue is None:
+            queue = Queue.Queue()
+        with self.lock:
+            self.responses[channel] = queue
 
+    def poke(self, channel):
+        self.responses[channel].put(None)
 
-class HttpStratumInterface(InterfaceAncestor):
-    """ non-persistent connection. synchronous calls"""
 
-    def __init__(self, host, port, proxy=None, use_ssl=True):
-        InterfaceAncestor.__init__(self, host, port, proxy, use_ssl)
+    def init_http(self, host, port, proxy=None, use_ssl=True):
+        self.init_server(host, port, proxy, use_ssl)
         self.session_id = None
-        self.connection_msg = "http://%s:%d"%(self.host,self.port)
+        self.is_connected = True
+        self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
+        try:
+            self.poll()
+        except:
+            print_error("http init session failed")
+            self.is_connected = False
+            return
 
-    def get_history(self, address):
-        self.send([('blockchain.address.get_history', [address] )])
+        if self.session_id:
+            print_error('http session:',self.session_id)
+            self.is_connected = True
+        else:
+            self.is_connected = False
 
-    def run(self):
+    def run_http(self):
         self.is_connected = True
         while self.is_connected:
             try:
@@ -151,18 +243,19 @@ class HttpStratumInterface(InterfaceAncestor):
                 break
             
         self.is_connected = False
-        self.poke()
 
                 
     def poll(self):
         self.send([])
 
-    def send(self, messages):
+
+    def send_http(self, messages, channel='default'):
         import urllib2, json, time, cookielib
+        print_error( "send_http", messages )
         
         if self.proxy:
             import socks
-            socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
+            socks.setdefaultproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
             socks.wrapmodule(urllib2)
 
         cj = cookielib.CookieJar()
@@ -176,7 +269,7 @@ class HttpStratumInterface(InterfaceAncestor):
             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:
@@ -185,17 +278,16 @@ class HttpStratumInterface(InterfaceAncestor):
             # poll with GET
             data_json = None 
 
-        if self.use_ssl:
-            host = 'https://%s:%d'%( self.host, self.port )
-        else:
-            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)
-        response_stream = urllib2.urlopen(req)
+        try:
+            req = urllib2.Request(self.connection_msg, data_json, headers)
+            response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
+        except:
+            return
 
         for index, cookie in enumerate(cj):
             if cookie.name=='SESSION':
@@ -224,15 +316,9 @@ class HttpStratumInterface(InterfaceAncestor):
 
 
 
-class TcpStratumInterface(InterfaceAncestor):
-    """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, 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
         self.connection_msg = "%s:%d"%(self.host,self.port)
         if self.proxy is None:
@@ -241,38 +327,57 @@ class TcpStratumInterface(InterfaceAncestor):
             self.connection_msg += " using proxy %s:%s:%s"%(self.proxy.get('mode'), self.proxy.get('host'), self.proxy.get('port'))
             import socks
             s = socks.socksocket()
-            s.setproxy(proxy_modes.index(self.proxy["mode"]), self.proxy["host"], int(self.proxy["port"]) )
+            s.setproxy(proxy_modes.index(self.proxy["mode"]) + 1, self.proxy["host"], int(self.proxy["port"]) )
 
         if self.use_ssl:
-            s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23)
+            s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv23, do_handshake_on_connect=True)
             
         s.settimeout(2)
         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 
         try:
             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])])
         except:
+            #traceback.print_exc(file=sys.stdout)
+            print_error("failed to connect", host, port)
             self.is_connected = False
             self.s = None
+            return
 
-    def run(self):
+        s.settimeout(60)
+        self.s = s
+        self.is_connected = True
+
+    def run_tcp(self):
         try:
+            #if self.use_ssl: self.s.do_handshake()
             out = ''
             while self.is_connected:
-                try: msg = self.s.recv(1024)
+                try: 
+                    timeout = False
+                    msg = self.s.recv(1024)
                 except socket.timeout:
+                    timeout = True
+                except ssl.SSLError:
+                    timeout = True
+                except socket.error, err:
+                    if err.errno in [11, 10035]:
+                        print_error("socket errno", err.errno)
+                        time.sleep(0.1)
+                        continue
+                    else:
+                        traceback.print_exc(file=sys.stdout)
+                        raise
+
+                if timeout:
                     # ping the server with server.version, as a real ping does not exist yet
-                    self.send([('server.version', [ELECTRUM_VERSION])])
+                    self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
                     continue
+
                 out += msg
                 self.bytes_received += len(msg)
                 if msg == '': 
                     self.is_connected = False
-                    print "Disconnected."
 
                 while True:
                     s = out.find('\n')
@@ -286,38 +391,85 @@ class TcpStratumInterface(InterfaceAncestor):
             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
-
+            self.unanswered_requests[self.message_id] = method, params, channel
+            ids.append(self.message_id)
             # uncomment to debug
-            # print "-->",request
-
+            # print "-->", request
             self.message_id += 1
             out += request + '\n'
-
         while out:
-            sent = self.s.send( out )
-            out = out[sent:]
+            try:
+                sent = self.s.send( out )
+                out = out[sent:]
+            except socket.error,e:
+                if e[0] in (errno.EWOULDBLOCK,errno.EAGAIN):
+                    print_error( "EAGAIN: retrying")
+                    time.sleep(0.1)
+                    continue
+                else:
+                    traceback.print_exc(file=sys.stdout)
+                    # this happens when we get disconnected
+                    print_error( "Not connected, cannot send" )
+                    return None
+        return ids
 
-    def get_history(self, addr):
-        self.send([('blockchain.address.get_history', [addr])])
 
 
-
-class Interface(TcpStratumInterface, HttpStratumInterface):
-    
-    def __init__(self, config = None):
+    def __init__(self, config=None):
+        self.server = random.choice(filter_protocol(DEFAULT_SERVERS, 's'))
+        self.proxy = None
 
         if config is None:
             from simple_config import SimpleConfig
             config = SimpleConfig()
+
+        threading.Thread.__init__(self)
+        self.daemon = True
+        self.config = config
+        self.connect_event = threading.Event()
+
+        self.subscriptions = {}
+        self.responses = {}
+        self.responses['default'] = Queue.Queue()
+
+        self.callbacks = {}
+        self.lock = threading.Lock()
+
+        self.servers = {} # actual list from IRC
+        self.rtime = 0
+        self.bytes_received = 0
+        self.is_connected = False
+
+        # init with None server, in case we are offline 
+        self.init_server(None, None)
+
+
+
+
+    def init_interface(self):
+        if self.config.get('server'):
+            self.init_with_server(self.config)
+        else:
+            if self.config.get('auto_cycle') is None:
+                self.config.set_key('auto_cycle', True, False)
+
+        if not self.is_connected: 
+            self.connect_event.set()
+            return
+
+        self.connect_event.set()
+
+
+    def init_with_server(self, config):
             
         s = config.get('server')
         host, port, protocol = s.split(':')
@@ -329,24 +481,40 @@ class Interface(TcpStratumInterface, HttpStratumInterface):
 
         #print protocol, host, port
         if protocol in 'st':
-            TcpStratumInterface.__init__(self, host, port, proxy, use_ssl=(protocol=='s'))
+            self.init_tcp(host, port, proxy, use_ssl=(protocol=='s'))
         elif protocol in 'gh':
-            HttpStratumInterface.__init__(self, host, port, proxy, use_ssl=(protocol=='g'))
+            self.init_http(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, channel='default'):
+
+        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] = []
+                for message in sub:
+                    if message not in self.subscriptions[channel]:
+                        self.subscriptions[channel].append(message)
+
+        if not self.is_connected: 
+            return
 
-    def send(self, messages):
         if self.protocol in 'st':
-            TcpStratumInterface.send(self, messages)
+            with self.lock:
+                out = self.send_tcp(messages, channel)
         else:
-            HttpStratumInterface.send(self, messages)
+            # do not use lock, http is synchronous
+            out = self.send_http(messages, channel)
+
+        return out
 
 
     def parse_proxy_options(self, s):
@@ -379,140 +547,80 @@ class Interface(TcpStratumInterface, HttpStratumInterface):
             print "changing server:", server, proxy
             self.server = server
             self.proxy = proxy
+            if self.is_connected and self.protocol in 'st' and self.s:
+                self.s.shutdown(socket.SHUT_RDWR)
+                self.s.close()
             self.is_connected = False  # this exits the polling loop
-            self.poke()
+            self.trigger_callback('disconnecting') # for actively disconnecting
 
-    def is_up_to_date(self):
-        return self.responses.empty() and not self.unanswered_requests
+    def stop(self):
+        if self.is_connected and self.protocol in 'st' and self.s:
+            self.s.shutdown(socket.SHUT_RDWR)
+            self.s.close()
 
 
+    def get_servers(self):
+        if not self.servers:
+            return DEFAULT_SERVERS
+        else:
+            return self.servers
 
 
+    def is_empty(self, channel):
+        q = self.responses.get(channel)
+        if q: 
+            return q.empty()
+        else:
+            return True
 
 
-class WalletSynchronizer(threading.Thread):
+    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 __init__(self, wallet, config, loop=False, servers_loaded_callback=None):
-        threading.Thread.__init__(self)
-        self.daemon = True
-        self.wallet = wallet
-        self.loop = loop
-        self.config = config
-        self.init_interface()
-        self.servers_loaded_callback = servers_loaded_callback
+    def is_up_to_date(self, channel):
+        return self.is_empty(channel) and not self.get_pending_requests(channel)
 
-    def init_interface(self):
-        if self.config.get('server'):
-            self.interface = Interface(self.config)
-        else:
-            print "Using random server..."
-            self.interface = pick_random_interface()
 
-        if self.interface.is_connected:
-            print "Connected to " + self.interface.connection_msg
-        else:
-            print_error("Failed to connect " + self.interface.connection_msg)
+    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
 
-        self.wallet.interface = self.interface
 
-    def handle_response(self, r):
-        if r is None:
-            return
+    def start(self, queue):
+        self.queue = queue
+        threading.Thread.start(self)
 
-        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("[stgh]\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
 
-        else:
-            print_error("Error: Unknown message:" + method + ", " + params + ", " + result)
 
+    def run(self):
+        self.init_interface()
+        if self.is_connected:
+            self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])])
+            self.change_status()
+            self.run_tcp() if self.protocol in 'st' else self.run_http()
+        self.change_status()
+        
+    def change_status(self):
+        self.queue.put(self)
 
-    def start_interface(self):
-        self.interface.start()
-        if self.interface.is_connected:
-            self.wallet.start_session(self.interface)
 
 
 
-    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.interface.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