1

from __future__ import print_function

     2

from __future__ import absolute_import

     3

     4

import csv

     5

import functools

     6

from threading import Thread

     7

from collections import OrderedDict as OD

     8

     9

import wx

    10

import wx.dataview as dv

    11

    12

import util.paths as paths

    13

    14

# from perfect_hash import generate_code, IntSaltHash

    15

    16

MQTT_IEC_types = dict(

    17

# IEC61131|  C  type   | sz

    18

    BOOL  = ("uint8_t" , "X"),

    19

    SINT  = ("int8_t"  , "B"),

    20

    USINT = ("uint8_t" , "B"),

    21

    INT   = ("int16_t" , "W"),

    22

    UINT  = ("uint16_t", "W"),

    23

    DINT  = ("uint32_t", "D"),

    24

    UDINT = ("int32_t" , "D"),

    25

    LINT  = ("int64_t" , "L"),

    26

    ULINT = ("uint64_t", "L"),

    27

    REAL  = ("float"   , "D"),

    28

    LREAL = ("double"  , "L"),

    29

)

    30

    31

"""

    32

 QoS - Quality of Service

    33

  0  : "At most one delivery"

    34

  1  : "At least one delivery"

    35

  2  : "Exactly one delivery"

    36

"""

    37

QoS_values = [0, 1, 2]

    38

    39

def boolean(v):

    40

    if v in ["False","0"]:

    41

        return False

    42

    else:

    43

        return bool(v)

    44

    45

_lstcolnames  = [ "Topic",  "QoS",  "Retained", "Type", "Location"]

    46

_lstcolwidths = [     100,     50,         100,    100,         50]

    47

_lstcoltypess = [     str,    int,     boolean,    str,        int]

    48

_lstcoldeflts = [ "a/b/c",    "1",       False, "DINT",        "0"]

    49

    50

subsublist = lambda l : l[0:2] + l[3:5]

    51

    52

lstcoldsc = {

    53

    "input" : type("",(),dict(

    54

        lstcolnames  = subsublist(_lstcolnames),

    55

        lstcolwidths = subsublist(_lstcolwidths),

    56

        lstcoltypess = subsublist(_lstcoltypess),

    57

        lstcoldeflts = subsublist(_lstcoldeflts),

    58

        Location_column = 3)),

    59

    "output" : type("",(),dict(

    60

        lstcolnames  = _lstcolnames,

    61

        lstcolwidths = _lstcolwidths,

    62

        lstcoltypess = _lstcoltypess,

    63

        lstcoldeflts = _lstcoldeflts,

    64

        Location_column = 4)),

    65

}

    66

    67

directions = ["input", "output"]

    68

    69

# expected configuration entries with internal default value

    70

authParams = {

    71

    "x509":[

    72

        ("Verify", True),

    73

        ("KeyStore", None),

    74

        ("TrustStore", None)],

    75

    "UserPassword":[

    76

        ("User", None),

    77

        ("Password", None)]}

    78

    79

class MQTTTopicListModel(dv.PyDataViewIndexListModel):

    80

    def __init__(self, data, log, direction):

    81

        dv.PyDataViewIndexListModel.__init__(self, len(data))

    82

        self.data = data

    83

        self.log = log

    84

        self.dsc = lstcoldsc[direction]

    85

    86

    def GetColumnType(self, col):

    87

        return "string"

    88

    89

    def GetValueByRow(self, row, col):

    90

        return str(self.data[row][col])

    91

    92

    # This method is called when the user edits a data item in the view.

    93

    def SetValueByRow(self, value, row, col):

    94

        expectedtype = self.dsc.lstcoltypess[col]

    95

    96

        try:

    97

            v = expectedtype(value)

    98

        except ValueError: 

    99

            self.log("String {} is invalid for type {}\n".format(value,expectedtype.__name__))

   100

            return False

   101

   102

        if col == self.dsc.lstcolnames.index("QoS") and v not in QoS_values:

   103

            self.log("{} is invalid for IdType\n".format(value))

   104

            return False

   105

   106

        line = self.data[row]

   107

        line[col] = v

   108

        self.data[row] = line

   109

        return True

   110

   111

    # Report how many columns this model provides data for.

   112

    def GetColumnCount(self):

   113

        return len(self.dsc.lstcolnames)

   114

   115

    # Report the number of rows in the model

   116

    def GetCount(self):

   117

        #self.log.write('GetCount')

   118

        return len(self.data)

   119

   120

    # Called to check if non-standard attributes should be used in the

   121

    # cell at (row, col)

   122

    def GetAttrByRow(self, row, col, attr):

   123

        if col == self.dsc.Location_column:

   124

            attr.SetColour('blue')

   125

            attr.SetBold(True)

   126

            return True

   127

        return False

   128

   129

   130

    def DeleteRows(self, rows):

   131

        # make a copy since we'll be sorting(mutating) the list

   132

        # use reverse order so the indexes don't change as we remove items

   133

        rows = sorted(rows, reverse=True)

   134

   135

        for row in rows:

   136

            # remove it from our data structure

   137

            del self.data[row]

   138

            # notify the view(s) using this model that it has been removed

   139

            self.RowDeleted(row)

   140

   141

   142

    def AddRow(self, value):

   143

        if self.data.append(value):

   144

            # notify views

   145

            self.RowAppended()

   146

   147

    def InsertDefaultRow(self, row):

   148

        self.data.insert(row, self.dsc.lstcoldeflts[:])

   149

        # notify views

   150

        self.RowInserted(row)

   151

   152

    def ResetData(self):

   153

        self.Reset(len(self.data))

   154

   155

class MQTTTopicListPanel(wx.Panel):

   156

    def __init__(self, parent, log, model, direction, types_getter):

   157

        self.log = log

   158

        wx.Panel.__init__(self, parent, -1)

   159

   160

        self.dvc = dv.DataViewCtrl(self,

   161

                                   style=wx.BORDER_THEME

   162

                                   | dv.DV_ROW_LINES

   163

                                   | dv.DV_HORIZ_RULES

   164

                                   | dv.DV_VERT_RULES

   165

                                   | dv.DV_MULTIPLE

   166

                                   )

   167

   168

        self.model = model

   169

   170

        self.dvc.AssociateModel(self.model)

   171

   172

        self.types_getter = types_getter

   173

        self.direction =  direction

   174

        self.CreateDVCColumns()

   175

   176

        self.Sizer = wx.BoxSizer(wx.VERTICAL)

   177

   178

        titlestr = direction + " variables"

   179

   180

        title = wx.StaticText(self, label = titlestr)

   181

   182

        addbt = wx.Button(self, label="Add")

   183

        self.Bind(wx.EVT_BUTTON, self.OnAddRow, addbt)

   184

        delbt = wx.Button(self, label="Delete")

   185

        self.Bind(wx.EVT_BUTTON, self.OnDeleteRows, delbt)

   186

   187

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   188

        topsizer.Add(title, 1, wx.ALIGN_CENTER_VERTICAL|wx.LEFT|wx.RIGHT, 5)

   189

        topsizer.Add(addbt, 0, wx.LEFT|wx.RIGHT, 5)

   190

        topsizer.Add(delbt, 0, wx.LEFT|wx.RIGHT, 5)

   191

        self.Sizer.Add(topsizer, 0, wx.EXPAND|wx.TOP|wx.BOTTOM, 5)

   192

        self.Sizer.Add(self.dvc, 1, wx.EXPAND)

   193

   194

   195

    def CreateDVCColumns(self):

   196

        dsc = lstcoldsc[self.direction]

   197

        for idx,(colname,width) in enumerate(zip(dsc.lstcolnames,dsc.lstcolwidths)):

   198

            if colname == "Type":

   199

                choice_DV_render = dv.DataViewChoiceRenderer(self.types_getter())

   200

                choice_DV_col = dv.DataViewColumn(colname, choice_DV_render, idx, width=width)

   201

                self.dvc.AppendColumn(choice_DV_col)

   202

            else:

   203

                self.dvc.AppendTextColumn(colname,  idx, width=width, mode=dv.DATAVIEW_CELL_EDITABLE)

   204

   205

    def ResetDVCColumns(self):

   206

        self.dvc.ClearColumns()

   207

        self.CreateDVCColumns()

   208

   209

    def OnAddRow(self, evt):

   210

        items = self.dvc.GetSelections()

   211

        row = self.model.GetRow(items[0]) if items else 0

   212

        self.model.InsertDefaultRow(row)

   213

   214

    def OnDeleteRows(self, evt):

   215

        items = self.dvc.GetSelections()

   216

        rows = [self.model.GetRow(item) for item in items]

   217

        self.model.DeleteRows(rows)

   218

   219

   220

class MQTTClientPanel(wx.SplitterWindow):

   221

    def __init__(self, parent, modeldata, log, types_getter):

   222

        self.log = log

   223

        wx.SplitterWindow.__init__(self, parent, style=wx.SUNKEN_BORDER | wx.SP_3D)

   224

   225

        self.selected_datas = modeldata

   226

        self.selected_models = { direction:MQTTTopicListModel(

   227

            self.selected_datas[direction], log, direction) for direction in directions }

   228

        self.selected_lists = { direction:MQTTTopicListPanel(

   229

                self, log, 

   230

                self.selected_models[direction], direction, types_getter) 

   231

            for direction in directions }

   232

   233

        self.SplitHorizontally(*[self.selected_lists[direction] for direction in directions]+[300])

   234

   235

        self.SetAutoLayout(True)

   236

   237

    def RefreshView(self):

   238

        for direction in directions:

   239

            self.selected_lists[direction].ResetDVCColumns()

   240

   241

    def OnClose(self):

   242

        pass

   243

   244

    def __del__(self):

   245

        self.OnClose()

   246

   247

    def Reset(self):

   248

        for direction in directions:

   249

            self.selected_models[direction].ResetData() 

   250

   251

   252

class MQTTClientList(list):

   253

    def __init__(self, log, change_callback, direction):

   254

        super(MQTTClientList, self).__init__(self)

   255

        self.log = log

   256

        self.change_callback = change_callback

   257

        self.dsc = lstcoldsc[direction]

   258

   259

    def _filter_line(self, value):

   260

        v = dict(list(zip(self.dsc.lstcolnames, value)))

   261

   262

        if type(v["Location"]) != int:

   263

            if len(self) == 0:

   264

                v["Location"] = 0

   265

            else:

   266

                iecnums = set(zip(*self)[self.dsc.Location_column])

   267

                greatest = max(iecnums)

   268

                holes = set(range(greatest)) - iecnums

   269

                v["Location"] = min(holes) if holes else greatest+1

   270

   271

        try:

   272

            for t,n in zip(self.dsc.lstcoltypess, self.dsc.lstcolnames):

   273

                v[n] = t(v[n]) 

   274

        except ValueError: 

   275

            self.log("MQTT topic {} (Location={}) has invalid type\n".format(v["Topic"],v["Location"]))

   276

            return None

   277

   278

        if v["QoS"] not in QoS_values:

   279

            self.log("Unknown QoS\n".format(value))

   280

            return None

   281

   282

        if len(self)>0 and v["Topic"] in list(zip(*self))[self.dsc.lstcolnames.index("Topic")]:

   283

            self.log("MQTT topic {} (Location={}) already in the list\n".format(v["Topic"],v["Location"]))

   284

            return None

   285

   286

        return [v[n] for n in self.dsc.lstcolnames]

   287

   288

    def insert(self, row, value):

   289

        v = self._filter_line(value)

   290

        if v is not None:

   291

            list.insert(self, row, v)

   292

            self.change_callback()

   293

            return True

   294

        return False

   295

   296

    def append(self, value):

   297

        v = self._filter_line(value)

   298

        if v is not None:

   299

            list.append(self, v)

   300

            self.change_callback()

   301

            return True

   302

        return False

   303

   304

    def __setitem__(self, index, value):

   305

        list.__setitem__(self, index, value)

   306

        self.change_callback()

   307

   308

    def __delitem__(self, index):

   309

        list.__delitem__(self, index)

   310

        self.change_callback()

   311

   312

   313

class MQTTClientModel(dict):

   314

    def __init__(self, log, change_callback = lambda : None):

   315

        super(MQTTClientModel, self).__init__()

   316

        for direction in directions:

   317

            self[direction] = MQTTClientList(log, change_callback, direction)

   318

   319

    def LoadCSV(self,path):

   320

        with open(path, 'r') as csvfile:

   321

            reader = csv.reader(csvfile, delimiter=',', quotechar='"')

   322

            buf = {direction:[] for direction, _model in self.iteritems()}

   323

            for direction, model in self.iteritems():

   324

                self[direction][:] = []

   325

            for row in reader:

   326

                direction = row[0]

   327

                # avoids calling change callback when loading CSV

   328

                l = self[direction]

   329

                v = l._filter_line(row[1:])

   330

                if v is not None:

   331

                    list.append(l,v)

   332

                # TODO be verbose in case of malformed CSV

   333

   334

    def SaveCSV(self,path):

   335

        with open(path, 'w') as csvfile:

   336

            for direction, data in self.items():

   337

                writer = csv.writer(csvfile, delimiter=',',

   338

                                quotechar='"', quoting=csv.QUOTE_MINIMAL)

   339

                for row in data:

   340

                    writer.writerow([direction] + row)

   341

   342

    def GenerateC(self, path, locstr, config, datatype_info_getter):

   343

        c_template_filepath = paths.AbsNeighbourFile(__file__, "mqtt_template.c")

   344

        c_template_file = open(c_template_filepath , 'rb')

   345

        c_template = c_template_file.read()

   346

        c_template_file.close()

   347

   348

        json_types = OD()

   349

   350

        formatdict = dict(

   351

            locstr          = locstr,

   352

            uri             = config["URI"],

   353

            clientID        = config["clientID"],

   354

            decl            = "",

   355

            topics          = "",

   356

            cleanup         = "",

   357

            init            = "",

   358

            init_pubsub     = "",

   359

            retrieve        = "",

   360

            publish         = "",

   361

            publish_changes = "",

   362

            json_decl       = ""

   363

        )

   364

   365

   366

        # Use Config's "MQTTVersion" to switch between protocol version at build time

   367

        if config["UseMQTT5"]:

   368

            formatdict["decl"] += """

   369

#define USE_MQTT_5""".format(**config)

   370

   371

        AuthType = config["AuthType"]

   372

        if AuthType == "x509":

   373

            for k in ["KeyStore","TrustStore"]:

   374

                config[k] = '"'+config[k]+'"' if config[k] else "NULL"

   375

            formatdict["init"] += """

   376

    INIT_x509({Verify:d}, {KeyStore}, {TrustStore})""".format(**config)

   377

        if AuthType == "PSK":

   378

            formatdict["init"] += """

   379

    INIT_PSK("{Secret}", "{ID}")""".format(**config)

   380

        elif AuthType == "UserPassword":

   381

            formatdict["init"] += """

   382

    INIT_UserPassword("{User}", "{Password}")""".format(**config)

   383

        else:

   384

            formatdict["init"] += """

   385

    INIT_NoAuth()"""

   386

   387

        for row in self["output"]:

   388

            Topic, QoS, _Retained, iec_type, iec_number = row

   389

            Retained = 1 if _Retained=="True" else 0

   390

            if iec_type in MQTT_IEC_types:

   391

                C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   392

                c_loc_name = "__Q" + iec_size_prefix + locstr + "_" + str(iec_number)

   393

                encoding = "SIMPLE"

   394

            else:

   395

                C_type = iec_type.upper();

   396

                c_loc_name = "__Q" + locstr + "_" + str(iec_number)

   397

                json_types.setdefault(iec_type,OD()).setdefault("OUTPUT",[]).append(c_loc_name)

   398

                encoding = "JSON"

   399

   400

   401

            formatdict["decl"] += """

   402

DECL_VAR({iec_type}, {C_type}, {c_loc_name})""".format(**locals())

   403

            formatdict["init_pubsub"] += """

   404

    INIT_PUBLICATION({encoding}, {Topic}, {QoS}, {C_type}, {c_loc_name}, {Retained})""".format(**locals())

   405

            formatdict["publish"] += """

   406

        WRITE_VALUE({c_loc_name}, {C_type})""".format(**locals())

   407

            formatdict["publish_changes"] += """

   408

            PUBLISH_CHANGE({encoding}, {Topic}, {QoS}, {C_type}, {c_loc_name}, {Retained})""".format(**locals())

   409

   410

        # inputs need to be sorted for bisection search 

   411

        for row in sorted(self["input"]):

   412

            Topic, QoS, iec_type, iec_number = row

   413

            if iec_type in MQTT_IEC_types:

   414

                C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   415

                c_loc_name = "__I" + iec_size_prefix + locstr + "_" + str(iec_number)

   416

                init_topic_call = "INIT_TOPIC"

   417

            else:

   418

                C_type = iec_type.upper();

   419

                c_loc_name = "__I" + locstr + "_" + str(iec_number)

   420

                init_topic_call = "INIT_JSON_TOPIC"

   421

                json_types.setdefault(iec_type,OD()).setdefault("INPUT",[]).append(c_loc_name)

   422

   423

            formatdict["decl"] += """

   424

DECL_VAR({iec_type}, {C_type}, {c_loc_name})""".format(**locals())

   425

            formatdict["topics"] += """

   426

    {init_topic_call}({Topic}, {iec_type}, {c_loc_name})""".format(**locals())

   427

            formatdict["init_pubsub"] += """

   428

    INIT_SUBSCRIPTION({Topic}, {QoS})""".format(**locals())

   429

            formatdict["retrieve"] += """

   430

        READ_VALUE({c_loc_name}, {C_type})""".format(**locals())

   431

   432

        def recurseJsonTypes(datatype, basetypes):

   433

            basetypes.append(datatype)

   434

            # add derivated type first fo we can expect the list to be sorted

   435

            # with base types in last position

   436

            infos = datatype_info_getter(datatype)

   437

            for element in infos["elements"]:

   438

                field_datatype = element["Type"]

   439

                if field_datatype not in MQTT_IEC_types:

   440

                    recurseJsonTypes(field_datatype, basetypes)

   441

   442

        print(json_types)

   443

   444

        # collect all type dependencies

   445

        basetypes=[]  # use a list to keep them ordered

   446

        for iec_type,_instances in json_types.items():

   447

            recurseJsonTypes(iec_type, basetypes)

   448

   449

        done_types = set()

   450

        # go backard to get most derivated type definition last

   451

        # so that CPP can always find base type deinition before

   452

        for iec_type in reversed(basetypes):

   453

            # avoid repeating type definition

   454

            if iec_type in done_types:

   455

                continue

   456

            done_types.add(iec_type)

   457

   458

            C_type = iec_type.upper()

   459

            json_decl = "#define TYPE_" + C_type + "(_P, _A) \\\n"

   460

   461

            infos = datatype_info_getter(iec_type)

   462

   463

            elements = infos["elements"]

   464

            last = len(elements) - 1

   465

            for idx, element in enumerate(elements):

   466

                field_iec_type = element["Type"]

   467

                field_C_type = field_iec_type.upper()

   468

                field_name = element["Name"].upper()

   469

                if field_iec_type in MQTT_IEC_types:

   470

                    decl_type = "SIMPLE"

   471

                else:

   472

                    decl_type = "OBJECT"

   473

   474

                json_decl += "    _P##_"+decl_type+"(" + field_C_type + ", " + field_name + ", _A)"

   475

                if idx != last:

   476

                    json_decl += " _P##_separator \\"

   477

                else:

   478

                    json_decl += "\n"

   479

                json_decl += "\n"

   480

   481

   482

            formatdict["json_decl"] += json_decl

   483

   484

        for iec_type, instances in json_types.items():

   485

            C_type = iec_type.upper()

   486

            for direction, instance_list in instances.items():

   487

                for c_loc_name in instance_list:

   488

                    formatdict["json_decl"] += "DECL_JSON_"+direction+"("+C_type+", "+c_loc_name+")\n"

   489

   490

        Ccode = c_template.format(**formatdict)

   491

   492

        return Ccode

   493