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 MQTTTopicListPanel(wx.Panel):

   156

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

   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

        dsc = lstcoldsc[direction]

   173

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

   174

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

   175

   176

   177

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

   178

   179

        self.direction =  direction

   180

        titlestr = direction + " variables"

   181

   182

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

   183

   184

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

   185

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

   186

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

   187

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

   188

   189

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   190

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

   191

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

   192

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

   193

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

   194

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

   195

   196

   197

    def OnAddRow(self, evt):

   198

        items = self.dvc.GetSelections()

   199

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

   200

        self.model.InsertDefaultRow(row)

   201

   202

    def OnDeleteRows(self, evt):

   203

        items = self.dvc.GetSelections()

   204

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

   205

        self.model.DeleteRows(rows)

   206

   207

   208

class MQTTClientPanel(wx.SplitterWindow):

   209

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

   210

        self.log = log

   211

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

   212

   213

        self.config_getter = config_getter

   214

   215

        self.selected_datas = modeldata

   216

        self.selected_models = { direction:MQTTTopicListModel(

   217

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

   218

        self.selected_lists = { direction:MQTTTopicListPanel(

   219

                self, log, 

   220

                self.selected_models[direction], direction) 

   221

            for direction in directions }

   222

   223

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

   224

   225

        self.SetAutoLayout(True)

   226

   227

    def OnClose(self):

   228

        pass

   229

   230

    def __del__(self):

   231

        self.OnClose()

   232

   233

    def Reset(self):

   234

        for direction in directions:

   235

            self.selected_models[direction].ResetData() 

   236

   237

   238

class MQTTClientList(list):

   239

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

   240

        super(MQTTClientList, self).__init__(self)

   241

        self.log = log

   242

        self.change_callback = change_callback

   243

        self.dsc = lstcoldsc[direction]

   244

   245

    def _filter_line(self, value):

   246

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

   247

   248

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

   249

            if len(self) == 0:

   250

                v["Location"] = 0

   251

            else:

   252

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

   253

                greatest = max(iecnums)

   254

                holes = set(range(greatest)) - iecnums

   255

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

   256

   257

        try:

   258

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

   259

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

   260

        except ValueError: 

   261

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

   262

            return None

   263

   264

        if v["QoS"] not in QoS_values:

   265

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

   266

            return None

   267

   268

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

   269

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

   270

            return None

   271

   272

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

   273

   274

    def insert(self, row, value):

   275

        v = self._filter_line(value)

   276

        if v is not None:

   277

            list.insert(self, row, v)

   278

            self.change_callback()

   279

            return True

   280

        return False

   281

   282

    def append(self, value):

   283

        v = self._filter_line(value)

   284

        if v is not None:

   285

            list.append(self, v)

   286

            self.change_callback()

   287

            return True

   288

        return False

   289

   290

    def __setitem__(self, index, value):

   291

        list.__setitem__(self, index, value)

   292

        self.change_callback()

   293

   294

    def __delitem__(self, index):

   295

        list.__delitem__(self, index)

   296

        self.change_callback()

   297

   298

   299

class MQTTClientModel(dict):

   300

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

   301

        super(MQTTClientModel, self).__init__()

   302

        for direction in directions:

   303

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

   304

   305

    def LoadCSV(self,path):

   306

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

   307

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

   308

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

   309

            for direction, model in self.iteritems():

   310

                self[direction][:] = []

   311

            for row in reader:

   312

                direction = row[0]

   313

                # avoids calling change callback when loading CSV

   314

                l = self[direction]

   315

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

   316

                if v is not None:

   317

                    list.append(l,v)

   318

                # TODO be verbose in case of malformed CSV

   319

   320

    def SaveCSV(self,path):

   321

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

   322

            for direction, data in self.items():

   323

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

   324

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

   325

                for row in data:

   326

                    writer.writerow([direction] + row)

   327

   328

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

   329

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

   330

        c_template_file = open(c_template_filepath , 'rb')

   331

        c_template = c_template_file.read()

   332

        c_template_file.close()

   333

   334

        formatdict = dict(

   335

            locstr          = locstr,

   336

            uri             = config["URI"],

   337

            clientID        = config["clientID"],

   338

            decl            = "",

   339

            topics          = "",

   340

            cleanup         = "",

   341

            init            = "",

   342

            init_pubsub     = "",

   343

            retrieve        = "",

   344

            publish         = "",

   345

            publish_changes = ""

   346

        )

   347

   348

   349

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

   350

        if config["UseMQTT5"]:

   351

            formatdict["decl"] += """

   352

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

   353

   354

        AuthType = config["AuthType"]

   355

        print(config)

   356

        if AuthType == "x509":

   357

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

   358

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

   359

            formatdict["init"] += """

   360

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

   361

        if AuthType == "PSK":

   362

            formatdict["init"] += """

   363

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

   364

        elif AuthType == "UserPassword":

   365

            formatdict["init"] += """

   366

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

   367

        else:

   368

            formatdict["init"] += """

   369

    INIT_NoAuth()"""

   370

   371

        for row in self["output"]:

   372

            Topic, QoS, _Retained, iec_type, iec_number = row

   373

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

   374

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   375

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

   376

   377

            formatdict["decl"] += """

   378

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

   379

            formatdict["init_pubsub"] += """

   380

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

   381

            formatdict["publish"] += """

   382

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

   383

            formatdict["publish_changes"] += """

   384

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

   385

   386

        # inputs need to be sorted for bisection search 

   387

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

   388

            Topic, QoS, iec_type, iec_number = row

   389

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   390

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

   391

            formatdict["decl"] += """

   392

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

   393

            formatdict["topics"] += """

   394

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

   395

            formatdict["init_pubsub"] += """

   396

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

   397

            formatdict["retrieve"] += """

   398

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

   399

   400

        Ccode = c_template.format(**formatdict)

   401

   402

        return Ccode

   403

   404

if __name__ == "__main__":

   405

   406

    import wx.lib.mixins.inspection as wit

   407

    import sys,os

   408

   409

    app = wit.InspectableApp()

   410

   411

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

   412

   413

    argc = len(sys.argv)

   414

   415

    config={}

   416

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

   417

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

   418

    config["AuthType"] = None

   419

    config["UseMQTT5"] = True

   420

   421

    if argc > 3:

   422

        AuthType = sys.argv[3]

   423

        config["AuthType"] = AuthType

   424

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

   425

            if value is None:

   426

                if default is None:

   427

                    raise Exception(name+" param expected")

   428

                value = default

   429

            config[name] = value

   430

   431

    test_panel = wx.Panel(frame)

   432

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

   433

    test_sizer.AddGrowableCol(0)

   434

    test_sizer.AddGrowableRow(0)

   435

   436

    modeldata = MQTTClientModel(print)

   437

   438

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

   439

   440

    def OnGenerate(evt):

   441

        dlg = wx.FileDialog(

   442

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

   443

            defaultFile="",

   444

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

   445

            )

   446

   447

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

   448

            path = dlg.GetPath()

   449

            Ccode = """

   450

/*

   451

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

   452

gcc %s -o %s \\

   453

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

   454

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

   455

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

   456

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

   457

*/

   458

   459

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

   460

   461

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

   462

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

   463

};

   464

   465

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

   466

   467

    __init_test(arc,argv);

   468

   469

    __retrieve_test();

   470

   471

    __publish_test();

   472

   473

    __cleanup_test();

   474

   475

    return EXIT_SUCCESS;

   476

}

   477

"""

   478

   479

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

   480

                Cfile.write(Ccode)

   481

   482

   483

        dlg.Destroy()

   484

   485

    def OnLoad(evt):

   486

        dlg = wx.FileDialog(

   487

            frame, message="Choose a file",

   488

            defaultDir=os.getcwd(),

   489

            defaultFile="",

   490

            wildcard="CSV (*.csv)|*.csv",

   491

            style=wx.FD_OPEN | wx.FD_CHANGE_DIR | wx.FD_FILE_MUST_EXIST )

   492

   493

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

   494

            path = dlg.GetPath()

   495

            modeldata.LoadCSV(path)

   496

            mqtttestpanel.Reset()

   497

   498

        dlg.Destroy()

   499

   500

    def OnSave(evt):

   501

        dlg = wx.FileDialog(

   502

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

   503

            defaultFile="",

   504

            wildcard="CSV (*.csv)|*.csv", style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT

   505

            )

   506

   507

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

   508

            path = dlg.GetPath()

   509

            modeldata.SaveCSV(path)

   510

   511

        dlg.Destroy()