/* PluginManager.cpp Copyright (C) 2009 Zdenek Prikryl (zprikryl@redhat.com) Copyright (C) 2009 RedHat inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include #include "PluginManager.h" #include "ABRTException.h" #include "CommLayerInner.h" #include #include #include #include #include "abrtlib.h" #include /** * Text representation of plugin types. */ static const char* const plugin_type_str_t[] = { "Analyzer", "Action", "Reporter", "Database" }; CPluginManager::CPluginManager( const std::string& pPluginsConfDir, const std::string& pPluginsLibDir) : m_sPluginsConfDir(pPluginsConfDir), m_sPluginsLibDir(pPluginsLibDir) {} CPluginManager::~CPluginManager() {} void CPluginManager::LoadPlugins() { DIR *dir = opendir(m_sPluginsLibDir.c_str()); struct dirent *dent = NULL; if (dir != NULL) { while ((dent = readdir(dir)) != NULL) { // FIXME: need to handle DT_UNKNOWN too if (dent->d_type == DT_REG) { std::string name = dent->d_name; std::string extension = name.substr(name.length() - sizeof(PLUGINS_LIB_EXTENSION) + 1); if (extension == PLUGINS_LIB_EXTENSION) { name.erase(0, sizeof(PLUGINS_LIB_PREFIX) - 1); name.erase(name.length() - sizeof(PLUGINS_LIB_EXTENSION)); LoadPlugin(name); } } } closedir(dir); } } void CPluginManager::UnLoadPlugins() { map_abrt_plugins_t::iterator it_p; while ((it_p = m_mapABRTPlugins.begin()) != m_mapABRTPlugins.end()) { std::string pluginName = it_p->first; UnLoadPlugin(pluginName); } } void CPluginManager::LoadPlugin(const std::string& pName) { if (m_mapABRTPlugins.find(pName) == m_mapABRTPlugins.end()) { CABRTPlugin* abrtPlugin = NULL; try { std::string libPath = m_sPluginsLibDir + "/" + PLUGINS_LIB_PREFIX + pName + "." + PLUGINS_LIB_EXTENSION; abrtPlugin = new CABRTPlugin(libPath); if (abrtPlugin->GetMagicNumber() != PLUGINS_MAGIC_NUMBER || (abrtPlugin->GetType() < ANALYZER && abrtPlugin->GetType() > DATABASE)) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::LoadPlugin(): non-compatible plugin"); } comm_layer_inner_debug("Plugin " + pName + " (" + abrtPlugin->GetVersion() + ") succesfully loaded."); m_mapABRTPlugins[pName] = abrtPlugin; } catch (CABRTException& e) { if (abrtPlugin != NULL) { delete abrtPlugin; } comm_layer_inner_warning("CPluginManager::LoadPlugin(): " + e.what()); comm_layer_inner_warning("Failed to load plugin " + pName); } } } void CPluginManager::UnLoadPlugin(const std::string& pName) { if (m_mapABRTPlugins.find(pName) != m_mapABRTPlugins.end()) { UnRegisterPlugin(pName); delete m_mapABRTPlugins[pName]; m_mapABRTPlugins.erase(pName); comm_layer_inner_debug("Plugin " + pName + " sucessfully unloaded."); } } void CPluginManager::RegisterPlugin(const std::string& pName) { if (m_mapABRTPlugins.find(pName) != m_mapABRTPlugins.end()) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { CPlugin* plugin = m_mapABRTPlugins[pName]->PluginNew(); map_plugin_settings_t pluginSettings; LoadPluginSettings(m_sPluginsConfDir + "/" + pName + "." + PLUGINS_CONF_EXTENSION, pluginSettings); try { plugin->Init(); plugin->SetSettings(pluginSettings); } catch (CABRTException& e) { comm_layer_inner_warning("Can not initialize plugin " + pName + "(" + std::string(plugin_type_str_t[m_mapABRTPlugins[pName]->GetType()]) + "): " + e.what()); UnLoadPlugin(pName); return; } m_mapPlugins[pName] = plugin; comm_layer_inner_debug("Registered plugin " + pName + "(" + std::string(plugin_type_str_t[m_mapABRTPlugins[pName]->GetType()]) + ")"); } } } void CPluginManager::UnRegisterPlugin(const std::string& pName) { if (m_mapABRTPlugins.find(pName) != m_mapABRTPlugins.end()) { if (m_mapPlugins.find(pName) != m_mapPlugins.end()) { m_mapPlugins[pName]->DeInit(); delete m_mapPlugins[pName]; m_mapPlugins.erase(pName); comm_layer_inner_debug("UnRegistred plugin " + pName + "(" + std::string(plugin_type_str_t[m_mapABRTPlugins[pName]->GetType()]) + ")"); } } } CAnalyzer* CPluginManager::GetAnalyzer(const std::string& pName) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetAnalyzer():" "Analyzer plugin: '"+pName+"' is not registered."); } if (m_mapABRTPlugins[pName]->GetType() != ANALYZER) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetAnalyzer():" "Plugin: '"+pName+"' is not analyzer plugin."); } return (CAnalyzer*)(m_mapPlugins[pName]); } CReporter* CPluginManager::GetReporter(const std::string& pName) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetReporter():" "Reporter plugin: '"+pName+"' is not registered."); } if (m_mapABRTPlugins[pName]->GetType() != REPORTER) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetReporter():" "Plugin: '"+pName+"' is not reporter plugin."); } return (CReporter*)(m_mapPlugins[pName]); } CAction* CPluginManager::GetAction(const std::string& pName) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetAction():" "Action plugin: '"+pName+"' is not registered."); } if (m_mapABRTPlugins[pName]->GetType() != ACTION) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetAction():" "Plugin: '"+pName+"' is not action plugin."); } return (CAction*)(m_mapPlugins[pName]); } CDatabase* CPluginManager::GetDatabase(const std::string& pName) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetDatabase():" "Database plugin: '"+pName+"' is not registered."); } if (m_mapABRTPlugins[pName]->GetType() != DATABASE) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetDatabase():" "Plugin: '"+pName+"' is not database plugin."); } return (CDatabase*)(m_mapPlugins[pName]); } plugin_type_t CPluginManager::GetPluginType(const std::string& pName) { if (m_mapPlugins.find(pName) == m_mapPlugins.end()) { throw CABRTException(EXCEP_PLUGIN, "CPluginManager::GetPluginType():" "Plugin: '"+pName+"' is not registered."); } return m_mapABRTPlugins[pName]->GetType(); } vector_map_string_string_t CPluginManager::GetPluginsInfo() { vector_map_string_string_t ret; map_abrt_plugins_t::iterator it_abrt_plugin; for (it_abrt_plugin = m_mapABRTPlugins.begin(); it_abrt_plugin != m_mapABRTPlugins.end(); it_abrt_plugin++) { map_string_string_t plugin_info; plugin_info["Enabled"] = (m_mapPlugins.find(it_abrt_plugin->second->GetName()) != m_mapPlugins.end()) ? "yes" : "no"; plugin_info["Type"] = plugin_type_str_t[it_abrt_plugin->second->GetType()]; plugin_info["Name"] = it_abrt_plugin->second->GetName(); plugin_info["Version"] = it_abrt_plugin->second->GetVersion(); plugin_info["Description"] = it_abrt_plugin->second->GetDescription(); plugin_info["Email"] = it_abrt_plugin->second->GetEmail(); plugin_info["WWW"] = it_abrt_plugin->second->GetWWW(); plugin_info["GTKBuilder"] = it_abrt_plugin->second->GetGTKBuilder(); ret.push_back(plugin_info); } return ret; } void CPluginManager::SetPluginSettings(const std::string& pName, const std::string& pUID, const map_plugin_settings_t& pSettings) { if (m_mapABRTPlugins.find(pName) != m_mapABRTPlugins.end()) { if (m_mapPlugins.find(pName) != m_mapPlugins.end()) { m_mapPlugins[pName]->SetSettings(pSettings); if (m_mapABRTPlugins[pName]->GetType() == REPORTER) { std::string home = get_home_dir(atoi(pUID.c_str())); if (home != "") { SavePluginSettings(home + "/.abrt/" + pName + "." + PLUGINS_CONF_EXTENSION, pSettings); } } } } } map_plugin_settings_t CPluginManager::GetPluginSettings(const std::string& pName, const std::string& pUID) { map_plugin_settings_t ret; if (m_mapABRTPlugins.find(pName) != m_mapABRTPlugins.end()) { if (m_mapPlugins.find(pName) != m_mapPlugins.end()) { if (m_mapABRTPlugins[pName]->GetType() == REPORTER) { std::string home = get_home_dir(atoi(pUID.c_str())); if (home != "") { if (LoadPluginSettings(home + "/.abrt/" + pName + "." + PLUGINS_CONF_EXTENSION, ret)) { return ret; } } } return m_mapPlugins[pName]->GetSettings(); } } return ret; } bool CPluginManager::LoadPluginSettings(const std::string& pPath, map_plugin_settings_t& pSettings) { std::ifstream fIn; fIn.open(pPath.c_str()); if (fIn.is_open()) { std::string line; while (!fIn.eof()) { getline(fIn, line); int ii; bool is_value = false; bool valid = false; bool in_quote = false; std::string key = ""; std::string value = ""; for (ii = 0; ii < line.length(); ii++) { if (line[ii] == '\"') { in_quote = in_quote == true ? false : true; } if (isspace(line[ii]) && !in_quote) { continue; } if (line[ii] == '#' && !in_quote) { break; } else if (line[ii] == '=' && !in_quote) { is_value = true; } else if (line[ii] == '=' && is_value && !in_quote) { key = ""; value = ""; break; } else if (!is_value) { key += line[ii]; } else { valid = true; value += line[ii]; } } if (valid && !in_quote) { pSettings[key] = value; } } fIn.close(); return true; } return false; } bool CPluginManager::SavePluginSettings(const std::string& pPath, const map_plugin_settings_t& pSettings) { std::ofstream fOut; fOut.open(pPath.c_str()); if (fOut.is_open()) { fOut << "# Settings were written by abrt." << std::endl; map_plugin_settings_t::const_iterator it; for (it = pSettings.begin(); it != pSettings.end(); it++) { fOut << it->first << " = " << it->second << std::endl; } fOut.close(); return true; } return false; }