Merge "res_pjsip_mwi: Turn some NOTICEs and WARNINGs into debug 1s."
[asterisk/asterisk.git] / cdr / cdr_odbc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2003-2005, Digium, Inc.
5  *
6  * Brian K. West <brian@bkw.org>
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 ODBC CDR Backend
22  *
23  * \author Brian K. West <brian@bkw.org>
24  *
25  * See also:
26  * \arg http://www.unixodbc.org
27  * \arg \ref Config_cdr
28  * \ingroup cdr_drivers
29  */
30
31 /*! \li \ref cdr_odbc.c uses the configuration file \ref cdr_odbc.conf
32  * \addtogroup configuration_file Configuration Files
33  */
34
35 /*!
36  * \page cdr_odbc.conf cdr_odbc.conf
37  * \verbinclude cdr_odbc.conf.sample
38  */
39
40 /*** MODULEINFO
41         <depend>res_odbc</depend>
42         <support_level>extended</support_level>
43  ***/
44
45 #include "asterisk.h"
46
47 ASTERISK_REGISTER_FILE()
48
49 #include "asterisk/config.h"
50 #include "asterisk/channel.h"
51 #include "asterisk/cdr.h"
52 #include "asterisk/module.h"
53 #include "asterisk/res_odbc.h"
54
55 #define DATE_FORMAT "%Y-%m-%d %T"
56
57 static const char name[] = "ODBC";
58 static const char config_file[] = "cdr_odbc.conf";
59 static char *dsn = NULL, *table = NULL;
60
61 enum {
62         CONFIG_LOGUNIQUEID =       1 << 0,
63         CONFIG_USEGMTIME =         1 << 1,
64         CONFIG_DISPOSITIONSTRING = 1 << 2,
65         CONFIG_HRTIME =            1 << 3,
66         CONFIG_REGISTERED =        1 << 4,
67         CONFIG_NEWCDRCOLUMNS =     1 << 5,
68 };
69
70 static struct ast_flags config = { 0 };
71
72 static SQLHSTMT execute_cb(struct odbc_obj *obj, void *data)
73 {
74         struct ast_cdr *cdr = data;
75         SQLRETURN ODBC_res;
76         char sqlcmd[2048] = "", timestr[128], new_columns[120] = "", new_values[7] = "";
77         struct ast_tm tm;
78         SQLHSTMT stmt;
79         int i = 0;
80
81         ast_localtime(&cdr->start, &tm, ast_test_flag(&config, CONFIG_USEGMTIME) ? "GMT" : NULL);
82         ast_strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
83
84         if (ast_test_flag(&config, CONFIG_NEWCDRCOLUMNS)) {
85                 snprintf(new_columns, sizeof(new_columns), "%s", ",peeraccount,linkedid,sequence");
86                 snprintf(new_values, sizeof(new_values), "%s", ",?,?,?");
87         }
88
89         if (ast_test_flag(&config, CONFIG_LOGUNIQUEID)) {
90                 snprintf(sqlcmd,sizeof(sqlcmd),"INSERT INTO %s "
91                 "(calldate,clid,src,dst,dcontext,channel,dstchannel,lastapp,"
92                 "lastdata,duration,billsec,disposition,amaflags,accountcode,uniqueid,userfield%s) "
93                 "VALUES ({ts '%s'},?,?,?,?,?,?,?,?,?,?,?,?,?,?,?%s)", table, new_columns, timestr, new_values);
94         } else {
95                 snprintf(sqlcmd,sizeof(sqlcmd),"INSERT INTO %s "
96                 "(calldate,clid,src,dst,dcontext,channel,dstchannel,lastapp,lastdata,"
97                 "duration,billsec,disposition,amaflags,accountcode%s) "
98                 "VALUES ({ts '%s'},?,?,?,?,?,?,?,?,?,?,?,?,?%s)", table, new_columns, timestr, new_values);
99         }
100
101         ODBC_res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
102
103         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
104                 ast_log(LOG_WARNING, "cdr_odbc: Failure in AllocStatement %d\n", ODBC_res);
105                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
106                 return NULL;
107         }
108
109         SQLBindParameter(stmt, 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->clid), 0, cdr->clid, 0, NULL);
110         SQLBindParameter(stmt, 2, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->src), 0, cdr->src, 0, NULL);
111         SQLBindParameter(stmt, 3, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dst), 0, cdr->dst, 0, NULL);
112         SQLBindParameter(stmt, 4, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dcontext), 0, cdr->dcontext, 0, NULL);
113         SQLBindParameter(stmt, 5, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->channel), 0, cdr->channel, 0, NULL);
114         SQLBindParameter(stmt, 6, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dstchannel), 0, cdr->dstchannel, 0, NULL);
115         SQLBindParameter(stmt, 7, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->lastapp), 0, cdr->lastapp, 0, NULL);
116         SQLBindParameter(stmt, 8, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->lastdata), 0, cdr->lastdata, 0, NULL);
117
118         if (ast_test_flag(&config, CONFIG_HRTIME)) {
119                 double hrbillsec = 0.0;
120                 double hrduration;
121
122                 if (!ast_tvzero(cdr->answer)) {
123                         hrbillsec = (double) ast_tvdiff_us(cdr->end, cdr->answer) / 1000000.0;
124                 }
125                 hrduration = (double) ast_tvdiff_us(cdr->end, cdr->start) / 1000000.0;
126
127                 SQLBindParameter(stmt, 9, SQL_PARAM_INPUT, SQL_C_DOUBLE, SQL_FLOAT, 0, 0, &hrduration, 0, NULL);
128                 SQLBindParameter(stmt, 10, SQL_PARAM_INPUT, SQL_C_DOUBLE, SQL_FLOAT, 0, 0, &hrbillsec, 0, NULL);
129         } else {
130                 SQLBindParameter(stmt, 9, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->duration, 0, NULL);
131                 SQLBindParameter(stmt, 10, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->billsec, 0, NULL);
132         }
133
134         if (ast_test_flag(&config, CONFIG_DISPOSITIONSTRING)) {
135                 char *disposition;
136                 disposition = ast_strdupa(ast_cdr_disp2str(cdr->disposition));
137                 SQLBindParameter(stmt, 11, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(disposition) + 1, 0, disposition, 0, NULL);
138         } else {
139                 SQLBindParameter(stmt, 11, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->disposition, 0, NULL);
140         }
141         SQLBindParameter(stmt, 12, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->amaflags, 0, NULL);
142         SQLBindParameter(stmt, 13, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->accountcode), 0, cdr->accountcode, 0, NULL);
143
144         i = 14;
145         if (ast_test_flag(&config, CONFIG_LOGUNIQUEID)) {
146                 SQLBindParameter(stmt, 14, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->uniqueid), 0, cdr->uniqueid, 0, NULL);
147                 SQLBindParameter(stmt, 15, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->userfield), 0, cdr->userfield, 0, NULL);
148                 i = 16;
149         }
150
151         if (ast_test_flag(&config, CONFIG_NEWCDRCOLUMNS)) {
152                 SQLBindParameter(stmt, i, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->peeraccount), 0, cdr->peeraccount, 0, NULL);
153                 SQLBindParameter(stmt, i + 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->linkedid), 0, cdr->linkedid, 0, NULL);
154                 SQLBindParameter(stmt, i + 2, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->sequence, 0, NULL);
155         }
156
157         ODBC_res = SQLExecDirect(stmt, (unsigned char *)sqlcmd, SQL_NTS);
158
159         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
160                 ast_log(LOG_WARNING, "cdr_odbc: Error in ExecDirect: %d, query is: %s\n", ODBC_res, sqlcmd);
161                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
162                 return NULL;
163         }
164
165         return stmt;
166 }
167
168
169 static int odbc_log(struct ast_cdr *cdr)
170 {
171         struct odbc_obj *obj = ast_odbc_request_obj(dsn, 0);
172         SQLHSTMT stmt;
173
174         if (!obj) {
175                 ast_log(LOG_ERROR, "Unable to retrieve database handle.  CDR failed.\n");
176                 return -1;
177         }
178
179         stmt = ast_odbc_direct_execute(obj, execute_cb, cdr);
180         if (stmt) {
181                 SQLLEN rows = 0;
182
183                 SQLRowCount(stmt, &rows);
184                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
185
186                 if (rows == 0)
187                         ast_log(LOG_WARNING, "CDR successfully ran, but inserted 0 rows?\n");
188         } else
189                 ast_log(LOG_ERROR, "CDR direct execute failed\n");
190         ast_odbc_release_obj(obj);
191         return 0;
192 }
193
194 static int odbc_load_module(int reload)
195 {
196         int res = 0;
197         struct ast_config *cfg;
198         struct ast_variable *var;
199         const char *tmp;
200         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
201
202         do {
203                 cfg = ast_config_load(config_file, config_flags);
204                 if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
205                         ast_log(LOG_WARNING, "cdr_odbc: Unable to load config for ODBC CDR's: %s\n", config_file);
206                         res = AST_MODULE_LOAD_DECLINE;
207                         break;
208                 } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
209                         break;
210
211                 var = ast_variable_browse(cfg, "global");
212                 if (!var) {
213                         /* nothing configured */
214                         break;
215                 }
216
217                 if ((tmp = ast_variable_retrieve(cfg, "global", "dsn")) == NULL) {
218                         ast_log(LOG_WARNING, "cdr_odbc: dsn not specified.  Assuming asteriskdb\n");
219                         tmp = "asteriskdb";
220                 }
221                 if (dsn)
222                         ast_free(dsn);
223                 dsn = ast_strdup(tmp);
224                 if (dsn == NULL) {
225                         res = -1;
226                         break;
227                 }
228
229                 if (((tmp = ast_variable_retrieve(cfg, "global", "dispositionstring"))) && ast_true(tmp))
230                         ast_set_flag(&config, CONFIG_DISPOSITIONSTRING);
231                 else
232                         ast_clear_flag(&config, CONFIG_DISPOSITIONSTRING);
233
234                 if (((tmp = ast_variable_retrieve(cfg, "global", "loguniqueid"))) && ast_true(tmp)) {
235                         ast_set_flag(&config, CONFIG_LOGUNIQUEID);
236                         ast_debug(1, "cdr_odbc: Logging uniqueid\n");
237                 } else {
238                         ast_clear_flag(&config, CONFIG_LOGUNIQUEID);
239                         ast_debug(1, "cdr_odbc: Not logging uniqueid\n");
240                 }
241
242                 if (((tmp = ast_variable_retrieve(cfg, "global", "usegmtime"))) && ast_true(tmp)) {
243                         ast_set_flag(&config, CONFIG_USEGMTIME);
244                         ast_debug(1, "cdr_odbc: Logging in GMT\n");
245                 } else {
246                         ast_clear_flag(&config, CONFIG_USEGMTIME);
247                         ast_debug(1, "cdr_odbc: Logging in local time\n");
248                 }
249
250                 if (((tmp = ast_variable_retrieve(cfg, "global", "hrtime"))) && ast_true(tmp)) {
251                         ast_set_flag(&config, CONFIG_HRTIME);
252                         ast_debug(1, "cdr_odbc: Logging billsec and duration fields as floats\n");
253                 } else {
254                         ast_clear_flag(&config, CONFIG_HRTIME);
255                         ast_debug(1, "cdr_odbc: Logging billsec and duration fields as integers\n");
256                 }
257
258                 if ((tmp = ast_variable_retrieve(cfg, "global", "table")) == NULL) {
259                         ast_log(LOG_WARNING, "cdr_odbc: table not specified.  Assuming cdr\n");
260                         tmp = "cdr";
261                 }
262                 if (table)
263                         ast_free(table);
264                 table = ast_strdup(tmp);
265                 if (table == NULL) {
266                         res = -1;
267                         break;
268                 }
269
270                 if (!ast_test_flag(&config, CONFIG_REGISTERED)) {
271                         res = ast_cdr_register(name, ast_module_info->description, odbc_log);
272                         if (res) {
273                                 ast_log(LOG_ERROR, "cdr_odbc: Unable to register ODBC CDR handling\n");
274                         } else {
275                                 ast_set_flag(&config, CONFIG_REGISTERED);
276                         }
277                 }
278                 if (((tmp = ast_variable_retrieve(cfg, "global", "newcdrcolumns"))) && ast_true(tmp)) {
279                         ast_set_flag(&config, CONFIG_NEWCDRCOLUMNS);
280                         ast_debug(1, "cdr_odbc: Add new cdr columns\n");
281                 } else {
282                         ast_clear_flag(&config, CONFIG_NEWCDRCOLUMNS);
283                         ast_debug(1, "cdr_odbc: Not add new cdr columns\n");
284                 }
285         } while (0);
286
287         if (ast_test_flag(&config, CONFIG_REGISTERED) && (!cfg || dsn == NULL || table == NULL)) {
288                 ast_cdr_backend_suspend(name);
289                 ast_clear_flag(&config, CONFIG_REGISTERED);
290         } else {
291                 ast_cdr_backend_unsuspend(name);
292         }
293
294         if (cfg && cfg != CONFIG_STATUS_FILEUNCHANGED && cfg != CONFIG_STATUS_FILEINVALID) {
295                 ast_config_destroy(cfg);
296         }
297         return res;
298 }
299
300 static int load_module(void)
301 {
302         return odbc_load_module(0);
303 }
304
305 static int unload_module(void)
306 {
307         if (ast_cdr_unregister(name)) {
308                 return -1;
309         }
310
311         if (dsn) {
312                 ast_free(dsn);
313         }
314         if (table) {
315                 ast_free(table);
316         }
317
318         return 0;
319 }
320
321 static int reload(void)
322 {
323         return odbc_load_module(1);
324 }
325
326 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "ODBC CDR Backend",
327         .support_level = AST_MODULE_SUPPORT_EXTENDED,
328         .load = load_module,
329         .unload = unload_module,
330         .reload = reload,
331         .load_pri = AST_MODPRI_CDR_DRIVER,
332 );