1

# mqtt/client.py

     2

     3

from __future__ import absolute_import

     4

     5

import os

     6

import re

     7

     8

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

     9

from PLCControler import LOCATION_CONFNODE, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT

    10

from .mqtt_client_gen import MQTTClientPanel, MQTTClientModel, MQTT_IEC_types, authParams

    11

    12

import util.paths as paths

    13

    14

    15

# assumes that "build" directory was created in paho.mqtt.c source directory,

    16

# and cmake build was invoked from this directory

    17

PahoMqttCLibraryPath = paths.ThirdPartyPath("paho.mqtt.c", "build", "src")

    18

    19

PahoMqttCIncludePaths = [

    20

    paths.ThirdPartyPath("paho.mqtt.c", "build"),  # VersionInfo.h

    21

    paths.ThirdPartyPath("paho.mqtt.c", "src")

    22

]

    23

    24

class MQTTClientEditor(ConfTreeNodeEditor):

    25

    CONFNODEEDITOR_TABS = [

    26

        (_("MQTT Client"), "CreateMQTTClient_UI")]

    27

    28

    def Log(self, msg):

    29

        self.Controler.GetCTRoot().logger.write(msg)

    30

    31

    def CreateMQTTClient_UI(self, parent):

    32

        return MQTTClientPanel(parent, self.Controler.GetModelData(), self.Log, self.Controler.GetConfig)

    33

    34

class MQTTClient(object):

    35

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

    36

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    37

      <xsd:element name="MQTTClient">

    38

        <xsd:complexType>

    39

          <xsd:sequence>

    40

            <xsd:element name="AuthType" minOccurs="0">

    41

              <xsd:complexType>

    42

                <xsd:choice minOccurs="0">

    43

                  <xsd:element name="x509">

    44

                    <xsd:complexType>

    45

                      <xsd:attribute name="Client_certificate" type="xsd:string" use="optional" default="KeyStore.pem"/>

    46

                      <xsd:attribute name="Broker_certificate" type="xsd:string" use="optional" default="TrustStore.pem"/>

    47

                      <xsd:attribute name="Verify_hostname" type="xsd:boolean" use="optional" default="true"/>

    48

                    </xsd:complexType>

    49

                  </xsd:element>

    50

                  <xsd:element name="PSK">

    51

                    <xsd:complexType>

    52

                      <xsd:attribute name="Secret" type="xsd:string" use="optional" default=""/>

    53

                      <xsd:attribute name="ID" type="xsd:string" use="optional" default=""/>

    54

                    </xsd:complexType>

    55

                  </xsd:element>

    56

                  <xsd:element name="UserPassword">

    57

                    <xsd:complexType>

    58

                      <xsd:attribute name="User" type="xsd:string" use="optional"/>

    59

                      <xsd:attribute name="Password" type="xsd:string" use="optional"/>

    60

                    </xsd:complexType>

    61

                  </xsd:element>

    62

                </xsd:choice>

    63

              </xsd:complexType>

    64

            </xsd:element>

    65

          </xsd:sequence>

    66

          <xsd:attribute name="Use_MQTT_5" type="xsd:boolean" use="optional" default="true"/>

    67

          <xsd:attribute name="Broker_URI" type="xsd:string" use="optional" default="ws://localhost:1883"/>

    68

          <xsd:attribute name="Client_ID" type="xsd:string" use="optional" default=""/>

    69

        </xsd:complexType>

    70

      </xsd:element>

    71

    </xsd:schema>

    72

    """

    73

    74

    EditorType = MQTTClientEditor

    75

    76

    def __init__(self):

    77

        self.modeldata = MQTTClientModel(self.Log, self.CTNMarkModified)

    78

    79

        filepath = self.GetFileName()

    80

        if os.path.isfile(filepath):

    81

            self.modeldata.LoadCSV(filepath)

    82

    83

    def Log(self, msg):

    84

        self.GetCTRoot().logger.write(msg)

    85

    86

    def GetModelData(self):

    87

        return self.modeldata

    88

    89

    def GetConfig(self):

    90

        def cfg(path): 

    91

            try:

    92

                attr=self.GetParamsAttributes("MQTTClient."+path)

    93

            except ValueError:

    94

                return None

    95

            return attr["value"]

    96

    97

        AuthType = cfg("AuthType")

    98

        res = dict(

    99

            URI=cfg("Broker_URI"),

   100

            AuthType=AuthType,

   101

            clientID=cfg("Client_ID"),

   102

            UseMQTT5=cfg("Use_MQTT_5"))

   103

   104

        paramList = authParams.get(AuthType, None)

   105

        if paramList:

   106

            for name,default in paramList:

   107

   108

                # Translate internal config naming into user config naming

   109

                displayed_name = {"KeyStore"   : "Client_certificate",

   110

                                  "TrustStore" : "Broker_certificate", 

   111

                                  "Verify"     : "Verify_hostname"}.get(name, name)

   112

   113

                value = cfg("AuthType." + displayed_name)

   114

                if value == "" or value is None:

   115

                    value = default

   116

   117

                if value is not None:

   118

                    # cryptomaterial is expected to be in project's user provided file directory

   119

   120

                    # User input may contain char incompatible with C string literal escaping

   121

                    if name in ["User","Password","TrustStore","KeyStore","Broker_URI","Client_ID"]:

   122

                        value = re.sub(r'([\"\\])',  r'\\\1', value)

   123

   124

                res[name] = value

   125

   126

        return res

   127

   128

    def GetFileName(self):

   129

        return os.path.join(self.CTNPath(), 'selected.csv')

   130

   131

    def OnCTNSave(self, from_project_path=None):

   132

        self.modeldata.SaveCSV(self.GetFileName())

   133

        return True

   134

   135

    def CTNGenerate_C(self, buildpath, locations):

   136

        current_location = self.GetCurrentLocation()

   137

        locstr = "_".join(map(str, current_location))

   138

        c_path = os.path.join(buildpath, "mqtt_client__%s.c" % locstr)

   139

   140

        c_code = """

   141

#include "iec_types_all.h"

   142

#include "beremiz.h"

   143

"""

   144

        config = self.GetConfig()

   145

        c_code += self.modeldata.GenerateC(c_path, locstr, config)

   146

   147

        with open(c_path, 'w') as c_file:

   148

            c_file.write(c_code)

   149

   150

        if config["AuthType"] == "x509":

   151

            static_lib = "libpaho-mqtt3cs.a"

   152

            libs = ['-lssl', '-lcrypto']

   153

        else:

   154

            static_lib = "libpaho-mqtt3c.a"

   155

            libs = []

   156

   157

        LDFLAGS = [' "' + os.path.join(PahoMqttCLibraryPath, static_lib) + '"'] + libs

   158

   159

        CFLAGS = ' '.join(['-I"' + path + '"' for path in PahoMqttCIncludePaths])

   160

   161

        return [(c_path, CFLAGS)], LDFLAGS, True

   162

   163

    def GetVariableLocationTree(self):

   164

        current_location = self.GetCurrentLocation()

   165

        locstr = "_".join(map(str, current_location))

   166

        name = self.BaseParams.getName()

   167

   168

        entries = []

   169

        children = []

   170

   171

        for row in self.modeldata["output"]:

   172

            Topic, QoS, _Retained, iec_type, iec_number = row

   173

            entries.append((Topic, QoS, iec_type, iec_number, "Q", LOCATION_VAR_OUTPUT))

   174

   175

        for row in self.modeldata["input"]:

   176

            Topic, QoS, iec_type, iec_number = row

   177

            entries.append((Topic, QoS, iec_type, iec_number, "I", LOCATION_VAR_INPUT))

   178

   179

        for Topic, QoS, iec_type, iec_number, iec_dir_prefix, loc_type in entries:

   180

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   181

            c_loc_name = "__" + iec_dir_prefix + iec_size_prefix + locstr + "_" + str(iec_number)

   182

            children.append({

   183

                "name": Topic,

   184

                "type": loc_type,

   185

                "size": {"X":1, "B":8, "W":16, "D":32, "L":64}[iec_size_prefix],

   186

                "IEC_type": iec_type,

   187

                "var_name": c_loc_name,

   188

                "location": "%" + iec_dir_prefix + iec_size_prefix + ".".join([str(i) for i in current_location]) + "." + str(iec_number),

   189

                "description": "",

   190

                "children": []})

   191

   192

        return {"name": name,

   193

                "type": LOCATION_CONFNODE,

   194

                "location": ".".join([str(i) for i in current_location]) + ".x",

   195

                "children": children}

   196