etisserant@14: """ etisserant@14: Base definitions for beremiz plugins etisserant@14: """ etisserant@14: etisserant@13: import os etisserant@14: import types etisserant@14: import shutil etisserant@14: from xml.dom import minidom etisserant@13: import plugins etisserant@14: from xmlclass import GenerateClassesFromXSDstring etisserant@14: etisserant@14: _BaseParamsClass = GenerateClassesFromXSDstring(""" etisserant@14: etisserant@14: etisserant@14: etisserant@14: etisserant@14: etisserant@14: etisserant@14: etisserant@14: etisserant@14: """)[0]["BaseParams"] etisserant@14: etisserant@14: NameTypeSeparator = '@' etisserant@14: etisserant@14: class PlugTemplate: etisserant@14: """ etisserant@14: This class is the one that define plugins. etisserant@14: """ etisserant@14: etisserant@14: XSD = None etisserant@14: PlugChildsTypes = [] etisserant@14: PlugMaxCount = None etisserant@14: PluginMethods = [] etisserant@14: etisserant@14: def _AddParamsMembers(self): etisserant@14: Classes = GenerateClassesFromXSDstring(self.XSD)[0] etisserant@14: self.PlugParams = [] etisserant@14: for name, XSDclass in Classes.items(): etisserant@14: if XSDclass.IsBaseClass: etisserant@14: obj = XSDclass() etisserant@14: self.PlugParams.append( (name, obj) ) etisserant@14: setattr(self, name, obj) etisserant@14: etisserant@14: def __init__(self, PlugPath): etisserant@14: # Create BaseParam etisserant@14: self.BaseParams = _BaseParamsClass() etisserant@14: self.MandatoryParams = [("BaseParams", self.BaseParams)] etisserant@14: self._AddParamsMembers() etisserant@14: self.PluggedChilds = {} etisserant@14: etisserant@14: def PluginXmlFilePath(self, PlugName=None): etisserant@14: return os.path.join(self.PlugPath(PlugName), "plugin.xml") etisserant@14: etisserant@14: def PlugPath(self,PlugName=None): etisserant@14: if not PlugName: etisserant@14: PlugName = self.BaseParams.getName() etisserant@14: return os.path.join(self.PlugParent.PlugPath(), PlugName + NameTypeSeparator + self.PlugType) etisserant@14: etisserant@14: def PlugTestModified(self): etisserant@14: return False etisserant@14: etisserant@14: def OnPlugSave(self): etisserant@14: return True etisserant@14: etisserant@14: def PlugRequestSave(self): etisserant@14: # If plugin do not have corresponding directory etisserant@14: if not os.path.isdir(self.PlugPath(PlugName)): etisserant@14: # Create it etisserant@14: os.mkdir(self.PlugPath(PlugName)) etisserant@14: etisserant@14: # generate XML for all XML parameters controllers of the plugin etisserant@14: XMLString = '' etisserant@14: for nodeName, XMLController in self.PlugParams + self.MandatoryParams: etisserant@14: XMLString += XMLController.generateXMLTextMethod(self, nodeName, 0) etisserant@14: XMLFile = open(self.PluginXmlFilePath(PlugName),'w') etisserant@14: XMLFile.write(XMLString) etisserant@14: XMLFile.close() etisserant@14: etisserant@14: # Call the plugin specific OnPlugSave method etisserant@14: self.OnPlugSave() etisserant@14: etisserant@14: # go through all childs and do the same etisserant@14: for PlugChild in self.IterChilds(): etisserant@14: PlugChild.PlugRequestSave() etisserant@14: etisserant@14: def PlugImport(self, src_PlugPath): etisserant@14: shutil.copytree(src_PlugPath, self.PlugPath) etisserant@14: return True etisserant@14: etisserant@14: def PlugGenerate_C(self, buildpath, current_location, locations): etisserant@14: """ etisserant@14: Generate C code etisserant@14: @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5) etisserant@14: @param locations: List of complete variables locations \ etisserant@14: [(IEC_loc, IEC_Direction IEC_Type, Name)]\ etisserant@16: ex: [((0,0,4,5),'I','STRING','__IX_0_0_4_5'),...] etisserant@14: """ etisserant@14: return [],"" etisserant@14: etisserant@14: def _Generate_C(self, buildpath, current_location, locations): etisserant@14: # Generate plugins [(Cfiles, CFLAGS)], LDFLAGS etisserant@16: PlugCFilesAndCFLAGS, PlugLDFLAGS = self.PlugGenerate_C(buildpath, current_location, locations) etisserant@14: # recurse through all childs, and stack their results etisserant@14: for PlugChild in self.IterChilds(): etisserant@16: # Compute chile IEC location etisserant@16: new_location = current_location + (self.BaseParams.getIEC_Channel()) etisserant@14: # Get childs [(Cfiles, CFLAGS)], LDFLAGS etisserant@14: CFilesAndCFLAGS, LDFLAGS = \ etisserant@14: PlugChild._Generate_C( etisserant@14: #keep the same path etisserant@14: buildpath, etisserant@14: # but update location (add curent IEC channel at the end) etisserant@16: new_location, etisserant@14: # filter locations that start with current IEC location etisserant@16: [ (l,d,t,n) for l,d,t,n in locations if l[0:len(new_location)] == new_location ]) etisserant@14: # stack the result etisserant@14: PlugCFilesAndCFLAGS += CFilesAndCFLAGS etisserant@14: PlugLDFLAGS += LDFLAGS etisserant@14: etisserant@14: return PlugCFilesAndCFLAGS,PlugLDFLAGS etisserant@14: etisserant@14: def BlockTypesFactory(self): etisserant@14: return [] etisserant@14: etisserant@14: def STLibraryFactory(self): etisserant@14: return "" etisserant@14: etisserant@14: def IterChilds(self): etisserant@14: for PlugType, PluggedChilds in self.PluggedChilds.items(): etisserant@14: for PlugInstance in PluggedChilds: etisserant@14: yield PlugInstance etisserant@14: etisserant@14: def _GetChildBySomething(self, sep, something, matching): etisserant@14: toks = matching.split(sep,1) etisserant@14: for PlugInstance in self.IterChilds: etisserant@14: # if match component of the name etisserant@14: if getattr(PlugInstance.BaseParams, something) == toks[0]: etisserant@14: # if Name have other components etisserant@14: if len(toks) == 2: etisserant@14: # Recurse in order to find the latest object etisserant@14: return PlugInstance._GetChildBySomething( sep, something, toks[1]) etisserant@14: # No sub name -> found etisserant@14: return PlugInstance etisserant@14: # Not found etisserant@14: return None etisserant@14: etisserant@14: def GetChildByName(self, Name): etisserant@14: return self._GetChildBySomething('.',"Name", Name) etisserant@14: etisserant@14: def GetChildByIECLocation(self, Location): etisserant@14: return self._GetChildBySomething('_',"IEC_Channel", Name) etisserant@14: etisserant@14: def FindNewIEC_Channel(self, DesiredChannel): etisserant@14: """ etisserant@14: Changes IEC Channel number to DesiredChannel if available, nearest available if not. etisserant@14: @param DesiredChannel: The desired IEC channel (int) etisserant@14: """ etisserant@14: # Get Current IEC channel etisserant@14: CurrentChannel = self.BaseParams.getIEC_Channel() etisserant@14: # Do nothing if no change etisserant@14: if CurrentChannel == DesiredChannel: return CurrentChannel etisserant@14: # Build a list of used Channels out of parent's PluggedChilds etisserant@14: AllChannels=[] etisserant@14: for PlugInstance in self.PlugParent.IterChilds(): etisserant@14: if PlugInstance != self: etisserant@14: AllChannels.append(PlugInstance.BaseParams.getIEC_Channel()) etisserant@14: AllChannels.sort() etisserant@14: etisserant@14: # Now, try to guess the nearest available channel etisserant@14: res = DesiredChannel etisserant@14: while res in AllChannels: # While channel not free etisserant@14: if res < CurrentChannel: # Want to go down ? etisserant@14: res -= 1 # Test for n-1 etisserant@14: if res < 0 : return CurrentChannel # Can't go bellow 0, do nothing etisserant@14: else : # Want to go up ? etisserant@14: res += 1 # Test for n-1 etisserant@14: # Finally set IEC Channel etisserant@14: self.BaseParams.setIEC_Channel(res) etisserant@14: return res etisserant@14: etisserant@14: def OnPlugClose(self): etisserant@14: return True etisserant@14: etisserant@14: def _doRemoveChild(self, PlugInstance): etisserant@14: # Remove all childs of child etisserant@14: for SubPlugInstance in PlugInstance.IterChilds(): etisserant@14: PlugInstance._doRemoveChild(SubPlugInstance) etisserant@14: # Call the OnCloseMethod etisserant@14: PlugInstance.OnPlugClose() etisserant@14: # Delete plugin dir etisserant@14: shutil.rmtree(PlugInstance.PlugPath()) etisserant@14: # Remove child of PluggedChilds etisserant@14: self.PluggedChilds[PlugInstance.PlugType].remove(PlugInstance) etisserant@14: # Forget it... (View have to refresh) etisserant@14: etisserant@14: def PlugRemoveChild(self, PlugName): etisserant@14: # Fetch the plugin etisserant@14: PlugInstance = self.GetChildByName(PlugName) etisserant@14: # Ask to his parent to remove it etisserant@14: PlugInstance.PlugParent._doRemoveChild(PlugInstance) etisserant@14: etisserant@14: def PlugAddChild(self, PlugName, PlugType): etisserant@14: """ etisserant@14: Create the plugins that may be added as child to this node self etisserant@14: @param PlugType: string desining the plugin class name (get name from PlugChildsTypes) etisserant@14: @param PlugName: string for the name of the plugin instance etisserant@14: """ etisserant@14: PlugChildsTypes = dict(self.PlugChildsTypes) etisserant@14: # Check that adding this plugin is allowed etisserant@14: try: etisserant@14: PlugClass = PlugChildsTypes[PlugType] etisserant@14: except KeyError: etisserant@14: raise Exception, "Cannot create child %s of type %s "%(PlugName, PlugType) etisserant@14: etisserant@14: # if PlugClass is a class factory, call it. (prevent unneeded imports) etisserant@14: if type(PlugClass) == types.FunctionType: etisserant@14: PlugClass = PlugClass() etisserant@14: etisserant@14: # Eventualy Initialize child instance list for this class of plugin etisserant@14: PluggedChildsWithSameClass = self.PluggedChilds.setdefault(PlugType,list()) etisserant@14: # Check count etisserant@14: if PlugClass.MaxCount and len(PluggedChildsWithSameClass) >= PlugClass.MaxCount: etisserant@14: raise Exception, "Max count (%d) reached for this plugin of type %s "%(PlugClass.MaxCount, PlugType) etisserant@14: etisserant@14: # create the final class, derived of provided plugin and template etisserant@14: class FinalPlugClass(PlugClass, PlugTemplate): etisserant@14: """ etisserant@14: Plugin class is derivated into FinalPlugClass before being instanciated etisserant@14: This way __init__ is overloaded to ensure PlugTemplate.__init__ is called etisserant@14: before PlugClass.__init__, and to do the file related stuff. etisserant@14: """ etisserant@14: def __init__(_self): etisserant@14: # self is the parent etisserant@14: _self.PlugParent = self etisserant@14: # Keep track of the plugin type name etisserant@14: _self.PlugType = PlugType etisserant@14: # Call the base plugin template init - change XSD into class members etisserant@14: PlugTemplate.__init__(_self) etisserant@14: # If dir have already be made, and file exist etisserant@14: if os.path.isdir(_self.PlugPath(PlugName)) and os.path.isfile(_self.PluginXmlFilePath(PlugName)): etisserant@14: #Load the plugin.xml file into parameters members etisserant@14: _self.LoadXMLParams() etisserant@15: # Check that IEC_Channel is not already in use. etisserant@15: self.FindNewIEC_Channel(self.BaseParams.getIEC_Channel()) etisserant@14: # Call the plugin real __init__ etisserant@14: PlugClass.__init__(_self) etisserant@14: #Load and init all the childs etisserant@14: _self.LoadChilds() etisserant@14: else: etisserant@14: # If plugin do not have corresponding file/dirs - they will be created on Save etisserant@14: # Set plugin name etisserant@14: _self.BaseParams.setName(PlugName) etisserant@14: # Find an IEC number etisserant@14: _self.FindNewIEC_Channel(0) etisserant@14: # Call the plugin real __init__ etisserant@14: PlugClass.__init__(_self) etisserant@14: etisserant@14: # Create the object out of the resulting class etisserant@14: newPluginOpj = FinalPlugClass() etisserant@14: # Store it in PluggedChils etisserant@14: PluggedChildsWithSameClass.append(newPluginOpj) etisserant@14: etisserant@14: return newPluginOpj etisserant@14: etisserant@14: etisserant@14: def LoadXMLParams(self): etisserant@14: # PlugParams have been filled, make a local dict to work with etisserant@14: PlugParams = dict(self.PlugParams + self.MandatoryParams) etisserant@14: # Get the xml tree etisserant@14: xmlfile = open(self.PluginXmlFilePath(PlugName), 'r') etisserant@14: tree = minidom.parse(xmlfile) etisserant@14: xmlfile.close() etisserant@14: # for each root elements etisserant@14: for subtree in tree.childNodes: etisserant@14: # if a plugin specific parameter set etisserant@14: if subtree.nodeName in PlugParams: etisserant@14: #Load into associated xmlclass. etisserant@14: PlugParams[subtree.nodeName].loadXMLTree(subtree) etisserant@14: etisserant@14: # Basic check. Better to fail immediately. etisserant@14: if(self.BaseParams.getName() != PlugName): etisserant@14: raise Exception, "Project tree layout do not match plugin.xml %s!=%s "%(PlugName,self.BaseParams.getName()) etisserant@14: # Now, self.PlugPath() should be OK etisserant@14: etisserant@14: def LoadChilds(self): etisserant@14: # Iterate over all PlugName@PlugType in plugin directory, and try to open them etisserant@14: for PlugDir in os.listdir(self.PlugPath()): etisserant@14: if os.path.isdir(os.path.join(self.PlugPath(),PlugDir)) and \ etisserant@14: PlugDir.count(NameTypeSeparator) == 1: etisserant@14: try: etisserant@14: self.PlugAddChild(*PlugDir.split[NameTypeSeparator]) etisserant@14: except Exception, e: etisserant@14: print e etisserant@13: etisserant@13: class PluginsRoot(PlugTemplate): etisserant@13: etisserant@14: # For root object, available Childs Types are modules of the plugin packages. etisserant@13: PlugChildsTypes = [(name,lambda : getattr(__import__("plugins." + name), name).RootClass) for name in plugins.__all__] etisserant@13: etisserant@13: XSD = """ etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@14: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@14: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: etisserant@13: """ etisserant@13: etisserant@13: def __init__(self, ProjectPath): etisserant@13: # self is the parent etisserant@13: self.PlugParent = None etisserant@13: # Keep track of the plugin type name etisserant@13: self.PlugType = "Beremiz" etisserant@13: # Keep track of the root plugin (i.e. project path) etisserant@13: self.ProjectPath = ProjectPath etisserant@13: # Change XSD into class members etisserant@13: self._AddParamsMembers() etisserant@13: self.PluggedChilds = {} etisserant@13: # No IEC channel, name, etc... etisserant@13: self.MandatoryParams = [] etisserant@13: # If dir have already be made, and file exist etisserant@13: if os.path.isdir(_self.PlugPath(PlugName)) and os.path.isfile(_self.PluginXmlFilePath(PlugName)): etisserant@13: #Load the plugin.xml file into parameters members etisserant@13: _self.LoadXMLParams() etisserant@13: #Load and init all the childs etisserant@13: _self.LoadChilds() etisserant@13: etisserant@13: def PlugPath(self,PlugName=None): etisserant@13: return self.ProjectPath etisserant@13: etisserant@13: def PluginXmlFilePath(self, PlugName=None): etisserant@13: return os.path.join(self.PlugPath(PlugName), "beremiz.xml") etisserant@16: etisserant@16: