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