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