proxy: mqtt: allow arbitrary writes v1 PROPOSED

Jan Kundrát: 1
 proxy: mqtt: allow arbitrary writes

 2 files changed, 40 insertions(+), 4 deletions(-)
Export patchset (mbox)
How do I use this?

Copy & paste the following snippet into your terminal to import this patchset into git:

curl -s https://lists.sr.ht/~martijnbraam/openatem/patches/26458/mbox | git am -3
Learn more about email & git

[PATCH] proxy: mqtt: allow arbitrary writes Export this patch

Since there are typically no server-side MQTT ACLs, this has to be
enabled explicitly.

There's some duplication of code between this implementation and the one
in the HTTP backend. The most straightforward way of fixing that is to
convert these early returns into proper exceptions, but I'm too lazy for
this and I'm gonna be using this feature tomorrow :).

Signed-off-by: Jan Kundrát <jkt@jankundrat.com>
 openswitcher_proxy/frontend_mqtt.py | 43 ++++++++++++++++++++++++++---
 proxy.toml                          |  1 +
 2 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/openswitcher_proxy/frontend_mqtt.py b/openswitcher_proxy/frontend_mqtt.py
index 63538c6..ff0b23a 100644
--- a/openswitcher_proxy/frontend_mqtt.py
+++ b/openswitcher_proxy/frontend_mqtt.py
@@ -5,6 +5,7 @@ from functools import partial

from .error import DependencyError
from .frontend_httpapi import FieldEncoder
import pyatem.command as commandmodule

    import paho.mqtt.client as mqtt
@@ -74,12 +75,46 @@ class MqttFrontendThread(threading.Thread):
    def on_mqtt_connect(self, flags, rc):
        self.status = 'running'
        logging.info(f'MQTT: connected ({rc})')
        # TODO: enable once on_mqtt_message() works
        # client.subscribe(f'atem/{userdata.hw_name}/#')

    def on_mqtt_message(self, msg):
        # TODO: propagate to the switcher, eventually
        logging.debug(f'MQTT: msg: {msg.topic} {msg.payload}')
        if not self.config.get('allow-writes', False):
            logging.error('MQTT writes disabled')
        parts = msg.topic.split('/')
        if len(parts) != 4:
            logging.error(f'MQTT: malformed command topic: {msg.topic}')
        hw = parts[1]
        if parts[0] != 'atem' or parts[2] != 'set':
            logging.error(f'MQTT: malformed command topic: {msg.topic}')
        if hw not in self.hw_name:
            logging.error(f'MQTT: not handling writes for "{hw}"')
        fieldname = parts[3]
        classname = fieldname.title().replace('-', '') + "Command"
        if not hasattr(commandmodule, classname):
            logging.error(f'MQTT: unrecognized command {fieldname}')
        arguments = json.loads(msg.payload)
        if not isinstance(arguments, dict):
            logging.error(f'MQTT: mailformed payload, needs a JSON dict')
        for key in arguments:
                arguments[key] = int(arguments[key])
        if 'source' in arguments:
            inputs = self.threadlist['hardware'][hw].switcher.inputs
            if arguments['source'] in inputs:
                arguments['source'] = inputs[arguments['source']]
            cmd = getattr(commandmodule, classname)(**arguments)
        except Exception as e:
            logging.error(f'MQTT: cannot write {fieldname}: {str(e)}')

    def get_status(self):
        if self.status == 'error':
diff --git a/proxy.toml b/proxy.toml
index bd6b213..1e55bf5 100644
--- a/proxy.toml
+++ b/proxy.toml
@@ -36,3 +36,4 @@ type = "mqtt"
host = "localhost:1883"
hardware = "mini"
auth = false
allow-writes = false