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