Salome HOME
Merge branch 'Dev_0.6.1' of newgeom:newgeom into Dev_0.6.1
[modules/shaper.git] / src / Config / Config_ModuleReader.cpp
index d77e6b830fd7ee091cf6d1ab7b5083c768d65de9..d0da80ba0a8f0914a27ea7baa8706096f209f066 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_ModuleReader.cpp
  *
@@ -6,27 +8,52 @@
  */
 
 #include <Config_Keywords.h>
+#include <Config_Common.h>
 #include <Config_ModuleReader.h>
 #include <Config_FeatureReader.h>
+#include <Events_Error.h>
+
+#include <libxml/parser.h>
+#include <libxml/tree.h>
 
-#include <libxml\parser.h>
-#include <libxml\tree.h>
+// Have to be included before std headers
+#include <Python.h>
 
-#ifdef _DEBUG
+//Necessary for cerr
 #include <iostream>
-#endif
+#include <algorithm>
 
+#ifdef WIN32
+#include <windows.h>
+#pragma warning(disable : 4996) // for getenv
+#else
+#include <dlfcn.h>
+#endif
 
+std::map<std::string, Config_ModuleReader::PluginType> Config_ModuleReader::myPluginTypes;
 
-Config_ModuleReader::Config_ModuleReader()
-    : Config_XMLReader("plugins.xml"), myIsAutoImport(false)
+Config_ModuleReader::Config_ModuleReader(const char* theEventGenerated)
+    : Config_XMLReader(PLUGIN_FILE),
+      myEventGenerated(theEventGenerated)
 {
+  myHaveSalome = false;
+  char* anEnv = getenv("SALOME_ROOT_DIR");
+  std::string value = normalize(anEnv);
+  if (!value.empty()) {
+    myHaveSalome = true;
+  }
+
 }
 
 Config_ModuleReader::~Config_ModuleReader()
 {
 }
 
+const std::map<std::string, std::string>& Config_ModuleReader::featuresInFiles() const
+{
+  return myFeaturesInFiles;
+}
+
 /*
  * Get module name from plugins.xml
  * (property "module")
@@ -43,11 +70,19 @@ std::string Config_ModuleReader::getModuleName()
 void Config_ModuleReader::processNode(xmlNodePtr theNode)
 {
   if (isNode(theNode, NODE_PLUGIN, NULL)) {
+    bool isAvailable = isAvaliableOnThisPlatform(getProperty(theNode, PLUGIN_PLATFORM));
+    if (!isAvailable)
+      return;
     std::string aPluginConf = getProperty(theNode, PLUGIN_CONFIG);
     std::string aPluginLibrary = getProperty(theNode, PLUGIN_LIBRARY);
-    if (myIsAutoImport)
-      importPlugin(aPluginConf, aPluginLibrary);
-    myPluginsMap[aPluginLibrary] = aPluginConf;
+    std::string aPluginScript = getProperty(theNode, PLUGIN_SCRIPT);
+    std::string aPluginName = addPlugin(aPluginLibrary, aPluginScript, aPluginConf);
+
+    std::list<std::string> aFeatures = importPlugin(aPluginName, aPluginConf);
+    std::list<std::string>::iterator it = aFeatures.begin();
+    for (; it != aFeatures.end(); it++) {
+      myFeaturesInFiles[*it] = aPluginConf;
+    }
   }
 }
 
@@ -56,24 +91,128 @@ bool Config_ModuleReader::processChildren(xmlNodePtr theNode)
   return isNode(theNode, NODE_PLUGINS, NULL);
 }
 
-void Config_ModuleReader::importPlugin(const std::string& thePluginName,
-                                       const std::string& thePluginLibrary)
+std::list<std::string> Config_ModuleReader::importPlugin(const std::string& thePluginLibrary,
+                                                         const std::string& thePluginXmlConf)
 {
-  Config_FeatureReader* aReader;
-  if(thePluginLibrary.empty()) {
-    aReader = new Config_FeatureReader(thePluginName);
+  if (thePluginXmlConf.empty()) {  //probably a third party library
+    loadLibrary(thePluginLibrary);
+    return std::list<std::string>();
+  }
+
+  Config_FeatureReader aReader = Config_FeatureReader(thePluginXmlConf,
+                                                      thePluginLibrary,
+                                                      myEventGenerated);
+  aReader.readAll();
+  return aReader.features();
+}
+
+std::string Config_ModuleReader::addPlugin(const std::string& aPluginLibrary,
+                                           const std::string& aPluginScript,
+                                           const std::string& aPluginConf)
+{
+  PluginType aType = Config_ModuleReader::Binary;
+  std::string aPluginName;
+  if (!aPluginLibrary.empty()) {
+    aPluginName = aPluginLibrary;
+    if (aPluginConf.empty()) {
+      aType = Config_ModuleReader::Intrenal;
+    }
+  } else if (!aPluginScript.empty()) {
+    aPluginName = aPluginScript;
+    aType = Config_ModuleReader::Python;
+  }
+  if(!aPluginName.empty()) {
+    myPluginTypes[aPluginName] = aType;
+  }
+
+  return aPluginName;
+}
+
+void Config_ModuleReader::loadPlugin(const std::string thePluginName)
+{
+  PluginType aType = Config_ModuleReader::Binary;
+  if(myPluginTypes.find(thePluginName) != myPluginTypes.end()) {
+    aType = myPluginTypes.at(thePluginName);
+  }
+  switch (aType) {
+    case Config_ModuleReader::Python:
+      loadScript(thePluginName);
+      break;
+    case Config_ModuleReader::Binary:
+    case Config_ModuleReader::Intrenal:
+    default:
+      loadLibrary(thePluginName);
+      break;
+  }
+}
+
+bool Config_ModuleReader::isAvaliableOnThisPlatform(const std::string& thePluginPlatform)
+{
+  bool result = true;
+  PluginPlatform aPlatform = All;
+  std::string aPlatformName = normalize(thePluginPlatform) ;
+  if (aPlatformName == PLUGIN_PLATFORM_SALOME) {
+    aPlatform = Salome;
+  } else if (aPlatformName == PLUGIN_PLATFORM_NEWGEOM) {
+    aPlatform = OpenParts;
+  } else if (!thePluginPlatform.empty()) {
+    Events_Error::send("Unknown platform: " + thePluginPlatform);
+  }
+  if (aPlatform == All) {
+    result = true;
+  } else if (myHaveSalome) {
+    result = aPlatform == Salome;
   } else {
-    aReader = new Config_FeatureReader(thePluginName, thePluginLibrary);
+    result = aPlatform == OpenParts;
   }
-  aReader->readAll();
+  return result;
+
 }
 
-void Config_ModuleReader::setAutoImport(bool theEnabled)
+void Config_ModuleReader::loadScript(const std::string theFileName)
 {
-  myIsAutoImport = theEnabled;
+  /* aquire python thread */
+  PyGILState_STATE gstate = PyGILState_Ensure();
+  PyObject* module = PyImport_ImportModule(theFileName.c_str());
+
+  if (!module) {
+    std::string anErrorMsg = "An error occured while importing " + theFileName;
+    //Get detailed error message:
+    if (PyErr_Occurred()) {
+      PyObject *ptype, *pvalue, *ptraceback;
+      PyErr_Fetch(&ptype, &pvalue, &ptraceback);
+      std::string aPyError = std::string(PyString_AsString(pvalue));
+      if (!aPyError.empty()) {
+        anErrorMsg += ":\n" + aPyError;
+      }
+      Py_XDECREF(ptype);
+      Py_XDECREF(pvalue);
+      Py_XDECREF(ptraceback);
+    }
+    Events_Error::send(anErrorMsg);
+  }
+
+  /* release python thread */
+  PyGILState_Release(gstate);
 }
 
-const std::map<std::string, std::string>& Config_ModuleReader::plugins() const
+void Config_ModuleReader::loadLibrary(const std::string theLibName)
 {
-  return myPluginsMap;
+  std::string aFileName = library(theLibName);
+  if (aFileName.empty())
+    return;
+
+#ifdef WIN32
+  HINSTANCE aModLib = ::LoadLibrary(aFileName.c_str());
+#else
+  void* aModLib = dlopen( aFileName.c_str(), RTLD_LAZY | RTLD_GLOBAL );
+#endif
+  if(!aModLib && theLibName != "DFBrowser") { // don't show error for internal debugging tool
+    std::string anErrorMsg = "Failed to load " + aFileName;
+    #ifndef WIN32
+    anErrorMsg += ": " + std::string(dlerror());
+    #endif
+    Events_Error::send(anErrorMsg);
+  }
 }
+