1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #include <Config_Keywords.h>
23 #include <Config_Common.h>
24 #include <Config_ModuleReader.h>
25 #include <Config_FeatureReader.h>
26 #include <Config_PluginMessage.h>
27 #include <Events_InfoMessage.h>
29 #include <libxml/parser.h>
30 #include <libxml/tree.h>
32 // Have to be included before std headers
41 #pragma warning(disable : 4996) // for getenv
46 std::map<std::string, Config_ModuleReader::PluginType> Config_ModuleReader::myPluginTypes;
47 std::set<std::string> Config_ModuleReader::myDependencyModules;
49 Config_ModuleReader::Config_ModuleReader(const char* theEventGenerated)
50 : Config_XMLReader(PLUGIN_FILE),
51 myEventGenerated(theEventGenerated)
55 Config_ModuleReader::~Config_ModuleReader()
59 const std::map<std::string, std::string>& Config_ModuleReader::featuresInFiles() const
61 return myFeaturesInFiles;
64 const std::set<std::string>& Config_ModuleReader::modulePluginFiles() const
70 * Get module name from plugins.xml
73 std::string Config_ModuleReader::getModuleName()
75 xmlNodePtr aRoot = findRoot();
76 return getProperty(aRoot, PLUGINS_MODULE);
80 void Config_ModuleReader::addFeature(const std::string& theFeatureName,
81 const std::string& thePluginConfig)
83 if (myFeaturesInFiles.count(theFeatureName)) {
84 std::string anErrorMsg = "Can not register feature '%1' in plugin '%2'."
85 " There is a feature with the same ID.";
86 Events_InfoMessage("Config_ModuleReader", anErrorMsg)
87 .arg(theFeatureName).arg(thePluginConfig).send();
91 myFeaturesInFiles[theFeatureName] = thePluginConfig;
94 void Config_ModuleReader::processNode(xmlNodePtr theNode)
96 if (isNode(theNode, NODE_PLUGIN, NULL)) {
97 if (!hasRequiredModules(theNode))
99 std::string aPluginConf = getProperty(theNode, PLUGIN_CONFIG);
100 if (!aPluginConf.empty())
101 myPluginFiles.insert(aPluginConf);
102 std::string aPluginLibrary = getProperty(theNode, PLUGIN_LIBRARY);
103 std::string aPluginScript = getProperty(theNode, PLUGIN_SCRIPT);
104 std::string aPluginName = addPlugin(aPluginLibrary, aPluginScript, aPluginConf);
105 std::string aUsesPlugin = getProperty(theNode, PLUGIN_USES);
106 if (!aUsesPlugin.empty()) { // send information about the plugin dependencies
107 std::shared_ptr<Config_PluginMessage> aMess(new Config_PluginMessage(
108 Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID()), aPluginName));
109 aMess->setUses(aUsesPlugin);
110 Events_Loop::loop()->send(aMess);
113 std::list<std::string> aFeatures = importPlugin(aPluginName, aPluginConf);
114 std::list<std::string>::iterator it = aFeatures.begin();
115 for (; it != aFeatures.end(); it++) {
116 addFeature(*it, aPluginConf);
121 bool Config_ModuleReader::processChildren(xmlNodePtr theNode)
123 return isNode(theNode, NODE_PLUGINS, NULL);
126 bool Config_ModuleReader::hasRequiredModules(xmlNodePtr theNode) const
128 std::string aRequiredModule = normalize(getProperty(theNode, PLUGIN_DEPENDENCY));
129 if(aRequiredModule.empty())
131 std::set<std::string>::iterator it = myDependencyModules.begin();
132 for ( ; it != myDependencyModules.end(); it++ ) {
133 if (*it == aRequiredModule) return true;
138 std::list<std::string> Config_ModuleReader::importPlugin(const std::string& thePluginLibrary,
139 const std::string& thePluginXmlConf)
141 if (thePluginXmlConf.empty()) { //probably a third party library
142 loadLibrary(thePluginLibrary);
143 return std::list<std::string>();
146 Config_FeatureReader aReader = Config_FeatureReader(thePluginXmlConf,
150 return aReader.features();
153 std::string Config_ModuleReader::addPlugin(const std::string& aPluginLibrary,
154 const std::string& aPluginScript,
155 const std::string& aPluginConf)
157 PluginType aType = Config_ModuleReader::Binary;
158 std::string aPluginName;
159 if (!aPluginLibrary.empty()) {
160 aPluginName = aPluginLibrary;
161 if (aPluginConf.empty()) {
162 aType = Config_ModuleReader::Intrenal;
164 } else if (!aPluginScript.empty()) {
165 aPluginName = aPluginScript;
166 aType = Config_ModuleReader::Python;
168 if(!aPluginName.empty()) {
169 myPluginTypes[aPluginName] = aType;
171 addDependencyModule(aPluginName);
175 void Config_ModuleReader::loadPlugin(const std::string& thePluginName)
177 // informs model that plugin loading is started
178 static const Events_ID kEVENT_ID =
179 Events_Loop::loop()->eventByName(Config_PluginMessage::EVENT_ID());
180 std::shared_ptr<Config_PluginMessage> aMess(new Config_PluginMessage(kEVENT_ID, thePluginName));
181 Events_Loop::loop()->send(aMess);
183 PluginType aType = Config_ModuleReader::Binary;
184 if(myPluginTypes.find(thePluginName) != myPluginTypes.end()) {
185 aType = myPluginTypes.at(thePluginName);
188 case Config_ModuleReader::Python:
189 loadScript(thePluginName);
191 case Config_ModuleReader::Binary:
192 case Config_ModuleReader::Intrenal:
194 loadLibrary(thePluginName);
199 void Config_ModuleReader::loadScript(const std::string& theFileName, bool theSendErr)
201 /* acquire python thread */
202 PyGILState_STATE gstate = PyGILState_Ensure();
204 PyObject* module = PyImport_ImportModule(theFileName.c_str());
206 std::string anErrorMsg = "An error occurred while importing " + theFileName;
207 //Get detailed error message:
208 if (PyErr_Occurred()) {
209 PyObject *pstr, *ptype, *pvalue, *ptraceback;
210 PyErr_Fetch(&ptype, &pvalue, &ptraceback);
211 PyErr_NormalizeException(&ptype, &pvalue, &ptraceback);
212 pstr = PyObject_Str(pvalue);
213 std::string aPyError = std::string(PyUnicode_AsUTF8(pstr));
214 if (!aPyError.empty()) {
215 anErrorMsg += ":\n" + aPyError;
220 Py_XDECREF(ptraceback);
223 Events_InfoMessage("Config_ModuleReader", anErrorMsg).send();
226 /* release python thread */
227 PyGILState_Release(gstate);
230 void Config_ModuleReader::loadLibrary(const std::string& theLibName)
232 std::string aFileName = library(theLibName);
233 if (aFileName.empty())
237 HINSTANCE aModLib = ::LoadLibraryA(aFileName.c_str());
239 void* aModLib = dlopen( aFileName.c_str(), RTLD_LAZY | RTLD_GLOBAL );
241 if(!aModLib && theLibName != "DFBrowser") { // don't show error for internal debugging tool
243 std::string anErrorMsg = "Failed to load " + aFileName;
245 DWORD dwLastError = ::GetLastError();
246 LPSTR messageBuffer = NULL;
247 size_t size = ::FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER |
248 FORMAT_MESSAGE_FROM_SYSTEM |
249 FORMAT_MESSAGE_IGNORE_INSERTS,
252 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
253 (LPSTR)&messageBuffer, 0, NULL);
254 anErrorMsg += ": " + std::string(messageBuffer, size);
256 anErrorMsg += ": " + std::string(dlerror());
258 std::cerr << anErrorMsg << std::endl;
259 Events_InfoMessage("Config_ModuleReader", anErrorMsg).send();
264 void Config_ModuleReader::addDependencyModule(const std::string& theModuleName)
266 myDependencyModules.insert(normalize(theModuleName));