new workflow
[electrum-server.git] / stratum.py
index 8a25065..0ce7485 100644 (file)
@@ -8,36 +8,60 @@ class Processor(threading.Thread):
 
     def __init__(self):
         self.shared = None
-        self.lock = threading.Lock()
-        self.sessions = []
         threading.Thread.__init__(self)
         self.daemon = True
+        self.request_queue = queue.Queue()
+        self.response_queue = queue.Queue()
+        self.id_session = {}
 
-    def add_session(self, session):
-        with self.lock:
-            self.sessions.append(session)
+    def push_response(self, item):
+        self.response_queue.put(item)
+
+    def pop_response(self):
+        return self.response_queue.get()
+
+    def push_request(self, session, item):
+        self.request_queue.put((session,item))
+
+    def pop_request(self):
+        return self.request_queue.get()
 
     def run(self):
         if self.shared is None:
             raise TypeError("self.shared not set in Processor")
         while not self.shared.stopped():
-            # Deep copy entire sessions list and blank it
-            # This is done to minimise lock contention
-            with self.lock:
-                sessions = self.sessions[:]
-                self.sessions = []
-            for session in sessions:
-                if not session.stopped():
-                    # If session is still alive then re-add it back
-                    # to our internal register
-                    self.add_session(session)
-                    self.process(session)
-
-    def process(self, session):
-        request = session.pop_request()
+            session, request = self.pop_request()
+
+            method = request['method']
+            params = request.get('params',[])
+
+            if method == 'numblocks.subscribe':
+                session.subscribe_to_numblocks()
+
+            elif method == 'address.subscribe':
+                address = params[0]
+                session.subscribe_to_address(address)
+
+            elif method == 'server.peers':
+                session.subscribe_to_peers()
+
+            message_id = request['id']
+            self.id_session[message_id] = session
+            self.process(request)
+
+        self.stop()
+
+    def stop(self):
+        pass
+
+    def process(self, request):
         print "New request", request
-        # Execute and when ready, you call
-        # session.push_response(response)
+        # Do stuff...
+        # response = request
+        # When ready, you call
+        # self.push_response(response)
+
+
 
 class Session:
 
@@ -46,9 +70,9 @@ class Session:
         self.address = address
         self._stopped = False
         self.lock = threading.Lock()
-
-        self.request_queue = queue.Queue()
-        self.response_queue = queue.Queue()
+        self.numblocks_sub = None
+        self.addresses_sub = {}
+        print "new session", address
 
     def stop(self):
         self._connection.close()
@@ -66,42 +90,82 @@ class Session:
         else:
             return self._connection
 
-    def push_request(self, item):
-        self.request_queue.put(item)
-
-    def pop_request(self):
-        return self.request_queue.get()
+    def subscribe_to_numblocks(self):
+        with self.lock:
+            self.numblocks_sub = True
+    
+    def subscribe_to_peers(self):
+        pass
 
-    def push_response(self):
-        self.response_queue.put(item)
+    def subscribe_to_address(self,address):
+        with self.lock:
+            self.addresses_sub[address] = 'unknown'
 
-    def pop_response(self):
-        return self.response_queue.get()
 
-class TcpClientResponder(threading.Thread):
+class TcpResponder(threading.Thread):
 
-    def __init__(self, shared, session):
+    def __init__(self, shared, processor, server):
         self.shared = shared
-        self.session = session
+        self.processor = processor
+        self.server = server
         threading.Thread.__init__(self)
 
+
     def run(self):
-        while not self.shared.stopped() or self.session.stopped():
-            response = self.session.pop_response()
-            raw_response = json.dumps(response)
-            # Possible race condition here by having session
-            # close connection?
-            # I assume Python connections are thread safe interfaces
-            connection = self.session.connection()
+        while not self.shared.stopped():
+            response = self.processor.pop_response()
+            # if it is a subscription, find the list of sessions that suuscribed
+            
+            # if there is an id, there should be a session
+            # note: I must add and remove the session id to the message id..
+
+            message_id = response.get('id')
             try:
-                connection.send(raw_response + "\n")
+                method = response['method']
             except:
-                self.session.stop()
+                print "no method", response
+                continue
+
+            if message_id:
+                session = self.processor.id_session.pop(message_id)
+                self.send_response(response, session)
+
+            elif method == 'numblocks.subscribe':
+                for session in self.server.sessions:
+                    if not session.stopped():
+                        if session.numblocks_sub:
+                            self.send_response(response, session)
+
+            elif method == 'address.subscribe':
+                for session in self.server.sessions:
+                    if not session.stopped():
+                        addr = response['params'][0]
+                        last_status = session.addresses_sub.get(addr)
+                        if last_status:
+                            new_status = response.get('result')
+                            if new_status != last_status:
+                                session.addresses_sub[addr] = new_status
+                                self.send_response(response, session)
+            else:
+                print "error", response
+
+
+    def send_response(self, response, session):
+        raw_response = json.dumps(response)
+        # Possible race condition here by having session
+        # close connection?
+        # I assume Python connections are thread safe interfaces
+        try:
+            connection = session.connection()
+            connection.send(raw_response + "\n")
+        except:
+            session.stop()
 
 class TcpClientRequestor(threading.Thread):
 
-    def __init__(self, shared, session):
+    def __init__(self, shared, processor, session):
         self.shared = shared
+        self.processor = processor
         self.message = ""
         self.session = session
         threading.Thread.__init__(self)
@@ -109,77 +173,100 @@ class TcpClientRequestor(threading.Thread):
     def run(self):
         while not self.shared.stopped():
             if not self.update():
-                self.session.stop()
-                return
+                break
+
+            while self.parse():
+                pass
 
     def update(self):
         data = self.receive()
-        if data is None:
+        if not data:
             # close_session
-            self.stop()
+            self.session.stop()
             return False
 
         self.message += data
-        if not self.parse():
-            return False
         return True
 
     def receive(self):
         try:
             return self.session.connection().recv(1024)
         except socket.error:
-            return None
+            return ''
 
     def parse(self):
-        while True:
-            raw_buffer = self.message.find('\n')
-            if raw_buffer == -1:
-                return True
+        raw_buffer = self.message.find('\n')
+        if raw_buffer == -1:
+            return False
 
-            command = self.message[0:raw_buffer].strip()
-            self.message = self.message[raw_buffer + 1:]
-            if command == 'quit': 
-                return False
+        raw_command = self.message[0:raw_buffer].strip()
+        self.message = self.message[raw_buffer + 1:]
+        if raw_command == 'quit': 
+            self.session.stop()
+            return False
 
-            try:
-                command = json.loads(command)
-            except:
-                print "json error", repr(command)
-                continue
+        try:
+            command = json.loads(raw_command)
+        except:
+            self.processor.push_response({"error": "bad JSON", "request": raw_command})
+            return True
 
-            try:
-                # Try to load vital fields, and return an error if
-                # unsuccessful.
-                message_id = command['id']
-                method = command['method']
-            except KeyError:
-                # This should return an error JSON in response.
-                print "syntax error", repr(command), self.session.address[0]
-            else:
-                self.session.push_request(command)
+        try:
+            # Try to load vital fields, and return an error if
+            # unsuccessful.
+            message_id = command['id']
+            method = command['method']
+        except KeyError:
+            # Return an error JSON in response.
+            self.processor.push_response({"error": "syntax error", "request": raw_command})
+        else:
+            self.processor.push_request(self.session,command)
+
+        return True
 
 class TcpServer(threading.Thread):
 
-    def __init__(self, shared, processor):
+    def __init__(self, shared, processor, host, port):
         self.shared = shared
         self.processor = processor
-        self.clients = []
+        self.sessions = []
         threading.Thread.__init__(self)
         self.daemon = True
+        self.host = host
+        self.port = port
+        self.lock = threading.Lock()
 
     def run(self):
         print "TCP server started."
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-        sock.bind(("localhost", 50001))
+        sock.bind((self.host, self.port))
         sock.listen(1)
+        responder = TcpResponder(self.shared, self.processor, self)
+        responder.start()
         while not self.shared.stopped():
             session = Session(*sock.accept())
-            client_req = TcpClientRequestor(self.shared, session)
+            client_req = TcpClientRequestor(self.shared, self.processor, session)
             client_req.start()
-            client_res = TcpClientResponder(self.shared, session)
-            client_res.start()
-            self.processor.add_session(session)
+            self.add_session(session)
+            self.collect_garbage()
+
+    def add_session(self, session):
+        with self.lock:
+            self.sessions.append(session)
+
+    def collect_garbage(self):
+        # Deep copy entire sessions list and blank it
+        # This is done to minimise lock contention
+        with self.lock:
+            sessions = self.sessions[:]
+            self.sessions = []
+        for session in sessions:
+            if not session.stopped():
+                # If session is still alive then re-add it back
+                # to our internal register
+                self.add_session(session)
+
 
 class Shared:
 
@@ -204,7 +291,7 @@ class Stratum:
         processor.shared = shared
         processor.start()
         # Create various transports we need
-        transports = TcpServer(shared, processor),
+        transports = TcpServer(shared, processor, "176.31.24.241", 50001),
         for server in transports:
             server.start()
         while not shared.stopped():