bf8d310153a205af43fb7a7e8cabb55264b7e875
[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  *
21  * ODBC CDR Backend
22  * 
23  */
24
25 #include <sys/types.h>
26 #include <stdio.h>
27 #include <string.h>
28
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <time.h>
32
33 #ifndef __CYGWIN__
34 #include <sql.h>
35 #include <sqlext.h>
36 #include <sqltypes.h>
37 #else
38 #include <windows.h>
39 #include <w32api/sql.h>
40 #include <w32api/sqlext.h>
41 #include <w32api/sqltypes.h>
42 #endif
43
44 #include "asterisk.h"
45
46 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
47
48 #include "asterisk/config.h"
49 #include "asterisk/options.h"
50 #include "asterisk/channel.h"
51 #include "asterisk/cdr.h"
52 #include "asterisk/module.h"
53 #include "asterisk/logger.h"
54
55 #define DATE_FORMAT "%Y-%m-%d %T"
56
57 static char *desc = "ODBC CDR Backend";
58 static char *name = "ODBC";
59 static char *config = "cdr_odbc.conf";
60 static char *dsn = NULL, *username = NULL, *password = NULL, *table = NULL;
61 static int loguniqueid = 0;
62 static int usegmtime = 0;
63 static int dispositionstring = 0;
64 static int connected = 0;
65
66 AST_MUTEX_DEFINE_STATIC(odbc_lock);
67
68 static int odbc_do_query(void);
69 static int odbc_init(void);
70
71 static SQLHENV  ODBC_env = SQL_NULL_HANDLE;     /* global ODBC Environment */
72 static SQLHDBC  ODBC_con;                       /* global ODBC Connection Handle */
73 static SQLHSTMT ODBC_stmt;                      /* global ODBC Statement Handle */
74
75 static int odbc_log(struct ast_cdr *cdr)
76 {
77         SQLINTEGER ODBC_err;
78         short int ODBC_mlen;
79         int ODBC_res;
80         char ODBC_msg[200], ODBC_stat[10];
81         char sqlcmd[2048] = "", timestr[128];
82         int res = 0;
83         struct tm tm;
84
85         if (usegmtime) 
86                 gmtime_r(&cdr->start.tv_sec,&tm);
87         else
88                 localtime_r(&cdr->start.tv_sec,&tm);
89
90         ast_mutex_lock(&odbc_lock);
91         strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
92         memset(sqlcmd,0,2048);
93         if (loguniqueid) {
94                 snprintf(sqlcmd,sizeof(sqlcmd),"INSERT INTO %s "
95                 "(calldate,clid,src,dst,dcontext,channel,dstchannel,lastapp,"
96                 "lastdata,duration,billsec,disposition,amaflags,accountcode,uniqueid,userfield) "
97                 "VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)", table);
98         } else {
99                 snprintf(sqlcmd,sizeof(sqlcmd),"INSERT INTO %s "
100                 "(calldate,clid,src,dst,dcontext,channel,dstchannel,lastapp,lastdata,"
101                 "duration,billsec,disposition,amaflags,accountcode) "
102                 "VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?)", table);
103         }
104
105         if (!connected) {
106                 res = odbc_init();
107                 if (res < 0) {
108                         connected = 0;
109                         ast_mutex_unlock(&odbc_lock);
110                         return 0;
111                 }                               
112         }
113
114         ODBC_res = SQLAllocHandle(SQL_HANDLE_STMT, ODBC_con, &ODBC_stmt);
115
116         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
117                 if (option_verbose > 10)
118                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Failure in AllocStatement %d\n", ODBC_res);
119                 SQLGetDiagRec(SQL_HANDLE_DBC, ODBC_con, 1, ODBC_stat, &ODBC_err, ODBC_msg, 100, &ODBC_mlen);
120                 SQLFreeHandle(SQL_HANDLE_STMT, ODBC_stmt);      
121                 connected = 0;
122                 ast_mutex_unlock(&odbc_lock);
123                 return 0;
124         }
125
126         /* We really should only have to do this once.  But for some
127            strange reason if I don't it blows holes in memory like
128            like a shotgun.  So we just do this so its safe. */
129
130         ODBC_res = SQLPrepare(ODBC_stmt, sqlcmd, SQL_NTS);
131         
132         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
133                 if (option_verbose > 10)
134                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error in PREPARE %d\n", ODBC_res);
135                 SQLGetDiagRec(SQL_HANDLE_DBC, ODBC_con, 1, ODBC_stat, &ODBC_err, ODBC_msg, 100, &ODBC_mlen);
136                 SQLFreeHandle(SQL_HANDLE_STMT, ODBC_stmt);
137                 connected = 0;
138                 ast_mutex_unlock(&odbc_lock);
139                 return 0;
140         }
141
142         SQLBindParameter(ODBC_stmt, 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(timestr), 0, &timestr, 0, NULL);
143         SQLBindParameter(ODBC_stmt, 2, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->clid), 0, cdr->clid, 0, NULL);
144         SQLBindParameter(ODBC_stmt, 3, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->src), 0, cdr->src, 0, NULL);
145         SQLBindParameter(ODBC_stmt, 4, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dst), 0, cdr->dst, 0, NULL);
146         SQLBindParameter(ODBC_stmt, 5, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dcontext), 0, cdr->dcontext, 0, NULL);
147         SQLBindParameter(ODBC_stmt, 6, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->channel), 0, cdr->channel, 0, NULL);
148         SQLBindParameter(ODBC_stmt, 7, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->dstchannel), 0, cdr->dstchannel, 0, NULL);
149         SQLBindParameter(ODBC_stmt, 8, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->lastapp), 0, cdr->lastapp, 0, NULL);
150         SQLBindParameter(ODBC_stmt, 9, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->lastdata), 0, cdr->lastdata, 0, NULL);
151         SQLBindParameter(ODBC_stmt, 10, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->duration, 0, NULL);
152         SQLBindParameter(ODBC_stmt, 11, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->billsec, 0, NULL);
153         if (dispositionstring)
154                 SQLBindParameter(ODBC_stmt, 12, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(ast_cdr_disp2str(cdr->disposition)) + 1, 0, ast_cdr_disp2str(cdr->disposition), 0, NULL);
155         else
156                 SQLBindParameter(ODBC_stmt, 12, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->disposition, 0, NULL);
157         SQLBindParameter(ODBC_stmt, 13, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &cdr->amaflags, 0, NULL);
158         SQLBindParameter(ODBC_stmt, 14, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->accountcode), 0, cdr->accountcode, 0, NULL);
159
160         if (loguniqueid) {
161                 SQLBindParameter(ODBC_stmt, 15, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->uniqueid), 0, cdr->uniqueid, 0, NULL);
162                 SQLBindParameter(ODBC_stmt, 16, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, sizeof(cdr->userfield), 0, cdr->userfield, 0, NULL);
163         }
164
165         if (connected) {
166                 res = odbc_do_query();
167                 if (res < 0) {
168                         if (option_verbose > 10)                
169                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Query FAILED Call not logged!\n");
170                         res = odbc_init();
171                         if (option_verbose > 10)
172                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Reconnecting to dsn %s\n", dsn);
173                         if (res < 0) {
174                                 if (option_verbose > 10)
175                                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: %s has gone away!\n", dsn);
176                                 connected = 0;
177                         } else {
178                                 if (option_verbose > 10)
179                                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Trying Query again!\n");
180                                 res = odbc_do_query();
181                                 if (res < 0) {
182                                         if (option_verbose > 10)
183                                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Query FAILED Call not logged!\n");
184                                 }
185                         }
186                 }
187         } else {
188                 if (option_verbose > 10)
189                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Query FAILED Call not logged!\n");
190         }
191         SQLFreeHandle(SQL_HANDLE_STMT, ODBC_stmt);
192         ast_mutex_unlock(&odbc_lock);
193         return 0;
194 }
195
196 char *description(void)
197 {
198         return desc;
199 }
200
201 static int odbc_unload_module(void)
202 {
203         ast_mutex_lock(&odbc_lock);
204         if (connected) {
205                 if (option_verbose > 10)
206                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Disconnecting from %s\n", dsn);
207                 SQLFreeHandle(SQL_HANDLE_STMT, ODBC_stmt);
208                 SQLDisconnect(ODBC_con);
209                 SQLFreeHandle(SQL_HANDLE_DBC, ODBC_con);
210                 SQLFreeHandle(SQL_HANDLE_ENV, ODBC_env);
211         }
212         if (dsn) {
213                 if (option_verbose > 10)
214                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: free dsn\n");
215                 free(dsn);
216         }
217         if (username) {
218                 if (option_verbose > 10)
219                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: free username\n");
220                 free(username);
221         }
222         if (password) {
223                 if (option_verbose > 10)
224                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: free password\n");
225                 free(password);
226         }
227         if (table) {
228                 if (option_verbose > 10)
229                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: free table\n");
230                 free(table);
231         }
232
233         ast_cdr_unregister(name);
234         ast_mutex_unlock(&odbc_lock);
235         return 0;
236 }
237
238 static int odbc_load_module(void)
239 {
240         int res = 0;
241         struct ast_config *cfg;
242         struct ast_variable *var;
243         char *tmp;
244
245         ast_mutex_lock(&odbc_lock);
246
247         cfg = ast_config_load(config);
248         if (!cfg) {
249                 ast_log(LOG_WARNING, "cdr_odbc: Unable to load config for ODBC CDR's: %s\n", config);
250                 goto out;
251         }
252         
253         var = ast_variable_browse(cfg, "global");
254         if (!var) {
255                 /* nothing configured */
256                 goto out;
257         }
258
259         tmp = ast_variable_retrieve(cfg,"global","dsn");
260         if (tmp == NULL) {
261                 ast_log(LOG_WARNING,"cdr_odbc: dsn not specified.  Assuming asteriskdb\n");
262                 tmp = "asteriskdb";
263         }
264         dsn = strdup(tmp);
265         if (dsn == NULL) {
266                 ast_log(LOG_ERROR,"cdr_odbc: Out of memory error.\n");
267                 res = -1;
268                 goto out;
269         }
270
271         tmp = ast_variable_retrieve(cfg,"global","dispositionstring");
272         if (tmp) {
273                 dispositionstring = ast_true(tmp);
274         } else {
275                 dispositionstring = 0;
276         }
277                 
278         tmp = ast_variable_retrieve(cfg,"global","username");
279         if (tmp) {
280                 username = strdup(tmp);
281                 if (username == NULL) {
282                         ast_log(LOG_ERROR,"cdr_odbc: Out of memory error.\n");
283                         res = -1;
284                         goto out;
285                 }
286         }
287
288         tmp = ast_variable_retrieve(cfg,"global","password");
289         if (tmp) {
290                 password = strdup(tmp);
291                 if (password == NULL) {
292                         ast_log(LOG_ERROR,"cdr_odbc: Out of memory error.\n");
293                         res = -1;
294                         goto out;
295                 }
296         }
297
298         tmp = ast_variable_retrieve(cfg,"global","loguniqueid");
299         if (tmp) {
300                 loguniqueid = ast_true(tmp);
301                 if (loguniqueid) {
302                         ast_log(LOG_DEBUG,"cdr_odbc: Logging uniqueid\n");
303                 } else {
304                         ast_log(LOG_DEBUG,"cdr_odbc: Not logging uniqueid\n");
305                 }
306         } else {
307                 ast_log(LOG_DEBUG,"cdr_odbc: Not logging uniqueid\n");
308                 loguniqueid = 0;
309         }
310
311         tmp = ast_variable_retrieve(cfg,"global","usegmtime");
312         if (tmp) {
313                 usegmtime = ast_true(tmp);
314                 if (usegmtime) {
315                         ast_log(LOG_DEBUG,"cdr_odbc: Logging in GMT\n");
316                 } else {
317                         ast_log(LOG_DEBUG,"cdr_odbc: Not logging in GMT\n");
318                 }
319         } else {
320                 ast_log(LOG_DEBUG,"cdr_odbc: Not logging in GMT\n");
321                 usegmtime = 0;
322         }
323
324         tmp = ast_variable_retrieve(cfg,"global","table");
325         if (tmp == NULL) {
326                 ast_log(LOG_WARNING,"cdr_odbc: table not specified.  Assuming cdr\n");
327                 tmp = "cdr";
328         }
329         table = strdup(tmp);
330         if (table == NULL) {
331                 ast_log(LOG_ERROR,"cdr_odbc: Out of memory error.\n");
332                 res = -1;
333                 goto out;
334         }
335
336         ast_config_destroy(cfg);
337         if (option_verbose > 2) {
338                 ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: dsn is %s\n",dsn);
339                 if (username)
340                 {
341                         ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: username is %s\n",username);
342                         ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: password is [secret]\n");
343                 }
344                 else
345                         ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: retreiving username and password from odbc config\n");
346                 ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: table is %s\n",table);
347         }
348         
349         res = odbc_init();
350         if (res < 0) {
351                 ast_log(LOG_ERROR, "cdr_odbc: Unable to connect to datasource: %s\n", dsn);
352                 if (option_verbose > 2) {
353                         ast_verbose( VERBOSE_PREFIX_3 "cdr_odbc: Unable to connect to datasource: %s\n", dsn);
354                 }
355         }
356         res = ast_cdr_register(name, desc, odbc_log);
357         if (res) {
358                 ast_log(LOG_ERROR, "cdr_odbc: Unable to register ODBC CDR handling\n");
359         }
360 out:
361         ast_mutex_unlock(&odbc_lock);
362         return res;
363 }
364
365 static int odbc_do_query(void)
366 {
367         SQLINTEGER ODBC_err;
368         int ODBC_res;
369         short int ODBC_mlen;
370         char ODBC_msg[200], ODBC_stat[10];
371         
372         ODBC_res = SQLExecute(ODBC_stmt);
373         
374         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
375                 if (option_verbose > 10)
376                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error in Query %d\n", ODBC_res);
377                 SQLGetDiagRec(SQL_HANDLE_DBC, ODBC_con, 1, ODBC_stat, &ODBC_err, ODBC_msg, 100, &ODBC_mlen);
378                 SQLFreeHandle(SQL_HANDLE_STMT, ODBC_stmt);
379                 connected = 0;
380                 return -1;
381         } else {
382                 if (option_verbose > 10)
383                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Query Successful!\n");
384                 connected = 1;
385         }
386         return 0;
387 }
388
389 static int odbc_init(void)
390 {
391         SQLINTEGER ODBC_err;
392         short int ODBC_mlen;
393         int ODBC_res;
394         char ODBC_msg[200], ODBC_stat[10];
395
396         if (ODBC_env == SQL_NULL_HANDLE || connected == 0) {
397                 ODBC_res = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &ODBC_env);
398                 if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
399                         if (option_verbose > 10)
400                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error AllocHandle\n");
401                         connected = 0;
402                         return -1;
403                 }
404
405                 ODBC_res = SQLSetEnvAttr(ODBC_env, SQL_ATTR_ODBC_VERSION, (void*)SQL_OV_ODBC3, 0);
406
407                 if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
408                         if (option_verbose > 10)
409                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error SetEnv\n");
410                         SQLFreeHandle(SQL_HANDLE_ENV, ODBC_env);
411                         connected = 0;
412                         return -1;
413                 }
414
415                 ODBC_res = SQLAllocHandle(SQL_HANDLE_DBC, ODBC_env, &ODBC_con);
416
417                 if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
418                         if (option_verbose > 10)
419                                 ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error AllocHDB %d\n", ODBC_res);
420                         SQLFreeHandle(SQL_HANDLE_ENV, ODBC_env);
421                         connected = 0;
422                         return -1;
423                 }
424                 SQLSetConnectAttr(ODBC_con, SQL_LOGIN_TIMEOUT, (SQLPOINTER *)10, 0);    
425         }
426
427         /* Note that the username and password could be NULL here, but that is allowed in ODBC.
428            In this case, the default username and password will be used from odbc.conf */
429         ODBC_res = SQLConnect(ODBC_con, (SQLCHAR*)dsn, SQL_NTS, (SQLCHAR*)username, SQL_NTS, (SQLCHAR*)password, SQL_NTS);
430
431         if ((ODBC_res != SQL_SUCCESS) && (ODBC_res != SQL_SUCCESS_WITH_INFO)) {
432                 if (option_verbose > 10)
433                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Error SQLConnect %d\n", ODBC_res);
434                 SQLGetDiagRec(SQL_HANDLE_DBC, ODBC_con, 1, ODBC_stat, &ODBC_err, ODBC_msg, 100, &ODBC_mlen);
435                 SQLFreeHandle(SQL_HANDLE_ENV, ODBC_env);
436                 connected = 0;
437                 return -1;
438         } else {
439                 if (option_verbose > 10)
440                         ast_verbose( VERBOSE_PREFIX_4 "cdr_odbc: Connected to %s\n", dsn);
441                 connected = 1;
442         }
443         return 0;
444 }
445
446 int load_module(void)
447 {
448         return odbc_load_module();
449 }
450
451 int unload_module(void)
452 {
453         return odbc_unload_module();
454 }
455
456 int reload(void)
457 {
458         odbc_unload_module();
459         return odbc_load_module();
460 }
461
462 int usecount(void)
463 {
464         /* Simplistic use count */
465         if (ast_mutex_trylock(&odbc_lock)) {
466                 return 1;
467         } else {
468                 ast_mutex_unlock(&odbc_lock);
469                 return 0;
470         }
471 }
472
473 char *key()
474 {
475         return ASTERISK_GPL_KEY;
476 }