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