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