processor.py

   1 import json
   2 import socket
   3 import threading
   4 import time
   5 import traceback, sys
   6 import Queue as queue
   7
   8 def random_string(N):
   9     import random, string
  10     return ''.join(random.choice(string.ascii_uppercase + string.digits) for x in range(N))
  11
  12 def timestr():
  13     return time.strftime("[%d/%m/%Y-%H:%M:%S]")
  14
  15
  16 print_lock = threading.Lock()
  17 def print_log(*args):
  18     args = [str(item) for item in args]
  19     with print_lock:
  20         sys.stderr.write(timestr() + " " + " ".join(args) + "\n")
  21         sys.stderr.flush()
  22
  23
  24
  25 class Shared:
  26
  27     def __init__(self):
  28         self.lock = threading.Lock()
  29         self._stopped = False
  30
  31     def stop(self):
  32         print_log( "Stopping Stratum" )
  33         with self.lock:
  34             self._stopped = True
  35
  36     def stopped(self):
  37         with self.lock:
  38             return self._stopped
  39
  40
  41 class Processor(threading.Thread):
  42
  43     def __init__(self):
  44         threading.Thread.__init__(self)
  45         self.daemon = True
  46         self.dispatcher = None
  47         self.queue = queue.Queue()
  48
  49     def process(self, request):
  50         pass
  51
  52     def add_request(self, request):
  53         self.queue.put(request)
  54
  55     def push_response(self, response):
  56         #print "response", response
  57         self.dispatcher.request_dispatcher.push_response(response)
  58
  59     def run(self):
  60         while not self.shared.stopped():
  61             request = self.queue.get(10000000000)
  62             try:
  63                 self.process(request)
  64             except:
  65                 traceback.print_exc(file=sys.stdout)
  66
  67         print_log( "processor terminating")
  68
  69
  70
  71 class Dispatcher:
  72
  73     def __init__(self):
  74         self.shared = Shared()
  75         self.request_dispatcher = RequestDispatcher(self.shared)
  76         self.request_dispatcher.start()
  77         self.response_dispatcher = \
  78             ResponseDispatcher(self.shared, self.request_dispatcher)
  79         self.response_dispatcher.start()
  80
  81     def register(self, prefix, processor):
  82         processor.dispatcher = self
  83         processor.shared = self.shared
  84         processor.start()
  85         self.request_dispatcher.processors[prefix] = processor
  86
  87
  88
  89 class RequestDispatcher(threading.Thread):
  90
  91     def __init__(self, shared):
  92         self.shared = shared
  93         threading.Thread.__init__(self)
  94         self.daemon = True
  95         self.request_queue = queue.Queue()
  96         self.response_queue = queue.Queue()
  97         self.internal_ids = {}
  98         self.internal_id = 1
  99         self.lock = threading.Lock()
 100         self.sessions = []
 101         self.processors = {}
 102
 103     def push_response(self, item):
 104         self.response_queue.put(item)
 105
 106     def pop_response(self):
 107         return self.response_queue.get()
 108
 109     def push_request(self, session, item):
 110         self.request_queue.put((session,item))
 111
 112     def pop_request(self):
 113         return self.request_queue.get()
 114
 115     def get_session_by_address(self, address):
 116         for x in self.sessions:
 117             if x.address == address:
 118                 return x
 119
 120     def get_session_id(self, internal_id):
 121         with self.lock:
 122             return self.internal_ids.pop(internal_id)
 123
 124     def store_session_id(self, session, msgid):
 125         with self.lock:
 126             self.internal_ids[self.internal_id] = session, msgid
 127             r = self.internal_id
 128             self.internal_id += 1
 129             return r
 130
 131     def run(self):
 132         if self.shared is None:
 133             raise TypeError("self.shared not set in Processor")
 134         while not self.shared.stopped():
 135             session, request = self.pop_request()
 136             try:
 137                 self.do_dispatch(session, request)
 138             except:
 139                 traceback.print_exc(file=sys.stdout)
 140
 141
 142         self.stop()
 143
 144     def stop(self):
 145         pass
 146
 147     def do_dispatch(self, session, request):
 148         """ dispatch request to the relevant processor """
 149
 150         method = request['method']
 151         params = request.get('params',[])
 152         suffix = method.split('.')[-1]
 153
 154         if session is not None:
 155             is_new = session.protocol_version >= 0.5
 156             if suffix == 'subscribe':
 157                 session.subscribe_to_service(method, params)
 158
 159         # store session and id locally
 160         request['id'] = self.store_session_id(session, request['id'])
 161
 162         prefix = request['method'].split('.')[0]
 163         try:
 164             p = self.processors[prefix]
 165         except:
 166             print_log( "error: no processor for", prefix)
 167             return
 168
 169         p.add_request(request)
 170
 171         if method in ['server.version']:
 172             session.version = params[0]
 173             try:
 174                 session.protocol_version = float(params[1])
 175             except:
 176                 pass
 177
 178             #if session.protocol_version < 0.6:
 179             #    print_log("stopping session from old client", session.protocol_version)
 180             #    session.stop()
 181
 182     def get_sessions(self):
 183         with self.lock:
 184             r = self.sessions[:]
 185         return r
 186
 187     def add_session(self, session):
 188         with self.lock:
 189             self.sessions.append(session)
 190
 191     def collect_garbage(self):
 192         # Deep copy entire sessions list and blank it
 193         # This is done to minimise lock contention
 194         with self.lock:
 195             sessions = self.sessions[:]
 196             self.sessions = []
 197         for session in sessions:
 198             if not session.stopped():
 199                 # If session is still alive then re-add it back
 200                 # to our internal register
 201                 self.add_session(session)
 202
 203
 204 class Session:
 205
 206     def __init__(self):
 207         self._stopped = False
 208         self.lock = threading.Lock()
 209         self.subscriptions = []
 210         self.address = ''
 211         self.name = ''
 212         self.version = 'unknown'
 213         self.protocol_version = 0.
 214         self.time = time.time()
 215         threading.Timer(2, self.info).start()
 216
 217     # Debugging method. Doesn't need to be threadsafe.
 218     def info(self):
 219         for sub in self.subscriptions:
 220             #print sub
 221             method = sub[0]
 222             if method == 'blockchain.address.subscribe':
 223                 addr = sub[1]
 224                 break
 225         else:
 226             addr = None
 227
 228         if self.subscriptions:
 229             print_log( "%4s"%self.name, "%14s"%self.address, "%35s"%addr, "%3d"%len(self.subscriptions), self.version )
 230
 231     def stopped(self):
 232         with self.lock:
 233             return self._stopped
 234
 235     def subscribe_to_service(self, method, params):
 236         subdesc = self.build_subdesc(method, params)
 237         with self.lock:
 238             if subdesc is not None:
 239                 self.subscriptions.append(subdesc)
 240
 241     # subdesc = A subscription description
 242     @staticmethod
 243     def build_subdesc(method, params):
 244         if method == "blockchain.numblocks.subscribe":
 245             return method,
 246         elif method == "blockchain.headers.subscribe":
 247             return method,
 248         elif method in ["blockchain.address.subscribe"]:
 249             if not params:
 250                 return None
 251             else:
 252                 return method, params[0]
 253         else:
 254             return None
 255
 256     def contains_subscription(self, subdesc):
 257         with self.lock:
 258             return subdesc in self.subscriptions
 259
 260
 261 class ResponseDispatcher(threading.Thread):
 262
 263     def __init__(self, shared, request_dispatcher):
 264         self.shared = shared
 265         self.request_dispatcher = request_dispatcher
 266         threading.Thread.__init__(self)
 267         self.daemon = True
 268
 269     def run(self):
 270         while not self.shared.stopped():
 271             self.update()
 272
 273     def update(self):
 274         response = self.request_dispatcher.pop_response()
 275         #print "pop response", response
 276         internal_id = response.get('id')
 277         method = response.get('method')
 278         params = response.get('params')
 279
 280         # A notification
 281         if internal_id is None: # and method is not None and params is not None:
 282             found = self.notification(method, params, response)
 283             if not found and method == 'blockchain.address.subscribe':
 284                 self.request_dispatcher.push_request(None,{'method':method.replace('.subscribe', '.unsubscribe'), 'params':params, 'id':None})
 285                 pass
 286         # A response
 287         elif internal_id is not None:
 288             self.send_response(internal_id, response)
 289         else:
 290             print_log( "no method", response)
 291
 292     def notification(self, method, params, response):
 293         subdesc = Session.build_subdesc(method, params)
 294         found = False
 295         for session in self.request_dispatcher.sessions:
 296             if session.stopped():
 297                 continue
 298             if session.contains_subscription(subdesc):
 299                 session.send_response(response)
 300                 found = True
 301         if not found: print "no subscriber for", subdesc
 302         return found
 303
 304     def send_response(self, internal_id, response):
 305         session, message_id = self.request_dispatcher.get_session_id(internal_id)
 306         if session:
 307             response['id'] = message_id
 308             session.send_response(response)
 309         else:
 310             print_log( "send_response: no session", message_id, internal_id, response )
 311