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(

    33

            parent,

    34

            self.Controler.GetModelData(),

    35

            self.Log,

    36

            self.Controler.GetTypes)

    37

    38

class MQTTClient(object):

    39

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

    40

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

    41

      <xsd:element name="MQTTClient">

    42

        <xsd:complexType>

    43

          <xsd:sequence>

    44

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

    45

              <xsd:complexType>

    46

                <xsd:choice minOccurs="0">

    47

                  <xsd:element name="x509">

    48

                    <xsd:complexType>

    49

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

    50

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

    51

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

    52

                    </xsd:complexType>

    53

                  </xsd:element>

    54

                  <xsd:element name="PSK">

    55

                    <xsd:complexType>

    56

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

    57

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

    58

                    </xsd:complexType>

    59

                  </xsd:element>

    60

                  <xsd:element name="UserPassword">

    61

                    <xsd:complexType>

    62

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

    63

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

    64

                    </xsd:complexType>

    65

                  </xsd:element>

    66

                </xsd:choice>

    67

              </xsd:complexType>

    68

            </xsd:element>

    69

          </xsd:sequence>

    70

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

    71

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

    72

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

    73

        </xsd:complexType>

    74

      </xsd:element>

    75

    </xsd:schema>

    76

    """

    77

    78

    EditorType = MQTTClientEditor

    79

    80

    def __init__(self):

    81

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

    82

    83

        filepath = self.GetFileName()

    84

        if os.path.isfile(filepath):

    85

            self.modeldata.LoadCSV(filepath)

    86

    87

    def Log(self, msg):

    88

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

    89

    90

    def GetModelData(self):

    91

        return self.modeldata

    92

    93

    def GetTypes(self):

    94

        datatype_candidates = self.GetCTRoot().GetDataTypes()

    95

        return datatype_candidates

    96

    97

    def GetConfig(self):

    98

        def cfg(path): 

    99

            try:

   100

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

   101

            except ValueError:

   102

                return None

   103

            return attr["value"]

   104

   105

        AuthType = cfg("AuthType")

   106

        res = dict(

   107

            URI=cfg("Broker_URI"),

   108

            AuthType=AuthType,

   109

            clientID=cfg("Client_ID"),

   110

            UseMQTT5=cfg("Use_MQTT_5"))

   111

   112

        paramList = authParams.get(AuthType, None)

   113

        if paramList:

   114

            for name,default in paramList:

   115

   116

                # Translate internal config naming into user config naming

   117

                displayed_name = {"KeyStore"   : "Client_certificate",

   118

                                  "TrustStore" : "Broker_certificate", 

   119

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

   120

   121

                value = cfg("AuthType." + displayed_name)

   122

                if value == "" or value is None:

   123

                    value = default

   124

   125

                if value is not None:

   126

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

   127

   128

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

   129

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

   130

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

   131

   132

                res[name] = value

   133

   134

        return res

   135

   136

    def GetFileName(self):

   137

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

   138

   139

    def OnCTNSave(self, from_project_path=None):

   140

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

   141

        return True

   142

   143

    def CTNGenerate_C(self, buildpath, locations):

   144

        current_location = self.GetCurrentLocation()

   145

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

   146

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

   147

   148

        c_code = """

   149

#include "iec_types_all.h"

   150

#include "beremiz.h"

   151

"""

   152

        config = self.GetConfig()

   153

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

   154

   155

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

   156

            c_file.write(c_code)

   157

   158

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

   159

            static_lib = "libpaho-mqtt3cs.a"

   160

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

   161

        else:

   162

            static_lib = "libpaho-mqtt3c.a"

   163

            libs = []

   164

   165

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

   166

   167

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

   168

   169

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

   170

   171

    def GetVariableLocationTree(self):

   172

        current_location = self.GetCurrentLocation()

   173

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

   174

        name = self.BaseParams.getName()

   175

   176

        entries = []

   177

        children = []

   178

   179

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

   180

            Topic, QoS, _Retained, iec_type, iec_number = row

   181

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

   182

   183

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

   184

            Topic, QoS, iec_type, iec_number = row

   185

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

   186

   187

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

   188

            _C_type, iec_size_prefix = MQTT_IEC_types.get(iec_type,(None,""))

   189

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

   190

            children.append({

   191

                "name": Topic,

   192

                "type": loc_type,

   193

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

   194

                "IEC_type": iec_type,

   195

                "var_name": c_loc_name,

   196

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

   197

                "description": "",

   198

                "children": []})

   199

   200

        return {"name": name,

   201

                "type": LOCATION_CONFNODE,

   202

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

   203

                "children": children}

   204

   205

   206

    def CTNGlobalInstances(self):

   207

        location_str = "_".join(map(str, self.GetCurrentLocation()))

   208

        return [("MQTT_HAPPY_"+location_str, "DINT", "")]

   209

   210