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