1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
PluginManager.h - header file for plugin manager. it takes care about
(un)loading plugins
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.
*/
#ifndef PLUGINMANAGER_H_
#define PLUGINMANAGER_H_
#include "abrt_types.h"
#include "Plugin.h"
#include "Analyzer.h"
#include "Reporter.h"
#include "Database.h"
#include "Action.h"
class CLoadedModule; /* opaque */
/**
* A class. It takes care of loading, registering and manipulating with
* plugins. When a plugin is loaded, its library is opened, but no plugin
* instance is created. It is possible after plugin registration.
*/
class CPluginManager
{
private:
typedef std::map<std::string, CLoadedModule*> map_loaded_module_t;
typedef std::map<std::string, CPlugin*> map_plugin_t;
/**
* Loaded plugins. A key is a plugin name.
*/
map_loaded_module_t m_mapLoadedModules;
/**
* Registered plugins. A key is a plugin name.
*/
map_plugin_t m_mapPlugins;
/**
* List of all possible plugins (loaded or not), with some attributes.
*/
map_map_string_t m_map_plugin_info;
map_map_string_t m_map_plugin_settings;
public:
/**
* A constructor.
* @param pPluginsConfDir A plugins configuration directory.
* @param pPluginsLibDir A plugins library directory.
*/
CPluginManager();
/**
* A destructor.
*/
~CPluginManager();
/**
* A method, which loads all plugins in plugins library direcotry.
*/
void LoadPlugins();
/**
* A method, which unregister and unload all loaded plugins.
*/
void UnLoadPlugins();
/**
* A method, which loads particular plugin.
* @param pName A plugin name.
*/
CPlugin* LoadPlugin(const char *pName, bool enabled_only = false);
/**
* A method, which unloads particular plugin.
* @param pName A plugin name.
*/
void UnLoadPlugin(const char *pName);
#ifdef PLUGIN_DYNAMIC_LOAD_UNLOAD
/**
* A method, which registers particular plugin.
* @param pName A plugin name.
*/
void RegisterPluginDBUS(const char *pName, const char *pDBUSSender);
/**
* A method, which unregister particular plugin,
* called via DBUS
* @param pName A plugin name.
* @param pDBUSSender DBUS user identification
*/
void UnRegisterPluginDBUS(const char *pName, const char *pDBUSSender);
#endif
/**
* A method, which returns instance of particular analyzer plugin.
* @param pName A plugin name.
* @return An analyzer plugin.
*/
CAnalyzer* GetAnalyzer(const char *pName);
/**
* A method, which returns instance of particular reporter plugin.
* @param pName A plugin name.
* @return A reporter plugin.
*/
CReporter* GetReporter(const char *pName);
/**
* A method, which returns instance of particular action plugin.
* @param pName A plugin name.
* @return An action plugin.
*/
CAction* GetAction(const char *pName, bool silent = false);
/**
* A method, which returns instance of particular database plugin.
* @param pName A plugin name.
* @return A database plugin.
*/
CDatabase* GetDatabase(const char *pName);
/**
* A method, which returns type of particular plugin.
* @param pName A plugin name.
* @return A plugin type.
*/
plugin_type_t GetPluginType(const char *pName);
/**
* A method, which gets all plugins info (even those plugins which are
* disabled). It can be sent via DBus to GUI and displayed to an user.
* Then user can fill all needed informations like URLs etc.
* @return A vector of maps <key, value>
*/
const map_map_string_t& GetPluginsInfo() { return m_map_plugin_info; }
/**
* A method, which sets up a plugin. The settings are also saved in home
* directory of an user.
* @param pName A plugin name.
* @param pUID An uid of user.
* @param pSettings A plugin's settings.
*/
void SetPluginSettings(const char *pName,
const char *pUID,
const map_plugin_settings_t& pSettings);
/**
* A method, which returns plugin's settings according to user.
* @param pName A plugin name.
* @return Plugin's settings.
*/
map_plugin_settings_t GetPluginSettings(const char *pName);
};
#endif /*PLUGINMANAGER_H_*/
|
