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