2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 2004 - 2006, Digium, Inc.
6 * See http://www.asterisk.org for more information about
7 * the Asterisk project. Please do not directly contact
8 * any of the maintainers of this project for assistance;
9 * the project provides a web site, mailing lists and IRC
10 * channels for your use.
12 * This program is free software, distributed under the terms of
13 * the GNU General Public License Version 2. See the LICENSE file
14 * at the top of the source tree.
19 * \brief FreeTDS CDR logger
22 * \arg \ref Config_cdr
23 * \arg http://www.freetds.org/
24 * \ingroup cdr_drivers
29 * Table Structure for `cdr`
31 * Created on: 05/20/2004 16:16
32 * Last changed on: 07/27/2004 20:01
34 CREATE TABLE [dbo].[cdr] (
35 [accountcode] [varchar] (20) NULL ,
36 [src] [varchar] (80) NULL ,
37 [dst] [varchar] (80) NULL ,
38 [dcontext] [varchar] (80) NULL ,
39 [clid] [varchar] (80) NULL ,
40 [channel] [varchar] (80) NULL ,
41 [dstchannel] [varchar] (80) NULL ,
42 [lastapp] [varchar] (80) NULL ,
43 [lastdata] [varchar] (80) NULL ,
44 [start] [datetime] NULL ,
45 [answer] [datetime] NULL ,
46 [end] [datetime] NULL ,
47 [duration] [int] NULL ,
48 [billsec] [int] NULL ,
49 [disposition] [varchar] (20) NULL ,
50 [amaflags] [varchar] (16) NULL ,
51 [uniqueid] [varchar] (32) NULL ,
52 [userfield] [varchar] (256) NULL
60 <depend>freetds</depend>
65 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
70 #include "asterisk/config.h"
71 #include "asterisk/channel.h"
72 #include "asterisk/cdr.h"
73 #include "asterisk/module.h"
78 #define DATE_FORMAT "%Y/%m/%d %T"
80 static char *name = "FreeTDS (MSSQL)";
81 static char *config = "cdr_tds.conf";
83 struct cdr_tds_config {
84 AST_DECLARE_STRING_FIELDS(
85 AST_STRING_FIELD(hostname);
86 AST_STRING_FIELD(database);
87 AST_STRING_FIELD(username);
88 AST_STRING_FIELD(password);
89 AST_STRING_FIELD(table);
90 AST_STRING_FIELD(charset);
91 AST_STRING_FIELD(language);
94 unsigned int connected:1;
95 unsigned int has_userfield:1;
98 AST_MUTEX_DEFINE_STATIC(tds_lock);
100 static struct cdr_tds_config *settings;
102 static char *anti_injection(const char *, int);
103 static void get_date(char *, size_t len, struct timeval);
105 static int execute_and_consume(DBPROCESS *dbproc, const char *fmt, ...)
106 __attribute__ ((format (printf, 2, 3)));
108 static int mssql_connect(void);
109 static int mssql_disconnect(void);
111 static int tds_log(struct ast_cdr *cdr)
113 char start[80], answer[80], end[80];
114 char *accountcode, *src, *dst, *dcontext, *clid, *channel, *dstchannel, *lastapp, *lastdata, *uniqueid, *userfield = NULL;
119 accountcode = anti_injection(cdr->accountcode, 20);
120 src = anti_injection(cdr->src, 80);
121 dst = anti_injection(cdr->dst, 80);
122 dcontext = anti_injection(cdr->dcontext, 80);
123 clid = anti_injection(cdr->clid, 80);
124 channel = anti_injection(cdr->channel, 80);
125 dstchannel = anti_injection(cdr->dstchannel, 80);
126 lastapp = anti_injection(cdr->lastapp, 80);
127 lastdata = anti_injection(cdr->lastdata, 80);
128 uniqueid = anti_injection(cdr->uniqueid, 32);
130 get_date(start, sizeof(start), cdr->start);
131 get_date(answer, sizeof(answer), cdr->answer);
132 get_date(end, sizeof(end), cdr->end);
134 ast_mutex_lock(&tds_lock);
136 if (settings->has_userfield) {
137 userfield = anti_injection(cdr->userfield, AST_MAX_USER_FIELD);
141 /* Ensure that we are connected */
142 if (!settings->connected) {
143 ast_log(LOG_NOTICE, "Attempting to reconnect to %s (Attempt %d)\n", settings->hostname, attempt);
144 if (mssql_connect()) {
153 if (settings->has_userfield) {
154 erc = dbfcmd(settings->dbproc,
157 "accountcode, src, dst, dcontext, clid, channel, "
158 "dstchannel, lastapp, lastdata, start, answer, [end], duration, "
159 "billsec, disposition, amaflags, uniqueid, userfield"
163 "'%s', '%s', '%s', '%s', '%s', '%s', "
164 "'%s', '%s', '%s', %s, %s, %s, %ld, "
165 "%ld, '%s', '%s', '%s', '%s'"
168 accountcode, src, dst, dcontext, clid, channel,
169 dstchannel, lastapp, lastdata, start, answer, end, cdr->duration,
170 cdr->billsec, ast_cdr_disp2str(cdr->disposition), ast_cdr_flags2str(cdr->amaflags), uniqueid,
174 erc = dbfcmd(settings->dbproc,
177 "accountcode, src, dst, dcontext, clid, channel, "
178 "dstchannel, lastapp, lastdata, start, answer, [end], duration, "
179 "billsec, disposition, amaflags, uniqueid"
183 "'%s', '%s', '%s', '%s', '%s', '%s', "
184 "'%s', '%s', '%s', %s, %s, %s, %ld, "
185 "%ld, '%s', '%s', '%s'"
188 accountcode, src, dst, dcontext, clid, channel,
189 dstchannel, lastapp, lastdata, start, answer, end, cdr->duration,
190 cdr->billsec, ast_cdr_disp2str(cdr->disposition), ast_cdr_flags2str(cdr->amaflags), uniqueid
196 ast_log(LOG_NOTICE, "Failed to build INSERT statement, retrying...\n");
200 ast_log(LOG_ERROR, "Failed to build INSERT statement, no CDR was logged.\n");
205 if (dbsqlexec(settings->dbproc) == FAIL) {
207 ast_log(LOG_NOTICE, "Failed to execute INSERT statement, retrying...\n");
211 ast_log(LOG_ERROR, "Failed to execute INSERT statement, no CDR was logged.\n");
216 /* Consume any results we might get back (this is more of a sanity check than
217 * anything else, since an INSERT shouldn't return results). */
218 while (dbresults(settings->dbproc) != NO_MORE_RESULTS) {
219 while (dbnextrow(settings->dbproc) != NO_MORE_ROWS);
225 ast_mutex_unlock(&tds_lock);
227 ast_free(accountcode);
233 ast_free(dstchannel);
245 static char *anti_injection(const char *str, int len)
247 /* Reference to http://www.nextgenss.com/papers/advanced_sql_injection.pdf */
249 char *buf_ptr, *srh_ptr;
250 char *known_bad[] = {"select", "insert", "update", "delete", "drop", ";", "--", "\0"};
253 if (!(buf = ast_calloc(1, len + 1))) {
254 ast_log(LOG_ERROR, "Out of memory\n");
260 /* Escape single quotes */
261 for (; *str && strlen(buf) < len; str++) {
269 /* Erase known bad input */
270 for (idx = 0; *known_bad[idx]; idx++) {
271 while ((srh_ptr = strcasestr(buf, known_bad[idx]))) {
272 memmove(srh_ptr, srh_ptr + strlen(known_bad[idx]), strlen(srh_ptr + strlen(known_bad[idx])) + 1);
279 static void get_date(char *dateField, size_t len, struct timeval when)
281 /* To make sure we have date variable if not insert null to SQL */
282 if (!ast_tvzero(when)) {
284 ast_localtime(&when, &tm, NULL);
285 ast_strftime(dateField, len, "'" DATE_FORMAT "'", &tm);
287 ast_copy_string(dateField, "null", len);
291 static int execute_and_consume(DBPROCESS *dbproc, const char *fmt, ...)
297 if (ast_vasprintf(&buffer, fmt, ap) < 0) {
303 if (dbfcmd(dbproc, buffer) == FAIL) {
310 if (dbsqlexec(dbproc) == FAIL) {
314 /* Consume the result set (we don't really care about the result, though) */
315 while (dbresults(dbproc) != NO_MORE_RESULTS) {
316 while (dbnextrow(dbproc) != NO_MORE_ROWS);
322 static int mssql_disconnect(void)
324 if (settings->dbproc) {
325 dbclose(settings->dbproc);
326 settings->dbproc = NULL;
329 settings->connected = 0;
334 static int mssql_connect(void)
338 if ((login = dblogin()) == NULL) {
339 ast_log(LOG_ERROR, "Unable to allocate login structure for db-lib\n");
343 DBSETLAPP(login, "TSQL");
344 DBSETLUSER(login, (char *) settings->username);
345 DBSETLPWD(login, (char *) settings->password);
346 DBSETLCHARSET(login, (char *) settings->charset);
347 DBSETLNATLANG(login, (char *) settings->language);
349 if ((settings->dbproc = dbopen(login, (char *) settings->hostname)) == NULL) {
350 ast_log(LOG_ERROR, "Unable to connect to %s\n", settings->hostname);
357 if (dbuse(settings->dbproc, (char *) settings->database) == FAIL) {
358 ast_log(LOG_ERROR, "Unable to select database %s\n", settings->database);
362 if (execute_and_consume(settings->dbproc, "SELECT 1 FROM [%s]", settings->table)) {
363 ast_log(LOG_ERROR, "Unable to find table '%s'\n", settings->table);
367 /* Check to see if we have a userfield column in the table */
368 if (execute_and_consume(settings->dbproc, "SELECT userfield FROM [%s] WHERE 1 = 0", settings->table)) {
369 ast_log(LOG_NOTICE, "Unable to find 'userfield' column in table '%s'\n", settings->table);
370 settings->has_userfield = 0;
372 settings->has_userfield = 1;
375 settings->connected = 1;
380 dbclose(settings->dbproc);
381 settings->dbproc = NULL;
385 static int tds_unload_module(void)
388 ast_mutex_lock(&tds_lock);
390 ast_mutex_unlock(&tds_lock);
392 ast_string_field_free_memory(settings);
396 ast_cdr_unregister(name);
403 static int tds_error_handler(DBPROCESS *dbproc, int severity, int dberr, int oserr, char *dberrstr, char *oserrstr)
405 ast_log(LOG_ERROR, "%s (%d)\n", dberrstr, dberr);
407 if (oserr != DBNOERR) {
408 ast_log(LOG_ERROR, "%s (%d)\n", oserrstr, oserr);
414 static int tds_message_handler(DBPROCESS *dbproc, DBINT msgno, int msgstate, int severity, char *msgtext, char *srvname, char *procname, int line)
416 ast_debug(1, "Msg %d, Level %d, State %d, Line %d\n", msgno, severity, msgstate, line);
417 ast_log(LOG_NOTICE, "%s\n", msgtext);
422 static int tds_load_module(int reload)
424 struct ast_config *cfg;
425 const char *ptr = NULL;
426 struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
428 cfg = ast_config_load(config, config_flags);
430 ast_log(LOG_NOTICE, "Unable to load TDS config for CDRs: %s\n", config);
432 } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
435 if (!ast_variable_browse(cfg, "global")) {
436 /* nothing configured */
437 ast_config_destroy(cfg);
441 ast_mutex_lock(&tds_lock);
443 /* Clear out any existing settings */
444 ast_string_field_init(settings, 0);
446 ptr = ast_variable_retrieve(cfg, "global", "hostname");
448 ast_string_field_set(settings, hostname, ptr);
450 ast_log(LOG_ERROR, "Failed to connect: Database server hostname not specified.\n");
454 ptr = ast_variable_retrieve(cfg, "global", "dbname");
456 ast_string_field_set(settings, database, ptr);
458 ast_log(LOG_ERROR, "Failed to connect: Database dbname not specified.\n");
462 ptr = ast_variable_retrieve(cfg, "global", "user");
464 ast_string_field_set(settings, username, ptr);
466 ast_log(LOG_ERROR, "Failed to connect: Database dbuser not specified.\n");
470 ptr = ast_variable_retrieve(cfg, "global", "password");
472 ast_string_field_set(settings, password, ptr);
474 ast_log(LOG_ERROR, "Failed to connect: Database password not specified.\n");
478 ptr = ast_variable_retrieve(cfg, "global", "charset");
480 ast_string_field_set(settings, charset, ptr);
482 ast_string_field_set(settings, charset, "iso_1");
485 ptr = ast_variable_retrieve(cfg, "global", "language");
487 ast_string_field_set(settings, language, ptr);
489 ast_string_field_set(settings, language, "us_english");
492 ptr = ast_variable_retrieve(cfg, "global", "table");
494 ast_string_field_set(settings, table, ptr);
496 ast_log(LOG_NOTICE, "Table name not specified, using 'cdr' by default.\n");
497 ast_string_field_set(settings, table, "cdr");
502 if (mssql_connect()) {
503 /* We failed to connect (mssql_connect takes care of logging it) */
507 ast_mutex_unlock(&tds_lock);
508 ast_config_destroy(cfg);
513 ast_mutex_unlock(&tds_lock);
514 ast_config_destroy(cfg);
519 static int reload(void)
521 return tds_load_module(1);
524 static int load_module(void)
526 if (dbinit() == FAIL) {
527 ast_log(LOG_ERROR, "Failed to initialize FreeTDS db-lib\n");
528 return AST_MODULE_LOAD_DECLINE;
531 dberrhandle(tds_error_handler);
532 dbmsghandle(tds_message_handler);
534 settings = ast_calloc(1, sizeof(*settings));
536 if (!settings || ast_string_field_init(settings, 256)) {
542 return AST_MODULE_LOAD_DECLINE;
545 if (!tds_load_module(0)) {
546 ast_string_field_free_memory(settings);
550 return AST_MODULE_LOAD_DECLINE;
553 ast_cdr_register(name, ast_module_info->description, tds_log);
555 return AST_MODULE_LOAD_SUCCESS;
558 static int unload_module(void)
560 return tds_unload_module();
563 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "FreeTDS CDR Backend",
565 .unload = unload_module,