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