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

        # recurse through all childs, and stack their results

   164

        for PlugChild in self.IterChilds():

   165

            new_location = PlugChild.GetCurrentLocation()

   166

            # How deep are we in the tree ?

   167

            depth=len(new_location)

   168

            CFilesAndCFLAGS, LDFLAGS = \

   169

                PlugChild._Generate_C(

   170

                    #keep the same path

   171

                    buildpath,

   172

                    # filter locations that start with current IEC location

   173

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

   174

                    #propagete logger

   175

                    logger)

   176

            # stack the result

   177

            PlugCFilesAndCFLAGS += CFilesAndCFLAGS

   178

            PlugLDFLAGS += LDFLAGS

   179

   180

        return PlugCFilesAndCFLAGS,PlugLDFLAGS

   181

   182

    def BlockTypesFactory(self):

   183

        return []

   184

   185

    def STLibraryFactory(self):

   186

        return ""

   187

   188

    def IterChilds(self):

   189

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

   190

            for PlugInstance in PluggedChilds:

   191

                   yield PlugInstance

   192

   193

    def _GetChildBySomething(self, sep, something, matching):

   194

        toks = matching.split(sep,1)

   195

        for PlugInstance in self.IterChilds():

   196

            # if match component of the name

   197

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

   198

                # if Name have other components

   199

                if len(toks) == 2:

   200

                    # Recurse in order to find the latest object

   201

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

   202

                # No sub name -> found

   203

                return PlugInstance

   204

        # Not found

   205

        return None

   206

   207

    def GetChildByName(self, Name):

   208

        return self._GetChildBySomething('.',"Name", Name)

   209

   210

    def GetChildByIECLocation(self, Location):

   211

        return self._GetChildBySomething('_',"IEC_Channel", Name)

   212

   213

    def GetCurrentLocation(self):

   214

        """

   215

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

   216

        """

   217

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

   218

   219

    def GetPlugRoot(self):

   220

        return self.PlugParent.GetPlugRoot()

   221

   222

    def GetPlugInfos(self):

   223

        childs = []

   224

        # reorder childs by IEC_channels

   225

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

   226

        if ordered:

   227

            ordered.sort()

   228

            for child in zip(*ordered)[1]:

   229

                childs.append(child.GetPlugInfos())

   231

   232

   233

    def FindNewName(self, DesiredName, logger):

   234

        """

   235

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

   236

        @param DesiredName: The desired Name (string)

   237

        """

   238

        # Get Current Name

   239

        CurrentName = self.BaseParams.getName()

   240

        # Do nothing if no change

   241

        #if CurrentName == DesiredName: return CurrentName

   242

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

   243

        AllNames=[]

   244

        for PlugInstance in self.PlugParent.IterChilds():

   245

            if PlugInstance != self:

   246

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

   247

   248

        # Find a free name, eventually appending digit

   249

        res = DesiredName

   250

        suffix = 1

   251

        while res in AllNames:

   252

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

   253

            suffix += 1

   254

   255

        # Get old path

   256

        oldname = self.PlugPath()

   257

        # Check previous plugin existance

   258

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

   259

        # Set the new name

   260

        self.BaseParams.setName(res)

   261

        # Rename plugin dir if exist

   262

        if not dontexist:

   263

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

   264

        # warn user he has two left hands

   265

        if DesiredName != res:

   266

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

   267

        return res

   268

   269

    def FindNewIEC_Channel(self, DesiredChannel, logger):

   270

        """

   271

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

   272

        @param DesiredChannel: The desired IEC channel (int)

   273

        """

   274

        # Get Current IEC channel

   275

        CurrentChannel = self.BaseParams.getIEC_Channel()

   276

        # Do nothing if no change

   277

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   278

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

   279

        AllChannels=[]

   280

        for PlugInstance in self.PlugParent.IterChilds():

   281

            if PlugInstance != self:

   282

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

   283

        AllChannels.sort()

   284

   285

        # Now, try to guess the nearest available channel

   286

        res = DesiredChannel

   287

        while res in AllChannels: # While channel not free

   288

            if res < CurrentChannel: # Want to go down ?

   289

                res -=  1 # Test for n-1

   290

                if res < 0 :

   291

                    if logger :

   292

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

   293

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

   294

            else : # Want to go up ?

   295

                res +=  1 # Test for n-1

   296

        # Finally set IEC Channel

   297

        self.BaseParams.setIEC_Channel(res)

   298

        if logger and DesiredChannel != res:

   299

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

   300

        return res

   301

   302

    def OnPlugClose(self):

   303

        return True

   304

   305

    def _doRemoveChild(self, PlugInstance):

   306

        # Remove all childs of child

   307

        for SubPlugInstance in PlugInstance.IterChilds():

   308

            PlugInstance._doRemoveChild(SubPlugInstance)

   309

        # Call the OnCloseMethod

   310

        PlugInstance.OnPlugClose()

   311

        # Delete plugin dir

   312

        shutil.rmtree(PlugInstance.PlugPath())

   313

        # Remove child of PluggedChilds

   314

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

   315

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

   316

   317

    def PlugRemoveChild(self, PlugName):

   318

        # Fetch the plugin

   319

        PlugInstance = self.GetChildByName(PlugName)

   320

        # Ask to his parent to remove it

   321

        PlugInstance.PlugParent._doRemoveChild(PlugInstance)

   322

   323

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

   324

        """

   325

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

   326

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

   327

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

   328

        """

   329

        PlugChildsTypes = dict(self.PlugChildsTypes)

   330

        # Check that adding this plugin is allowed

   331

        try:

   332

            PlugClass = PlugChildsTypes[PlugType]

   333

        except KeyError:

   334

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

   335

   336

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

   337

        if type(PlugClass) == types.FunctionType:

   338

            PlugClass = PlugClass()

   339

   340

        # Eventualy Initialize child instance list for this class of plugin

   341

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

   342

        # Check count

   343

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

   344

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

   345

   346

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

   347

        class FinalPlugClass(PlugClass, PlugTemplate):

   348

            """

   349

            Plugin class is derivated into FinalPlugClass before being instanciated

   350

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

   351

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

   352

            """

   353

            def __init__(_self):

   354

                # self is the parent

   355

                _self.PlugParent = self

   356

                # Keep track of the plugin type name

   357

                _self.PlugType = PlugType

   358

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

   359

                PlugTemplate.__init__(_self)

   360

                # check name is unique

   361

                NewPlugName = _self.FindNewName(PlugName, logger)

   362

                # If dir have already be made, and file exist

   363

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

   364

                    #Load the plugin.xml file into parameters members

   365

                    _self.LoadXMLParams(NewPlugName)

   366

                    # Basic check. Better to fail immediately.

   367

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

   368

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

   369

   370

                    # Now, self.PlugPath() should be OK

   371

   372

                    # Check that IEC_Channel is not already in use.

   373

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

   374

                    # Call the plugin real __init__

   375

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

   376

                        PlugClass.__init__(_self)

   377

                    #Load and init all the childs

   378

                    _self.LoadChilds(logger)

   379

                else:

   380

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

   381

                    os.mkdir(_self.PlugPath())

   382

                    # Find an IEC number

   383

                    _self.FindNewIEC_Channel(0, None)

   384

                    # Call the plugin real __init__

   385

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

   386

                        PlugClass.__init__(_self)

   387

                    _self.PlugRequestSave()

   388

   389

        # Create the object out of the resulting class

   390

        newPluginOpj = FinalPlugClass()

   391

        # Store it in PluggedChils

   392

        PluggedChildsWithSameClass.append(newPluginOpj)

   393

   394

        return newPluginOpj

   395

   396

   397

    def LoadXMLParams(self, PlugName = None):

   398

        # Get the base xml tree

   399

        if self.MandatoryParams:

   400

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

   401

            basetree = minidom.parse(basexmlfile)

   402

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

   403

            basexmlfile.close()

   404

   405

        # Get the xml tree

   406

        if self.PlugParams:

   407

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

   408

            tree = minidom.parse(xmlfile)

   409

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

   410

            xmlfile.close()

   411

   412

    def LoadChilds(self, logger):

   413

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

   414

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

   415

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

   416

               PlugDir.count(NameTypeSeparator) == 1:

   417

                pname, ptype = PlugDir.split(NameTypeSeparator)

   418

                try:

   419

                    self.PlugAddChild(pname, ptype, logger)

   420

                except Exception, e:

   421

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

   422

   423

def _GetClassFunction(name):

   424

    def GetRootClass():

   425

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

   426

    return GetRootClass

   427

   428

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

   437

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

   438

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

   439

   440

# import for project creation timestamping

   441

from time import localtime

   442

from datetime import datetime

   443

# import necessary stuff from PLCOpenEditor

   444

from PLCControler import PLCControler

   445

from PLCOpenEditor import PLCOpenEditor, ProjectDialog

   446

from TextViewer import TextViewer

   447

from plcopen.structures import IEC_KEYWORDS

   448

import re

   449

   450

class PluginsRoot(PlugTemplate):

   451

    """

   452

    This class define Root object of the plugin tree. 

   453

    It is responsible of :

   454

    - Managing project directory

   455

    - Building project

   456

    - Handling PLCOpenEditor controler and view

   457

    - Loading user plugins and instanciante them as childs

   458

    - ...

   459

   460

    """

   461

   462

    # For root object, available Childs Types are modules of the plugin packages.

   463

    PlugChildsTypes = [(name, _GetClassFunction(name)) for name in plugins.__all__]

   464

   465

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   466

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

   467

      <xsd:simpleType name="Win32Compiler">

   468

        <xsd:restriction base="xsd:string">

   469

          <xsd:enumeration value="Cygwin"/>

   470

          <xsd:enumeration value="MinGW"/>

   471

          <xsd:enumeration value="VC++"/>

   472

        </xsd:restriction>

   473

      </xsd:simpleType>

   474

      <xsd:element name="BeremizRoot">

   475

        <xsd:complexType>

   476

          <xsd:element name="TargetType">

   477

            <xsd:complexType>

   478

              <xsd:choice>

   479

                <xsd:element name="Win32">

   480

                  <xsd:complexType>

   481

                    <xsd:attribute name="ToolChain" type="ppx:Win32Compiler" use="required" default="MinGW"/>

   482

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

   483

                  </xsd:complexType>

   484

                </xsd:element>

   485

                <xsd:element name="Linux">

   486

                  <xsd:complexType>

   487

                    <xsd:attribute name="Compiler" type="xsd:string" use="required" default="gcc"/>

   488

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

   489

                  </xsd:complexType>

   490

                </xsd:element>