1

"""

     2

Base definitions for beremiz plugins

     3

"""

     4

     5

import os,sys,traceback

     6

import time

     7

import plugins

     8

import types

     9

import shutil

    10

from xml.dom import minidom

    11

import wx

    12

    13

#Quick hack to be able to find Beremiz IEC tools. Should be config params.

    14

base_folder = os.path.split(sys.path[0])[0]

    15

    16

from xmlclass import GenerateClassesFromXSDstring

    17

from wxPopen import ProcessLogger

    18

    19

from PLCControler import PLCControler, LOCATION_PLUGIN, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    20

    21

_BaseParamsClass = GenerateClassesFromXSDstring("""<?xml version="1.0" encoding="ISO-8859-1" ?>

    22

        <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    23

          <xsd:element name="BaseParams">

    24

            <xsd:complexType>

    25

              <xsd:attribute name="Name" type="xsd:string" use="optional" default="__unnamed__"/>

    26

              <xsd:attribute name="IEC_Channel" type="xsd:integer" use="required"/>

    27

              <xsd:attribute name="Enabled" type="xsd:boolean" use="optional" default="true"/>

    28

            </xsd:complexType>

    29

          </xsd:element>

    30

        </xsd:schema>""")["BaseParams"]

    31

    32

NameTypeSeparator = '@'

    33

    34

class MiniTextControler:

    35

    36

    def __init__(self, filepath):

    37

        self.FilePath = filepath

    38

    39

    def SetEditedElementText(self, tagname, text):

    40

        file = open(self.FilePath, "w")

    41

        file.write(text)

    42

        file.close()

    43

    44

    def GetEditedElementText(self, tagname, debug = False):

    45

        if os.path.isfile(self.FilePath):

    46

            file = open(self.FilePath, "r")

    47

            text = file.read()

    48

            file.close()

    49

            return text

    50

        return ""

    51

    52

    def GetEditedElementInterfaceVars(self, tagname, debug = False):

    53

        return []

    54

    55

    def GetEditedElementType(self, tagname, debug = False):

    56

        return "program"

    57

    58

    def GetBlockTypes(self, tagname = "", debug = False):

    59

        return []

    60

    61

    def GetDataTypes(self, tagname = "", basetypes = True, only_locatables = False, debug = False):

    62

        return []

    63

    64

    def GetEnumeratedDataValues(self, debug = False):

    65

        return []

    66

    67

    def StartBuffering(self):

    68

        pass

    69

    70

    def EndBuffering(self):

    71

        pass

    72

    73

    def BufferProject(self):

    74

        pass

    75

    76

# helper func to get path to images

    77

def opjimg(imgname):

    78

    return os.path.join(base_folder, "beremiz", "images",imgname)

    79

    80

# helper func to check path write permission

    81

def CheckPathPerm(path):

    82

    if path is None or not os.path.isdir(path):

    83

        return False

    84

    for root, dirs, files in os.walk(path):

    85

         for name in files:

    86

             if os.access(root, os.W_OK) is not True or os.access(os.path.join(root, name), os.W_OK) is not True:

    87

                 return False

    88

    return True

    89

    90

class PlugTemplate:

    91

    """

    92

    This class is the one that define plugins.

    93

    """

    94

    95

    XSD = None

    96

    PlugChildsTypes = []

    97

    PlugMaxCount = None

    98

    PluginMethods = []

    99

    LibraryControler = None

   100

    EditorType = None

   101

   102

    def _AddParamsMembers(self):

   103

        self.PlugParams = None

   104

        if self.XSD:

   105

            self.Classes = GenerateClassesFromXSDstring(self.XSD)

   106

            Classes = [(name, XSDclass) for name, XSDclass in self.Classes.items() if XSDclass.IsBaseClass]

   107

            if len(Classes) == 1:

   108

                name, XSDclass = Classes[0]

   109

                obj = XSDclass()

   110

                self.PlugParams = (name, obj)

   111

                setattr(self, name, obj)

   112

   113

    def __init__(self):

   114

        # Create BaseParam 

   115

        self.BaseParams = _BaseParamsClass()

   116

        self.MandatoryParams = ("BaseParams", self.BaseParams)

   117

        self._AddParamsMembers()

   118

        self.PluggedChilds = {}

   119

        self._View = None

   120

        # copy PluginMethods so that it can be later customized

   121

        self.PluginMethods = [dic.copy() for dic in self.PluginMethods]

   122

        self.LoadSTLibrary()

   123

   124

    def PluginBaseXmlFilePath(self, PlugName=None):

   125

        return os.path.join(self.PlugPath(PlugName), "baseplugin.xml")

   126

   127

    def PluginXmlFilePath(self, PlugName=None):

   128

        return os.path.join(self.PlugPath(PlugName), "plugin.xml")

   129

   130

    def PluginLibraryFilePath(self):

   131

        return os.path.join(self.PluginPath(), "pous.xml")

   132

   133

    def PluginPath(self):

   134

        return os.path.join(self.PlugParent.PluginPath(), self.PlugType)

   135

   136

    def PlugPath(self,PlugName=None):

   137

        if not PlugName:

   138

            PlugName = self.BaseParams.getName()

   139

        return os.path.join(self.PlugParent.PlugPath(),

   140

                            PlugName + NameTypeSeparator + self.PlugType)

   141

   142

    def PlugFullName(self):

   143

        parent = self.PlugParent.PlugFullName()

   144

        if parent != "":

   145

            return parent + "." + self.BaseParams.getName()

   146

        return self.BaseParams.getName()

   147

   148

    def GetIconPath(self, name):

   149

        return opjimg(name)

   150

   151

    def PlugTestModified(self):

   152

        return self.ChangesToSave

   153

   154

    def ProjectTestModified(self):

   155

        """

   156

        recursively check modified status

   157

        """

   158

        if self.PlugTestModified():

   159

            return True

   160

   161

        for PlugChild in self.IterChilds():

   162

            if PlugChild.ProjectTestModified():

   163

                return True

   164

   165

        return False

   166

   167

    def OnPlugSave(self):

   168

        #Default, do nothing and return success

   169

        return True

   170

   171

    def GetParamsAttributes(self, path = None):

   172

        if path:

   173

            parts = path.split(".", 1)

   174

            if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:

   175

                return self.MandatoryParams[1].getElementInfos(parts[0], parts[1])

   176

            elif self.PlugParams and parts[0] == self.PlugParams[0]:

   177

                return self.PlugParams[1].getElementInfos(parts[0], parts[1])

   178

        else:

   179

            params = []

   180

            if wx.VERSION < (2, 8, 0) and self.MandatoryParams:

   181

                params.append(self.MandatoryParams[1].getElementInfos(self.MandatoryParams[0]))

   182

            if self.PlugParams:

   183

                params.append(self.PlugParams[1].getElementInfos(self.PlugParams[0]))

   184

            return params

   185

   186

    def SetParamsAttribute(self, path, value):

   187

        self.ChangesToSave = True

   188

        # Filter IEC_Channel and Name, that have specific behavior

   189

        if path == "BaseParams.IEC_Channel":

   190

            old_leading = ".".join(map(str, self.GetCurrentLocation()))

   191

            new_value = self.FindNewIEC_Channel(value)

   192

            new_leading = ".".join(map(str, self.PlugParent.GetCurrentLocation() + (new_value,)))

   193

            self.GetPlugRoot().UpdateProjectVariableLocation(old_leading, new_leading)

   194

            return new_value, True

   195

        elif path == "BaseParams.Name":

   196

            res = self.FindNewName(value)

   197

            self.PlugRequestSave()

   198

            return res, True

   199

   200

        parts = path.split(".", 1)

   201

        if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:

   202

            self.MandatoryParams[1].setElementValue(parts[1], value)

   203

        elif self.PlugParams and parts[0] == self.PlugParams[0]:

   204

            self.PlugParams[1].setElementValue(parts[1], value)

   205

        return value, False

   206

   207

    def PlugMakeDir(self):

   208

        os.mkdir(self.PlugPath())

   209

   210

    def PlugRequestSave(self):

   211

        if self.GetPlugRoot().CheckProjectPathPerm(False):

   212

            # If plugin do not have corresponding directory

   213

            plugpath = self.PlugPath()

   214

            if not os.path.isdir(plugpath):

   215

                # Create it

   216

                os.mkdir(plugpath)

   217

   218

            # generate XML for base XML parameters controller of the plugin

   219

            if self.MandatoryParams:

   220

                BaseXMLFile = open(self.PluginBaseXmlFilePath(),'w')

   221

                BaseXMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")

   222

                BaseXMLFile.write(self.MandatoryParams[1].generateXMLText(self.MandatoryParams[0], 0).encode("utf-8"))

   223

                BaseXMLFile.close()

   224

   225

            # generate XML for XML parameters controller of the plugin

   226

            if self.PlugParams:

   227

                XMLFile = open(self.PluginXmlFilePath(),'w')

   228

                XMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")

   229

                XMLFile.write(self.PlugParams[1].generateXMLText(self.PlugParams[0], 0).encode("utf-8"))

   230

                XMLFile.close()

   231

   232

            # Call the plugin specific OnPlugSave method

   233

            result = self.OnPlugSave()

   234

            if not result:

   235

                return _("Error while saving \"%s\"\n")%self.PlugPath()

   236

   237

            # mark plugin as saved

   238

            self.ChangesToSave = False

   239

            # go through all childs and do the same

   240

            for PlugChild in self.IterChilds():

   241

                result = PlugChild.PlugRequestSave()

   242

                if result:

   243

                    return result

   244

        return None

   245

   246

    def PlugImport(self, src_PlugPath):

   247

        shutil.copytree(src_PlugPath, self.PlugPath)

   248

        return True

   249

   250

    def PlugGenerate_C(self, buildpath, locations):

   251

        """

   252

        Generate C code

   253

        @param locations: List of complete variables locations \

   254

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   255

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   256

            "DIR" : direction "Q","I" or "M"

   257

            "SIZE" : size "X", "B", "W", "D", "L"

   258

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   259

            }, ...]

   260

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   261

        """

   262

        self.GetPlugRoot().logger.write_warning(".".join(map(lambda x:str(x), self.GetCurrentLocation())) + " -> Nothing to do\n")

   263

        return [],"",False

   264

   265

    def _Generate_C(self, buildpath, locations):

   266

        # Generate plugins [(Cfiles, CFLAGS)], LDFLAGS, DoCalls, extra_files

   267

        # extra_files = [(fname,fobject), ...]

   268

        gen_result = self.PlugGenerate_C(buildpath, locations)

   269

        PlugCFilesAndCFLAGS, PlugLDFLAGS, DoCalls = gen_result[:3]

   270

        extra_files = gen_result[3:]

   271

        # if some files have been generated put them in the list with their location

   272

        if PlugCFilesAndCFLAGS:

   273

            LocationCFilesAndCFLAGS = [(self.GetCurrentLocation(), PlugCFilesAndCFLAGS, DoCalls)]

   274

        else:

   275

            LocationCFilesAndCFLAGS = []

   276

   277

        # plugin asks for some LDFLAGS

   278

        if PlugLDFLAGS:

   279

            # LDFLAGS can be either string

   280

            if type(PlugLDFLAGS)==type(str()):

   281

                LDFLAGS=[PlugLDFLAGS]

   282

            #or list of strings

   283

            elif type(PlugLDFLAGS)==type(list()):

   284

                LDFLAGS=PlugLDFLAGS[:]

   285

        else:

   286

            LDFLAGS=[]

   287

   288

        # recurse through all childs, and stack their results

   289

        for PlugChild in self.IECSortedChilds():

   290

            new_location = PlugChild.GetCurrentLocation()

   291

            # How deep are we in the tree ?

   292

            depth=len(new_location)

   293

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   294

                PlugChild._Generate_C(

   295

                    #keep the same path

   296

                    buildpath,

   297

                    # filter locations that start with current IEC location

   298

                    [loc for loc in locations if loc["LOC"][0:depth] == new_location ])

   299

            # stack the result

   300

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   301

            LDFLAGS += _LDFLAGS

   302

            extra_files += _extra_files

   303

   304

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   305

   306

    def BlockTypesFactory(self):

   307

        if self.LibraryControler is not None:

   308

            return [{"name" : _("%s POUs") % self.PlugType, "list": self.LibraryControler.Project.GetCustomBlockTypes()}]

   309

        return []

   310

   311

    def ParentsBlockTypesFactory(self):

   312

        return self.PlugParent.ParentsBlockTypesFactory() + self.BlockTypesFactory()

   313

   314

    def PluginsBlockTypesFactory(self):

   315

        list = self.BlockTypesFactory()

   316

        for PlugChild in self.IterChilds():

   317

            list += PlugChild.PluginsBlockTypesFactory()

   318

        return list

   319

   320

    def STLibraryFactory(self):

   321

        if self.LibraryControler is not None:

   322

            program, errors, warnings = self.LibraryControler.GenerateProgram()

   323

            return program + "\n"

   324

        return ""

   325

   326

    def PluginsSTLibraryFactory(self):

   327

        program = self.STLibraryFactory()

   328

        for PlugChild in self.IECSortedChilds():

   329

            program += PlugChild.PluginsSTLibraryFactory()

   330

        return program

   331

   332

    def IterChilds(self):

   333

        for PlugType, PluggedChilds in self.PluggedChilds.items():

   334

            for PlugInstance in PluggedChilds:

   335

                yield PlugInstance

   336

   337

    def IECSortedChilds(self):

   338

        # reorder childs by IEC_channels

   339

        ordered = [(chld.BaseParams.getIEC_Channel(),chld) for chld in self.IterChilds()]

   340

        if ordered:

   341

            ordered.sort()

   342

            return zip(*ordered)[1]

   343

        else:

   344

            return []

   345

   346

    def _GetChildBySomething(self, something, toks):

   347

        for PlugInstance in self.IterChilds():

   348

            # if match component of the name

   349

            if getattr(PlugInstance.BaseParams, something) == toks[0]:

   350

                # if Name have other components

   351

                if len(toks) >= 2:

   352

                    # Recurse in order to find the latest object

   353

                    return PlugInstance._GetChildBySomething( something, toks[1:])

   354

                # No sub name -> found

   355

                return PlugInstance

   356

        # Not found

   357

        return None

   358

   359

    def GetChildByName(self, Name):

   360

        if Name:

   361

            toks = Name.split('.')

   362

            return self._GetChildBySomething("Name", toks)

   363

        else:

   364

            return self

   365

   366

    def GetChildByIECLocation(self, Location):

   367

        if Location:

   368

            return self._GetChildBySomething("IEC_Channel", Location)

   369

        else:

   370

            return self

   371

   372

    def GetCurrentLocation(self):

   373

        """

   374

        @return:  Tupple containing plugin IEC location of current plugin : %I0.0.4.5 => (0,0,4,5)

   375

        """

   376

        return self.PlugParent.GetCurrentLocation() + (self.BaseParams.getIEC_Channel(),)

   377

   378

    def GetCurrentName(self):

   379

        """

   380

        @return:  String "ParentParentName.ParentName.Name"

   381

        """

   382

        return  self.PlugParent._GetCurrentName() + self.BaseParams.getName()

   383

   384

    def _GetCurrentName(self):

   385

        """

   386

        @return:  String "ParentParentName.ParentName.Name."

   387

        """

   388

        return  self.PlugParent._GetCurrentName() + self.BaseParams.getName() + "."

   389

   390

    def GetPlugRoot(self):

   391

        return self.PlugParent.GetPlugRoot()

   392

   393

    def GetFullIEC_Channel(self):

   394

        return ".".join([str(i) for i in self.GetCurrentLocation()]) + ".x"

   395

   396

    def GetLocations(self):

   397

        location = self.GetCurrentLocation()

   398

        return [loc for loc in self.PlugParent.GetLocations() if loc["LOC"][0:len(location)] == location]

   399

   400

    def GetVariableLocationTree(self):

   401

        '''

   402

        This function is meant to be overridden by plugins.

   403

   404

        It should returns an list of dictionaries

   405

   406

        - IEC_type is an IEC type like BOOL/BYTE/SINT/...

   407

        - location is a string of this variable's location, like "%IX0.0.0"

   408

        '''

   409

        children = []

   410

        for child in self.IECSortedChilds():

   411

            children.append(child.GetVariableLocationTree())

   412

        return {"name": self.BaseParams.getName(),

   413

                "type": LOCATION_PLUGIN,

   414

                "location": self.GetFullIEC_Channel(),

   415

                "children": children}

   416

   417

    def GetPlugInfos(self):

   418

        childs = []

   419

        # reorder childs by IEC_channels

   420

        for child in self.IECSortedChilds():

   421

            childs.append(child.GetPlugInfos())

   422

        if wx.VERSION < (2, 8, 0):

   423

            return {"name" : "%d-%s"%(self.BaseParams.getIEC_Channel(),self.BaseParams.getName()), "type" : self.BaseParams.getName(), "values" : childs}

   424

        else:

   425

            return {"name" : self.BaseParams.getName(), "channel" : self.BaseParams.getIEC_Channel(), "enabled" : self.BaseParams.getEnabled(), "parent" : len(self.PlugChildsTypes) > 0, "type" : self.BaseParams.getName(), "values" : childs}

   426

   427

    def FindNewName(self, DesiredName):

   428

        """

   429

        Changes Name to DesiredName if available, Name-N if not.

   430

        @param DesiredName: The desired Name (string)

   431

        """

   432

        # Get Current Name

   433

        CurrentName = self.BaseParams.getName()

   434

        # Do nothing if no change

   435

        #if CurrentName == DesiredName: return CurrentName

   436

        # Build a list of used Name out of parent's PluggedChilds

   437

        AllNames=[]

   438

        for PlugInstance in self.PlugParent.IterChilds():

   439

            if PlugInstance != self:

   440

                AllNames.append(PlugInstance.BaseParams.getName())

   441

   442

        # Find a free name, eventually appending digit

   443

        res = DesiredName

   444

        suffix = 1

   445

        while res in AllNames:

   446

            res = "%s-%d"%(DesiredName, suffix)

   447

            suffix += 1

   448

   449

        # Get old path

   450

        oldname = self.PlugPath()

   451

        # Check previous plugin existance

   452

        dontexist = self.BaseParams.getName() == "__unnamed__"

   453

        # Set the new name

   454

        self.BaseParams.setName(res)

   455

        # Rename plugin dir if exist

   456

        if not dontexist:

   457

            shutil.move(oldname, self.PlugPath())

   458

        # warn user he has two left hands

   459

        if DesiredName != res:

   460

            self.GetPlugRoot().logger.write_warning(_("A child names \"%s\" already exist -> \"%s\"\n")%(DesiredName,res))

   461

        return res

   462

   463

    def FindNewIEC_Channel(self, DesiredChannel):

   464

        """

   465

        Changes IEC Channel number to DesiredChannel if available, nearest available if not.

   466

        @param DesiredChannel: The desired IEC channel (int)

   467

        """

   468

        # Get Current IEC channel

   469

        CurrentChannel = self.BaseParams.getIEC_Channel()

   470

        # Do nothing if no change

   471

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   472

        # Build a list of used Channels out of parent's PluggedChilds

   473

        AllChannels=[]

   474

        for PlugInstance in self.PlugParent.IterChilds():

   475

            if PlugInstance != self:

   476

                AllChannels.append(PlugInstance.BaseParams.getIEC_Channel())

   477

        AllChannels.sort()

   478

   479

        # Now, try to guess the nearest available channel

   480

        res = DesiredChannel

   481

        while res in AllChannels: # While channel not free

   482

            if res < CurrentChannel: # Want to go down ?

   483

                res -=  1 # Test for n-1

   484

                if res < 0 :

   485

                    self.GetPlugRoot().logger.write_warning(_("Cannot find lower free IEC channel than %d\n")%CurrentChannel)

   486

                    return CurrentChannel # Can't go bellow 0, do nothing