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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
Plugin.h - header file for plugin. It contains mandatory macros
and common function for 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 PLUGIN_H_
#define PLUGIN_H_
#include <string>
#include <map>
#include <fstream>
#define PLUGINS_MAGIC_NUMBER 4
#define PLUGINS_CONF_EXTENSION "conf"
#define PLUGINS_LIB_EXTENSION "so"
#define PLUGINS_LIB_PREFIX "lib"
typedef std::map<std::string, std::string> map_plugin_settings_t;
/**
* An abstract class. The class defines a common plugin interface. If a plugin
* has some settings, then a *Settings(*) method has to be written.
*/
class CPlugin
{
public:
/**
* A destructor.
*/
virtual ~CPlugin() {}
/**
* A method, which initializes a plugin. It is not mandatory method.
*/
virtual void Init() {}
/**
* A method, which deinitializes a plugin. It is not mandatory method.
*/
virtual void DeInit() {}
/**
* A method, which loads a plugin settings from a file. It is not mandatory method.
* @param pPath A path to plugin configuration file.
*/
virtual void LoadSettings(const std::string& pPath) {}
/**
* A method, which takes a settings and apply them. It is not a mandatory method.
* @param pSettings Plugin's settings
*/
virtual void SetSettings(const map_plugin_settings_t& pSettings) {}
/**
* A method, which return current settings. It is not mandatory method.
* @return Plugin's settings
*/
virtual map_plugin_settings_t GetSettings() {return map_plugin_settings_t();}
};
/**
* An emun of plugin types.
*/
typedef enum {
ANALYZER, /**< An analyzer plugin*/
ACTION, /**< An action plugin*/
REPORTER, /**< A reporter plugin*/
DATABASE /**< A database plugin*/
} plugin_type_t;
/**
* A struct contains all needed data about particular plugin.
*/
typedef struct SPluginInfo
{
const plugin_type_t m_Type; /**< Plugin type.*/
const std::string m_sName; /**< Plugin name.*/
const std::string m_sVersion; /**< Plugin version.*/
const std::string m_sDescription; /**< Plugin description.*/
const std::string m_sEmail; /**< Plugin author's email.*/
const std::string m_sWWW; /**< Plugin's home page.*/
const std::string m_sGTKBuilder; /**< Plugin's gui description.*/
const int m_nMagicNumber; /**< Plugin magical number.*/
} plugin_info_t;
#define PLUGIN_IFACE extern "C"
#define PLUGIN_INFO(type, plugin_class, name, version, description, email, www, gtk_builder)\
PLUGIN_IFACE CPlugin* plugin_new()\
{\
return new plugin_class();\
}\
PLUGIN_IFACE const plugin_info_t plugin_info =\
{\
type,\
name,\
version,\
description,\
email,\
www,\
gtk_builder,\
PLUGINS_MAGIC_NUMBER,\
};
inline void plugin_load_settings(const std::string& path, map_plugin_settings_t& settings)
{
std::ifstream fIn;
fIn.open(path.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)
{
settings[key] = value;
}
}
fIn.close();
}
}
#endif /* PLUGIN_H_ */
|
