1

# mqtt/client.py

     2

     3

from __future__ import absolute_import

     4

     5

import os

     6

import re

     8

     9

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    10

from PLCControler import LOCATION_CONFNODE, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT

    11

from .mqtt_client_gen import MQTTClientPanel, MQTTClientModel, MQTT_IEC_types, authParams

    12

    13

import util.paths as paths

    14

    15

    16

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

    17

# and cmake build was invoked from this directory

    18

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

    19

    20

frozen_path = paths.ThirdPartyPath("frozen")

    21

    22

MqttCIncludePaths = [

    23

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

    24

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

    25

    frozen_path

    26

]

    27

    28

class MQTTClientEditor(ConfTreeNodeEditor):

    29

    CONFNODEEDITOR_TABS = [

    32

    33

    MQTTClient_UI = None

    35

    36

    def Log(self, msg):

    37

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

    38

    39

    def CreateMQTTClient_UI(self, parent):

    40

        self.MQTTClient_UI = MQTTClientPanel(

    41

            parent,

    42

            self.Controler.GetModelData(),

    43

            self.Log,

    44

            self.Controler.GetTypes)

    45

        return self.MQTTClient_UI

    46

    56

    def RefreshView(self):

    57

        if(self.MQTTClient_UI):

    58

            self.MQTTClient_UI.RefreshView()

    59

        return ConfTreeNodeEditor.RefreshView(self)

    60

    61

    62

class MQTTClient(object):

    63

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

    64

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

    65

      <xsd:element name="MQTTClient">

    66

        <xsd:complexType>

    67

          <xsd:sequence>

    68

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

    69

              <xsd:complexType>

    70

                <xsd:choice minOccurs="0">

    71

                  <xsd:element name="x509">

    72

                    <xsd:complexType>

    73

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

    74

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

    75

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

    76

                    </xsd:complexType>

    77

                  </xsd:element>

    78

                  <xsd:element name="PSK">

    79

                    <xsd:complexType>

    80

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

    81

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

    82

                    </xsd:complexType>

    83

                  </xsd:element>

    84

                  <xsd:element name="UserPassword">

    85

                    <xsd:complexType>

    86

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

    87

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

    88

                    </xsd:complexType>

    89

                  </xsd:element>

    90

                </xsd:choice>

    91

              </xsd:complexType>

    92

            </xsd:element>

    93

          </xsd:sequence>

    94

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

    95

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

    96

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

    97

        </xsd:complexType>

    98

      </xsd:element>

    99

    </xsd:schema>

   100

    """

   101

   102

    EditorType = MQTTClientEditor

   103

   104

    def __init__(self):

   105

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

   106

   107

        filepath = self.GetFileName()

   108

        if os.path.isfile(filepath):

   109

            self.modeldata.LoadCSV(filepath)

   110

   111

    def Log(self, msg):

   112

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

   113

   114

    def GetModelData(self):

   115

        return self.modeldata

   116

   117

    def GetTypes(self):

   118

        datatype_candidates = self.GetCTRoot().GetDataTypes(basetypes=False, only_locatables=True)

   119

        return datatype_candidates

   120

   121

    def GetDataTypeInfos(self, typename):

   122

        tagname = "D::"+typename

   123

        return self.GetCTRoot().GetDataTypeInfos(tagname)

   124

   125

    def GetConfig(self):

   126

        def cfg(path): 

   127

            try:

   128

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

   129

            except ValueError:

   130

                return None

   131

            return attr["value"]

   132

   133

        AuthType = cfg("AuthType")

   134

        res = dict(

   135

            URI=cfg("Broker_URI"),

   136

            AuthType=AuthType,

   137

            clientID=cfg("Client_ID"),

   138

            UseMQTT5=cfg("Use_MQTT_5"))

   139

   140

        paramList = authParams.get(AuthType, None)

   141

        if paramList:

   142

            for name,default in paramList:

   143

   144

                # Translate internal config naming into user config naming

   145

                displayed_name = {"KeyStore"   : "Client_certificate",

   146

                                  "TrustStore" : "Broker_certificate", 

   147

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

   148

   149

                value = cfg("AuthType." + displayed_name)

   150

                if value == "" or value is None:

   151

                    value = default

   152

   153

                if value is not None:

   154

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

   155

   156

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

   157

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

   158

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

   159

   160

                res[name] = value

   161

   162

        return res

   163

   164

    def GetFileName(self):

   165

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

   166

   167

    def OnCTNSave(self, from_project_path=None):

   168

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

   169

        return True

   170

   171

    def CTNGenerate_C(self, buildpath, locations):

   172

        current_location = self.GetCurrentLocation()

   173

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

   174

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

   175

   176

        c_code = """

   177

#include "iec_types_all.h"

   178

#include "beremiz.h"

   179

"""

   180

        config = self.GetConfig()

   181

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

   182

   183

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

   184

            c_file.write(c_code)

   185

   186

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

   187

            static_lib = "libpaho-mqtt3cs.a"

   188

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

   189

        else:

   190

            static_lib = "libpaho-mqtt3c.a"

   191

            libs = []

   192

   193

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

   194

   195

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

   196

   197

        # TODO: add frozen only if using JSON

   198

        frozen_c_path = os.path.join(frozen_path, "frozen.c")

   199

   200

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

   201

   202

    def GetVariableLocationTree(self):

   203

        current_location = self.GetCurrentLocation()

   204

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

   205

        name = self.BaseParams.getName()

   206

   207

        entries = []

   208

        children = []

   209

   210

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

   211

            Topic, QoS, _Retained, iec_type, iec_number = row

   212

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

   213

   214

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

   215

            Topic, QoS, iec_type, iec_number = row

   216

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

   217

   218

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

   219

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

   220

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

   221

            children.append({

   222

                "name": Topic,

   223

                "type": loc_type,

   224

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

   225

                "IEC_type": iec_type,

   226

                "var_name": c_loc_name,

   227

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

   228

                "description": "",

   229

                "children": []})

   230

   231

        return {"name": name,

   232

                "type": LOCATION_CONFNODE,

   233

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

   234

                "children": children}

   235

   236

   237

    def CTNGlobalInstances(self):

   238

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