X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_ModuleReader.cpp;h=8c4119975c5bc78d1e7bd5e4f8a2acbad72a88b6;hb=dff2e776460fc98e6b234181479ec680a91e9623;hp=d77e6b830fd7ee091cf6d1ab7b5083c768d65de9;hpb=24fd5aa4e000a03e484c5d4c544e5e08b08a747f;p=modules%2Fshaper.git diff --git a/src/Config/Config_ModuleReader.cpp b/src/Config/Config_ModuleReader.cpp index d77e6b830..8c4119975 100644 --- a/src/Config/Config_ModuleReader.cpp +++ b/src/Config/Config_ModuleReader.cpp @@ -1,25 +1,54 @@ -/* - * Config_ModuleReader.cpp - * - * Created on: Mar 20, 2014 - * Author: sbh - */ +// Copyright (C) 2014-2019 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 #include +#include #include #include +#include +#include + +#include +#include -#include -#include +// Have to be included before std headers +#include -#ifdef _DEBUG +//Necessary for cerr #include -#endif +#include +#ifdef WIN32 +#include +#pragma warning(disable : 4996) // for getenv +#else +#include +#endif +std::map Config_ModuleReader::myPluginTypes; +std::set Config_ModuleReader::myDependencyModules; -Config_ModuleReader::Config_ModuleReader() - : Config_XMLReader("plugins.xml"), myIsAutoImport(false) +Config_ModuleReader::Config_ModuleReader(const char* theEventGenerated) + : Config_XMLReader(PLUGIN_FILE), + myEventGenerated(theEventGenerated) { } @@ -27,7 +56,17 @@ Config_ModuleReader::~Config_ModuleReader() { } -/* +const std::map& Config_ModuleReader::featuresInFiles() const +{ + return myFeaturesInFiles; +} + +const std::set& Config_ModuleReader::modulePluginFiles() const +{ + return myPluginFiles; +} + +/*! * Get module name from plugins.xml * (property "module") */ @@ -37,17 +76,45 @@ 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); - if (myIsAutoImport) - importPlugin(aPluginConf, aPluginLibrary); - myPluginsMap[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 aMess(new Config_PluginMessage( + Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID()), aPluginName)); + aMess->setUses(aUsesPlugin); + Events_Loop::loop()->send(aMess); + } + + std::list aFeatures = importPlugin(aPluginName, aPluginConf); + std::list::iterator it = aFeatures.begin(); + for (; it != aFeatures.end(); it++) { + addFeature(*it, aPluginConf); + } } } @@ -56,24 +123,146 @@ bool Config_ModuleReader::processChildren(xmlNodePtr theNode) return isNode(theNode, NODE_PLUGINS, NULL); } -void Config_ModuleReader::importPlugin(const std::string& thePluginName, - const std::string& thePluginLibrary) +bool Config_ModuleReader::hasRequiredModules(xmlNodePtr theNode) const +{ + std::string aRequiredModule = normalize(getProperty(theNode, PLUGIN_DEPENDENCY)); + if(aRequiredModule.empty()) + return true; + std::set::iterator it = myDependencyModules.begin(); + for ( ; it != myDependencyModules.end(); it++ ) { + if (*it == aRequiredModule) return true; + } + return false; +} + +std::list Config_ModuleReader::importPlugin(const std::string& thePluginLibrary, + const std::string& thePluginXmlConf) +{ + if (thePluginXmlConf.empty()) { //probably a third party library + loadLibrary(thePluginLibrary); + return std::list(); + } + + 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; + } + addDependencyModule(aPluginName); + return aPluginName; +} + +void Config_ModuleReader::loadPlugin(const std::string& thePluginName) { - Config_FeatureReader* aReader; - if(thePluginLibrary.empty()) { - aReader = new Config_FeatureReader(thePluginName); - } else { - aReader = new Config_FeatureReader(thePluginName, thePluginLibrary); + // informs model that plugin loading is started + static const Events_ID kEVENT_ID = + Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID()); + std::shared_ptr 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; } - aReader->readAll(); } -void Config_ModuleReader::setAutoImport(bool theEnabled) +void Config_ModuleReader::loadScript(const std::string& theFileName, bool theSendErr) { - myIsAutoImport = theEnabled; + /* 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); } -const std::map& 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 = ::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 + } } + +void Config_ModuleReader::addDependencyModule(const std::string& theModuleName) +{ + myDependencyModules.insert(normalize(theModuleName)); +} +