Merged revisions 317474 via svnmerge from
[asterisk/asterisk.git] / cel / cel_sqlite3_custom.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007, Digium, Inc.
5  *
6  * Steve Murphy <murf@digium.com> borrowed code from cdr,
7  * Mark Spencer <markster@digium.com> and others.
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Custom SQLite3 CEL records.
23  *
24  * \author Adapted by Steve Murphy <murf@digium.com> from
25  *  Alejandro Rios <alejandro.rios@avatar.com.co> and
26  *  Russell Bryant <russell@digium.com> from
27  *  cdr_mysql_custom by Edward Eastman <ed@dm3.co.uk>,
28  *      and cdr_sqlite by Holger Schurig <hs4233@mail.mn-solutions.de>
29  *
30  *
31  * \arg See also \ref AstCEL
32  *
33  *
34  * \ingroup cel_drivers
35  */
36
37 /*** MODULEINFO
38         <depend>sqlite3</depend>
39  ***/
40
41 #include "asterisk.h"
42
43 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
44
45 #include <sqlite3.h>
46
47 #include "asterisk/paths.h"
48 #include "asterisk/channel.h"
49 #include "asterisk/cel.h"
50 #include "asterisk/module.h"
51 #include "asterisk/config.h"
52 #include "asterisk/pbx.h"
53 #include "asterisk/logger.h"
54 #include "asterisk/utils.h"
55 #include "asterisk/cli.h"
56 #include "asterisk/options.h"
57 #include "asterisk/stringfields.h"
58
59 AST_MUTEX_DEFINE_STATIC(lock);
60
61 static const char config_file[] = "cel_sqlite3_custom.conf";
62
63 static const char name[] = "cel_sqlite3_custom";
64 static sqlite3 *db = NULL;
65
66 static char table[80];
67 /*! XXX \bug Handling of this var is crash prone on reloads */
68 static char *columns;
69 static struct ast_event_sub *event_sub = NULL;
70
71 struct values {
72         char *expression;
73         AST_LIST_ENTRY(values) list;
74 };
75
76 static AST_LIST_HEAD_STATIC(sql_values, values);
77
78 static void free_config(void);
79
80 static int load_column_config(const char *tmp)
81 {
82         char *col = NULL;
83         char *cols = NULL, *save = NULL;
84         char *escaped = NULL;
85         struct ast_str *column_string = NULL;
86
87         if (ast_strlen_zero(tmp)) {
88                 ast_log(LOG_WARNING, "Column names not specified. Module not loaded.\n");
89                 return -1;
90         }
91         if (!(column_string = ast_str_create(1024))) {
92                 ast_log(LOG_ERROR, "Out of memory creating temporary buffer for column list for table '%s.'\n", table);
93                 return -1;
94         }
95         if (!(save = cols = ast_strdup(tmp))) {
96                 ast_log(LOG_ERROR, "Out of memory creating temporary buffer for column list for table '%s.'\n", table);
97                 ast_free(column_string);
98                 return -1;
99         }
100         while ((col = strsep(&cols, ","))) {
101                 col = ast_strip(col);
102                 escaped = sqlite3_mprintf("%q", col);
103                 if (!escaped) {
104                         ast_log(LOG_ERROR, "Out of memory creating entry for column '%s' in table '%s.'\n", col, table);
105                         ast_free(column_string);
106                         ast_free(save);
107                         return -1;
108                 }
109                 ast_str_append(&column_string, 0, "%s%s", ast_str_strlen(column_string) ? "," : "", escaped);
110                 sqlite3_free(escaped);
111         }
112         if (!(columns = ast_strdup(ast_str_buffer(column_string)))) {
113                 ast_log(LOG_ERROR, "Out of memory copying columns string for table '%s.'\n", table);
114                 ast_free(column_string);
115                 ast_free(save);
116                 return -1;
117         }
118         ast_free(column_string);
119         ast_free(save);
120
121         return 0;
122 }
123
124 static int load_values_config(const char *tmp)
125 {
126         char *val = NULL;
127         char *vals = NULL, *save = NULL;
128         struct values *value = NULL;
129
130         if (ast_strlen_zero(tmp)) {
131                 ast_log(LOG_WARNING, "Values not specified. Module not loaded.\n");
132                 return -1;
133         }
134         if (!(save = vals = ast_strdup(tmp))) {
135                 ast_log(LOG_ERROR, "Out of memory creating temporary buffer for value '%s'\n", tmp);
136                 return -1;
137         }
138         while ((val = strsep(&vals, ","))) {
139                 /* Strip the single quotes off if they are there */
140                 val = ast_strip_quoted(val, "'", "'");
141                 value = ast_calloc(sizeof(char), sizeof(*value) + strlen(val) + 1);
142                 if (!value) {
143                         ast_log(LOG_ERROR, "Out of memory creating entry for value '%s'\n", val);
144                         ast_free(save);
145                         return -1;
146                 }
147                 value->expression = (char *) value + sizeof(*value);
148                 ast_copy_string(value->expression, val, strlen(val) + 1);
149                 AST_LIST_INSERT_TAIL(&sql_values, value, list);
150         }
151         ast_free(save);
152
153         return 0;
154 }
155
156 static int load_config(int reload)
157 {
158         struct ast_config *cfg;
159         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
160         struct ast_variable *mappingvar;
161         const char *tmp;
162
163         if ((cfg = ast_config_load(config_file, config_flags)) == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEINVALID) {
164                 ast_log(LOG_WARNING, "Failed to %sload configuration file. %s\n",
165                         reload ? "re" : "", reload ? "" : "Module not activated.");
166                 return -1;
167         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
168                 return 0;
169         }
170
171         if (reload) {
172                 free_config();
173         }
174
175         if (!(mappingvar = ast_variable_browse(cfg, "master"))) {
176                 /* Nothing configured */
177                 ast_config_destroy(cfg);
178                 return -1;
179         }
180
181         /* Mapping must have a table name */
182         if (!ast_strlen_zero(tmp = ast_variable_retrieve(cfg, "master", "table"))) {
183                 ast_copy_string(table, tmp, sizeof(table));
184         } else {
185                 ast_log(LOG_WARNING, "Table name not specified.  Assuming cel.\n");
186                 strcpy(table, "cel");
187         }
188
189         /* Columns */
190         if (load_column_config(ast_variable_retrieve(cfg, "master", "columns"))) {
191                 ast_config_destroy(cfg);
192                 free_config();
193                 return -1;
194         }
195
196         /* Values */
197         if (load_values_config(ast_variable_retrieve(cfg, "master", "values"))) {
198                 ast_config_destroy(cfg);
199                 free_config();
200                 return -1;
201         }
202
203         ast_verb(3, "Logging CEL records to table '%s' in 'master.db'\n", table);
204
205         ast_config_destroy(cfg);
206
207         return 0;
208 }
209
210 static void free_config(void)
211 {
212         struct values *value;
213
214         if (db) {
215                 sqlite3_close(db);
216                 db = NULL;
217         }
218
219         if (columns) {
220                 ast_free(columns);
221                 columns = NULL;
222         }
223
224         while ((value = AST_LIST_REMOVE_HEAD(&sql_values, list))) {
225                 ast_free(value);
226         }
227 }
228
229 static void write_cel(const struct ast_event *event, void *userdata)
230 {
231         char *error = NULL;
232         char *sql = NULL;
233         int count = 0;
234
235         if (db == NULL) {
236                 /* Should not have loaded, but be failsafe. */
237                 return;
238         }
239
240         ast_mutex_lock(&lock);
241
242         { /* Make it obvious that only sql should be used outside of this block */
243                 char *escaped;
244                 char subst_buf[2048];
245                 struct values *value;
246                 struct ast_channel *dummy;
247                 struct ast_str *value_string = ast_str_create(1024);
248
249                 dummy = ast_cel_fabricate_channel_from_event(event);
250                 if (!dummy) {
251                         ast_log(LOG_ERROR, "Unable to fabricate channel from CEL event.\n");
252                         ast_free(value_string);
253                         ast_mutex_unlock(&lock);
254                         return;
255                 }
256                 AST_LIST_TRAVERSE(&sql_values, value, list) {
257                         pbx_substitute_variables_helper(dummy, value->expression, subst_buf, sizeof(subst_buf) - 1);
258                         escaped = sqlite3_mprintf("%q", subst_buf);
259                         ast_str_append(&value_string, 0, "%s'%s'", ast_str_strlen(value_string) ? "," : "", escaped);
260                         sqlite3_free(escaped);
261                 }
262                 sql = sqlite3_mprintf("INSERT INTO %q (%s) VALUES (%s)", table, columns, ast_str_buffer(value_string));
263                 ast_debug(1, "About to log: %s\n", sql);
264                 dummy = ast_channel_release(dummy);
265                 ast_free(value_string);
266         }
267
268         /* XXX This seems awful arbitrary... */
269         for (count = 0; count < 5; count++) {
270                 int res = sqlite3_exec(db, sql, NULL, NULL, &error);
271                 if (res != SQLITE_BUSY && res != SQLITE_LOCKED) {
272                         break;
273                 }
274                 usleep(200);
275         }
276
277         ast_mutex_unlock(&lock);
278
279         if (error) {
280                 ast_log(LOG_ERROR, "%s. SQL: %s.\n", error, sql);
281                 sqlite3_free(error);
282         }
283
284         if (sql) {
285                 sqlite3_free(sql);
286         }
287
288         return;
289 }
290
291 static int unload_module(void)
292 {
293         if (event_sub) {
294                 event_sub = ast_event_unsubscribe(event_sub);
295         }
296
297         free_config();
298
299         return 0;
300 }
301
302 static int load_module(void)
303 {
304         char *error;
305         char filename[PATH_MAX];
306         int res;
307         char *sql;
308
309         if (load_config(0)) {
310                 return AST_MODULE_LOAD_DECLINE;
311         }
312
313         /* is the database there? */
314         snprintf(filename, sizeof(filename), "%s/master.db", ast_config_AST_LOG_DIR);
315         res = sqlite3_open(filename, &db);
316         if (res != SQLITE_OK) {
317                 ast_log(LOG_ERROR, "Could not open database %s.\n", filename);
318                 free_config();
319                 return AST_MODULE_LOAD_DECLINE;
320         }
321
322         /* is the table there? */
323         sql = sqlite3_mprintf("SELECT COUNT(AcctId) FROM %q;", table);
324         res = sqlite3_exec(db, sql, NULL, NULL, NULL);
325         sqlite3_free(sql);
326         if (res != SQLITE_OK) {
327                 /* We don't use %q for the column list here since we already escaped when building it */
328                 sql = sqlite3_mprintf("CREATE TABLE %q (AcctId INTEGER PRIMARY KEY, %s)", table, columns);
329                 res = sqlite3_exec(db, sql, NULL, NULL, &error);
330                 sqlite3_free(sql);
331                 if (res != SQLITE_OK) {
332                         ast_log(LOG_WARNING, "Unable to create table '%s': %s.\n", table, error);
333                         sqlite3_free(error);
334                         free_config();
335                         return AST_MODULE_LOAD_DECLINE;
336                 }
337         }
338
339         event_sub = ast_event_subscribe(AST_EVENT_CEL, write_cel, "CEL sqlite3 custom backend", NULL, AST_EVENT_IE_END);
340         if (!event_sub) {
341                 ast_log(LOG_ERROR, "Unable to register custom SQLite3 CEL handling\n");
342                 free_config();
343                 return AST_MODULE_LOAD_DECLINE;
344         }
345
346         return AST_MODULE_LOAD_SUCCESS;
347 }
348
349 static int reload(void)
350 {
351         int res = 0;
352
353         ast_mutex_lock(&lock);
354         res = load_config(1);
355         ast_mutex_lock(&lock);
356
357         return res;
358 }
359
360 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SQLite3 Custom CEL Module",
361         .load = load_module,
362         .unload = unload_module,
363         .reload = reload,
364         .load_pri = AST_MODPRI_CDR_DRIVER,
365 );