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