Fix a few potential deadlocks in cdr_sqlite3_custom.
[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 <stdlib.h>
44 #include <stdio.h>
45 #include <string.h>
46 #include <errno.h>
47 #include <unistd.h>
48 #include <time.h>
49 #include <sys/types.h>
50 #include <sqlite3.h>
51
52 #include "asterisk/channel.h"
53 #include "asterisk/cdr.h"
54 #include "asterisk/module.h"
55 #include "asterisk/config.h"
56 #include "asterisk/pbx.h"
57 #include "asterisk/logger.h"
58 #include "asterisk/utils.h"
59 #include "asterisk/cli.h"
60 #include "asterisk/options.h"
61
62 AST_MUTEX_DEFINE_STATIC(lock);
63
64 static const char config_file[] = "cdr_sqlite3_custom.conf";
65
66 static char *desc = "Customizable SQLite3 CDR Backend";
67 static char *name = "cdr_sqlite3_custom";
68 static sqlite3 *db = NULL;
69
70 static char table[80];
71 static char columns[1024];
72 static char values[1024];
73
74 static int load_config(int reload)
75 {
76         struct ast_config *cfg;
77         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
78         struct ast_variable *mappingvar;
79         const char *tmp;
80
81         if (!(cfg = ast_config_load(config_file, config_flags))) {
82                 if (reload)
83                         ast_log(LOG_WARNING, "%s: Failed to reload configuration file.\n", name);
84                 else {
85                         ast_log(LOG_WARNING,
86                                         "%s: Failed to load configuration file. Module not activated.\n",
87                                         name);
88                 }
89                 return -1;
90         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
91                 return 0;
92
93         ast_mutex_lock(&lock);
94
95         if (!(mappingvar = ast_variable_browse(cfg, "master"))) {
96                 /* nothing configured */
97                 ast_mutex_unlock(&lock);
98                 ast_config_destroy(cfg);
99                 return 0;
100         }
101         
102         /* Mapping must have a table name */
103         tmp = ast_variable_retrieve(cfg, "master", "table");
104         if (!ast_strlen_zero(tmp))
105                 ast_copy_string(table, tmp, sizeof(table));
106         else {
107                 ast_log(LOG_WARNING, "%s: Table name not specified.  Assuming cdr.\n", name);
108                 strcpy(table, "cdr");
109         }
110
111         tmp = ast_variable_retrieve(cfg, "master", "columns");
112         if (!ast_strlen_zero(tmp))
113                 ast_copy_string(columns, tmp, sizeof(columns));
114         else {
115                 ast_log(LOG_WARNING, "%s: Column names not specified. Module not loaded.\n",
116                                 name);
117                 ast_mutex_unlock(&lock);
118                 ast_config_destroy(cfg);
119                 return -1;
120         }
121
122         tmp = ast_variable_retrieve(cfg, "master", "values");
123         if (!ast_strlen_zero(tmp))
124                 ast_copy_string(values, tmp, sizeof(values));
125         else {
126                 ast_log(LOG_WARNING, "%s: Values not specified. Module not loaded.\n", name);
127                 ast_mutex_unlock(&lock);
128                 ast_config_destroy(cfg);
129                 return -1;
130         }
131
132         ast_mutex_unlock(&lock);
133
134         ast_config_destroy(cfg);
135
136         return 0;
137 }
138
139 /* assumues 'to' buffer is at least strlen(from) * 2 + 1 bytes */
140 static int do_escape(char *to, const char *from)
141 {
142         char *out = to;
143
144         for (; *from; from++) {
145                 if (*from == '\'' || *from == '\\')
146                         *out++ = *from;
147                 *out++ = *from;
148         }
149         *out = '\0';
150
151         return 0;
152 }
153
154 static int sqlite3_log(struct ast_cdr *cdr)
155 {
156         int res = 0;
157         char *zErr = 0;
158         char *sql_cmd;
159         struct ast_channel dummy = { 0, };
160         int count;
161
162         { /* Make it obvious that only sql_cmd should be used outside of this block */
163                 char *sql_tmp_cmd;
164                 char sql_insert_cmd[2048];
165                 sql_tmp_cmd = sqlite3_mprintf("INSERT INTO %q (%q) VALUES (%q)", table, columns, values);
166                 dummy.cdr = cdr;
167                 pbx_substitute_variables_helper(&dummy, sql_tmp_cmd, sql_insert_cmd, sizeof(sql_insert_cmd) - 1);
168                 sqlite3_free(sql_tmp_cmd);
169                 sql_cmd = alloca(strlen(sql_insert_cmd) * 2 + 1);
170                 do_escape(sql_cmd, sql_insert_cmd);
171         }
172
173         ast_mutex_lock(&lock);
174
175         for (count = 0; count < 5; count++) {
176                 res = sqlite3_exec(db, sql_cmd, NULL, NULL, &zErr);
177                 if (res != SQLITE_BUSY && res != SQLITE_LOCKED)
178                         break;
179                 usleep(200);
180         }
181
182         if (zErr) {
183                 ast_log(LOG_ERROR, "%s: %s. sentence: %s.\n", name, zErr, sql_cmd);
184                 sqlite3_free(zErr);
185         }
186
187         ast_mutex_unlock(&lock);
188
189         return res;
190 }
191
192 static int unload_module(void)
193 {
194         if (db)
195                 sqlite3_close(db);
196
197         ast_cdr_unregister(name);
198
199         return 0;
200 }
201
202 static int load_module(void)
203 {
204         char *zErr;
205         char fn[PATH_MAX];
206         int res;
207         char *sql_cmd;
208
209         if (!load_config(0)) {
210                 res = ast_cdr_register(name, desc, sqlite3_log);
211                 if (res) {
212                         ast_log(LOG_ERROR, "%s: Unable to register custom SQLite3 CDR handling\n", name);
213                         return AST_MODULE_LOAD_DECLINE;
214                 }
215         } else
216                 return AST_MODULE_LOAD_DECLINE;
217
218         /* is the database there? */
219         snprintf(fn, sizeof(fn), "%s/master.db", ast_config_AST_LOG_DIR);
220         res = sqlite3_open(fn, &db);
221         if (!db) {
222                 ast_log(LOG_ERROR, "%s: Could not open database %s.\n", name, fn);
223                 sqlite3_free(zErr);
224                 return AST_MODULE_LOAD_DECLINE;
225         }
226
227         /* is the table there? */
228         sql_cmd = sqlite3_mprintf("SELECT COUNT(AcctId) FROM %q;", table);
229         res = sqlite3_exec(db, sql_cmd, NULL, NULL, NULL);
230         sqlite3_free(sql_cmd);
231         if (res) {
232                 sql_cmd = sqlite3_mprintf("CREATE TABLE %q (AcctId INTEGER PRIMARY KEY,%q)", table, columns);
233                 res = sqlite3_exec(db, sql_cmd, NULL, NULL, &zErr);
234                 sqlite3_free(sql_cmd);
235                 if (zErr) {
236                         ast_log(LOG_WARNING, "%s: %s.\n", name, zErr);
237                         sqlite3_free(zErr);
238                         return 0;
239                 }
240
241                 if (res) {
242                         ast_log(LOG_ERROR, "%s: Unable to create table '%s': %s.\n", name, table, zErr);
243                         sqlite3_free(zErr);
244                         if (db)
245                                 sqlite3_close(db);
246                         return AST_MODULE_LOAD_DECLINE;
247                 }
248         }
249
250         return 0;
251 }
252
253 static int reload(void)
254 {
255         return load_config(1);
256 }
257
258 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "SQLite3 Custom CDR Module",
259         .load = load_module,
260         .unload = unload_module,
261         .reload = reload,
262 );