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

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

    16

    17

from docpdf import *

    18

from xmlclass import GenerateClassesFromXSDstring

    19

from wxPopen import ProcessLogger

    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):

    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):

    53

        return []

    54

    55

    def GetEditedElementType(self, tagname):

    56

        return "program"

    57

    58

    def GetBlockTypes(self, tagname = ""):

    59

        return []

    60

    61

    def GetEnumeratedDataValues(self):

    62

        return []

    63

    64

    def StartBuffering(self):

    65

        pass

    66

    67

    def EndBuffering(self):

    68

        pass

    69

    70

    def BufferProject(self):

    71

        pass

    72

    73

class PlugTemplate:

    74

    """

    75

    This class is the one that define plugins.

    76

    """

    77

    78

    XSD = None

    79

    PlugChildsTypes = []

    80

    PlugMaxCount = None

    81

    PluginMethods = []

    82

    83

    def _AddParamsMembers(self):

    84

        self.PlugParams = None

    85

        if self.XSD:

    86

            Classes = GenerateClassesFromXSDstring(self.XSD)

    87

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

    88

            if len(Classes) == 1:

    89

                name, XSDclass = Classes[0]

    90

                obj = XSDclass()

    91

                self.PlugParams = (name, obj)

    92

                setattr(self, name, obj)

    93

    94

    def __init__(self):

    95

        # Create BaseParam 

    96

        self.BaseParams = _BaseParamsClass()

    97

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

    98

        self._AddParamsMembers()

    99

        self.PluggedChilds = {}

   100

        # copy PluginMethods so that it can be later customized

   101

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

   102

   103

    def IsGUIPlugin(self):

   104

        return False

   105

   106

    def PluginBaseXmlFilePath(self, PlugName=None):

   107

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

   108

   109

    def PluginXmlFilePath(self, PlugName=None):

   110

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

   111

   112

    def PlugPath(self,PlugName=None):

   113

        if not PlugName:

   114

            PlugName = self.BaseParams.getName()

   115

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

   116

   117

    def PlugTestModified(self):

   118

        return self.ChangesToSave

   119

   120

    def ProjectTestModified(self):

   121

        """

   122

        recursively check modified status

   123

        """

   124

        if self.PlugTestModified():

   125

            return True

   126

   127

        for PlugChild in self.IterChilds():

   128

            if PlugChild.ProjectTestModified():

   129

                return True

   130

   131

        return False

   132

   133

    def OnPlugSave(self):

   134

        #Default, do nothing and return success

   135

        return True

   136

   137

    def GetParamsAttributes(self, path = None):

   138

        if path:

   139

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

   140

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

   141

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

   142

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

   143

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

   144

        else:

   145

            params = []

   146

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

   147

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

   148

            if self.PlugParams:

   149

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

   150

            return params

   151

   152

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

   153

        self.ChangesToSave = True

   154

        # Filter IEC_Channel and Name, that have specific behavior

   155

        if path == "BaseParams.IEC_Channel":

   156

            return self.FindNewIEC_Channel(value,logger), True

   157

        elif path == "BaseParams.Name":

   158

            res = self.FindNewName(value,logger)

   159

            self.PlugRequestSave()

   160

            return res, True

   161

   162

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

   163

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

   164

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

   165

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

   166

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

   167

        return value, False

   168

   169

    def PlugRequestSave(self):

   170

        # If plugin do not have corresponding directory

   171

        plugpath = self.PlugPath()

   172

        if not os.path.isdir(plugpath):

   173

            # Create it

   174

            os.mkdir(plugpath)

   175

   176

        # generate XML for base XML parameters controller of the plugin

   177

        if self.MandatoryParams:

   178

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

   179

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

   180

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

   181

            BaseXMLFile.close()

   182

   183

        # generate XML for XML parameters controller of the plugin

   184

        if self.PlugParams:

   185

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

   186

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

   187

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

   188

            XMLFile.close()

   189

   190

        # Call the plugin specific OnPlugSave method

   191

        result = self.OnPlugSave()

   192

        if not result:

   193

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

   194

   195

        # mark plugin as saved

   196

        self.ChangesToSave = False        

   197

        # go through all childs and do the same

   198

        for PlugChild in self.IterChilds():

   199

            result = PlugChild.PlugRequestSave()

   200

            if result:

   201

                return result

   202

        return None

   203

   204

    def PlugImport(self, src_PlugPath):

   205

        shutil.copytree(src_PlugPath, self.PlugPath)

   206

        return True

   207

   208

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

   209

        """

   210

        Generate C code

   211

        @param locations: List of complete variables locations \

   212

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

   213

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

   214

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

   215

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

   216

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

   217

            }, ...]

   218

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

   219

        """

   220

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

   221

        return [],"",False

   222

   223

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

   224

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

   225

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

   226

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

   227

        if PlugCFilesAndCFLAGS:

   228

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

   229

        else:

   230

            LocationCFilesAndCFLAGS = []

   231

   232

        # plugin asks for some LDFLAGS

   233

        if PlugLDFLAGS:

   234

            # LDFLAGS can be either string

   235

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

   236

                LDFLAGS=[PlugLDFLAGS]

   237

            #or list of strings

   238

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

   239

                LDFLAGS=PlugLDFLAGS[:]

   240

        else:

   241

            LDFLAGS=[]

   242

   243

        # recurse through all childs, and stack their results

   244

        for PlugChild in self.IECSortedChilds():

   245

            new_location = PlugChild.GetCurrentLocation()

   246

            # How deep are we in the tree ?

   247

            depth=len(new_location)

   248

            _LocationCFilesAndCFLAGS, _LDFLAGS = \

   249

                PlugChild._Generate_C(

   250

                    #keep the same path

   251

                    buildpath,

   252

                    # filter locations that start with current IEC location

   253

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

   254

                    #propagete logger

   255

                    logger)

   256

            # stack the result

   257

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   258

            LDFLAGS += _LDFLAGS

   259

   260

        return LocationCFilesAndCFLAGS,LDFLAGS

   261

   262

    def BlockTypesFactory(self):

   263

        return []

   264

   265

    def STLibraryFactory(self):

   266

        return ""

   267

   268

    def IterChilds(self):

   269

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

   270

            for PlugInstance in PluggedChilds:

   271

                   yield PlugInstance

   272

   273

    def IECSortedChilds(self):

   274

        # reorder childs by IEC_channels

   275

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

   276

        if ordered:

   277

            ordered.sort()

   278

            return zip(*ordered)[1]

   279

        else:

   280

            return []

   281

   282

    def _GetChildBySomething(self, something, toks):

   283

        for PlugInstance in self.IterChilds():

   284

            # if match component of the name

   285

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

   286

                # if Name have other components

   287

                if len(toks) >= 2:

   288

                    # Recurse in order to find the latest object

   289

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

   290

                # No sub name -> found

   291

                return PlugInstance

   292

        # Not found

   293

        return None

   294

   295

    def GetChildByName(self, Name):

   296

        if Name:

   297

            toks = Name.split('.')

   298

            return self._GetChildBySomething("Name", toks)

   299

        else:

   300

            return self

   301

   302

    def GetChildByIECLocation(self, Location):

   303

        if Location:

   304

            return self._GetChildBySomething("IEC_Channel", Location)

   305

        else:

   306

            return self

   307

   308

    def GetCurrentLocation(self):

   309

        """

   310

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

   311

        """

   312

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

   313

   314

    def GetCurrentName(self):

   315

        """

   316

        @return:  String "ParentParentName.ParentName.Name"

   317

        """

   318

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

   319

   320

    def _GetCurrentName(self):

   321

        """

   322

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

   323

        """

   324

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

   325

   326

    def GetPlugRoot(self):

   327

        return self.PlugParent.GetPlugRoot()

   328

   329

    def GetFullIEC_Channel(self):

   330

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

   331

   332

    def GetLocations(self):

   333

        location = self.GetCurrentLocation()

   334

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

   335

   336

    def GetPlugInfos(self):

   337

        childs = []

   338

        # reorder childs by IEC_channels

   339

        for child in self.IECSortedChilds():

   340

            childs.append(child.GetPlugInfos())

   341

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

   342

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

   343

        else:

   344

            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}

   345

   346

    def FindNewName(self, DesiredName, logger):

   347

        """

   348

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

   349

        @param DesiredName: The desired Name (string)

   350

        """

   351

        # Get Current Name

   352

        CurrentName = self.BaseParams.getName()

   353

        # Do nothing if no change

   354

        #if CurrentName == DesiredName: return CurrentName

   355

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

   356

        AllNames=[]

   357

        for PlugInstance in self.PlugParent.IterChilds():

   358

            if PlugInstance != self:

   359

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

   360

   361

        # Find a free name, eventually appending digit

   362

        res = DesiredName

   363

        suffix = 1

   364

        while res in AllNames:

   365

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

   366

            suffix += 1

   367

   368

        # Get old path

   369

        oldname = self.PlugPath()

   370

        # Check previous plugin existance

   371

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

   372

        # Set the new name

   373

        self.BaseParams.setName(res)

   374

        # Rename plugin dir if exist

   375

        if not dontexist:

   376

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

   377

        # warn user he has two left hands

   378

        if DesiredName != res:

   379

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

   380

        return res

   381

   382

    def FindNewIEC_Channel(self, DesiredChannel, logger):

   383

        """

   384

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

   385

        @param DesiredChannel: The desired IEC channel (int)

   386

        """

   387

        # Get Current IEC channel

   388

        CurrentChannel = self.BaseParams.getIEC_Channel()

   389

        # Do nothing if no change

   390

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   391

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

   392

        AllChannels=[]

   393

        for PlugInstance in self.PlugParent.IterChilds():

   394

            if PlugInstance != self:

   395

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

   396

        AllChannels.sort()

   397

   398

        # Now, try to guess the nearest available channel

   399

        res = DesiredChannel

   400

        while res in AllChannels: # While channel not free

   401

            if res < CurrentChannel: # Want to go down ?

   402

                res -=  1 # Test for n-1

   403

                if res < 0 :

   404

                    if logger :

   405

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

   406

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

   407

            else : # Want to go up ?

   408

                res +=  1 # Test for n-1

   409

        # Finally set IEC Channel

   410

        self.BaseParams.setIEC_Channel(res)

   411

        if logger and DesiredChannel != res:

   412

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

   413

        return res

   414

   415

    def OnPlugClose(self):

   416

        return True

   417

   418

    def _doRemoveChild(self, PlugInstance):

   419

        # Remove all childs of child

   420

        for SubPlugInstance in PlugInstance.IterChilds():

   421

            PlugInstance._doRemoveChild(SubPlugInstance)

   422

        # Call the OnCloseMethod

   423

        PlugInstance.OnPlugClose()

   424

        # Delete plugin dir

   425

        shutil.rmtree(PlugInstance.PlugPath())

   426

        # Remove child of PluggedChilds

   427

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

   428

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

   429

   430

    def PlugRemove(self):

   431

        # Fetch the plugin

   432

        #PlugInstance = self.GetChildByName(PlugName)

   433

        # Ask to his parent to remove it

   434

        self.PlugParent._doRemoveChild(self)

   435

   436

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

   437

        """

   438

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

   439

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

   440

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

   441

        """

   442

        # reorgabize self.PlugChildsTypes tuples from (name, PlugClass, Help)

   443

        # to ( name, (PlugClass, Help)), an make a dict

   444

        transpose = zip(*self.PlugChildsTypes)

   445

        PlugChildsTypes = dict(zip(transpose[0],zip(transpose[1],transpose[2])))

   446

        # Check that adding this plugin is allowed

   447

        try:

   448

            PlugClass, PlugHelp = PlugChildsTypes[PlugType]

   449

        except KeyError:

   450

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

   451

   452

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

   453

        if type(PlugClass) == types.FunctionType:

   454

            PlugClass = PlugClass()

   455

   456

        # Eventualy Initialize child instance list for this class of plugin

   457

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

   458

        # Check count

   459

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

   460

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

   461

   462

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

   463

        class FinalPlugClass(PlugClass, PlugTemplate):

   464

            """

   465

            Plugin class is derivated into FinalPlugClass before being instanciated

   466

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

   467

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

   468

            """

   469

            def __init__(_self):

   470

                # self is the parent

   471

                _self.PlugParent = self

   472

                # Keep track of the plugin type name

   473

                _self.PlugType = PlugType

   474

                # remind the help string, for more fancy display

   475

                _self.PlugHelp = PlugHelp

   476

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

   477

                PlugTemplate.__init__(_self)

   478

                # check name is unique

   479

                NewPlugName = _self.FindNewName(PlugName, logger)

   480

                # If dir have already be made, and file exist

   481

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

   482

                    #Load the plugin.xml file into parameters members

   483

                    _self.LoadXMLParams(logger, NewPlugName)

   484

                    # Basic check. Better to fail immediately.

   485

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

   486

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

   487