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("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

   101

    def _AddParamsMembers(self):

   102

        self.PlugParams = None

   103

        if self.XSD:

   104

            self.Classes = GenerateClassesFromXSDstring(self.XSD)

   105

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

   106

            if len(Classes) == 1:

   107

                name, XSDclass = Classes[0]

   108

                obj = XSDclass()

   109

                self.PlugParams = (name, obj)

   110

                setattr(self, name, obj)

   111

   112

    def __init__(self):

   113

        # Create BaseParam 

   114

        self.BaseParams = _BaseParamsClass()

   115

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

   116

        self._AddParamsMembers()

   117

        self.PluggedChilds = {}

   118

        # copy PluginMethods so that it can be later customized

   119

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

   120

        self.LoadSTLibrary()

   121

   122

    def PluginBaseXmlFilePath(self, PlugName=None):

   123

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

   124

   125

    def PluginXmlFilePath(self, PlugName=None):

   126

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

   127

   128

    def PluginLibraryFilePath(self):

   129

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

   130

   131

    def PluginPath(self):

   132

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

   133

   134

    def PlugPath(self,PlugName=None):

   135

        if not PlugName:

   136

            PlugName = self.BaseParams.getName()

   137

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

   138

                            PlugName + NameTypeSeparator + self.PlugType)

   139

   140

    def PlugTestModified(self):

   141

        return self.ChangesToSave

   142

   143

    def ProjectTestModified(self):

   144

        """

   145

        recursively check modified status

   146

        """

   147

        if self.PlugTestModified():

   148

            return True

   149

   150

        for PlugChild in self.IterChilds():

   151

            if PlugChild.ProjectTestModified():

   152

                return True

   153

   154

        return False

   155

   156

    def OnPlugSave(self):

   157

        #Default, do nothing and return success

   158

        return True

   159

   160

    def GetParamsAttributes(self, path = None):

   161

        if path:

   162

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

   163

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

   164

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

   165

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

   166

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

   167

        else:

   168

            params = []

   169

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

   170

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

   171

            if self.PlugParams:

   172

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

   173

            return params

   174

   175

    def SetParamsAttribute(self, path, value):

   176

        self.ChangesToSave = True

   177

        # Filter IEC_Channel and Name, that have specific behavior

   178

        if path == "BaseParams.IEC_Channel":

   179

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

   180

            new_value = self.FindNewIEC_Channel(value)

   181

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

   182

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

   183

            return new_value, True

   184

        elif path == "BaseParams.Name":

   185

            res = self.FindNewName(value)

   186

            self.PlugRequestSave()

   187

            return res, True

   188

   189

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

   190

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

   191

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

   192

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

   193

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

   194

        return value, False

   195

   196

    def PlugMakeDir(self):

   197

        os.mkdir(self.PlugPath())

   198

   199

    def PlugRequestSave(self):

   200

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

   201

            # If plugin do not have corresponding directory

   202

            plugpath = self.PlugPath()

   203

            if not os.path.isdir(plugpath):

   204

                # Create it

   205

                os.mkdir(plugpath)

   206

   207

            # generate XML for base XML parameters controller of the plugin

   208

            if self.MandatoryParams:

   209

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

   210

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

   211

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

   212

                BaseXMLFile.close()

   213

   214

            # generate XML for XML parameters controller of the plugin

   215

            if self.PlugParams:

   216

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

   217

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

   218

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

   219

                XMLFile.close()

   220

   221

            # Call the plugin specific OnPlugSave method

   222

            result = self.OnPlugSave()

   223

            if not result:

   224

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

   225

   226

            # mark plugin as saved

   227

            self.ChangesToSave = False

   228

            # go through all childs and do the same

   229

            for PlugChild in self.IterChilds():

   230

                result = PlugChild.PlugRequestSave()

   231

                if result:

   232

                    return result

   233

        return None

   234

   235

    def PlugImport(self, src_PlugPath):

   236

        shutil.copytree(src_PlugPath, self.PlugPath)

   237

        return True

   238

   239

    def PlugGenerate_C(self, buildpath, locations):

   240

        """

   241

        Generate C code

   242

        @param locations: List of complete variables locations \

   243

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

   244

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

   245

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

   246

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

   247

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

   248

            }, ...]

   249

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

   250

        """

   251

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

   252

        return [],"",False

   253

   254

    def _Generate_C(self, buildpath, locations):

   255

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

   256

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

   257

        gen_result = self.PlugGenerate_C(buildpath, locations)

   258

        PlugCFilesAndCFLAGS, PlugLDFLAGS, DoCalls = gen_result[:3]

   259

        extra_files = gen_result[3:]

   260

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

   261

        if PlugCFilesAndCFLAGS:

   262

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

   263

        else:

   264

            LocationCFilesAndCFLAGS = []

   265

   266

        # plugin asks for some LDFLAGS

   267

        if PlugLDFLAGS:

   268

            # LDFLAGS can be either string

   269

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

   270

                LDFLAGS=[PlugLDFLAGS]

   271

            #or list of strings

   272

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

   273

                LDFLAGS=PlugLDFLAGS[:]

   274

        else:

   275

            LDFLAGS=[]

   276

   277

        # recurse through all childs, and stack their results

   278

        for PlugChild in self.IECSortedChilds():

   279

            new_location = PlugChild.GetCurrentLocation()

   280

            # How deep are we in the tree ?

   281

            depth=len(new_location)

   282

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   283

                PlugChild._Generate_C(

   284

                    #keep the same path

   285

                    buildpath,

   286

                    # filter locations that start with current IEC location

   287

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

   288

            # stack the result

   289

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   290

            LDFLAGS += _LDFLAGS

   291

            extra_files += _extra_files

   292

   293

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   294

   295

    def BlockTypesFactory(self):

   296

        if self.LibraryControler is not None:

   297

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

   298

        return []

   299

   300

    def ParentsBlockTypesFactory(self):

   301

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

   302

   303

    def PluginsBlockTypesFactory(self):

   304

        list = self.BlockTypesFactory()

   305

        for PlugChild in self.IterChilds():

   306

            list += PlugChild.PluginsBlockTypesFactory()

   307

        return list

   308

   309

    def STLibraryFactory(self):

   310

        if self.LibraryControler is not None:

   311

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

   312

            return program + "\n"

   313

        return ""

   314

   315

    def PluginsSTLibraryFactory(self):

   316

        program = self.STLibraryFactory()

   317

        for PlugChild in self.IECSortedChilds():

   318

            program += PlugChild.PluginsSTLibraryFactory()

   319

        return program

   320

   321

    def IterChilds(self):

   322

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

   323

            for PlugInstance in PluggedChilds:

   324

                yield PlugInstance

   325

   326

    def IECSortedChilds(self):

   327

        # reorder childs by IEC_channels

   328

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

   329

        if ordered:

   330

            ordered.sort()

   331

            return zip(*ordered)[1]

   332

        else:

   333

            return []

   334

   335

    def _GetChildBySomething(self, something, toks):

   336

        for PlugInstance in self.IterChilds():

   337

            # if match component of the name

   338

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

   339

                # if Name have other components

   340

                if len(toks) >= 2:

   341

                    # Recurse in order to find the latest object

   342

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

   343

                # No sub name -> found

   344

                return PlugInstance

   345

        # Not found

   346

        return None

   347

   348

    def GetChildByName(self, Name):

   349

        if Name:

   350

            toks = Name.split('.')

   351

            return self._GetChildBySomething("Name", toks)

   352

        else:

   353

            return self

   354

   355

    def GetChildByIECLocation(self, Location):

   356

        if Location:

   357

            return self._GetChildBySomething("IEC_Channel", Location)

   358

        else:

   359

            return self

   360

   361

    def GetCurrentLocation(self):

   362

        """

   363

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

   364

        """

   365

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

   366

   367

    def GetCurrentName(self):

   368

        """

   369

        @return:  String "ParentParentName.ParentName.Name"

   370

        """

   371

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

   372

   373

    def _GetCurrentName(self):

   374

        """

   375

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

   376

        """

   377

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

   378

   379

    def GetPlugRoot(self):

   380

        return self.PlugParent.GetPlugRoot()

   381

   382

    def GetFullIEC_Channel(self):

   383

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

   384

   385

    def GetLocations(self):

   386

        location = self.GetCurrentLocation()

   387

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

   388

   389

    def GetVariableLocationTree(self):

   390

        '''

   391

        This function is meant to be overridden by plugins.

   392

   393

        It should returns an list of dictionaries

   394

   395

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

   396

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

   397

        '''

   398

        children = []

   399

        for child in self.IECSortedChilds():

   400

            children.append(child.GetVariableLocationTree())

   401

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

   402

                "type": LOCATION_PLUGIN,

   403

                "location": self.GetFullIEC_Channel(),

   404

                "children": children}

   405

   406

    def GetPlugInfos(self):

   407

        childs = []

   408

        # reorder childs by IEC_channels

   409

        for child in self.IECSortedChilds():

   410

            childs.append(child.GetPlugInfos())

   411

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

   412

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

   413

        else:

   414

            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}

   415

   416

    def FindNewName(self, DesiredName):

   417

        """

   418

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

   419

        @param DesiredName: The desired Name (string)

   420

        """

   421

        # Get Current Name

   422

        CurrentName = self.BaseParams.getName()

   423

        # Do nothing if no change

   424

        #if CurrentName == DesiredName: return CurrentName

   425

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

   426

        AllNames=[]

   427

        for PlugInstance in self.PlugParent.IterChilds():

   428

            if PlugInstance != self:

   429

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

   430

   431

        # Find a free name, eventually appending digit

   432

        res = DesiredName

   433

        suffix = 1

   434

        while res in AllNames:

   435

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

   436

            suffix += 1

   437

   438

        # Get old path

   439

        oldname = self.PlugPath()

   440

        # Check previous plugin existance

   441

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

   442

        # Set the new name

   443

        self.BaseParams.setName(res)

   444

        # Rename plugin dir if exist

   445

        if not dontexist:

   446

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

   447

        # warn user he has two left hands

   448

        if DesiredName != res:

   449

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

   450

        return res

   451

   452

    def FindNewIEC_Channel(self, DesiredChannel):

   453

        """

   454

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

   455

        @param DesiredChannel: The desired IEC channel (int)

   456

        """

   457

        # Get Current IEC channel

   458

        CurrentChannel = self.BaseParams.getIEC_Channel()

   459

        # Do nothing if no change

   460

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   461

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

   462

        AllChannels=[]

   463

        for PlugInstance in self.PlugParent.IterChilds():

   464

            if PlugInstance != self:

   465

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

   466

        AllChannels.sort()

   467

   468

        # Now, try to guess the nearest available channel

   469

        res = DesiredChannel

   470

        while res in AllChannels: # While channel not free

   471

            if res < CurrentChannel: # Want to go down ?

   472

                res -=  1 # Test for n-1

   473

                if res < 0 :

   474

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

   475

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

   476

            else : # Want to go up ?

   477

                res +=  1 # Test for n-1

   478

        # Finally set IEC Channel

   479

        self.BaseParams.setIEC_Channel(res)

   480

        if DesiredChannel != res:

   481

            self.GetPlugRoot().logger.write_warning(_("A child with IEC channel %d already exist -> %d\n")%(DesiredChannel,res))

   482

        return res

   483

   484

    def OnPlugClose(self):

   485

        return True

   486