76 lines
2.6 KiB
Python
76 lines
2.6 KiB
Python
import json
|
|
|
|
try:
|
|
from websockets.exceptions import ConnectionClosed
|
|
from websockets import connect as websocket_connect
|
|
except ImportError:
|
|
from websockets import ConnectionClosed, connect as websocket_connect
|
|
|
|
from platypush.context import get_or_create_event_loop
|
|
from platypush.message import Message
|
|
from platypush.plugins import Plugin, action
|
|
from platypush.utils import get_ssl_client_context
|
|
|
|
|
|
class WebsocketPlugin(Plugin):
|
|
"""
|
|
Plugin to send messages over a websocket connection.
|
|
"""
|
|
|
|
def __init__(self, **kwargs):
|
|
super().__init__(**kwargs)
|
|
|
|
@action
|
|
def send(self, url, msg, ssl_cert=None, ssl_key=None, ssl_cafile=None, ssl_capath=None):
|
|
"""
|
|
Sends a message to a websocket.
|
|
|
|
:param url: Websocket URL, e.g. ws://localhost:8765 or wss://localhost:8765
|
|
:type url: str
|
|
|
|
:param msg: Message to be sent. It can be a list, a dict, or a Message object
|
|
|
|
:param ssl_cert: Path to the SSL certificate to be used, if the SSL connection requires client authentication
|
|
as well (default: None) :type ssl_cert: str
|
|
|
|
:param ssl_key: Path to the SSL key to be used, if the SSL connection requires client authentication as well
|
|
(default: None) :type ssl_key: str
|
|
|
|
:param ssl_cafile: Path to the certificate authority file if required by the SSL configuration (default: None)
|
|
:type ssl_cafile: str
|
|
|
|
:param ssl_capath: Path to the certificate authority directory if required by the SSL configuration
|
|
(default: None)
|
|
:type ssl_capath: str
|
|
"""
|
|
|
|
async def send():
|
|
websocket_args = {}
|
|
if ssl_cert:
|
|
websocket_args['ssl'] = get_ssl_client_context(ssl_cert=ssl_cert,
|
|
ssl_key=ssl_key,
|
|
ssl_cafile=ssl_cafile,
|
|
ssl_capath=ssl_capath)
|
|
|
|
async with websocket_connect(url, **websocket_args) as websocket:
|
|
try:
|
|
await websocket.send(str(msg))
|
|
except ConnectionClosed as err:
|
|
self.logger.warning('Error on websocket {}: {}'.
|
|
format(url, err))
|
|
|
|
try:
|
|
msg = json.dumps(msg)
|
|
except Exception as e:
|
|
self.logger.debug(e)
|
|
|
|
try:
|
|
msg = Message.build(json.loads(msg))
|
|
except Exception as e:
|
|
self.logger.debug(e)
|
|
|
|
loop = get_or_create_event_loop()
|
|
loop.run_until_complete(send())
|
|
|
|
# vim:sw=4:ts=4:et:
|