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