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

authParams = {

    70

    "x509":[

    71

        ("Certificate", "certificate.der"),

    72

        ("PrivateKey", "private_key.pem")],

    73

    "UserPassword":[

    74

        ("User", None),

    75

        ("Password", None)]}

    76

    77

class MQTTTopicListModel(dv.PyDataViewIndexListModel):

    78

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

    79

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

    80

        self.data = data

    81

        self.log = log

    82

        self.dsc = lstcoldsc[direction]

    83

    84

    def GetColumnType(self, col):

    85

        return "string"

    86

    87

    def GetValueByRow(self, row, col):

    88

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

    89

    90

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

    91

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

    92

        expectedtype = self.dsc.lstcoltypess[col]

    93

    94

        try:

    95

            v = expectedtype(value)

    96

        except ValueError: 

    97

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

    98

            return False

    99

   100

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

   101

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

   102

            return False

   103

   104

        line = self.data[row]

   105

        line[col] = v

   106

        self.data[row] = line

   107

        return True

   108

   109

    # Report how many columns this model provides data for.

   110

    def GetColumnCount(self):

   111

        return len(self.dsc.lstcolnames)

   112

   113

    # Report the number of rows in the model

   114

    def GetCount(self):

   115

        #self.log.write('GetCount')

   116

        return len(self.data)

   117

   118

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

   119

    # cell at (row, col)

   120

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

   121

        if col == self.dsc.Location_column:

   122

            attr.SetColour('blue')

   123

            attr.SetBold(True)

   124

            return True

   125

        return False

   126

   127

   128

    def DeleteRows(self, rows):

   129

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

   130

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

   131

        rows = sorted(rows, reverse=True)

   132

   133

        for row in rows:

   134

            # remove it from our data structure

   135

            del self.data[row]

   136

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

   137

            self.RowDeleted(row)

   138

   139

   140

    def AddRow(self, value):

   141

        if self.data.append(value):

   142

            # notify views

   143

            self.RowAppended()

   144

   145

    def InsertDefaultRow(self, row):

   146

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

   147

        # notify views

   148

        self.RowInserted(row)

   149

   150

    def ResetData(self):

   151

        self.Reset(len(self.data))

   152

   153

class MQTTTopicListPanel(wx.Panel):

   154

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

   155

        self.log = log

   156

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

   157

   158

        self.dvc = dv.DataViewCtrl(self,

   159

                                   style=wx.BORDER_THEME

   160

                                   | dv.DV_ROW_LINES

   161

                                   | dv.DV_HORIZ_RULES

   162

                                   | dv.DV_VERT_RULES

   163

                                   | dv.DV_MULTIPLE

   164

                                   )

   165

   166

        self.model = model

   167

   168

        self.dvc.AssociateModel(self.model)

   169

   170

        dsc = lstcoldsc[direction]

   171

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

   172

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

   173

   174

   175

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

   176

   177

        self.direction =  direction

   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 OnAddRow(self, evt):

   196

        items = self.dvc.GetSelections()

   197

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

   198

        self.model.InsertDefaultRow(row)

   199

   200

    def OnDeleteRows(self, evt):

   201

        items = self.dvc.GetSelections()

   202

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

   203

        self.model.DeleteRows(rows)

   204

   205

   206

class MQTTClientPanel(wx.SplitterWindow):

   207

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

   208

        self.log = log

   209

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

   210

   211

        self.config_getter = config_getter

   212

   213

        self.selected_datas = modeldata

   214

        self.selected_models = { direction:MQTTTopicListModel(

   215

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

   216

        self.selected_lists = { direction:MQTTTopicListPanel(

   217

                self, log, 

   218

                self.selected_models[direction], direction) 

   219

            for direction in directions }

   220

   221

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

   222

   223

        self.SetAutoLayout(True)

   224

   225

    def OnClose(self):

   226

        pass

   227

   228

    def __del__(self):

   229

        self.OnClose()

   230

   231

    def Reset(self):

   232

        for direction in directions:

   233

            self.selected_models[direction].ResetData() 

   234

   235

   236

class MQTTClientList(list):

   237

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

   238

        super(MQTTClientList, self).__init__(self)

   239

        self.log = log

   240

        self.change_callback = change_callback

   241

        self.dsc = lstcoldsc[direction]

   242

   243

    def _filter_line(self, value):

   244

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

   245

   246

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

   247

            if len(self) == 0:

   248

                v["Location"] = 0

   249

            else:

   250

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

   251

                greatest = max(iecnums)

   252

                holes = set(range(greatest)) - iecnums

   253

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

   254

   255

        try:

   256

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

   257

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

   258

        except ValueError: 

   259

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

   260

            return None

   261

   262

        if v["QoS"] not in QoS_values:

   263

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

   264

            return None

   265

   266

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

   267

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

   268

            return None

   269

   270

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

   271

   272

    def insert(self, row, value):

   273

        v = self._filter_line(value)

   274

        if v is not None:

   275

            list.insert(self, row, v)

   276

            self.change_callback()

   277

            return True

   278

        return False

   279

   280

    def append(self, value):

   281

        v = self._filter_line(value)

   282

        if v is not None:

   283

            list.append(self, v)

   284

            self.change_callback()

   285

            return True

   286

        return False

   287

   288

    def __setitem__(self, index, value):

   289

        list.__setitem__(self, index, value)

   290

        self.change_callback()

   291

   292

    def __delitem__(self, index):

   293

        list.__delitem__(self, index)

   294

        self.change_callback()

   295

   296

   297

class MQTTClientModel(dict):

   298

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

   299

        super(MQTTClientModel, self).__init__()

   300

        for direction in directions:

   301

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

   302

   303

    def LoadCSV(self,path):

   304

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

   305

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

   306

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

   307

            for direction, model in self.iteritems():

   308

                self[direction][:] = []

   309

            for row in reader:

   310

                direction = row[0]

   311

                # avoids calling change callback when loading CSV

   312

                l = self[direction]

   313

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

   314

                if v is not None:

   315

                    list.append(l,v)

   316

                # TODO be verbose in case of malformed CSV

   317

   318

    def SaveCSV(self,path):

   319

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

   320

            for direction, data in self.items():

   321

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

   322

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

   323

                for row in data:

   324

                    writer.writerow([direction] + row)

   325

   326

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

   327

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

   328

        c_template_file = open(c_template_filepath , 'rb')

   329

        c_template = c_template_file.read()

   330

        c_template_file.close()

   331

   332

        formatdict = dict(

   333

            locstr          = locstr,

   334

            uri             = config["URI"],

   335

            clientID        = config["clientID"],

   336

            decl            = "",

   337

            topics          = "",

   338

            cleanup         = "",

   339

            init            = "",

   340

            init_pubsub     = "",

   341

            retrieve        = "",

   342

            publish         = "",

   343

            publish_changes = ""

   344

        )

   345

   346

   347

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

   348

        if config["UseMQTT5"]:

   349

            formatdict["decl"] += """

   350

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

   351

   352

        AuthType = config["AuthType"]

   353

        if AuthType == "x509":

   354

            formatdict["init"] += """

   355

    INIT_x509("{PrivateKey}", "{Certificate}")""".format(**config)

   356

        elif AuthType == "UserPassword":

   357

            formatdict["init"] += """

   358

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

   359

        else:

   360

            formatdict["init"] += """

   361

    INIT_NoAuth()"""

   362

   363

        for row in self["output"]:

   364

            Topic, QoS, _Retained, iec_type, iec_number = row

   365

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

   366

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   367

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

   368

   369

            formatdict["decl"] += """

   370

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

   371

            formatdict["init_pubsub"] += """

   372

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

   373

            formatdict["publish"] += """

   374

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

   375

            formatdict["publish_changes"] += """

   376

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

   377

   378

        # inputs need to be sorted for bisection search 

   379

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

   380

            Topic, QoS, iec_type, iec_number = row

   381

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   382

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

   383

            formatdict["decl"] += """

   384

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

   385

            formatdict["topics"] += """

   386

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

   387

            formatdict["init_pubsub"] += """

   388

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

   389

            formatdict["retrieve"] += """

   390

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

   391

   392

        Ccode = c_template.format(**formatdict)

   393

   394

        return Ccode

   395

   396

if __name__ == "__main__":

   397

   398

    import wx.lib.mixins.inspection as wit

   399

    import sys,os

   400

   401

    app = wit.InspectableApp()

   402

   403

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

   404

   405

    argc = len(sys.argv)

   406

   407

    config={}

   408

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

   409

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

   410

    config["AuthType"] = None

   411

    config["UseMQTT5"] = True

   412

   413

    if argc > 3:

   414

        AuthType = sys.argv[3]

   415

        config["AuthType"] = AuthType

   416

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

   417

            if value is None:

   418

                if default is None:

   419

                    raise Exception(name+" param expected")

   420

                value = default

   421

            config[name] = value

   422

   423

    test_panel = wx.Panel(frame)

   424

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

   425

    test_sizer.AddGrowableCol(0)

   426

    test_sizer.AddGrowableRow(0)

   427

   428

    modeldata = MQTTClientModel(print)

   429

   430

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

   431

   432

    def OnGenerate(evt):

   433

        dlg = wx.FileDialog(

   434

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

   435

            defaultFile="",

   436

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

   437

            )

   438

   439

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

   440

            path = dlg.GetPath()

   441

            Ccode = """

   442

/*

   443

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

   444

gcc %s -o %s \\

   445

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

   446

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

   447

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

   448

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

   449

*/

   450

   451

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

   452

   453

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

   454

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

   455

};

   456

   457

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

   458

   459

    __init_test(arc,argv);

   460

   461

    __retrieve_test();

   462

   463

    __publish_test();

   464

   465

    __cleanup_test();

   466

   467

    return EXIT_SUCCESS;

   468

}

   469

"""

   470

   471

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

   472

                Cfile.write(Ccode)

   473

   474

   475

        dlg.Destroy()

   476

   477

    def OnLoad(evt):

   478

        dlg = wx.FileDialog(

   479

            frame, message="Choose a file",

   480

            defaultDir=os.getcwd(),

   481

            defaultFile="",

   482

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

   483

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

   484

   485

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

   486

            path = dlg.GetPath()

   487

            modeldata.LoadCSV(path)

   488

            mqtttestpanel.Reset()

   489

   490

        dlg.Destroy()

   491

   492

    def OnSave(evt):

   493

        dlg = wx.FileDialog(

   494

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

   495

            defaultFile="",

   496

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

   497

            )

   498

   499

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

   500

            path = dlg.GetPath()

   501

            modeldata.SaveCSV(path)

   502

   503

        dlg.Destroy()

   504

   505

    test_sizer.Add(mqtttestpanel, flag=wx.GROW|wx.EXPAND)

   506

   507

    testbt_sizer = wx.BoxSizer(wx.HORIZONTAL)

   508

   509

    loadbt = wx.Button(test_panel, label="Load")

   510

    test_panel.Bind(wx.EVT_BUTTON, OnLoad, loadbt)

   511

   512

    savebt = wx.Button(test_panel, label="Save")

   513