1

"""

     2

Base definitions for beremiz plugins

     3

"""

     4

     5

import os,sys

     6

import plugins

     7

import types

     8

import shutil

     9

from xml.dom import minidom

    10

import wx

    11

    12

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

    13

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

    14

sys.path.append(os.path.join(base_folder, "plcopeneditor"))

    15

    16

from xmlclass import GenerateClassesFromXSDstring

    17

    18

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

    19

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

    20

          <xsd:element name="BaseParams">

    21

            <xsd:complexType>

    22

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

    23

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

    24

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

    25

            </xsd:complexType>

    26

          </xsd:element>

    27

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

    28

    29

NameTypeSeparator = '@'

    30

    31

class PlugTemplate:

    32

    """

    33

    This class is the one that define plugins.

    34

    """

    35

    36

    XSD = None

    37

    PlugChildsTypes = []

    38

    PlugMaxCount = None

    39

    PluginMethods = []

    40

    41

    def _AddParamsMembers(self):

    42

        self.PlugParams = None

    43

        if self.XSD:

    44

            Classes = GenerateClassesFromXSDstring(self.XSD)[0]

    45

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

    46

            if len(Classes) == 1:

    47

                name, XSDclass = Classes[0]

    48

                obj = XSDclass()

    49

                self.PlugParams = (name, obj)

    50

                setattr(self, name, obj)

    51

    52

    def __init__(self):

    53

        # Create BaseParam 

    54

        self.BaseParams = _BaseParamsClass()

    55

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

    56

        self._AddParamsMembers()

    57

        self.PluggedChilds = {}

    58

    59

    def PluginBaseXmlFilePath(self, PlugName=None):

    60

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

    61

    62

    def PluginXmlFilePath(self, PlugName=None):

    63

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

    64

    65

    def PlugPath(self,PlugName=None):

    66

        if not PlugName:

    67

            PlugName = self.BaseParams.getName()

    68

        return os.path.join(self.PlugParent.PlugPath(), PlugName + NameTypeSeparator + self.PlugType)

    69

    70

    def PlugTestModified(self):

    71

        return False

    72

    73

    def OnPlugSave(self):

    74

        #Default, do nothing and return success

    75

        return True

    76

    77

    def GetParamsAttributes(self, path = None):

    78

        if path:

    79

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

    80

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

    81

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

    82

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

    83

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

    84

        else:

    85

            params = []

    86

            if self.MandatoryParams:

    87

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

    88

            if self.PlugParams:

    89

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

    90

            return params

    91

    92

    def SetParamsAttribute(self, path, value, logger):

    93

        # Filter IEC_Channel and Name, that have specific behavior

    94

        if path == "BaseParams.IEC_Channel":

    95

            return self.FindNewIEC_Channel(value,logger), True

    96

        elif path == "BaseParams.Name":

    97

            res = self.FindNewName(value,logger)

    98

            self.PlugRequestSave()

    99

            return res, True

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

        return value, False

   107

   108

    def PlugRequestSave(self):

   109

        # If plugin do not have corresponding directory

   110

        plugpath = self.PlugPath()

   111

        if not os.path.isdir(plugpath):

   112

            # Create it

   113

            os.mkdir(plugpath)

   114

   115

        # generate XML for base XML parameters controller of the plugin

   116

        if self.MandatoryParams:

   117

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

   118

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

   119

            BaseXMLFile.write(self.MandatoryParams[1].generateXMLText(self.MandatoryParams[0], 0))

   120

            BaseXMLFile.close()

   121

   122

        # generate XML for XML parameters controller of the plugin

   123

        if self.PlugParams:

   124

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

   125

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

   126

            XMLFile.write(self.PlugParams[1].generateXMLText(self.PlugParams[0], 0))

   127

            XMLFile.close()

   128

   129

        # Call the plugin specific OnPlugSave method

   130

        result = self.OnPlugSave()

   131

        if not result:

   132

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

   133

   134

        # go through all childs and do the same

   135

        for PlugChild in self.IterChilds():

   136

            result = PlugChild.PlugRequestSave()

   137

            if result:

   138

                return result

   139

        return None

   140

   141

    def PlugImport(self, src_PlugPath):

   142

        shutil.copytree(src_PlugPath, self.PlugPath)

   143

        return True

   144

   145

    def PlugGenerate_C(self, buildpath, locations, logger):

   146

        """

   147

        Generate C code

   148

        @param locations: List of complete variables locations \

   149

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

   150

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

   151

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

   152

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

   153

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

   154

            }, ...]

   155

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

   156

        """

   157

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

   158

        return [],""

   159

   160

    def _Generate_C(self, buildpath, locations, logger):

   161

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

   162

        PlugCFilesAndCFLAGS, PlugLDFLAGS = self.PlugGenerate_C(buildpath, locations, logger)

   163

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

   164

        if PlugCFilesAndCFLAGS:

   165

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

   166

        else:

   167

            LocationCFilesAndCFLAGS = []

   168

   169

        # plugin asks some some LDFLAGS

   170

        if PlugLDFLAGS:

   171

            # LDFLAGS can be either string

   172

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

   173

                LDFLAGS=[PlugLDFLAGS]

   174

            #or list of strings

   175

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

   176

                LDFLAGS=PlugLDFLAGS[:]

   177

        else:

   178

            LDFLAGS=[]

   179

   180

        # recurse through all childs, and stack their results

   181

        for PlugChild in self.IECSortedChilds():

   182

            new_location = PlugChild.GetCurrentLocation()

   183

            # How deep are we in the tree ?

   184

            depth=len(new_location)

   185

            _LocationCFilesAndCFLAGS, _LDFLAGS = \

   186

                PlugChild._Generate_C(

   187

                    #keep the same path

   188

                    buildpath,

   189

                    # filter locations that start with current IEC location

   190

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

   191

                    #propagete logger

   192

                    logger)

   193

            # stack the result

   194

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   195

            LDFLAGS += _LDFLAGS

   196

   197

        return LocationCFilesAndCFLAGS,LDFLAGS

   198

   199

    def BlockTypesFactory(self):

   200

        return []

   201

   202

    def STLibraryFactory(self):

   203

        return ""

   204

   205

    def IterChilds(self):

   206

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

   207

            for PlugInstance in PluggedChilds:

   208

                   yield PlugInstance

   209

   210

    def IECSortedChilds(self):

   211

        # reorder childs by IEC_channels

   212

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

   213

        if ordered:

   214

            ordered.sort()

   215

            return zip(*ordered)[1]

   216

        else:

   217

            return []

   218

   219

    def _GetChildBySomething(self, something, toks):

   220

        for PlugInstance in self.IterChilds():

   221

            # if match component of the name

   222

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

   223

                # if Name have other components

   224

                if len(toks) >= 2:

   225

                    # Recurse in order to find the latest object

   226

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

   227

                # No sub name -> found

   228

                return PlugInstance

   229

        # Not found

   230

        return None

   231

   232

    def GetChildByName(self, Name):

   233

        if Name:

   234

            toks = Name.split('.')

   235

            return self._GetChildBySomething("Name", toks)

   236

        else:

   237

            return self

   238

   239

    def GetChildByIECLocation(self, Location):

   240

        if Location:

   241

            return self._GetChildBySomething("IEC_Channel", Location)

   242

        else:

   243

            return self

   244

   245

    def GetCurrentLocation(self):

   246

        """

   247

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

   248

        """

   249

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

   250

   251

    def GetCurrentName(self):

   252

        """

   253

        @return:  String "ParentParentName.ParentName.Name"

   254

        """

   255

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

   256

   257

    def _GetCurrentName(self):

   258

        """

   259

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

   260

        """

   261

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

   262

   263

    def GetPlugRoot(self):

   264

        return self.PlugParent.GetPlugRoot()

   265

   266

    def GetPlugInfos(self):

   267

        childs = []

   268

        # reorder childs by IEC_channels

   269

        for child in self.IECSortedChilds():

   270

            childs.append(child.GetPlugInfos())

   271

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

   272

   273

    def FindNewName(self, DesiredName, logger):

   274

        """

   275

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

   276

        @param DesiredName: The desired Name (string)

   277

        """

   278

        # Get Current Name

   279

        CurrentName = self.BaseParams.getName()

   280

        # Do nothing if no change

   281

        #if CurrentName == DesiredName: return CurrentName

   282

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

   283

        AllNames=[]

   284

        for PlugInstance in self.PlugParent.IterChilds():

   285

            if PlugInstance != self:

   286

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

   287

   288

        # Find a free name, eventually appending digit

   289

        res = DesiredName

   290

        suffix = 1

   291

        while res in AllNames:

   292

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

   293

            suffix += 1

   294

   295

        # Get old path

   296

        oldname = self.PlugPath()

   297

        # Check previous plugin existance

   298

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

   299

        # Set the new name

   300

        self.BaseParams.setName(res)

   301

        # Rename plugin dir if exist

   302

        if not dontexist:

   303

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

   304

        # warn user he has two left hands

   305

        if DesiredName != res:

   306

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

   307

        return res

   308

   309

    def FindNewIEC_Channel(self, DesiredChannel, logger):

   310

        """

   311

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

   312

        @param DesiredChannel: The desired IEC channel (int)

   313

        """

   314

        # Get Current IEC channel

   315

        CurrentChannel = self.BaseParams.getIEC_Channel()

   316

        # Do nothing if no change

   317

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   318

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

   319

        AllChannels=[]

   320

        for PlugInstance in self.PlugParent.IterChilds():

   321

            if PlugInstance != self:

   322

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

   323

        AllChannels.sort()

   324

   325

        # Now, try to guess the nearest available channel

   326

        res = DesiredChannel

   327

        while res in AllChannels: # While channel not free

   328

            if res < CurrentChannel: # Want to go down ?

   329

                res -=  1 # Test for n-1

   330

                if res < 0 :

   331

                    if logger :

   332

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

   333

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

   334

            else : # Want to go up ?

   335

                res +=  1 # Test for n-1

   336

        # Finally set IEC Channel

   337

        self.BaseParams.setIEC_Channel(res)

   338

        if logger and DesiredChannel != res:

   339

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

   340

        return res

   341

   342

    def OnPlugClose(self):

   343

        return True

   344

   345

    def _doRemoveChild(self, PlugInstance):

   346

        # Remove all childs of child

   347

        for SubPlugInstance in PlugInstance.IterChilds():

   348

            PlugInstance._doRemoveChild(SubPlugInstance)

   349

        # Call the OnCloseMethod

   350

        PlugInstance.OnPlugClose()

   351

        # Delete plugin dir

   352

        shutil.rmtree(PlugInstance.PlugPath())

   353

        # Remove child of PluggedChilds

   354

        self.PluggedChilds[PlugInstance.PlugType].remove(PlugInstance)

   355

        # Forget it... (View have to refresh)

   356

   357

    def PlugRemoveChild(self, PlugName):

   358

        # Fetch the plugin

   359

        PlugInstance = self.GetChildByName(PlugName)

   360

        # Ask to his parent to remove it

   361

        PlugInstance.PlugParent._doRemoveChild(PlugInstance)

   362

   363

    def PlugAddChild(self, PlugName, PlugType, logger):

   364

        """

   365

        Create the plugins that may be added as child to this node self

   366

        @param PlugType: string desining the plugin class name (get name from PlugChildsTypes)

   367

        @param PlugName: string for the name of the plugin instance

   368

        """

   369

        PlugChildsTypes = dict(self.PlugChildsTypes)

   370

        # Check that adding this plugin is allowed

   371

        try:

   372

            PlugClass = PlugChildsTypes[PlugType]

   373

        except KeyError:

   374

            raise Exception, "Cannot create child %s of type %s "%(PlugName, PlugType)

   375

   376

        # if PlugClass is a class factory, call it. (prevent unneeded imports)

   377

        if type(PlugClass) == types.FunctionType:

   378

            PlugClass = PlugClass()

   379

   380

        # Eventualy Initialize child instance list for this class of plugin

   381

        PluggedChildsWithSameClass = self.PluggedChilds.setdefault(PlugType, list())

   382

        # Check count

   383

        if getattr(PlugClass, "PlugMaxCount", None) and len(PluggedChildsWithSameClass) >= PlugClass.PlugMaxCount:

   384

            raise Exception, "Max count (%d) reached for this plugin of type %s "%(PlugClass.PlugMaxCount, PlugType)

   385

   386

        # create the final class, derived of provided plugin and template

   387

        class FinalPlugClass(PlugClass, PlugTemplate):

   388

            """

   389

            Plugin class is derivated into FinalPlugClass before being instanciated

   390

            This way __init__ is overloaded to ensure PlugTemplate.__init__ is called 

   391

            before PlugClass.__init__, and to do the file related stuff.

   392

            """

   393

            def __init__(_self):

   394

                # self is the parent

   395

                _self.PlugParent = self

   396

                # Keep track of the plugin type name

   397

                _self.PlugType = PlugType

   398

                # Call the base plugin template init - change XSD into class members

   399

                PlugTemplate.__init__(_self)

   400

                # check name is unique

   401

                NewPlugName = _self.FindNewName(PlugName, logger)

   402

                # If dir have already be made, and file exist

   403

                if os.path.isdir(_self.PlugPath(NewPlugName)): #and os.path.isfile(_self.PluginXmlFilePath(PlugName)):

   404

                    #Load the plugin.xml file into parameters members

   405

                    _self.LoadXMLParams(NewPlugName)

   406

                    # Basic check. Better to fail immediately.

   407

                    if (_self.BaseParams.getName() != NewPlugName):

   408

                        raise Exception, "Project tree layout do not match plugin.xml %s!=%s "%(NewPlugName, _self.BaseParams.getName())

   409

   410

                    # Now, self.PlugPath() should be OK

   411

   412

                    # Check that IEC_Channel is not already in use.

   413

                    _self.FindNewIEC_Channel(_self.BaseParams.getIEC_Channel(),logger)

   414

                    # Call the plugin real __init__

   415

                    if getattr(PlugClass, "__init__", None):

   416

                        PlugClass.__init__(_self)

   417

                    #Load and init all the childs

   418

                    _self.LoadChilds(logger)

   419

                else:

   420

                    # If plugin do not have corresponding file/dirs - they will be created on Save

   421

                    os.mkdir(_self.PlugPath())

   422

                    # Find an IEC number

   423

                    _self.FindNewIEC_Channel(0, None)

   424

                    # Call the plugin real __init__

   425

                    if getattr(PlugClass, "__init__", None):

   426

                        PlugClass.__init__(_self)

   427

                    _self.PlugRequestSave()

   428

   429

        # Create the object out of the resulting class

   430

        newPluginOpj = FinalPlugClass()

   431

        # Store it in PluggedChils

   432

        PluggedChildsWithSameClass.append(newPluginOpj)

   433

   434

        return newPluginOpj

   435

   436

   437

    def LoadXMLParams(self, PlugName = None):

   438

        # Get the base xml tree

   439

        if self.MandatoryParams:

   440

            basexmlfile = open(self.PluginBaseXmlFilePath(PlugName), 'r')

   441

            basetree = minidom.parse(basexmlfile)

   442

            self.MandatoryParams[1].loadXMLTree(basetree.childNodes[0])

   443

            basexmlfile.close()

   444

   445

        # Get the xml tree

   446

        if self.PlugParams:

   447

            xmlfile = open(self.PluginXmlFilePath(PlugName), 'r')

   448

            tree = minidom.parse(xmlfile)

   449

            self.PlugParams[1].loadXMLTree(tree.childNodes[0])

   450

            xmlfile.close()

   451

   452

    def LoadChilds(self, logger):

   453

        # Iterate over all PlugName@PlugType in plugin directory, and try to open them

   454

        for PlugDir in os.listdir(self.PlugPath()):

   455

            if os.path.isdir(os.path.join(self.PlugPath(), PlugDir)) and \

   456

               PlugDir.count(NameTypeSeparator) == 1:

   457

                pname, ptype = PlugDir.split(NameTypeSeparator)

   458

                try:

   459

                    self.PlugAddChild(pname, ptype, logger)

   460

                except Exception, e:

   461

                    logger.write_error("Could not add child \"%s\", type %s :\n%s\n"%(pname, ptype, str(e)))

   462

   463

def _GetClassFunction(name):

   464

    def GetRootClass():

   465

        return getattr(__import__("plugins." + name), name).RootClass

   466

    return GetRootClass

   467

   468

   469

####################################################################################

   470

####################################################################################

   471

####################################################################################

   472

###################################   ROOT    ######################################

   473

####################################################################################

   474

####################################################################################

   475

####################################################################################

   476

   477

iec2cc_path = os.path.join(base_folder, "matiec", "iec2cc")

   478

ieclib_path = os.path.join(base_folder, "matiec", "lib")

   479

   480

# import for project creation timestamping

   481

from time import localtime

   482

from datetime import datetime

   483

# import necessary stuff from PLCOpenEditor

   484

from PLCControler import PLCControler

   485

from PLCOpenEditor import PLCOpenEditor, ProjectDialog

   486

from TextViewer import TextViewer

   487

from plcopen.structures import IEC_KEYWORDS, AddPluginBlockList, ClearPluginTypes, PluginTypes