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