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

    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 PluginBaseXmlFilePath(self, PlugName=None):

   104

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

   105

   106

    def PluginXmlFilePath(self, PlugName=None):

   107

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

   108

   109

    def PlugPath(self,PlugName=None):

   110

        if not PlugName:

   111

            PlugName = self.BaseParams.getName()

   112

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

   113

   114

    def PlugTestModified(self):

   115

        return self.ChangesToSave

   116

   117

    def ProjectTestModified(self):

   118

        """

   119

        recursively check modified status

   120

        """

   121

        if self.PlugTestModified():

   122

            return True

   123

   124

        for PlugChild in self.IterChilds():

   125

            if PlugChild.ProjectTestModified():

   126

                return True

   127

   128

        return False

   129

   130

    def OnPlugSave(self):

   131

        #Default, do nothing and return success

   132

        return True

   133

   134

    def GetParamsAttributes(self, path = None):

   135

        if path:

   136

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

   137

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

   138

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

   139

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

   140

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

   141

        else:

   142

            params = []

   143

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

   144

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

   145

            if self.PlugParams:

   146

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

   147

            return params

   148

   149

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

   150

        self.ChangesToSave = True

   151

        # Filter IEC_Channel and Name, that have specific behavior

   152

        if path == "BaseParams.IEC_Channel":

   153

            return self.FindNewIEC_Channel(value,logger), True

   154

        elif path == "BaseParams.Name":

   155

            res = self.FindNewName(value,logger)

   156

            self.PlugRequestSave()

   157

            return res, True

   158

   159

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

   160

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

   161

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

   162

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

   163

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

   164

        return value, False

   165

   166

    def PlugRequestSave(self):

   167

        # If plugin do not have corresponding directory

   168

        plugpath = self.PlugPath()

   169

        if not os.path.isdir(plugpath):

   170

            # Create it

   171

            os.mkdir(plugpath)

   172

   173

        # generate XML for base XML parameters controller of the plugin

   174

        if self.MandatoryParams:

   175

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

   176

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

   177

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

   178

            BaseXMLFile.close()

   179

   180

        # generate XML for XML parameters controller of the plugin

   181

        if self.PlugParams:

   182

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

   183

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

   184

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

   185

            XMLFile.close()

   186

   187

        # Call the plugin specific OnPlugSave method

   188

        result = self.OnPlugSave()

   189

        if not result:

   190

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

   191

   192

        # mark plugin as saved

   193

        self.ChangesToSave = False        

   194

        # go through all childs and do the same

   195

        for PlugChild in self.IterChilds():

   196

            result = PlugChild.PlugRequestSave()

   197

            if result:

   198

                return result

   199

        return None

   200

   201

    def PlugImport(self, src_PlugPath):

   202

        shutil.copytree(src_PlugPath, self.PlugPath)

   203

        return True

   204

   205

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

   206

        """

   207

        Generate C code

   208

        @param locations: List of complete variables locations \

   209

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

   210

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

   211

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

   212

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

   213

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

   214

            }, ...]

   215

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

   216

        """

   217

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

   218

        return [],"",False

   219

   220

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

   221

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

   222

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

   223

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

   224

        if PlugCFilesAndCFLAGS:

   225

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

   226

        else:

   227

            LocationCFilesAndCFLAGS = []

   228

   229

        # plugin asks for some LDFLAGS

   230

        if PlugLDFLAGS:

   231

            # LDFLAGS can be either string

   232

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

   233

                LDFLAGS=[PlugLDFLAGS]

   234

            #or list of strings

   235

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

   236

                LDFLAGS=PlugLDFLAGS[:]

   237

        else:

   238

            LDFLAGS=[]

   239

   240

        # recurse through all childs, and stack their results

   241

        for PlugChild in self.IECSortedChilds():

   242

            new_location = PlugChild.GetCurrentLocation()

   243

            # How deep are we in the tree ?

   244

            depth=len(new_location)

   245

            _LocationCFilesAndCFLAGS, _LDFLAGS = \

   246

                PlugChild._Generate_C(

   247

                    #keep the same path

   248

                    buildpath,

   249

                    # filter locations that start with current IEC location

   250

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

   251

                    #propagete logger

   252

                    logger)

   253

            # stack the result

   254

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   255

            LDFLAGS += _LDFLAGS

   256

   257

        return LocationCFilesAndCFLAGS,LDFLAGS

   258

   259

    def BlockTypesFactory(self):

   260

        return []

   261

   262

    def STLibraryFactory(self):

   263

        return ""

   264

   265

    def IterChilds(self):

   266

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

   267

            for PlugInstance in PluggedChilds:

   268

                   yield PlugInstance

   269

   270

    def IECSortedChilds(self):

   271

        # reorder childs by IEC_channels

   272

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

   273

        if ordered:

   274

            ordered.sort()

   275

            return zip(*ordered)[1]

   276

        else:

   277

            return []

   278

   279

    def _GetChildBySomething(self, something, toks):

   280

        for PlugInstance in self.IterChilds():

   281

            # if match component of the name

   282

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

   283

                # if Name have other components

   284

                if len(toks) >= 2:

   285

                    # Recurse in order to find the latest object

   286

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

   287

                # No sub name -> found

   288

                return PlugInstance

   289

        # Not found

   290

        return None

   291

   292

    def GetChildByName(self, Name):

   293

        if Name:

   294

            toks = Name.split('.')

   295

            return self._GetChildBySomething("Name", toks)

   296

        else:

   297

            return self

   298

   299

    def GetChildByIECLocation(self, Location):

   300

        if Location:

   301

            return self._GetChildBySomething("IEC_Channel", Location)

   302

        else:

   303

            return self

   304

   305

    def GetCurrentLocation(self):

   306

        """

   307

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

   308

        """

   309

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

   310

   311

    def GetCurrentName(self):

   312

        """

   313

        @return:  String "ParentParentName.ParentName.Name"

   314

        """

   315

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

   316

   317

    def _GetCurrentName(self):

   318

        """

   319

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

   320

        """

   321

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

   322

   323

    def GetPlugRoot(self):

   324

        return self.PlugParent.GetPlugRoot()

   325

   326

    def GetFullIEC_Channel(self):

   327

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

   328

   329

    def GetLocations(self):

   330

        location = self.GetCurrentLocation()

   331

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

   332

   333

    def GetPlugInfos(self):

   334

        childs = []

   335

        # reorder childs by IEC_channels

   336

        for child in self.IECSortedChilds():

   337

            childs.append(child.GetPlugInfos())

   338

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

   339

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

   340

        else:

   341

            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}

   342

   343

    def FindNewName(self, DesiredName, logger):

   344

        """

   345

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

   346

        @param DesiredName: The desired Name (string)

   347

        """

   348

        # Get Current Name

   349

        CurrentName = self.BaseParams.getName()

   350

        # Do nothing if no change

   351

        #if CurrentName == DesiredName: return CurrentName

   352

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

   353

        AllNames=[]

   354

        for PlugInstance in self.PlugParent.IterChilds():

   355

            if PlugInstance != self:

   356

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

   357

   358

        # Find a free name, eventually appending digit

   359

        res = DesiredName

   360

        suffix = 1

   361

        while res in AllNames:

   362

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

   363

            suffix += 1

   364

   365

        # Get old path

   366

        oldname = self.PlugPath()

   367

        # Check previous plugin existance

   368

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

   369

        # Set the new name

   370

        self.BaseParams.setName(res)

   371

        # Rename plugin dir if exist

   372

        if not dontexist:

   373

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

   374

        # warn user he has two left hands

   375

        if DesiredName != res:

   376

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

   377

        return res

   378

   379

    def FindNewIEC_Channel(self, DesiredChannel, logger):

   380

        """

   381

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

   382

        @param DesiredChannel: The desired IEC channel (int)

   383

        """

   384

        # Get Current IEC channel

   385

        CurrentChannel = self.BaseParams.getIEC_Channel()

   386

        # Do nothing if no change

   387

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   388

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

   389

        AllChannels=[]

   390

        for PlugInstance in self.PlugParent.IterChilds():

   391

            if PlugInstance != self:

   392

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

   393

        AllChannels.sort()

   394

   395

        # Now, try to guess the nearest available channel

   396

        res = DesiredChannel

   397

        while res in AllChannels: # While channel not free

   398

            if res < CurrentChannel: # Want to go down ?

   399

                res -=  1 # Test for n-1

   400

                if res < 0 :

   401

                    if logger :

   402

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

   403

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

   404

            else : # Want to go up ?

   405

                res +=  1 # Test for n-1

   406

        # Finally set IEC Channel

   407

        self.BaseParams.setIEC_Channel(res)

   408

        if logger and DesiredChannel != res:

   409

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

   410

        return res

   411

   412

    def OnPlugClose(self):

   413

        return True

   414

   415

    def _doRemoveChild(self, PlugInstance):

   416

        # Remove all childs of child

   417

        for SubPlugInstance in PlugInstance.IterChilds():

   418

            PlugInstance._doRemoveChild(SubPlugInstance)

   419

        # Call the OnCloseMethod

   420

        PlugInstance.OnPlugClose()

   421

        # Delete plugin dir

   422

        shutil.rmtree(PlugInstance.PlugPath())

   423

        # Remove child of PluggedChilds

   424

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

   425

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

   426

   427

    def PlugRemove(self):

   428

        # Fetch the plugin

   429

        #PlugInstance = self.GetChildByName(PlugName)

   430

        # Ask to his parent to remove it

   431

        self.PlugParent._doRemoveChild(self)

   432

   433

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

   434

        """

   435

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

   436

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

   437

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

   438

        """

   439

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

   440

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

   441

        transpose = zip(*self.PlugChildsTypes)

   442

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

   443

        # Check that adding this plugin is allowed

   444

        try:

   445

            PlugClass, PlugHelp = PlugChildsTypes[PlugType]

   446

        except KeyError:

   447

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

   448

   449

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

   450

        if type(PlugClass) == types.FunctionType:

   451

            PlugClass = PlugClass()

   452

   453

        # Eventualy Initialize child instance list for this class of plugin

   454

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

   455

        # Check count

   456

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

   457

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

   458

   459

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

   460

        class FinalPlugClass(PlugClass, PlugTemplate):

   461

            """

   462

            Plugin class is derivated into FinalPlugClass before being instanciated

   463

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

   464

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

   465

            """

   466

            def __init__(_self):

   467

                # self is the parent

   468

                _self.PlugParent = self

   469

                # Keep track of the plugin type name

   470

                _self.PlugType = PlugType

   471

                # remind the help string, for more fancy display

   472

                _self.PlugHelp = PlugHelp

   473

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

   474

                PlugTemplate.__init__(_self)

   475

                # check name is unique

   476

                NewPlugName = _self.FindNewName(PlugName, logger)

   477

                # If dir have already be made, and file exist

   478

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

   479

                    #Load the plugin.xml file into parameters members

   480

                    _self.LoadXMLParams(logger, NewPlugName)

   481

                    # Basic check. Better to fail immediately.

   482

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

   483

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

   484

   485

                    # Now, self.PlugPath() should be OK

   486

   487

                    # Check that IEC_Channel is not already in use.