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

     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 MQQTTypeChoiceRenderer(dv.DataViewChoiceRenderer):

   156

    def __init__(self, types_getter):

   157

        dv.DataViewChoiceRenderer.__init__(self, types_getter())

   158

        self.types_getter = types_getter

   159

   160

    def GetChoices(self):

   161

        return self.types_getter()

   162

   163

class MQTTTopicListPanel(wx.Panel):

   164

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

   165

        self.log = log

   166

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

   167

   168

        self.dvc = dv.DataViewCtrl(self,

   169

                                   style=wx.BORDER_THEME

   170

                                   | dv.DV_ROW_LINES

   171

                                   | dv.DV_HORIZ_RULES

   172

                                   | dv.DV_VERT_RULES

   173

                                   | dv.DV_MULTIPLE

   174

                                   )

   175

   176

        self.model = model

   177

   178

        self.dvc.AssociateModel(self.model)

   179

   180

        dsc = lstcoldsc[direction]

   181

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

   182

            if colname == "Type":

   183

                choice_DV_render = MQQTTypeChoiceRenderer(types_getter)

   184

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

   185

                self.dvc.AppendColumn(choice_DV_col)

   186

            else:

   187

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

   188

   189

   190

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

   191

   192

        self.direction =  direction

   193

        titlestr = direction + " variables"

   194

   195

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

   196

   197

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

   198

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

   199

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

   200

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

   201

   202

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   203

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

   204

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

   205

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

   206

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

   207

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

   208

   209

   210

    def OnAddRow(self, evt):

   211

        items = self.dvc.GetSelections()

   212

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

   213

        self.model.InsertDefaultRow(row)

   214

   215

    def OnDeleteRows(self, evt):

   216

        items = self.dvc.GetSelections()

   217

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

   218

        self.model.DeleteRows(rows)

   219

   220

   221

class MQTTClientPanel(wx.SplitterWindow):

   222

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

   223

        self.log = log

   224

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

   225

   226

        self.selected_datas = modeldata

   227

        self.selected_models = { direction:MQTTTopicListModel(

   228

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

   229

        self.selected_lists = { direction:MQTTTopicListPanel(

   230

                self, log, 

   231

                self.selected_models[direction], direction, types_getter) 

   232

            for direction in directions }

   233

   234

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

   235

   236

        self.SetAutoLayout(True)

   237

   238

    def OnClose(self):

   239

        pass

   240

   241

    def __del__(self):

   242

        self.OnClose()

   243

   244

    def Reset(self):

   245

        for direction in directions:

   246

            self.selected_models[direction].ResetData() 

   247

   248

   249

class MQTTClientList(list):

   250

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

   251

        super(MQTTClientList, self).__init__(self)

   252

        self.log = log

   253

        self.change_callback = change_callback

   254

        self.dsc = lstcoldsc[direction]

   255

   256

    def _filter_line(self, value):

   257

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

   258

   259

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

   260

            if len(self) == 0:

   261

                v["Location"] = 0

   262

            else:

   263

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

   264

                greatest = max(iecnums)

   265

                holes = set(range(greatest)) - iecnums

   266

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

   267

   268

        try:

   269

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

   270

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

   271

        except ValueError: 

   272

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

   273

            return None

   274

   275

        if v["QoS"] not in QoS_values:

   276

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

   277

            return None

   278

   279

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

   280

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

   281

            return None

   282

   283

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

   284

   285

    def insert(self, row, value):

   286

        v = self._filter_line(value)

   287

        if v is not None:

   288

            list.insert(self, row, v)

   289

            self.change_callback()

   290

            return True

   291

        return False

   292

   293

    def append(self, value):

   294

        v = self._filter_line(value)

   295

        if v is not None:

   296

            list.append(self, v)

   297

            self.change_callback()

   298

            return True

   299

        return False

   300

   301

    def __setitem__(self, index, value):

   302

        list.__setitem__(self, index, value)

   303

        self.change_callback()

   304

   305

    def __delitem__(self, index):

   306

        list.__delitem__(self, index)

   307

        self.change_callback()

   308

   309

   310

class MQTTClientModel(dict):

   311

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

   312

        super(MQTTClientModel, self).__init__()

   313

        for direction in directions:

   314

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

   315

   316

    def LoadCSV(self,path):

   317

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

   318

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

   319

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

   320

            for direction, model in self.iteritems():

   321

                self[direction][:] = []

   322

            for row in reader:

   323

                direction = row[0]

   324

                # avoids calling change callback when loading CSV

   325

                l = self[direction]

   326

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

   327

                if v is not None:

   328

                    list.append(l,v)

   329

                # TODO be verbose in case of malformed CSV

   330

   331

    def SaveCSV(self,path):

   332

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

   333

            for direction, data in self.items():

   334

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

   335

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

   336

                for row in data:

   337

                    writer.writerow([direction] + row)

   338

   339

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

   340

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

   341

        c_template_file = open(c_template_filepath , 'rb')

   342

        c_template = c_template_file.read()

   343

        c_template_file.close()

   344

   345

        formatdict = dict(

   346

            locstr          = locstr,

   347

            uri             = config["URI"],

   348

            clientID        = config["clientID"],

   349

            decl            = "",

   350

            topics          = "",

   351

            cleanup         = "",

   352

            init            = "",

   353

            init_pubsub     = "",

   354

            retrieve        = "",

   355

            publish         = "",

   356

            publish_changes = ""

   357

        )

   358

   359

   360

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

   361

        if config["UseMQTT5"]:

   362

            formatdict["decl"] += """

   363

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

   364

   365

        AuthType = config["AuthType"]

   366

        if AuthType == "x509":

   367

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

   368

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

   369

            formatdict["init"] += """

   370

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

   371

        if AuthType == "PSK":

   372

            formatdict["init"] += """

   373

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

   374

        elif AuthType == "UserPassword":

   375

            formatdict["init"] += """

   376

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

   377

        else:

   378

            formatdict["init"] += """

   379

    INIT_NoAuth()"""

   380

   381

        for row in self["output"]:

   382

            Topic, QoS, _Retained, iec_type, iec_number = row

   383

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

   391

   392

            formatdict["decl"] += """

   393

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

   394

            formatdict["init_pubsub"] += """

   395

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

   396

            formatdict["publish"] += """

   397

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

   398

            formatdict["publish_changes"] += """

   399

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

   400

   401

        # inputs need to be sorted for bisection search 

   402

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

   403

            Topic, QoS, iec_type, iec_number = row

   411

            formatdict["decl"] += """

   412

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

   413

            formatdict["topics"] += """

   414

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

   415

            formatdict["init_pubsub"] += """

   416

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

   417

            formatdict["retrieve"] += """

   418

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

   419

   420

        Ccode = c_template.format(**formatdict)

   421

   422

        return Ccode

   423

   424

if __name__ == "__main__":

   425

   426

    import wx.lib.mixins.inspection as wit

   427

    import sys,os

   428

   429

    app = wit.InspectableApp()

   430

   431

    frame = wx.Frame(None, -1, "MQTT Client Test App", size=(800,600))

   432

   433

    argc = len(sys.argv)

   434

   435

    config={}

   436

    config["URI"] = sys.argv[1] if argc>1 else "tcp://localhost:1883"

   437

    config["clientID"] = sys.argv[2] if argc>2 else ""

   438

    config["AuthType"] = None

   439

    config["UseMQTT5"] = True

   440

   441

    if argc > 3:

   442

        AuthType = sys.argv[3]

   443

        config["AuthType"] = AuthType

   444

        for (name, default), value in zip_longest(authParams[AuthType], sys.argv[4:]):

   445

            if value is None:

   446

                if default is None:

   447

                    raise Exception(name+" param expected")

   448

                value = default

   449

            config[name] = value

   450

   451

    test_panel = wx.Panel(frame)

   452

    test_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

   453

    test_sizer.AddGrowableCol(0)

   454

    test_sizer.AddGrowableRow(0)

   455

   456

    modeldata = MQTTClientModel(print)

   457

   458

    mqtttestpanel = MQTTClientPanel(test_panel, modeldata, print, lambda:config)

   459

   460

    def OnGenerate(evt):

   461

        dlg = wx.FileDialog(

   462

            frame, message="Generate file as ...", defaultDir=os.getcwd(),

   463

            defaultFile="",

   464

            wildcard="C (*.c)|*.c", style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT

   465

            )

   466

   467

        if dlg.ShowModal() == wx.ID_OK:

   468

            path = dlg.GetPath()

   469

            Ccode = """

   470

/*

   471

In case open62541 was built just aside beremiz, you can build this test with:

   472

gcc %s -o %s \\

   473

    -I ../../open62541/plugins/include/ \\

   474

    -I ../../open62541/build/src_generated/ \\

   475

    -I ../../open62541/include/ \\

   476

    -I ../../open62541/arch/ ../../open62541/build/bin/libopen62541.a

   477

*/

   478

   479

"""%(path, path[:-2]) + modeldata.GenerateC(path, "test", config) + """

   480

   481

int LogMessage(uint8_t level, char* buf, uint32_t size){

   482

    printf("log level:%d message:'%.*s'\\n", level, size, buf);

   483

};

   484

   485

int main(int argc, char *argv[]) {

   486

   487

    __init_test(arc,argv);

   488

   489

    __retrieve_test();

   490

   491

    __publish_test();

   492

   493

    __cleanup_test();

   494

   495

    return EXIT_SUCCESS;

   496

}

   497

"""

   498

   499

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

   500

                Cfile.write(Ccode)

   501

   502

   503

        dlg.Destroy()

   504

   505

    def OnLoad(evt):

   506

        dlg = wx.FileDialog(

   507

            frame, message="Choose a file",

   508

            defaultDir=os.getcwd(),

   509

            defaultFile="",