1

"""

     2

Base definitions for beremiz plugins

     3

"""

     4

     5

import os,sys,traceback

     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

# helper func to get path to images

    74

def opjimg(imgname):

    75

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

    76

    77

class PlugTemplate:

    78

    """

    79

    This class is the one that define plugins.

    80

    """

    81

    82

    XSD = None

    83

    PlugChildsTypes = []

    84

    PlugMaxCount = None

    85

    PluginMethods = []

    86

    87

    def _AddParamsMembers(self):

    88

        self.PlugParams = None

    89

        if self.XSD:

    90

            Classes = GenerateClassesFromXSDstring(self.XSD)

    91

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

    92

            if len(Classes) == 1:

    93

                name, XSDclass = Classes[0]

    94

                obj = XSDclass()

    95

                self.PlugParams = (name, obj)

    96

                setattr(self, name, obj)

    97

    98

    def __init__(self):

    99

        # Create BaseParam 

   100

        self.BaseParams = _BaseParamsClass()

   101

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

   102

        self._AddParamsMembers()

   103

        self.PluggedChilds = {}

   104

        # copy PluginMethods so that it can be later customized

   105

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

   106

   107

    def PluginBaseXmlFilePath(self, PlugName=None):

   108

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

   109

   110

    def PluginXmlFilePath(self, PlugName=None):

   111

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

   112

   113

    def PlugPath(self,PlugName=None):

   114

        if not PlugName:

   115

            PlugName = self.BaseParams.getName()

   116

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

   117

                            PlugName + NameTypeSeparator + self.PlugType)

   118

   119

    def PlugTestModified(self):

   120

        return self.ChangesToSave

   121

   122

    def ProjectTestModified(self):

   123

        """

   124

        recursively check modified status

   125

        """

   126

        if self.PlugTestModified():

   127

            return True

   128

   129

        for PlugChild in self.IterChilds():

   130

            if PlugChild.ProjectTestModified():

   131

                return True

   132

   133

        return False

   134

   135

    def OnPlugSave(self):

   136

        #Default, do nothing and return success

   137

        return True

   138

   139

    def GetParamsAttributes(self, path = None):

   140

        if path:

   141

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

   142

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

   143

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

   144

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

   145

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

   146

        else:

   147

            params = []

   148

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

   149

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

   150

            if self.PlugParams:

   151

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

   152

            return params

   153

   154

    def SetParamsAttribute(self, path, value):

   155

        self.ChangesToSave = True

   156

        # Filter IEC_Channel and Name, that have specific behavior

   157

        if path == "BaseParams.IEC_Channel":

   158

            return self.FindNewIEC_Channel(value), True

   159

        elif path == "BaseParams.Name":

   160

            res = self.FindNewName(value)

   161

            self.PlugRequestSave()

   162

            return res, True

   163

   164

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

   165

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

   166

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

   167

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

   168

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

   169

        return value, False

   170

   171

    def PlugRequestSave(self):

   172

        # If plugin do not have corresponding directory

   173

        plugpath = self.PlugPath()

   174

        if not os.path.isdir(plugpath):

   175

            # Create it

   176

            os.mkdir(plugpath)

   177

   178

        # generate XML for base XML parameters controller of the plugin

   179

        if self.MandatoryParams:

   180

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

   181

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

   182

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

   183

            BaseXMLFile.close()

   184

   185

        # generate XML for XML parameters controller of the plugin

   186

        if self.PlugParams:

   187

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

   188

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

   189

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

   190

            XMLFile.close()

   191

   192

        # Call the plugin specific OnPlugSave method

   193

        result = self.OnPlugSave()

   194

        if not result:

   195

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

   196

   197

        # mark plugin as saved

   198

        self.ChangesToSave = False        

   199

        # go through all childs and do the same

   200

        for PlugChild in self.IterChilds():

   201

            result = PlugChild.PlugRequestSave()

   202

            if result:

   203

                return result

   204

        return None

   205

   206

    def PlugImport(self, src_PlugPath):

   207

        shutil.copytree(src_PlugPath, self.PlugPath)

   208

        return True

   209

   210

    def PlugGenerate_C(self, buildpath, locations):

   211

        """

   212

        Generate C code

   213

        @param locations: List of complete variables locations \

   214

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

   215

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

   216

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

   217

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

   218

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

   219

            }, ...]

   220

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

   221

        """

   222

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

   223

        return [],"",False

   224

   225

    def _Generate_C(self, buildpath, locations):

   226

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

   227

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

   228

        gen_result = self.PlugGenerate_C(buildpath, locations)

   229

        PlugCFilesAndCFLAGS, PlugLDFLAGS, DoCalls = gen_result[:3]

   230

        extra_files = gen_result[3:]

   231

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

   232

        if PlugCFilesAndCFLAGS:

   233

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

   234

        else:

   235

            LocationCFilesAndCFLAGS = []

   236

   237

        # plugin asks for some LDFLAGS

   238

        if PlugLDFLAGS:

   239

            # LDFLAGS can be either string

   240

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

   241

                LDFLAGS=[PlugLDFLAGS]

   242

            #or list of strings

   243

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

   244

                LDFLAGS=PlugLDFLAGS[:]

   245

        else:

   246

            LDFLAGS=[]

   247

   248

        # recurse through all childs, and stack their results

   249

        for PlugChild in self.IECSortedChilds():

   250

            new_location = PlugChild.GetCurrentLocation()

   251

            # How deep are we in the tree ?

   252

            depth=len(new_location)

   253

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   254

                PlugChild._Generate_C(

   255

                    #keep the same path

   256

                    buildpath,

   257

                    # filter locations that start with current IEC location

   258

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

   259

            # stack the result

   260

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   261

            LDFLAGS += _LDFLAGS

   262

            extra_files += _extra_files

   263

   264

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   265

   266

    def BlockTypesFactory(self):

   267

        return []

   268

   269

    def STLibraryFactory(self):

   270

        return ""

   271

   272

    def IterChilds(self):

   273

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

   274

            for PlugInstance in PluggedChilds:

   275

                   yield PlugInstance

   276

   277

    def IECSortedChilds(self):

   278

        # reorder childs by IEC_channels

   279

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

   280

        if ordered:

   281

            ordered.sort()

   282

            return zip(*ordered)[1]

   283

        else:

   284

            return []

   285

   286

    def _GetChildBySomething(self, something, toks):

   287

        for PlugInstance in self.IterChilds():

   288

            # if match component of the name

   289

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

   290

                # if Name have other components

   291

                if len(toks) >= 2:

   292

                    # Recurse in order to find the latest object

   293

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

   294

                # No sub name -> found

   295

                return PlugInstance

   296

        # Not found

   297

        return None

   298

   299

    def GetChildByName(self, Name):

   300

        if Name:

   301

            toks = Name.split('.')

   302

            return self._GetChildBySomething("Name", toks)

   303

        else:

   304

            return self

   305

   306

    def GetChildByIECLocation(self, Location):

   307

        if Location:

   308

            return self._GetChildBySomething("IEC_Channel", Location)

   309

        else:

   310

            return self

   311

   312

    def GetCurrentLocation(self):

   313

        """

   314

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

   315

        """

   316

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

   317

   318

    def GetCurrentName(self):

   319

        """

   320

        @return:  String "ParentParentName.ParentName.Name"

   321

        """

   322

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

   323

   324

    def _GetCurrentName(self):

   325

        """

   326

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

   327

        """

   328

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

   329

   330

    def GetPlugRoot(self):

   331

        return self.PlugParent.GetPlugRoot()

   332

   333

    def GetFullIEC_Channel(self):

   334

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

   335

   336

    def GetLocations(self):

   337

        location = self.GetCurrentLocation()

   338

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

   339

   340

    def GetPlugInfos(self):

   341

        childs = []

   342

        # reorder childs by IEC_channels

   343

        for child in self.IECSortedChilds():

   344

            childs.append(child.GetPlugInfos())

   345

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

   346

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

   347

        else:

   348

            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}

   349

   350

    def FindNewName(self, DesiredName):

   351

        """

   352

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

   353

        @param DesiredName: The desired Name (string)

   354

        """

   355

        # Get Current Name

   356

        CurrentName = self.BaseParams.getName()

   357

        # Do nothing if no change

   358

        #if CurrentName == DesiredName: return CurrentName

   359

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

   360

        AllNames=[]

   361

        for PlugInstance in self.PlugParent.IterChilds():

   362

            if PlugInstance != self:

   363

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

   364

   365

        # Find a free name, eventually appending digit

   366

        res = DesiredName

   367

        suffix = 1

   368

        while res in AllNames:

   369

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

   370

            suffix += 1

   371

   372

        # Get old path

   373

        oldname = self.PlugPath()

   374

        # Check previous plugin existance

   375

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

   376

        # Set the new name

   377

        self.BaseParams.setName(res)

   378

        # Rename plugin dir if exist

   379

        if not dontexist:

   380

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

   381

        # warn user he has two left hands

   382

        if DesiredName != res:

   383

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

   384

        return res

   385

   386

    def FindNewIEC_Channel(self, DesiredChannel):

   387

        """

   388

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

   389

        @param DesiredChannel: The desired IEC channel (int)

   390

        """

   391

        # Get Current IEC channel

   392

        CurrentChannel = self.BaseParams.getIEC_Channel()

   393

        # Do nothing if no change

   394

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   395

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

   396

        AllChannels=[]

   397

        for PlugInstance in self.PlugParent.IterChilds():

   398

            if PlugInstance != self:

   399

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

   400

        AllChannels.sort()

   401

   402

        # Now, try to guess the nearest available channel

   403

        res = DesiredChannel

   404

        while res in AllChannels: # While channel not free

   405

            if res < CurrentChannel: # Want to go down ?

   406

                res -=  1 # Test for n-1

   407

                if res < 0 :

   408

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

   409

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

   410

            else : # Want to go up ?

   411

                res +=  1 # Test for n-1

   412

        # Finally set IEC Channel

   413

        self.BaseParams.setIEC_Channel(res)

   414

        if DesiredChannel != res:

   415

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

   416

        return res

   417

   418

    def OnPlugClose(self):

   419

        return True

   420

   421

    def _doRemoveChild(self, PlugInstance):

   422

        # Remove all childs of child

   423

        for SubPlugInstance in PlugInstance.IterChilds():

   424

            PlugInstance._doRemoveChild(SubPlugInstance)

   425

        # Call the OnCloseMethod

   426

        PlugInstance.OnPlugClose()

   427

        # Delete plugin dir

   428

        shutil.rmtree(PlugInstance.PlugPath())

   429

        # Remove child of PluggedChilds

   430

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

   431

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

   432

   433

    def PlugRemove(self):

   434

        # Fetch the plugin

   435

        #PlugInstance = self.GetChildByName(PlugName)

   436

        # Ask to his parent to remove it

   437

        self.PlugParent._doRemoveChild(self)

   438

   439

    def PlugAddChild(self, PlugName, PlugType):

   440

        """

   441

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

   442

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

   443

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

   444

        """

   445

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

   446

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

   447

        transpose = zip(*self.PlugChildsTypes)

   448

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

   449

        # Check that adding this plugin is allowed

   450

        try:

   451

            PlugClass, PlugHelp = PlugChildsTypes[PlugType]

   452

        except KeyError:

   453

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

   454

   455

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

   456

        if type(PlugClass) == types.FunctionType:

   457

            PlugClass = PlugClass()

   458

   459

        # Eventualy Initialize child instance list for this class of plugin

   460

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

   461

        # Check count

   462

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

   463

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

   464

   465

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

   466

        class FinalPlugClass(PlugClass, PlugTemplate):

   467

            """

   468

            Plugin class is derivated into FinalPlugClass before being instanciated

   469

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

   470

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

   471

            """

   472

            def __init__(_self):

   473

                # self is the parent

   474

                _self.PlugParent = self

   475

                # self is the parent

   476

                _self.logger = self.logger

   477

                # Keep track of the plugin type name

   478

                _self.PlugType = PlugType

   479

                # remind the help string, for more fancy display

   480

                _self.PlugHelp = PlugHelp

   481

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

   482

                PlugTemplate.__init__(_self)

   483

                # check name is unique

   484

                NewPlugName = _self.FindNewName(PlugName)

   485

                # If dir have already be made, and file exist

   486

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

   487