1

from __future__ import print_function

     2

from __future__ import absolute_import

     3

     4

import csv

     5

     6

from opcua import Client

     7

from opcua import ua

     8

     9

import wx

    10

import wx.lib.gizmos as gizmos  # Formerly wx.gizmos in Classic

    11

import wx.dataview as dv

    12

    13

    14

UA_IEC_types = dict(

    15

#   pyopcua | IEC61131|  C  type  | sz |  open62541  enum  | open62541

    16

    Boolean = ("BOOL" , "uint8_t" , "X", "UA_TYPES_BOOLEAN", "UA_Boolean"),

    17

    SByte   = ("SINT" , "int8_t"  , "B", "UA_TYPES_SBYTE"  , "UA_SByte"  ),

    18

    Byte    = ("USINT", "uint8_t" , "B", "UA_TYPES_BYTE"   , "UA_Byte"   ),

    19

    Int16   = ("INT"  , "int16_t" , "W", "UA_TYPES_INT16"  , "UA_Int16"  ),

    20

    UInt16  = ("UINT" , "uint16_t", "W", "UA_TYPES_UINT16" , "UA_UInt16" ),

    21

    Int32   = ("DINT" , "uint32_t", "D", "UA_TYPES_INT32"  , "UA_Int32"  ),

    22

    UInt32  = ("UDINT", "int32_t" , "D", "UA_TYPES_UINT32" , "UA_UInt32" ),

    23

    Int64   = ("LINT" , "int64_t" , "L", "UA_TYPES_INT64"  , "UA_Int64"  ),

    24

    UInt64  = ("ULINT", "uint64_t", "L", "UA_TYPES_UINT64" , "UA_UInt64" ),

    25

    Float   = ("REAL" , "float"   , "D", "UA_TYPES_FLOAT"  , "UA_Float"  ),

    26

    Double  = ("LREAL", "double"  , "L", "UA_TYPES_DOUBLE" , "UA_Double" ),

    27

)

    28

    29

UA_NODE_ID_types = {

    30

    "int"   : ("UA_NODEID_NUMERIC", "{}"  ),

    31

    "str"   : ("UA_NODEID_STRING" , '"{}"'),

    32

    "UUID"  : ("UA_NODEID_UUID"   , '"{}"'),

    33

}

    34

    35

lstcolnames  = [  "Name", "NSIdx", "IdType", "Id", "Type", "IEC"]

    36

lstcolwidths = [     100,      50,      100,  100,    100,    50]

    37

lstcoltypess = [     str,     int,      str,  str,    str,   int]

    38

    39

directions = ["input", "output"]

    40

    41

authParams = {

    42

    "x509":[

    43

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

    44

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

    45

        ("Policy", "Basic256Sha256"),

    46

        ("Mode", "SignAndEncrypt")],

    47

    "UserPassword":[

    48

        ("User", None),

    49

        ("Password", None)]}

    50

    51

class OPCUASubListModel(dv.DataViewIndexListModel):

    52

    def __init__(self, data, log):

    53

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

    54

        self.data = data

    55

        self.log = log

    56

    57

    def GetColumnType(self, col):

    58

        return "string"

    59

    60

    def GetValueByRow(self, row, col):

    61

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

    62

    63

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

    64

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

    65

        expectedtype = lstcoltypess[col]

    66

    67

        try:

    68

            v = expectedtype(value)

    69

        except ValueError: 

    70

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

    71

            return False

    72

    73

        if col == lstcolnames.index("IdType") and v not in UA_NODE_ID_types:

    74

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

    75

            return False

    76

    77

        self.data[row][col] = v

    78

        return True

    79

    80

    # Report how many columns this model provides data for.

    81

    def GetColumnCount(self):

    82

        return len(lstcolnames)

    83

    84

    # Report the number of rows in the model

    85

    def GetCount(self):

    86

        #self.log.write('GetCount')

    87

        return len(self.data)

    88

    89

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

    90

    # cell at (row, col)

    91

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

    92

        if col == 5:

    93

            attr.SetColour('blue')

    94

            attr.SetBold(True)

    95

            return True

    96

        return False

    97

    98

    99

    def DeleteRows(self, rows):

   100

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

   101

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

   102

        rows = sorted(rows, reverse=True)

   103

   104

        for row in rows:

   105

            # remove it from our data structure

   106

            del self.data[row]

   107

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

   108

            self.RowDeleted(row)

   109

   110

   111

    def AddRow(self, value):

   112

        if self.data.append(value):

   113

            # notify views

   114

            self.RowAppended()

   115

   116

    def ResetData(self):

   117

        self.Reset(len(self.data))

   118

   119

OPCUAClientDndMagicWord = "text/beremiz-opcuaclient"

   120

   121

class NodeDropTarget(wx.DropTarget):

   122

   123

    def __init__(self, parent):

   124

        data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   125

        wx.DropTarget.__init__(self, data)

   126

        self.ParentWindow = parent

   127

   128

    def OnDrop(self, x, y):

   129

        self.ParentWindow.OnNodeDnD()

   130

        return True

   131

   132

class OPCUASubListPanel(wx.Panel):

   133

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

   134

        self.log = log

   135

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

   136

   137

        self.dvc = dv.DataViewCtrl(self,

   138

                                   style=wx.BORDER_THEME

   139

                                   | dv.DV_ROW_LINES

   140

                                   | dv.DV_HORIZ_RULES

   141

                                   | dv.DV_VERT_RULES

   142

                                   | dv.DV_MULTIPLE

   143

                                   )

   144

   145

        self.model = model

   146

   147

        self.dvc.AssociateModel(self.model)

   148

   149

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

   150

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

   151

   152

        DropTarget = NodeDropTarget(self)

   153

        self.dvc.SetDropTarget(DropTarget)

   154

   155

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

   156

   157

        self.direction =  direction

   158

        titlestr = direction + " variables"

   159

   160

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

   161

   162

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

   163

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

   164

   165

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   166

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

   167

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

   168

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

   169

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

   170

   171

   172

   173

    def OnDeleteRows(self, evt):

   174

        items = self.dvc.GetSelections()

   175

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

   176

        self.model.DeleteRows(rows)

   177

   178

   179

    def OnNodeDnD(self):

   180

        # Have to find OPC-UA client extension panel from here 

   181

        # in order to avoid keeping reference (otherwise __del__ isn't called)

   182

        #             splitter.        panel.      splitter

   183

        ClientPanel = self.GetParent().GetParent().GetParent()

   184

        nodes = ClientPanel.GetSelectedNodes()

   185

        for node in nodes:

   186

            cname = node.get_node_class().name

   187

            dname = node.get_display_name().Text

   188

            if cname != "Variable":

   189

                self.log("Node {} ignored (not a variable)".format(dname))

   190

                continue

   191

   192

            tname = node.get_data_type_as_variant_type().name

   193

            if tname not in UA_IEC_types:

   194

                self.log("Node {} ignored (unsupported type)".format(dname))

   195

                continue

   196

   197

            access = node.get_access_level()

   198

            if {"input":ua.AccessLevel.CurrentRead,

   199

                "output":ua.AccessLevel.CurrentWrite}[self.direction] not in access:

   200

                self.log("Node {} ignored because of insuficient access rights".format(dname))

   201

                continue

   202

   203

            nsid = node.nodeid.NamespaceIndex

   204

            nid =  node.nodeid.Identifier

   205

            nid_type =  type(nid).__name__

   206

            iecid = nid

   207

   208

            value = [dname,

   209

                     nsid,

   210

                     nid_type,

   211

                     nid,

   212

                     tname,

   213

                     iecid]

   214

            self.model.AddRow(value)

   215

   216

   217

   218

il = None

   219

fldridx = None    

   220

fldropenidx = None

   221

fileidx = None

   222

smileidx = None

   223

isz = (16,16)

   224

   225

treecolnames  = [  "Name", "Class", "NSIdx", "Id"]

   226

treecolwidths = [     250,     100,      50,  200]

   227

   228

   229

def prepare_image_list():

   230

    global il, fldridx, fldropenidx, fileidx, smileidx    

   231

   232

    if il is not None: 

   233

        return

   234

   235

    il = wx.ImageList(isz[0], isz[1])

   236

    fldridx     = il.Add(wx.ArtProvider.GetBitmap(wx.ART_FOLDER,      wx.ART_OTHER, isz))

   237

    fldropenidx = il.Add(wx.ArtProvider.GetBitmap(wx.ART_FILE_OPEN,   wx.ART_OTHER, isz))

   238

    fileidx     = il.Add(wx.ArtProvider.GetBitmap(wx.ART_NORMAL_FILE, wx.ART_OTHER, isz))

   239

    smileidx    = il.Add(wx.ArtProvider.GetBitmap(wx.ART_ADD_BOOKMARK, wx.ART_OTHER, isz))

   240

   241

   242

class OPCUAClientPanel(wx.SplitterWindow):

   243

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

   244

        self.log = log

   245

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

   246

   247

        self.ordered_nodes = []

   248

   249

        self.inout_panel = wx.Panel(self)

   250

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

   251

        self.inout_sizer.AddGrowableCol(0)

   252

        self.inout_sizer.AddGrowableRow(1)

   253

   254

        self.client = None

   255

        self.config_getter = config_getter

   256

   257

        self.connect_button = wx.ToggleButton(self.inout_panel, -1, "Browse Server")

   258

   259

        self.selected_splitter = wx.SplitterWindow(self.inout_panel, style=wx.SUNKEN_BORDER | wx.SP_3D)

   260

   261

        self.selected_datas = modeldata

   262

        self.selected_models = { direction:OPCUASubListModel(self.selected_datas[direction], log) for direction in directions }

   263

        self.selected_lists = { direction:OPCUASubListPanel(

   264

                self.selected_splitter, log, 

   265

                self.selected_models[direction], direction) 

   266

            for direction in directions }

   267

   268

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

   269

   270

        self.inout_sizer.Add(self.connect_button, flag=wx.GROW)

   271

        self.inout_sizer.Add(self.selected_splitter, flag=wx.GROW)

   272

        self.inout_sizer.Layout()

   273

        self.inout_panel.SetAutoLayout(True)

   274

        self.inout_panel.SetSizer(self.inout_sizer)

   275

   276

        self.Initialize(self.inout_panel)

   277

   278

        self.Bind(wx.EVT_TOGGLEBUTTON, self.OnConnectButton, self.connect_button)

   279

   280

    def OnClose(self):

   281

        if self.client is not None:

   282

            self.client.disconnect()

   283

            self.client = None

   284

   285

    def __del__(self):

   286

        self.OnClose()

   287

   288

    def OnConnectButton(self, event):

   289

        if self.connect_button.GetValue():

   290

   291

            self.tree_panel = wx.Panel(self)

   292

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

   293

            self.tree_sizer.AddGrowableCol(0)

   294

            self.tree_sizer.AddGrowableRow(0)

   295

   296

            self.tree = gizmos.TreeListCtrl(self.tree_panel, -1, style=0, agwStyle=

   297

                                            gizmos.TR_DEFAULT_STYLE

   298

                                            | gizmos.TR_MULTIPLE

   299

                                            | gizmos.TR_FULL_ROW_HIGHLIGHT

   300

                                       )

   301

   302

            prepare_image_list()

   303

            self.tree.SetImageList(il)

   304

   305

            for idx,(colname, width) in enumerate(zip(treecolnames, treecolwidths)):

   306

                self.tree.AddColumn(colname)

   307

                self.tree.SetColumnWidth(idx, width)

   308

   309

            self.tree.SetMainColumn(0)

   310

   311

            config = self.config_getter()

   312

            self.client = Client(config["URI"])

   313

   314

            AuthType = config["AuthType"]

   315

            if AuthType=="UserPasword":

   316

                self.client.set_user(config["User"])

   317

                self.client.set_password(config["Password"])

   318

            elif AuthType=="x509":

   319

                self.client.set_security_string(

   320

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

   321

   322

            self.client.connect()

   323

            self.client.load_type_definitions()  # load definition of server specific structures/extension objects

   324

            rootnode = self.client.get_root_node()

   325

   326

            rootitem = self.AddNodeItem(self.tree.AddRoot, rootnode)

   327

   328

            # Populate first level so that root can be expanded

   329

            self.CreateSubItems(rootitem)

   330

   331

            self.tree.Bind(wx.EVT_TREE_ITEM_EXPANDED, self.OnExpand)

   332

   333

            self.tree.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeNodeSelection)

   334

            self.tree.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag)

   335

   336

            self.tree.Expand(rootitem)

   337

   338

            hint = wx.StaticText(self, label = "Drag'n'drop desired variables from tree to Input or Output list")

   339

   340

            self.tree_sizer.Add(self.tree, flag=wx.GROW)

   341

            self.tree_sizer.Add(hint, flag=wx.GROW)

   342

            self.tree_sizer.Layout()

   343

            self.tree_panel.SetAutoLayout(True)

   344

            self.tree_panel.SetSizer(self.tree_sizer)

   345

   346

            self.SplitVertically(self.tree_panel, self.inout_panel, 500)

   347

        else:

   348

            self.client.disconnect()

   349

            self.client = None

   350

            self.Unsplit(self.tree_panel)

   351

            self.tree_panel.Destroy()

   352

   353

   354

    def CreateSubItems(self, item):

   355

        node, browsed = self.tree.GetPyData(item)

   356

        if not browsed:

   357

            for subnode in node.get_children():

   358

                self.AddNodeItem(lambda n: self.tree.AppendItem(item, n), subnode)

   359

            self.tree.SetPyData(item,(node, True))

   360

   361

    def AddNodeItem(self, item_creation_func, node):

   362

        nsid = node.nodeid.NamespaceIndex

   363

        nid =  node.nodeid.Identifier

   364

        dname = node.get_display_name().Text

   365

        cname = node.get_node_class().name

   366

   367

        item = item_creation_func(dname)

   368

   369

        if cname == "Variable":

   370

            access = node.get_access_level()

   371

            normalidx = fileidx

   372

            r = ua.AccessLevel.CurrentRead in access

   373

            w = ua.AccessLevel.CurrentWrite in access

   374

            if r and w:

   375

                ext = "RW"

   376

            elif r:

   377

                ext = "RO"

   378

            elif w:

   379

                ext = "WO"  # not sure this one exist

   380

            else:

   381

                ext = "no access"  # not sure this one exist

   382

            cname = "Var "+node.get_data_type_as_variant_type().name+" (" + ext + ")"

   383

        else:

   384

            normalidx = fldridx

   385

   386

        self.tree.SetPyData(item,(node, False))

   387

        self.tree.SetItemText(item, cname, 1)

   388

        self.tree.SetItemText(item, str(nsid), 2)

   389

        self.tree.SetItemText(item, type(nid).__name__+": "+str(nid), 3)

   390

        self.tree.SetItemImage(item, normalidx, which = wx.TreeItemIcon_Normal)

   391

        self.tree.SetItemImage(item, fldropenidx, which = wx.TreeItemIcon_Expanded)

   392

   393

        return item

   394

   395

    def OnExpand(self, evt):

   396

        for item in evt.GetItem().GetChildren():

   397

            self.CreateSubItems(item)

   398

   399

    # def OnActivate(self, evt):

   400

    #     item = evt.GetItem()

   401

    #     node, browsed = self.tree.GetPyData(item)

   402

   403

    def OnTreeNodeSelection(self, event):

   404

        items = self.tree.GetSelections()

   405

        items_pydata = [self.tree.GetPyData(item) for item in items]

   406

   407

        nodes = [node for node, _unused in items_pydata]

   408

   409

        # append new nodes to ordered list

   410

        for node in nodes:

   411

            if node not in self.ordered_nodes:

   412

                self.ordered_nodes.append(node)

   413

   414

        # filter out vanished items

   415

        self.ordered_nodes = [

   416

            node 

   417

            for node in self.ordered_nodes 

   418

            if node in nodes]

   419

   420

    def GetSelectedNodes(self):

   421

        return self.ordered_nodes 

   422

   423

    def OnTreeBeginDrag(self, event):

   424

        """

   425

        Called when a drag is started in tree

   426

        @param event: wx.TreeEvent

   427

        """

   428

        if self.ordered_nodes:

   429

            # Just send a recognizable mime-type, drop destination

   430

            # will get python data from parent

   431

            data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   432

            dragSource = wx.DropSource(self)

   433

            dragSource.SetData(data)

   434

            dragSource.DoDragDrop()

   435

   436

    def Reset(self):

   437

        for direction in directions:

   438

            self.selected_models[direction].ResetData() 

   439

   440

   441

class OPCUAClientList(list):

   442

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

   443

        super(OPCUAClientList, self).__init__(self)

   444

        self.log = log

   445

   446

    def append(self, value):

   447

        v = dict(zip(lstcolnames, value))

   448

   449

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

   450

            if len(self) == 0:

   451

                v["IEC"] = 0

   452

            else:

   453

                iecnums = set(zip(*self)[lstcolnames.index("IEC")])

   454

                greatest = max(iecnums)

   455

                holes = set(range(greatest)) - iecnums

   456

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

   457

   458

        if v["IdType"] not in UA_NODE_ID_types:

   459

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

   460

            return False

   461

   462

        try:

   463

            for t,n in zip(lstcoltypess, lstcolnames):

   464

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

   465

        except ValueError: 

   466

            self.log("Variable {} (Id={}) has invalid type\n".format(v["Name"],v["Id"]))

   467

            return False

   468

   469

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

   470

            self.log("Variable {} (Id={}) already in list\n".format(v["Name"],v["Id"]))

   471

            return False

   472

   473

        list.append(self, [v[n] for n in lstcolnames])

   474

   475

        return True

   476

   477

class OPCUAClientModel(dict):

   478

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

   479

        super(OPCUAClientModel, self).__init__()

   480

        for direction in directions:

   481

            self[direction] = OPCUAClientList(log)

   482

   483

    def LoadCSV(self,path):

   484

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

   485

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

   486

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

   487

            for direction, model in self.iteritems():

   488

                self[direction][:] = []

   489

            for row in reader:

   490

                direction = row[0]

   491

                self[direction].append(row[1:])

   492

   493

    def SaveCSV(self,path):

   494

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

   495

            for direction, data in self.iteritems():

   496

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

   497

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

   498

                for row in data:

   499

                    writer.writerow([direction] + row)

   500

   501

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

   502

        template = """/* code generated by beremiz OPC-UA extension */

   503

   504

#include <open62541/client_config_default.h>

   505

#include <open62541/client_highlevel.h>

   506

#include <open62541/plugin/log_stdout.h>

   507

#include <open62541/plugin/securitypolicy.h>

   508

   509

#include <open62541/types.h>

   510

#include <open62541/types_generated_handling.h>

   511

   512

static UA_INLINE UA_ByteString

   513

loadFile(const char *const path) {{

   514

    UA_ByteString fileContents = UA_STRING_NULL;

   515

   516

    FILE *fp = fopen(path, "rb");

   517

    if(!fp) {{

   518

        errno = 0;

   519

        return fileContents;

   520

    }}