2018-04-03 12:49:14 +00:00
|
|
|
# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
|
|
|
|
# All Rights Reserved. See LICENSE file for details.
|
|
|
|
|
2018-01-26 14:15:05 +00:00
|
|
|
import json
|
2018-03-25 13:43:59 +00:00
|
|
|
|
2017-11-17 14:47:22 +00:00
|
|
|
from tornado.websocket import WebSocketHandler
|
|
|
|
|
2018-06-28 15:33:20 +00:00
|
|
|
from tfw.mixins import CallbackMixin
|
2018-02-06 13:19:41 +00:00
|
|
|
from tfw.config.logs import logging
|
2018-03-25 14:06:59 +00:00
|
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
2018-01-29 16:24:17 +00:00
|
|
|
|
2017-11-17 14:47:22 +00:00
|
|
|
|
2018-06-28 15:33:20 +00:00
|
|
|
class ZMQWebSocketProxy(WebSocketHandler):
|
2018-07-16 09:17:06 +00:00
|
|
|
# pylint: disable=abstract-method
|
2018-02-16 16:47:30 +00:00
|
|
|
instances = set()
|
|
|
|
|
2018-04-06 14:52:23 +00:00
|
|
|
def initialize(self, **kwargs): # pylint: disable=arguments-differ
|
2018-04-06 14:04:25 +00:00
|
|
|
self._event_handler_connector = kwargs['event_handler_connector']
|
2018-07-12 13:55:26 +00:00
|
|
|
|
2018-07-13 12:08:30 +00:00
|
|
|
self._message_handlers = kwargs.get('message_handlers', [])
|
|
|
|
self._frontend_message_handlers = kwargs.get('frontend_message_handlers', [])
|
|
|
|
self._eventhandler_message_handlers = kwargs.get('eventhandler_message_handlers', [])
|
|
|
|
self._proxy_filters = kwargs.get('proxy_filters', [])
|
2018-06-28 15:33:20 +00:00
|
|
|
|
|
|
|
self.proxy_eventhandler_to_websocket = TFWProxy(
|
|
|
|
self.send_eventhandler_message,
|
|
|
|
self.send_websocket_message
|
|
|
|
)
|
|
|
|
self.proxy_websocket_to_eventhandler = TFWProxy(
|
|
|
|
self.send_websocket_message,
|
|
|
|
self.send_eventhandler_message
|
|
|
|
)
|
|
|
|
|
2018-07-12 13:55:26 +00:00
|
|
|
self.subscribe_proxy_callbacks()
|
|
|
|
|
|
|
|
def subscribe_proxy_callbacks(self):
|
2018-07-13 12:08:30 +00:00
|
|
|
self.proxy_websocket_to_eventhandler.subscribe_proxy_callbacks_and_filters(
|
|
|
|
self._eventhandler_message_handlers + self._message_handlers,
|
|
|
|
self._proxy_filters
|
|
|
|
)
|
|
|
|
|
|
|
|
self.proxy_eventhandler_to_websocket.subscribe_proxy_callbacks_and_filters(
|
|
|
|
self._frontend_message_handlers + self._message_handlers,
|
|
|
|
self._proxy_filters
|
2018-07-12 13:55:26 +00:00
|
|
|
)
|
2018-04-06 14:04:25 +00:00
|
|
|
|
2018-02-16 16:47:30 +00:00
|
|
|
def prepare(self):
|
2018-06-28 15:33:20 +00:00
|
|
|
ZMQWebSocketProxy.instances.add(self)
|
2018-02-16 16:47:30 +00:00
|
|
|
|
|
|
|
def on_close(self):
|
2018-06-28 15:33:20 +00:00
|
|
|
ZMQWebSocketProxy.instances.remove(self)
|
2018-02-05 13:23:46 +00:00
|
|
|
|
2017-11-17 14:47:22 +00:00
|
|
|
def open(self, *args, **kwargs):
|
2018-03-25 14:06:59 +00:00
|
|
|
LOG.debug('WebSocket connection initiated')
|
2018-06-29 09:58:05 +00:00
|
|
|
self._event_handler_connector.register_callback(self.eventhander_callback)
|
2017-12-20 10:34:21 +00:00
|
|
|
|
2018-06-29 09:58:05 +00:00
|
|
|
def eventhander_callback(self, message):
|
2018-06-28 15:33:20 +00:00
|
|
|
"""
|
2018-06-29 09:58:05 +00:00
|
|
|
Invoked on ZMQ messages from event handlers.
|
2018-06-28 15:33:20 +00:00
|
|
|
"""
|
2018-04-11 13:22:54 +00:00
|
|
|
LOG.debug('Received on pull socket: %s', message)
|
2018-06-28 15:33:20 +00:00
|
|
|
self.proxy_eventhandler_to_websocket(message)
|
2017-11-17 14:47:22 +00:00
|
|
|
|
|
|
|
def on_message(self, message):
|
2018-06-28 15:33:20 +00:00
|
|
|
"""
|
2018-06-29 09:58:05 +00:00
|
|
|
Invoked on WS messages from frontend.
|
2018-06-28 15:33:20 +00:00
|
|
|
"""
|
|
|
|
message = json.loads(message)
|
2018-03-25 14:25:01 +00:00
|
|
|
LOG.debug('Received on WebSocket: %s', message)
|
2018-06-28 15:33:20 +00:00
|
|
|
self.proxy_websocket_to_eventhandler(message)
|
2018-01-29 13:09:40 +00:00
|
|
|
|
2018-06-28 15:33:20 +00:00
|
|
|
def send_eventhandler_message(self, message):
|
2018-04-13 18:33:35 +00:00
|
|
|
self._event_handler_connector.send_message(message)
|
2017-11-17 14:47:22 +00:00
|
|
|
|
2018-06-28 15:33:20 +00:00
|
|
|
@staticmethod
|
|
|
|
def send_websocket_message(message):
|
|
|
|
for instance in ZMQWebSocketProxy.instances:
|
|
|
|
instance.write_message(message)
|
2018-04-11 13:22:54 +00:00
|
|
|
|
2017-11-17 14:47:22 +00:00
|
|
|
# much secure, very cors, wow
|
|
|
|
def check_origin(self, origin):
|
|
|
|
return True
|
2018-06-29 13:33:45 +00:00
|
|
|
|
|
|
|
|
|
|
|
class TFWProxy:
|
2018-07-16 09:17:06 +00:00
|
|
|
# pylint: disable=protected-access
|
2018-06-29 13:33:45 +00:00
|
|
|
def __init__(self, to_source, to_destination):
|
|
|
|
self.to_source = to_source
|
|
|
|
self.to_destination = to_destination
|
|
|
|
|
|
|
|
self.proxy_filters = CallbackMixin()
|
|
|
|
self.proxy_callbacks = CallbackMixin()
|
|
|
|
|
|
|
|
self.proxy_filters.subscribe_callback(self.validate_message)
|
|
|
|
|
|
|
|
self.keyhandlers = {
|
|
|
|
'mirror': self.mirror,
|
|
|
|
'broadcast': self.broadcast
|
|
|
|
}
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def validate_message(message):
|
|
|
|
if 'key' not in message:
|
|
|
|
raise ValueError('Invalid TFW message format!')
|
|
|
|
|
|
|
|
def __call__(self, message):
|
|
|
|
try:
|
|
|
|
self.proxy_filters._execute_callbacks(message)
|
|
|
|
except ValueError:
|
|
|
|
LOG.exception('Invalid TFW message received!')
|
|
|
|
return
|
|
|
|
|
|
|
|
self.proxy_callbacks._execute_callbacks(message)
|
|
|
|
|
|
|
|
if message['key'] not in self.keyhandlers:
|
|
|
|
self.to_destination(message)
|
|
|
|
else:
|
|
|
|
handler = self.keyhandlers[message['key']]
|
|
|
|
try:
|
|
|
|
handler(message)
|
|
|
|
except KeyError:
|
|
|
|
LOG.error('Invalid "%s" message format! Ignoring.', handler.__name__)
|
|
|
|
|
|
|
|
def mirror(self, message):
|
|
|
|
message = message['data']
|
|
|
|
LOG.debug('Mirroring message: %s', message)
|
|
|
|
self.to_source(message)
|
|
|
|
|
|
|
|
def broadcast(self, message):
|
|
|
|
message = message['data']
|
|
|
|
LOG.debug('Broadcasting message: %s', message)
|
|
|
|
self.to_source(message)
|
|
|
|
self.to_destination(message)
|
2018-07-13 12:08:30 +00:00
|
|
|
|
|
|
|
def subscribe_proxy_callbacks_and_filters(self, proxy_callbacks, proxy_filters):
|
|
|
|
self.proxy_callbacks.subscribe_callbacks(*proxy_callbacks)
|
|
|
|
self.proxy_filters.subscribe_callbacks(*proxy_filters)
|