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 docpdf import *

    17

from xmlclass import GenerateClassesFromXSDstring

    18

from wxPopen import ProcessLogger

    19

    20

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

    21

    22

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

    23

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

    24

          <xsd:element name="BaseParams">

    25

            <xsd:complexType>

    26

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

    27

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

    28

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

    29

            </xsd:complexType>

    30

          </xsd:element>

    31

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

    32

    33

NameTypeSeparator = '@'

    34

    35

class MiniTextControler:

    36

    37

    def __init__(self, filepath):

    38

        self.FilePath = filepath

    39

    40

    def SetEditedElementText(self, tagname, text):

    41

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

    42

        file.write(text)

    43

        file.close()

    44

    45

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

    46

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

    47

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

    48

            text = file.read()

    49

            file.close()

    50

            return text

    51

        return ""

    52

    53

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

    54

        return []

    55

    56

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

    57

        return "program"

    58

    59

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

    60

        return []

    61

    62

    def GetEnumeratedDataValues(self, debug = False):

    63

        return []

    64

    65

    def StartBuffering(self):

    66

        pass

    67

    68

    def EndBuffering(self):

    69

        pass

    70

    71

    def BufferProject(self):

    72

        pass

    73

    74

# helper func to get path to images

    75

def opjimg(imgname):

    76

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

    77

    78

# helper func to check path write permission

    79

def CheckPathPerm(path):

    80

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

    81

        return False

    82

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

    83

         for name in files:

    84

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

    85

                 return False

    86

    return True

    87

    88

class PlugTemplate:

    89

    """

    90

    This class is the one that define plugins.

    91

    """

    92

    93

    XSD = None

    94

    PlugChildsTypes = []

    95

    PlugMaxCount = None

    96

    PluginMethods = []

    97

    LibraryControler = None

    98

    99

    def _AddParamsMembers(self):

   100

        self.PlugParams = None

   101

        if self.XSD:

   102

            self.Classes = GenerateClassesFromXSDstring(self.XSD)

   103

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

   104

            if len(Classes) == 1:

   105

                name, XSDclass = Classes[0]

   106

                obj = XSDclass()

   107

                self.PlugParams = (name, obj)

   108

                setattr(self, name, obj)

   109

   110

    def __init__(self):

   111

        # Create BaseParam 

   112

        self.BaseParams = _BaseParamsClass()

   113

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

   114

        self._AddParamsMembers()

   115

        self.PluggedChilds = {}

   116

        # copy PluginMethods so that it can be later customized

   117

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

   118

        self.LoadSTLibrary()

   119

   120

    def PluginBaseXmlFilePath(self, PlugName=None):

   121

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

   122

   123

    def PluginXmlFilePath(self, PlugName=None):

   124

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

   125

   126

    def PluginLibraryFilePath(self):

   127

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

   128

   129

    def PluginPath(self):

   130

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

   131

   132

    def PlugPath(self,PlugName=None):

   133

        if not PlugName:

   134

            PlugName = self.BaseParams.getName()

   135

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

   136

                            PlugName + NameTypeSeparator + self.PlugType)

   137

   138

    def PlugTestModified(self):

   139

        return self.ChangesToSave

   140

   141

    def ProjectTestModified(self):

   142

        """

   143

        recursively check modified status

   144

        """

   145

        if self.PlugTestModified():

   146

            return True

   147

   148

        for PlugChild in self.IterChilds():

   149

            if PlugChild.ProjectTestModified():

   150

                return True

   151

   152

        return False

   153

   154

    def OnPlugSave(self):

   155

        #Default, do nothing and return success

   156

        return True

   157

   158

    def GetParamsAttributes(self, path = None):

   159

        if path:

   160

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

   161

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

   162

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

   163

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

   164

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

   165

        else:

   166

            params = []

   167

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

   168

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

   169

            if self.PlugParams:

   170

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

   171

            return params

   172

   173

    def SetParamsAttribute(self, path, value):

   174

        self.ChangesToSave = True

   175

        # Filter IEC_Channel and Name, that have specific behavior

   176

        if path == "BaseParams.IEC_Channel":

   177

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

   178

            new_value = self.FindNewIEC_Channel(value)

   179

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

   180

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

   181

            return new_value, True

   182

        elif path == "BaseParams.Name":

   183

            res = self.FindNewName(value)

   184

            self.PlugRequestSave()

   185

            return res, True

   186

   187

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

   188

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

   189

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

   190

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

   191

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

   192

        return value, False

   193

   194

    def PlugMakeDir(self):

   195

        os.mkdir(self.PlugPath())

   196

   197

    def PlugRequestSave(self):

   198

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

   199

            # If plugin do not have corresponding directory

   200

            plugpath = self.PlugPath()

   201

            if not os.path.isdir(plugpath):

   202

                # Create it

   203

                os.mkdir(plugpath)

   204

   205

            # generate XML for base XML parameters controller of the plugin

   206

            if self.MandatoryParams:

   207

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

   208

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

   209

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

   210

                BaseXMLFile.close()

   211

   212

            # generate XML for XML parameters controller of the plugin

   213

            if self.PlugParams:

   214

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

   215

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

   216

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

   217

                XMLFile.close()

   218

   219

            # Call the plugin specific OnPlugSave method

   220

            result = self.OnPlugSave()

   221

            if not result:

   222

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

   223

   224

            # mark plugin as saved

   225

            self.ChangesToSave = False

   226

            # go through all childs and do the same

   227

            for PlugChild in self.IterChilds():

   228

                result = PlugChild.PlugRequestSave()

   229

                if result:

   230

                    return result

   231

        return None

   232

   233

    def PlugImport(self, src_PlugPath):

   234

        shutil.copytree(src_PlugPath, self.PlugPath)

   235

        return True

   236

   237

    def PlugGenerate_C(self, buildpath, locations):

   238

        """

   239

        Generate C code

   240

        @param locations: List of complete variables locations \

   241

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

   242

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

   243

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

   244

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

   245

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

   246

            }, ...]

   247

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

   248

        """

   249

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

   250

        return [],"",False

   251

   252

    def _Generate_C(self, buildpath, locations):

   253

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

   254

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

   255

        gen_result = self.PlugGenerate_C(buildpath, locations)

   256

        PlugCFilesAndCFLAGS, PlugLDFLAGS, DoCalls = gen_result[:3]

   257

        extra_files = gen_result[3:]

   258

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

   259

        if PlugCFilesAndCFLAGS:

   260

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

   261

        else:

   262

            LocationCFilesAndCFLAGS = []

   263

   264

        # plugin asks for some LDFLAGS

   265

        if PlugLDFLAGS:

   266

            # LDFLAGS can be either string

   267

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

   268

                LDFLAGS=[PlugLDFLAGS]

   269

            #or list of strings

   270

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

   271

                LDFLAGS=PlugLDFLAGS[:]

   272

        else:

   273

            LDFLAGS=[]

   274

   275

        # recurse through all childs, and stack their results

   276

        for PlugChild in self.IECSortedChilds():

   277

            new_location = PlugChild.GetCurrentLocation()

   278

            # How deep are we in the tree ?

   279

            depth=len(new_location)

   280

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   281

                PlugChild._Generate_C(

   282

                    #keep the same path

   283

                    buildpath,

   284

                    # filter locations that start with current IEC location

   285

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

   286

            # stack the result

   287

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   288

            LDFLAGS += _LDFLAGS

   289

            extra_files += _extra_files

   290

   291

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   292

   293

    def BlockTypesFactory(self):

   294

        if self.LibraryControler is not None:

   295

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

   296

        return []

   297

   298

    def ParentsBlockTypesFactory(self):

   299

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

   300

   301

    def PluginsBlockTypesFactory(self):

   302

        list = self.BlockTypesFactory()

   303

        for PlugChild in self.IterChilds():

   304

            list += PlugChild.PluginsBlockTypesFactory()

   305

        return list

   306

   307

    def STLibraryFactory(self):

   308

        if self.LibraryControler is not None:

   309

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

   310

            return program + "\n"

   311

        return ""

   312

   313

    def PluginsSTLibraryFactory(self):

   314

        program = self.STLibraryFactory()

   315

        for PlugChild in self.IECSortedChilds():

   316

            program += PlugChild.PluginsSTLibraryFactory()

   317

        return program

   318

   319

    def IterChilds(self):

   320

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

   321

            for PlugInstance in PluggedChilds:

   322

                yield PlugInstance

   323

   324

    def IECSortedChilds(self):

   325

        # reorder childs by IEC_channels

   326

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

   327

        if ordered:

   328

            ordered.sort()

   329

            return zip(*ordered)[1]

   330

        else:

   331

            return []

   332

   333

    def _GetChildBySomething(self, something, toks):

   334

        for PlugInstance in self.IterChilds():

   335

            # if match component of the name

   336

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

   337

                # if Name have other components

   338

                if len(toks) >= 2:

   339

                    # Recurse in order to find the latest object

   340

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

   341

                # No sub name -> found

   342

                return PlugInstance

   343

        # Not found

   344

        return None

   345

   346

    def GetChildByName(self, Name):

   347

        if Name:

   348

            toks = Name.split('.')

   349

            return self._GetChildBySomething("Name", toks)

   350

        else:

   351

            return self

   352

   353

    def GetChildByIECLocation(self, Location):

   354

        if Location:

   355

            return self._GetChildBySomething("IEC_Channel", Location)

   356

        else:

   357

            return self

   358

   359

    def GetCurrentLocation(self):

   360

        """

   361

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

   362

        """

   363

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

   364

   365

    def GetCurrentName(self):

   366

        """

   367

        @return:  String "ParentParentName.ParentName.Name"

   368

        """

   369

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

   370

   371

    def _GetCurrentName(self):

   372

        """

   373

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

   374

        """

   375

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

   376

   377

    def GetPlugRoot(self):

   378

        return self.PlugParent.GetPlugRoot()

   379

   380

    def GetFullIEC_Channel(self):

   381

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

   382

   383

    def GetLocations(self):

   384

        location = self.GetCurrentLocation()

   385

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

   386

   387

    def GetVariableLocationTree(self):

   388

        '''

   389

        This function is meant to be overridden by plugins.

   390

   391

        It should returns an list of dictionaries

   392

   393

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

   394

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

   395

        '''

   396

        children = []

   397

        for child in self.IECSortedChilds():

   398

            children.append(child.GetVariableLocationTree())

   399

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

   400

                "type": LOCATION_PLUGIN,

   401

                "location": self.GetFullIEC_Channel(),

   402

                "children": children}

   403

   404

    def GetPlugInfos(self):

   405

        childs = []

   406

        # reorder childs by IEC_channels

   407

        for child in self.IECSortedChilds():

   408

            childs.append(child.GetPlugInfos())

   409

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

   410

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

   411

        else:

   412

            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}

   413

   414

    def FindNewName(self, DesiredName):

   415

        """

   416

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

   417

        @param DesiredName: The desired Name (string)

   418

        """

   419

        # Get Current Name

   420

        CurrentName = self.BaseParams.getName()

   421

        # Do nothing if no change

   422

        #if CurrentName == DesiredName: return CurrentName

   423

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

   424

        AllNames=[]

   425

        for PlugInstance in self.PlugParent.IterChilds():

   426

            if PlugInstance != self:

   427

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

   428

   429

        # Find a free name, eventually appending digit

   430

        res = DesiredName

   431

        suffix = 1

   432

        while res in AllNames:

   433

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

   434

            suffix += 1

   435

   436

        # Get old path

   437

        oldname = self.PlugPath()

   438

        # Check previous plugin existance

   439

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

   440

        # Set the new name

   441

        self.BaseParams.setName(res)

   442

        # Rename plugin dir if exist

   443

        if not dontexist:

   444

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

   445

        # warn user he has two left hands

   446

        if DesiredName != res:

   447

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

   448

        return res

   449

   450

    def FindNewIEC_Channel(self, DesiredChannel):

   451

        """

   452

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

   453

        @param DesiredChannel: The desired IEC channel (int)

   454

        """

   455

        # Get Current IEC channel

   456

        CurrentChannel = self.BaseParams.getIEC_Channel()

   457

        # Do nothing if no change

   458

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   459

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

   460

        AllChannels=[]

   461

        for PlugInstance in self.PlugParent.IterChilds():

   462

            if PlugInstance != self:

   463

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

   464

        AllChannels.sort()

   465

   466

        # Now, try to guess the nearest available channel

   467

        res = DesiredChannel

   468

        while res in AllChannels: # While channel not free

   469

            if res < CurrentChannel: # Want to go down ?

   470

                res -=  1 # Test for n-1

   471

                if res < 0 :

   472

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

   473

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

   474

            else : # Want to go up ?

   475

                res +=  1 # Test for n-1

   476

        # Finally set IEC Channel

   477

        self.BaseParams.setIEC_Channel(res)

   478

        if DesiredChannel != res:

   479

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

   480

        return res

   481

   482

    def OnPlugClose(self):

   483

        return True

   484

   485

    def _doRemoveChild(self, PlugInstance):

   486

        # Remove all childs of child