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
|
/*
MiddleWare.h - header file for MiddleWare library. It wraps plugins and
take case of them.
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 MIDDLEWARE_H_
#define MIDDLEWARE_H_
#include "abrt_types.h"
#include "PluginManager.h"
/**
* An enum contains all return codes.
*/
typedef enum {
MW_OK, /**< No error.*/
MW_ERROR, /**< Common error.*/
MW_BLACKLISTED, /**< Package is blacklisted.*/
MW_CORRUPTED, /**< Debugdump directory is corrupted.*/
MW_PACKAGE_ERROR, /**< Cannot determine package name.*/
MW_GPG_ERROR, /**< Package is not signed properly.*/
MW_REPORTED, /**< Crash is already reported.*/
MW_OCCURRED, /**< Crash occurred in the past, but it is not reported yet.*/
MW_IN_DB, /**< Debugdump directory is already saved in a database.*/
MW_IN_DB_ERROR, /**< Error while working with a database.*/
MW_PLUGIN_ERROR, /**< plugin wasn't found or error within plugin*/
MW_FILE_ERROR /**< Error when trying open debugdump directory or
when trying open file in debug dump directory..*/
} mw_result_t;
typedef enum {
RS_CODE,
RS_MESSAGE
} report_status_items_t;
void LoadOpenGPGPublicKey(const char* key);
/**
* Takes care of getting all additional data needed
* for computing UUIDs and creating a report for particular analyzer
* plugin. This report could be send somewhere afterwards. If a creation
* is successful, then a crash report is filled.
* @param pAnalyzer A name of an analyzer plugin.
* @param pDebugDumpPath A debugdump dir containing all necessary data.
* @param pCrashData A filled crash report.
* @return It return results of operation. See mw_result_t.
*/
mw_result_t CreateCrashReport(const char *crash_id,
long caller_uid,
int force,
map_crash_data_t& pCrashData);
/**
* Activates particular action plugin.
* @param pActionDir A directory, which is passed as working to a action plugin.
* @param pPluginName An action plugin name.
* @param pPluginArgs Action plugin's arguments.
*/
void RunAction(const char *pActionDir,
const char *pPluginName,
const char *pPluginArgs);
/**
* Activates all action and reporter plugins when any
* crash occurs.
* @param pDebugDumpDir A debugdump dir containing all necessary data.
*/
void RunActionsAndReporters(const char *pDebugDumpDir);
/**
* Reports a crash report to particular receiver. It
* takes an user uid, tries to find user config file and load it. If it
* fails, then default config is used. If pUID is emply string, default
* config is used.
* ...).
* @param crash_data
* A crash report.
* @param reporters
* List of allowed reporters. Which reporters will be used depends
* on the analyzer of the crash_data. Reporters missing from this list
* will not be used.
* @param caller_uid
* An user uid.
* @return
* A report status, which reporters ends successfuly with messages.
*/
report_status_t Report(const map_crash_data_t& crash_data,
const vector_string_t& reporters,
map_map_string_t& settings,
long caller_uid);
/**
* Adds package name and description to debugdump dir.
* Saves debugdump into database.
* Detects whether it's a duplicate crash.
* Fills crash info.
* Note that if it's a dup, loads _first crash_ info, not this one's.
* @param pDebugDumpDir A debugdump directory.
* @param pCrashData A crash info.
* @return It return results of operation. See mw_result_t.
*/
mw_result_t SaveDebugDump(const char *pDebugDumpDir,
map_crash_data_t& pCrashData);
/**
* Get one crash info. If getting is successful,
* then crash info is filled.
* @param pUUID A local UUID of a crash.
* @param pUID An UID of an user.
* @param pCrashData A crash info.
* @return It return results of operation. See mw_result_t.
*/
mw_result_t FillCrashInfo(const char *crash_id,
map_crash_data_t& pCrashData);
/**
* Gets all local UUIDs and UIDs of crashes. These crashes
* occurred when a particular user was logged in.
* @param pUID an UID of an user.
* @return A vector of pairs (local UUID, UID).
*/
void GetUUIDsOfCrash(long caller_uid, vector_string_t &result);
/**
* Adds one association among alanyzer plugin and its
* action and reporter plugins.
* @param pAnalyzer A name of an analyzer plugin.
* @param pActionOrReporter A name of an action or reporter plugin.
* @param pArgs An arguments for action or reporter plugin.
*/
void AddAnalyzerActionOrReporter(const char *pAnalyzer,
const char *pActionOrReporter,
const char *pArgs);
/**
* Add action and reporter plugins, which are activated
* when any crash occurs.
* @param pActionOrReporter A name of an action or reporter plugin.
* @param pArgs An arguments for action or reporter plugin.
*/
void AddActionOrReporter(const char *pActionOrReporter,
const char *pArgs);
bool analyzer_has_InformAllUsers(const char *analyzer_name);
bool analyzer_has_AutoReportUIDs(const char *analyzer_name, const char *uid_str);
void autoreport(const pair_string_string_t& reporter_options, const map_crash_data_t& crash_report);
#endif /*MIDDLEWARE_H_*/
|
