X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_ModuleReader.cpp;h=2720bc308c9f010c2e5466281828a336991fb618;hb=f51f8ab55887ac6eff49fb9937a460abe1956517;hp=0291b83b4db3039eb1fe97a22d37c8153e66bb6f;hpb=58ff265b6b8337f8abc841ed78923a19c0565c66;p=modules%2Fshaper.git

diff --git a/src/Config/Config_ModuleReader.cpp b/src/Config/Config_ModuleReader.cpp
index 0291b83b4..2720bc308 100644
--- a/src/Config/Config_ModuleReader.cpp
+++ b/src/Config/Config_ModuleReader.cpp
@@ -1,30 +1,54 @@
-/*
- * Config_ModuleReader.cpp
- *
- *  Created on: Mar 20, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2020  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+#include <pyconfig.h>
 
 #include <Config_Keywords.h>
 #include <Config_Common.h>
 #include <Config_ModuleReader.h>
 #include <Config_FeatureReader.h>
-#include <Events_Error.h>
+#include <Config_PluginMessage.h>
+#include <Events_InfoMessage.h>
 
 #include <libxml/parser.h>
 #include <libxml/tree.h>
 
+// Have to be included before std headers
+#include <Python.h>
+
 //Necessary for cerr
 #include <iostream>
+#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;
+std::set<std::string> Config_ModuleReader::myDependencyModules;
+
 Config_ModuleReader::Config_ModuleReader(const char* theEventGenerated)
-    : Config_XMLReader("plugins.xml"), myEventGenerated(theEventGenerated)
+    : Config_XMLReader(PLUGIN_FILE),
+      myEventGenerated(theEventGenerated)
 {
 }
 
@@ -37,7 +61,12 @@ const std::map<std::string, std::string>& Config_ModuleReader::featuresInFiles()
   return myFeaturesInFiles;
 }
 
-/*
+const std::set<std::string>& Config_ModuleReader::modulePluginFiles() const
+{
+  return myPluginFiles;
+}
+
+/*!
  * Get module name from plugins.xml
  * (property "module")
  */
@@ -47,18 +76,44 @@ std::string Config_ModuleReader::getModuleName()
   return getProperty(aRoot, PLUGINS_MODULE);
 }
 
-/*
- *
- */
+
+void Config_ModuleReader::addFeature(const std::string& theFeatureName,
+                                     const std::string& thePluginConfig)
+{
+  if (myFeaturesInFiles.count(theFeatureName)) {
+    std::string anErrorMsg = "Can not register feature '%1' in plugin '%2'."
+      " There is a feature with the same ID.";
+    Events_InfoMessage("Config_ModuleReader", anErrorMsg)
+      .arg(theFeatureName).arg(thePluginConfig).send();
+    return;
+  }
+
+  myFeaturesInFiles[theFeatureName] = thePluginConfig;
+}
+
 void Config_ModuleReader::processNode(xmlNodePtr theNode)
 {
   if (isNode(theNode, NODE_PLUGIN, NULL)) {
+    if (!hasRequiredModules(theNode))
+      return;
     std::string aPluginConf = getProperty(theNode, PLUGIN_CONFIG);
+    if (!aPluginConf.empty())
+      myPluginFiles.insert(aPluginConf);
     std::string aPluginLibrary = getProperty(theNode, PLUGIN_LIBRARY);
-    std::list<std::string> aFeatures = importPlugin(aPluginLibrary, aPluginConf);
+    std::string aPluginScript = getProperty(theNode, PLUGIN_SCRIPT);
+    std::string aPluginName = addPlugin(aPluginLibrary, aPluginScript, aPluginConf);
+    std::string aUsesPlugin = getProperty(theNode, PLUGIN_USES);
+    if (!aUsesPlugin.empty()) { // send information about the plugin dependencies
+      std::shared_ptr<Config_PluginMessage> aMess(new Config_PluginMessage(
+        Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID()), aPluginName));
+      aMess->setUses(aUsesPlugin);
+      Events_Loop::loop()->send(aMess);
+    }
+
+    std::list<std::string> aFeatures = importPlugin(aPluginName, aPluginConf);
     std::list<std::string>::iterator it = aFeatures.begin();
-    for(; it != aFeatures.end(); it++) {
-      myFeaturesInFiles[*it] = aPluginConf;
+    for (; it != aFeatures.end(); it++) {
+      addFeature(*it, aPluginConf);
     }
   }
 }
@@ -68,41 +123,146 @@ bool Config_ModuleReader::processChildren(xmlNodePtr theNode)
   return isNode(theNode, NODE_PLUGINS, NULL);
 }
 
+bool Config_ModuleReader::hasRequiredModules(xmlNodePtr theNode) const
+{
+  std::string aRequiredModule = normalize(getProperty(theNode, PLUGIN_DEPENDENCY));
+  if(aRequiredModule.empty())
+    return true;
+  std::set<std::string>::iterator it = myDependencyModules.begin();
+  for ( ; it != myDependencyModules.end(); it++ ) {
+    if (*it == aRequiredModule) return true;
+  }
+  return false;
+}
+
 std::list<std::string> Config_ModuleReader::importPlugin(const std::string& thePluginLibrary,
-                                                         const std::string& thePluginFile)
+                                                         const std::string& thePluginXmlConf)
 {
-  if (thePluginFile.empty()) { //probably a third party library
+  if (thePluginXmlConf.empty()) {  //probably a third party library
     loadLibrary(thePluginLibrary);
     return std::list<std::string>();
   }
 
-  Config_FeatureReader aReader = Config_FeatureReader(thePluginFile, thePluginLibrary,
+  Config_FeatureReader aReader = Config_FeatureReader(thePluginXmlConf,
+                                                      thePluginLibrary,
                                                       myEventGenerated);
   aReader.readAll();
   return aReader.features();
 }
 
-void Config_ModuleReader::loadLibrary(const std::string theLibName)
+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;
+  }
+  addDependencyModule(aPluginName);
+  return aPluginName;
+}
+
+void Config_ModuleReader::loadPlugin(const std::string& thePluginName)
+{
+  // informs model that plugin loading is started
+  static const Events_ID kEVENT_ID =
+    Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID());
+  std::shared_ptr<Config_PluginMessage> aMess(new Config_PluginMessage(kEVENT_ID, thePluginName));
+  Events_Loop::loop()->send(aMess);
+
+  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;
+  }
+}
+
+void Config_ModuleReader::loadScript(const std::string& theFileName, bool theSendErr)
+{
+  /* acquire python thread */
+  PyGILState_STATE gstate = PyGILState_Ensure();
+
+  PyObject* module = PyImport_ImportModule(theFileName.c_str());
+  if (!module) {
+    std::string anErrorMsg = "An error occurred while importing " + theFileName;
+    //Get detailed error message:
+    if (PyErr_Occurred()) {
+      PyObject *pstr, *ptype, *pvalue, *ptraceback;
+      PyErr_Fetch(&ptype, &pvalue, &ptraceback);
+      PyErr_NormalizeException(&ptype, &pvalue, &ptraceback);
+      pstr = PyObject_Str(pvalue);
+      std::string aPyError = std::string(PyUnicode_AsUTF8(pstr));
+      if (!aPyError.empty()) {
+        anErrorMsg += ":\n" + aPyError;
+      }
+      Py_XDECREF(pstr);
+      Py_XDECREF(ptype);
+      Py_XDECREF(pvalue);
+      Py_XDECREF(ptraceback);
+    }
+    if (theSendErr)
+      Events_InfoMessage("Config_ModuleReader", anErrorMsg).send();
+  }
+
+  /* release python thread */
+  PyGILState_Release(gstate);
+}
+
+void Config_ModuleReader::loadLibrary(const std::string& theLibName)
 {
-#ifdef _DEBUG
-  std::cout << "Config_ModuleReader::loading library... "  << theLibName.c_str() << std::endl;
-#endif
   std::string aFileName = library(theLibName);
   if (aFileName.empty())
     return;
 
-#ifdef WIN32
-  HINSTANCE aModLib = ::LoadLibrary(aFileName.c_str());
-  if (!aModLib) {
-    std::string errorMsg = "Failed to load " + aFileName;
-    std::cerr << errorMsg << std::endl;
-    Events_Error::send(errorMsg);
+  #ifdef WIN32
+  HINSTANCE aModLib = ::LoadLibraryA(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
+// LCOV_EXCL_START
+    std::string anErrorMsg = "Failed to load " + aFileName;
+    #ifdef WIN32
+    DWORD   dwLastError = ::GetLastError();
+    LPSTR messageBuffer = NULL;
+    size_t size = ::FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER |
+                                   FORMAT_MESSAGE_FROM_SYSTEM |
+                                   FORMAT_MESSAGE_IGNORE_INSERTS,
+                                   NULL,
+                                   dwLastError,
+                                   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
+                                   (LPSTR)&messageBuffer, 0, NULL);
+    anErrorMsg += ": " +  std::string(messageBuffer, size);
+    #else
+    anErrorMsg += ": " + std::string(dlerror());
+    #endif
+    std::cerr << anErrorMsg << std::endl;
+    Events_InfoMessage("Config_ModuleReader", anErrorMsg).send();
+// LCOV_EXCL_STOP
   }
-#else
-  void* aModLib = dlopen( aFileName.c_str(), RTLD_LAZY );
-  if ( !aModLib ) {
-    std::cerr << "Failed to load " << aFileName.c_str() << std::endl;
-  }
-#endif
+}
+
+void Config_ModuleReader::addDependencyModule(const std::string& theModuleName)
+{
+  myDependencyModules.insert(normalize(theModuleName));
 }