tip/PluginMqttMonitor.py

# -*- coding: utf-8 -*-

# Copyright (c) 2018 - 2025 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing the MQTT Monitor plug-in.
"""

import json
import os

from PyQt6.QtCore import QCoreApplication, QObject, Qt, QTranslator
from PyQt6.QtGui import QKeySequence

from eric7 import Preferences
from eric7.EricGui.EricAction import EricAction
from eric7.EricWidgets.EricApplication import ericApp

try:
    from eric7.EricGui import EricPixmapCache
except ImportError:
    from UI import PixmapCache as EricPixmapCache

try:
    from eric7.UI.UserInterface import UserInterfaceSide

    _Side = UserInterfaceSide.Right
except ImportError:
    # backward compatibility for eric < 24.2
    from eric7.UI.UserInterface import UserInterface

    _Side = UserInterface.RightSide

from MqttMonitor.MqttProtocols import MqttProtocols

# Start-Of-Header
__header__ = {
    "name": "MQTT Monitor Plugin",
    "author": "Detlev Offenbach <detlev@die-offenbachs.de>",
    "autoactivate": True,
    "deactivateable": True,
    "version": "11.0.2",
    "className": "MqttMonitorPlugin",
    "packageName": "MqttMonitor",
    "shortDescription": "Plug-in implementing a tool to connect to a MQTT broker",
    "longDescription": (
        "Plug-in implementing a tool to connect to a MQTT broker, subscribe"
        " to topics, present received messages and publish messages."
        " It displays broker statistics (the $SYS/# topic tree) and"
        " log messages of the underlying paho-mqtt client. This tool"
        " supports unencrypted connections (port 1883) as well as encrypted"
        " SSL/TLS connections (port 8883)."
    ),
    "needsRestart": False,
    "hasCompiledForms": True,
    "pyqtApi": 2,
}
# End-Of-Header

error = ""

mqttPluginObject = None


def createMqttPage(
    _configDlg,
):
    """
    Module function to create the autocompletion configuration page.

    @param _configDlg reference to the configuration dialog (unused)
    @type ConfigurationWidget
    @return reference to the configuration page
    @rtype AutoCompletionRopePage
    """
    global mqttPluginObject
    from MqttMonitor.ConfigurationPage.MqttPage import MqttPage  # noqa: I101

    page = MqttPage(mqttPluginObject)
    return page


def getConfigData():
    """
    Module function returning data as required by the configuration dialog.

    @return dictionary containing the relevant data
    @rtype dict
    """
    usesDarkPalette = ericApp().usesDarkPalette()
    iconSuffix = "dark" if usesDarkPalette else "light"

    return {
        "mqttPage": [
            QCoreApplication.translate("MqttMonitorPlugin", "MQTT Monitor"),
            os.path.join("MqttMonitor", "icons", "mqtt22-{0}".format(iconSuffix)),
            createMqttPage,
            None,
            None,
        ],
    }


def exeDisplayData():
    """
    Module function to support the display of some executable info.

    @return dictionary containing the data to query the presence of
        the executable
    @rtype dict
    """
    try:
        import paho.mqtt  # noqa: I101, I102

        version = paho.mqtt.__version__
    except ImportError:
        version = QCoreApplication.translate(
            "MqttMonitorPlugin", "(package not available)"
        )

    return {
        "programEntry": False,
        "header": QCoreApplication.translate("MqttMonitorPlugin", "MQTT"),
        "text": QCoreApplication.translate("MqttMonitorPlugin", "paho-mqtt"),
        "version": version,
    }


def prepareUninstall():
    """
    Module function to prepare for an uninstallation.
    """
    Preferences.Prefs.settings.remove(MqttMonitorPlugin.PreferencesKey)


class MqttMonitorPlugin(QObject):
    """
    Class implementing the MQTT Monitor plug-in.
    """

    PreferencesKey = "MqttMonitor"

    def __init__(self, ui):
        """
        Constructor

        @param ui reference to the user interface object
        @type UI.UserInterface
        """
        super().__init__(ui)
        self.__ui = ui
        self.__initialize()

        self.__defaults = {
            "RecentBrokersWithPort": "[]",  # JSON formatted empty list
            "BrokerProfiles": "{}",  # JSON formatted empty dict
            # __IGNORE_WARNING_M613__
            "MostRecentProfile": "",  # most recently used profile
            "PublishProperties": "{}",  # JSON formatted empty dict
            # __IGNORE_WARNING_M613__
            "SubscribeProperties": "{}",  # JSON formatted empty dict
            # __IGNORE_WARNING_M613__
            "UnsubscribeProperties": "{}",  # JSON formatted empty dict
            # __IGNORE_WARNING_M613__
            "DefaultProtocol": MqttProtocols.MQTTv311,
            "RecentBrokersNumber": 20,
            "RecentTopicsNumber": 20,
            "RecentTopics": "[]",  # JSON formatted empty list
        }

        self.__translator = None
        self.__loadTranslator()

    def __initialize(self):
        """
        Private slot to (re)initialize the plugin.
        """
        self.__widget = None

    def activate(self):
        """
        Public method to activate this plug-in.

        @return tuple of None and activation status
        @rtype tuple of (None, bool)
        """
        global error, mqttPluginObject
        error = ""  # clear previous error
        mqttPluginObject = self

        try:
            import paho.mqtt  # __IGNORE_WARNING__
        except ImportError:
            error = self.tr("The 'paho-mqtt' package is not available.")
            return None, False

        from MqttMonitor.MqttMonitorWidget import MqttMonitorWidget  # noqa: I101

        usesDarkPalette = ericApp().usesDarkPalette()
        iconSuffix = "dark" if usesDarkPalette else "light"

        self.__widget = MqttMonitorWidget(self, usesDarkPalette)
        iconName = (
            "sbMqttMonitor96"
            if self.__ui.getLayoutType() == "Sidebars"
            else "mqtt22-{0}".format(iconSuffix)
        )
        self.__ui.addSideWidget(
            _Side,
            self.__widget,
            EricPixmapCache.getIcon(os.path.join("MqttMonitor", "icons", iconName)),
            self.tr("MQTT Monitor"),
        )

        self.__activateAct = EricAction(
            self.tr("MQTT Monitor"),
            self.tr("M&QTT Monitor"),
            QKeySequence(self.tr("Alt+Shift+Q")),
            0,
            self,
            "mqtt_monitor_activate",
        )
        self.__activateAct.setStatusTip(
            self.tr("Switch the input focus to the MQTT Monitor window.")
        )
        self.__activateAct.setWhatsThis(
            self.tr(
                """<b>Activate MQTT Monitor</b>"""
                """<p>This switches the input focus to the MQTT Monitor"""
                """ window.</p>"""
            )
        )
        self.__activateAct.triggered.connect(self.__activateWidget)

        self.__ui.addEricActions([self.__activateAct], "ui")
        menu = self.__ui.getMenu("subwindow")
        menu.addAction(self.__activateAct)

        return None, True

    def deactivate(self):
        """
        Public method to deactivate this plug-in.
        """
        menu = self.__ui.getMenu("subwindow")
        menu.removeAction(self.__activateAct)
        self.__ui.removeEricActions([self.__activateAct], "ui")
        self.__ui.removeSideWidget(self.__widget)

        self.__initialize()

    def __loadTranslator(self):
        """
        Private method to load the translation file.
        """
        if self.__ui is not None:
            loc = self.__ui.getLocale()
            if loc and loc != "C":
                locale_dir = os.path.join(
                    os.path.dirname(__file__), "MqttMonitor", "i18n"
                )
                translation = "mqttmonitor_{0}".format(loc)
                translator = QTranslator(None)
                loaded = translator.load(translation, locale_dir)
                if loaded:
                    self.__translator = translator
                    ericApp().installTranslator(self.__translator)
                else:
                    print(
                        "Warning: translation file '{0}' could not be"
                        " loaded.".format(translation)
                    )
                    print("Using default.")

    def __activateWidget(self):
        """
        Private slot to handle the activation of the MQTT Monitor.
        """
        uiLayoutType = self.__ui.getLayoutType()

        if uiLayoutType == "Toolboxes":
            self.__ui.rToolboxDock.show()
            self.__ui.rToolbox.setCurrentWidget(self.__widget)
        elif uiLayoutType == "Sidebars":
            try:
                self.__ui.activateLeftRightSidebarWidget(self.__widget)
            except AttributeError:
                self.__activateLeftRightSidebarWidget(self.__widget)
        else:
            self.__widget.show()
        self.__widget.setFocus(Qt.FocusReason.ActiveWindowFocusReason)

    def getPreferences(self, key):
        """
        Public method to retrieve the various settings.

        @param key key of the setting
        @type str
        @return value of the requested setting
        @rtype Any
        """
        if key in (
            "RecentBrokersWithPort",
            "BrokerProfiles",
            "SubscribeProperties",
            "UnsubscribeProperties",
            "PublishProperties",
            "RecentTopics",
        ):
            return json.loads(
                Preferences.Prefs.settings.value(
                    self.PreferencesKey + "/" + key, self.__defaults[key]
                )
            )
        elif key in ("DefaultProtocol",):
            return MqttProtocols(
                int(
                    Preferences.Prefs.settings.value(
                        self.PreferencesKey + "/" + key, self.__defaults[key]
                    )
                )
            )
        elif key in ("DefaultProtocol", "RecentBrokersNumber", "RecentTopicsNumber"):
            return int(
                Preferences.Prefs.settings.value(
                    self.PreferencesKey + "/" + key, self.__defaults[key]
                )
            )
        else:
            return Preferences.Prefs.settings.value(
                self.PreferencesKey + "/" + key, self.__defaults[key]
            )

    def setPreferences(self, key, value):
        """
        Public method to store the various settings.

        @param key key of the setting to be set
        @type str
        @param value value to be set
        @type Any
        """
        if key in (
            "RecentBrokersWithPort",
            "BrokerProfiles",
            "SubscribeProperties",
            "UnsubscribeProperties",
            "PublishProperties",
            "RecentTopics",
        ):
            Preferences.Prefs.settings.setValue(
                self.PreferencesKey + "/" + key, json.dumps(value)
            )
        elif key in ("DefaultProtocol",):
            Preferences.Prefs.settings.setValue(
                self.PreferencesKey + "/" + key, int(value)
            )
        else:
            Preferences.Prefs.settings.setValue(self.PreferencesKey + "/" + key, value)

    ############################################################################
    ## Methods for backward compatibility with eric-ide < 24.9
    ############################################################################

    def __activateLeftRightSidebarWidget(self, widget):
        """
        Private method to activate the given widget in the left or right
        sidebar.

        @param widget reference to the widget to be activated
        @type QWidget
        """
        # This is for backward compatibility with eric-ide < 24.9.
        sidebar = (
            self.__ui.leftSidebar
            if Preferences.getUI("CombinedLeftRightSidebar")
            else self.__ui.rightSidebar
        )
        sidebar.show()
        sidebar.setCurrentWidget(widget)


def installDependencies(pipInstall):
    """
    Function to install dependencies of this plug-in.

    @param pipInstall function to be called with a list of package names.
    @type function
    """
    try:
        import paho.mqtt  # __IGNORE_WARNING__
    except ImportError:
        pipInstall(["paho-mqtt>=2.0.0"])


#
# eflag: noqa = M801, U200