logging: Remove/fix some message annoyances
[asterisk/asterisk.git] / res / res_odbc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2012, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * res_odbc.c <ODBC resource manager>
9  * Copyright (C) 2004 - 2005 Anthony Minessale II <anthmct@yahoo.com>
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief ODBC resource manager
25  * 
26  * \author Mark Spencer <markster@digium.com>
27  * \author Anthony Minessale II <anthmct@yahoo.com>
28  * \author Tilghman Lesher <tilghman@digium.com>
29  *
30  * \arg See also: \ref cdr_odbc
31  */
32
33 /*! \li \ref res_odbc.c uses the configuration file \ref res_odbc.conf
34  * \addtogroup configuration_file Configuration Files
35  */
36
37 /*! 
38  * \page res_odbc.conf res_odbc.conf
39  * \verbinclude res_odbc.conf.sample
40  */
41
42 /*** MODULEINFO
43         <depend>generic_odbc</depend>
44         <depend>ltdl</depend>
45         <support_level>core</support_level>
46  ***/
47
48 #include "asterisk.h"
49
50 ASTERISK_REGISTER_FILE()
51
52 #include "asterisk/file.h"
53 #include "asterisk/channel.h"
54 #include "asterisk/config.h"
55 #include "asterisk/pbx.h"
56 #include "asterisk/module.h"
57 #include "asterisk/cli.h"
58 #include "asterisk/lock.h"
59 #include "asterisk/res_odbc.h"
60 #include "asterisk/time.h"
61 #include "asterisk/astobj2.h"
62 #include "asterisk/app.h"
63 #include "asterisk/strings.h"
64 #include "asterisk/threadstorage.h"
65 #include "asterisk/data.h"
66
67 struct odbc_class
68 {
69         AST_LIST_ENTRY(odbc_class) list;
70         char name[80];
71         char dsn[80];
72         char *username;
73         char *password;
74         char *sanitysql;
75         SQLHENV env;
76         unsigned int delme:1;                /*!< Purge the class */
77         unsigned int backslash_is_escape:1;  /*!< On this database, the backslash is a native escape sequence */
78         unsigned int forcecommit:1;          /*!< Should uncommitted transactions be auto-committed on handle release? */
79         unsigned int isolation;              /*!< Flags for how the DB should deal with data in other, uncommitted transactions */
80         unsigned int conntimeout;            /*!< Maximum time the connection process should take */
81         /*! When a connection fails, cache that failure for how long? */
82         struct timeval negative_connection_cache;
83         /*! When a connection fails, when did that last occur? */
84         struct timeval last_negative_connect;
85 };
86
87 static struct ao2_container *class_container;
88
89 static AST_RWLIST_HEAD_STATIC(odbc_tables, odbc_cache_tables);
90
91 static odbc_status odbc_obj_connect(struct odbc_obj *obj);
92 static odbc_status odbc_obj_disconnect(struct odbc_obj *obj);
93 static int odbc_register_class(struct odbc_class *class, int connect);
94
95 AST_THREADSTORAGE(errors_buf);
96
97 struct odbc_txn_frame {
98         AST_LIST_ENTRY(odbc_txn_frame) list;
99         struct ast_channel *owner;
100         struct odbc_obj *obj;        /*!< Database handle within which transacted statements are run */
101         /*!\brief Is this record the current active transaction within the channel?
102          * Note that the active flag is really only necessary for statements which
103          * are triggered from the dialplan, as there isn't a direct correlation
104          * between multiple statements.  Applications wishing to use transactions
105          * may simply perform each statement on the same odbc_obj, which keeps the
106          * transaction persistent.
107          */
108         unsigned int active:1;
109         unsigned int forcecommit:1;     /*!< Should uncommitted transactions be auto-committed on handle release? */
110         unsigned int isolation;         /*!< Flags for how the DB should deal with data in other, uncommitted transactions */
111         char name[0];                   /*!< Name of this transaction ID */
112 };
113
114 #define DATA_EXPORT_ODBC_CLASS(MEMBER)                          \
115         MEMBER(odbc_class, name, AST_DATA_STRING)               \
116         MEMBER(odbc_class, dsn, AST_DATA_STRING)                \
117         MEMBER(odbc_class, username, AST_DATA_STRING)           \
118         MEMBER(odbc_class, password, AST_DATA_PASSWORD)         \
119         MEMBER(odbc_class, forcecommit, AST_DATA_BOOLEAN)
120
121 AST_DATA_STRUCTURE(odbc_class, DATA_EXPORT_ODBC_CLASS);
122
123 const char *ast_odbc_isolation2text(int iso)
124 {
125         if (iso == SQL_TXN_READ_COMMITTED) {
126                 return "read_committed";
127         } else if (iso == SQL_TXN_READ_UNCOMMITTED) {
128                 return "read_uncommitted";
129         } else if (iso == SQL_TXN_SERIALIZABLE) {
130                 return "serializable";
131         } else if (iso == SQL_TXN_REPEATABLE_READ) {
132                 return "repeatable_read";
133         } else {
134                 return "unknown";
135         }
136 }
137
138 int ast_odbc_text2isolation(const char *txt)
139 {
140         if (strncasecmp(txt, "read_", 5) == 0) {
141                 if (strncasecmp(txt + 5, "c", 1) == 0) {
142                         return SQL_TXN_READ_COMMITTED;
143                 } else if (strncasecmp(txt + 5, "u", 1) == 0) {
144                         return SQL_TXN_READ_UNCOMMITTED;
145                 } else {
146                         return 0;
147                 }
148         } else if (strncasecmp(txt, "ser", 3) == 0) {
149                 return SQL_TXN_SERIALIZABLE;
150         } else if (strncasecmp(txt, "rep", 3) == 0) {
151                 return SQL_TXN_REPEATABLE_READ;
152         } else {
153                 return 0;
154         }
155 }
156
157 static void odbc_class_destructor(void *data)
158 {
159         struct odbc_class *class = data;
160         /* Due to refcounts, we can safely assume that any objects with a reference
161          * to us will prevent our destruction, so we don't need to worry about them.
162          */
163         if (class->username) {
164                 ast_free(class->username);
165         }
166         if (class->password) {
167                 ast_free(class->password);
168         }
169         if (class->sanitysql) {
170                 ast_free(class->sanitysql);
171         }
172         SQLFreeHandle(SQL_HANDLE_ENV, class->env);
173 }
174
175 static int null_hash_fn(const void *obj, const int flags)
176 {
177         return 0;
178 }
179
180 static void odbc_obj_destructor(void *data)
181 {
182         struct odbc_obj *obj = data;
183         struct odbc_class *class = obj->parent;
184         obj->parent = NULL;
185         odbc_obj_disconnect(obj);
186         ao2_ref(class, -1);
187 }
188
189 static void destroy_table_cache(struct odbc_cache_tables *table) {
190         struct odbc_cache_columns *col;
191         ast_debug(1, "Destroying table cache for %s\n", table->table);
192         AST_RWLIST_WRLOCK(&table->columns);
193         while ((col = AST_RWLIST_REMOVE_HEAD(&table->columns, list))) {
194                 ast_free(col);
195         }
196         AST_RWLIST_UNLOCK(&table->columns);
197         AST_RWLIST_HEAD_DESTROY(&table->columns);
198         ast_free(table);
199 }
200
201 /*!
202  * \brief Find or create an entry describing the table specified.
203  * \param database Name of an ODBC class on which to query the table
204  * \param tablename Tablename to describe
205  * \retval A structure describing the table layout, or NULL, if the table is not found or another error occurs.
206  * When a structure is returned, the contained columns list will be
207  * rdlock'ed, to ensure that it will be retained in memory.
208  *
209  * XXX This creates a connection and disconnects it. In some situations, the caller of
210  * this function has its own connection and could donate it to this function instead of
211  * needing to create another one.
212  *
213  * XXX The automatic readlock of the columns is awkward. It's done because it's possible for
214  * multiple threads to have references to the table, and the table is not refcounted. Possible
215  * changes here would be
216  * * Eliminate the table cache entirely. The use of ast_odbc_find_table() is generally
217  *   questionable. The only real good use right now is from ast_realtime_require_field() in
218  *   order to make sure the DB has the expected columns in it. Since that is only used sparingly,
219  *   the need to cache tables is questionable. Instead, the table structure can be fetched from
220  *   the DB directly each time, resulting in a single owner of the data.
221  * * Make odbc_cache_tables a refcounted object.
222  *
223  * \since 1.6.1
224  */
225 struct odbc_cache_tables *ast_odbc_find_table(const char *database, const char *tablename)
226 {
227         struct odbc_cache_tables *tableptr;
228         struct odbc_cache_columns *entry;
229         char columnname[80];
230         SQLLEN sqlptr;
231         SQLHSTMT stmt = NULL;
232         int res = 0, error = 0;
233         struct odbc_obj *obj;
234
235         AST_RWLIST_RDLOCK(&odbc_tables);
236         AST_RWLIST_TRAVERSE(&odbc_tables, tableptr, list) {
237                 if (strcmp(tableptr->connection, database) == 0 && strcmp(tableptr->table, tablename) == 0) {
238                         break;
239                 }
240         }
241         if (tableptr) {
242                 AST_RWLIST_RDLOCK(&tableptr->columns);
243                 AST_RWLIST_UNLOCK(&odbc_tables);
244                 return tableptr;
245         }
246
247         if (!(obj = ast_odbc_request_obj(database, 0))) {
248                 ast_log(LOG_WARNING, "Unable to retrieve database handle for table description '%s@%s'\n", tablename, database);
249                 AST_RWLIST_UNLOCK(&odbc_tables);
250                 return NULL;
251         }
252
253         /* Table structure not already cached; build it now. */
254         do {
255                 res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
256                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
257                         ast_log(LOG_WARNING, "SQL Alloc Handle failed on connection '%s'!\n", database);
258                         break;
259                 }
260
261                 res = SQLColumns(stmt, NULL, 0, NULL, 0, (unsigned char *)tablename, SQL_NTS, (unsigned char *)"%", SQL_NTS);
262                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
263                         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
264                         ast_log(LOG_ERROR, "Unable to query database columns on connection '%s'.\n", database);
265                         break;
266                 }
267
268                 if (!(tableptr = ast_calloc(sizeof(char), sizeof(*tableptr) + strlen(database) + 1 + strlen(tablename) + 1))) {
269                         ast_log(LOG_ERROR, "Out of memory creating entry for table '%s' on connection '%s'\n", tablename, database);
270                         break;
271                 }
272
273                 tableptr->connection = (char *)tableptr + sizeof(*tableptr);
274                 tableptr->table = (char *)tableptr + sizeof(*tableptr) + strlen(database) + 1;
275                 strcpy(tableptr->connection, database); /* SAFE */
276                 strcpy(tableptr->table, tablename); /* SAFE */
277                 AST_RWLIST_HEAD_INIT(&(tableptr->columns));
278
279                 while ((res = SQLFetch(stmt)) != SQL_NO_DATA && res != SQL_ERROR) {
280                         SQLGetData(stmt,  4, SQL_C_CHAR, columnname, sizeof(columnname), &sqlptr);
281
282                         if (!(entry = ast_calloc(sizeof(char), sizeof(*entry) + strlen(columnname) + 1))) {
283                                 ast_log(LOG_ERROR, "Out of memory creating entry for column '%s' in table '%s' on connection '%s'\n", columnname, tablename, database);
284                                 error = 1;
285                                 break;
286                         }
287                         entry->name = (char *)entry + sizeof(*entry);
288                         strcpy(entry->name, columnname);
289
290                         SQLGetData(stmt,  5, SQL_C_SHORT, &entry->type, sizeof(entry->type), NULL);
291                         SQLGetData(stmt,  7, SQL_C_LONG, &entry->size, sizeof(entry->size), NULL);
292                         SQLGetData(stmt,  9, SQL_C_SHORT, &entry->decimals, sizeof(entry->decimals), NULL);
293                         SQLGetData(stmt, 10, SQL_C_SHORT, &entry->radix, sizeof(entry->radix), NULL);
294                         SQLGetData(stmt, 11, SQL_C_SHORT, &entry->nullable, sizeof(entry->nullable), NULL);
295                         SQLGetData(stmt, 16, SQL_C_LONG, &entry->octetlen, sizeof(entry->octetlen), NULL);
296
297                         /* Specification states that the octenlen should be the maximum number of bytes
298                          * returned in a char or binary column, but it seems that some drivers just set
299                          * it to NULL. (Bad Postgres! No biscuit!) */
300                         if (entry->octetlen == 0) {
301                                 entry->octetlen = entry->size;
302                         }
303
304                         ast_debug(3, "Found %s column with type %hd with len %ld, octetlen %ld, and numlen (%hd,%hd)\n", entry->name, entry->type, (long) entry->size, (long) entry->octetlen, entry->decimals, entry->radix);
305                         /* Insert column info into column list */
306                         AST_LIST_INSERT_TAIL(&(tableptr->columns), entry, list);
307                 }
308                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
309
310                 AST_RWLIST_INSERT_TAIL(&odbc_tables, tableptr, list);
311                 AST_RWLIST_RDLOCK(&(tableptr->columns));
312                 break;
313         } while (1);
314
315         AST_RWLIST_UNLOCK(&odbc_tables);
316
317         if (error) {
318                 destroy_table_cache(tableptr);
319                 tableptr = NULL;
320         }
321         ast_odbc_release_obj(obj);
322         return tableptr;
323 }
324
325 struct odbc_cache_columns *ast_odbc_find_column(struct odbc_cache_tables *table, const char *colname)
326 {
327         struct odbc_cache_columns *col;
328         AST_RWLIST_TRAVERSE(&table->columns, col, list) {
329                 if (strcasecmp(col->name, colname) == 0) {
330                         return col;
331                 }
332         }
333         return NULL;
334 }
335
336 int ast_odbc_clear_cache(const char *database, const char *tablename)
337 {
338         struct odbc_cache_tables *tableptr;
339
340         AST_RWLIST_WRLOCK(&odbc_tables);
341         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&odbc_tables, tableptr, list) {
342                 if (strcmp(tableptr->connection, database) == 0 && strcmp(tableptr->table, tablename) == 0) {
343                         AST_LIST_REMOVE_CURRENT(list);
344                         destroy_table_cache(tableptr);
345                         break;
346                 }
347         }
348         AST_RWLIST_TRAVERSE_SAFE_END
349         AST_RWLIST_UNLOCK(&odbc_tables);
350         return tableptr ? 0 : -1;
351 }
352
353 SQLHSTMT ast_odbc_direct_execute(struct odbc_obj *obj, SQLHSTMT (*exec_cb)(struct odbc_obj *obj, void *data), void *data)
354 {
355         SQLHSTMT stmt;
356
357         stmt = exec_cb(obj, data);
358
359         return stmt;
360 }
361
362 SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_cb)(struct odbc_obj *obj, void *data), void *data)
363 {
364         int res = 0;
365         SQLHSTMT stmt;
366
367         /* This prepare callback may do more than just prepare -- it may also
368          * bind parameters, bind results, etc.  The real key, here, is that
369          * when we disconnect, all handles become invalid for most databases.
370          * We must therefore redo everything when we establish a new
371          * connection. */
372         stmt = prepare_cb(obj, data);
373
374         if (stmt) {
375                 res = SQLExecute(stmt);
376                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO) && (res != SQL_NO_DATA)) {
377                         if (res == SQL_ERROR) {
378                                 ast_odbc_print_errors(SQL_HANDLE_STMT, stmt, "SQL Execute");
379                         }
380
381                         ast_log(LOG_WARNING, "SQL Execute error %d!\n", res);
382                         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
383                         stmt = NULL;
384                 }
385         }
386
387         return stmt;
388 }
389
390 int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt)
391 {
392         int res = 0;
393
394         res = SQLExecute(stmt);
395         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO) && (res != SQL_NO_DATA)) {
396                 if (res == SQL_ERROR) {
397                         ast_odbc_print_errors(SQL_HANDLE_STMT, stmt, "SQL Execute");
398                 }
399         }
400
401         return res;
402 }
403
404 SQLRETURN ast_odbc_ast_str_SQLGetData(struct ast_str **buf, int pmaxlen, SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLSMALLINT TargetType, SQLLEN *StrLen_or_Ind)
405 {
406         SQLRETURN res;
407
408         if (pmaxlen == 0) {
409                 if (SQLGetData(StatementHandle, ColumnNumber, TargetType, ast_str_buffer(*buf), 0, StrLen_or_Ind) == SQL_SUCCESS_WITH_INFO) {
410                         ast_str_make_space(buf, *StrLen_or_Ind + 1);
411                 }
412         } else if (pmaxlen > 0) {
413                 ast_str_make_space(buf, pmaxlen);
414         }
415         res = SQLGetData(StatementHandle, ColumnNumber, TargetType, ast_str_buffer(*buf), ast_str_size(*buf), StrLen_or_Ind);
416         ast_str_update(*buf);
417
418         return res;
419 }
420
421 struct ast_str *ast_odbc_print_errors(SQLSMALLINT handle_type, SQLHANDLE handle, const char *operation)
422 {
423         struct ast_str *errors = ast_str_thread_get(&errors_buf, 16);
424         SQLINTEGER nativeerror = 0;
425         SQLINTEGER numfields = 0;
426         SQLSMALLINT diagbytes = 0;
427         SQLSMALLINT i;
428         unsigned char state[10];
429         unsigned char diagnostic[256];
430
431         ast_str_reset(errors);
432         SQLGetDiagField(handle_type, handle, 1, SQL_DIAG_NUMBER, &numfields,
433                         SQL_IS_INTEGER, &diagbytes);
434         for (i = 0; i < numfields; i++) {
435                 SQLGetDiagRec(handle_type, handle, i + 1, state, &nativeerror,
436                                 diagnostic, sizeof(diagnostic), &diagbytes);
437                 ast_str_append(&errors, 0, "%s%s", ast_str_strlen(errors) ? "," : "", state);
438                 ast_log(LOG_WARNING, "%s returned an error: %s: %s\n", operation, state, diagnostic);
439                 /* XXX Why is this here? */
440                 if (i > 10) {
441                         ast_log(LOG_WARNING, "Oh, that was good.  There are really %d diagnostics?\n", (int)numfields);
442                         break;
443                 }
444         }
445
446         return errors;
447 }
448
449 unsigned int ast_odbc_class_get_isolation(struct odbc_class *class)
450 {
451         return class->isolation;
452 }
453
454 unsigned int ast_odbc_class_get_forcecommit(struct odbc_class *class)
455 {
456         return class->forcecommit;
457 }
458
459 const char *ast_odbc_class_get_name(struct odbc_class *class)
460 {
461         return class->name;
462 }
463
464 static int load_odbc_config(void)
465 {
466         static char *cfg = "res_odbc.conf";
467         struct ast_config *config;
468         struct ast_variable *v;
469         char *cat;
470         const char *dsn, *username, *password, *sanitysql;
471         int enabled, bse, conntimeout, forcecommit, isolation;
472         struct timeval ncache = { 0, 0 };
473         int preconnect = 0, res = 0;
474         struct ast_flags config_flags = { 0 };
475
476         struct odbc_class *new;
477
478         config = ast_config_load(cfg, config_flags);
479         if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
480                 ast_log(LOG_WARNING, "Unable to load config file res_odbc.conf\n");
481                 return -1;
482         }
483         for (cat = ast_category_browse(config, NULL); cat; cat=ast_category_browse(config, cat)) {
484                 if (!strcasecmp(cat, "ENV")) {
485                         for (v = ast_variable_browse(config, cat); v; v = v->next) {
486                                 setenv(v->name, v->value, 1);
487                                 ast_log(LOG_NOTICE, "Adding ENV var: %s=%s\n", v->name, v->value);
488                         }
489                 } else {
490                         /* Reset all to defaults for each class of odbc connections */
491                         dsn = username = password = sanitysql = NULL;
492                         enabled = 1;
493                         preconnect = 0;
494                         bse = 1;
495                         conntimeout = 10;
496                         forcecommit = 0;
497                         isolation = SQL_TXN_READ_COMMITTED;
498                         for (v = ast_variable_browse(config, cat); v; v = v->next) {
499                                 if (!strcasecmp(v->name, "pooling") ||
500                                                 !strncasecmp(v->name, "share", 5) ||
501                                                 !strcasecmp(v->name, "limit") ||
502                                                 !strcasecmp(v->name, "idlecheck")) {
503                                         ast_log(LOG_WARNING, "The 'pooling', 'shared_connections', 'limit', and 'idlecheck' options are deprecated. Please see UPGRADE.txt for information\n");
504                                 } else if (!strcasecmp(v->name, "enabled")) {
505                                         enabled = ast_true(v->value);
506                                 } else if (!strcasecmp(v->name, "pre-connect")) {
507                                         preconnect = ast_true(v->value);
508                                 } else if (!strcasecmp(v->name, "dsn")) {
509                                         dsn = v->value;
510                                 } else if (!strcasecmp(v->name, "username")) {
511                                         username = v->value;
512                                 } else if (!strcasecmp(v->name, "password")) {
513                                         password = v->value;
514                                 } else if (!strcasecmp(v->name, "sanitysql")) {
515                                         sanitysql = v->value;
516                                 } else if (!strcasecmp(v->name, "backslash_is_escape")) {
517                                         bse = ast_true(v->value);
518                                 } else if (!strcasecmp(v->name, "connect_timeout")) {
519                                         if (sscanf(v->value, "%d", &conntimeout) != 1 || conntimeout < 1) {
520                                                 ast_log(LOG_WARNING, "connect_timeout must be a positive integer\n");
521                                                 conntimeout = 10;
522                                         }
523                                 } else if (!strcasecmp(v->name, "negative_connection_cache")) {
524                                         double dncache;
525                                         if (sscanf(v->value, "%lf", &dncache) != 1 || dncache < 0) {
526                                                 ast_log(LOG_WARNING, "negative_connection_cache must be a non-negative integer\n");
527                                                 /* 5 minutes sounds like a reasonable default */
528                                                 ncache.tv_sec = 300;
529                                                 ncache.tv_usec = 0;
530                                         } else {
531                                                 ncache.tv_sec = (int)dncache;
532                                                 ncache.tv_usec = (dncache - ncache.tv_sec) * 1000000;
533                                         }
534                                 } else if (!strcasecmp(v->name, "forcecommit")) {
535                                         forcecommit = ast_true(v->value);
536                                 } else if (!strcasecmp(v->name, "isolation")) {
537                                         if ((isolation = ast_odbc_text2isolation(v->value)) == 0) {
538                                                 ast_log(LOG_ERROR, "Unrecognized value for 'isolation': '%s' in section '%s'\n", v->value, cat);
539                                                 isolation = SQL_TXN_READ_COMMITTED;
540                                         }
541                                 }
542                         }
543
544                         if (enabled && !ast_strlen_zero(dsn)) {
545                                 new = ao2_alloc(sizeof(*new), odbc_class_destructor);
546
547                                 if (!new) {
548                                         res = -1;
549                                         break;
550                                 }
551
552                                 SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &new->env);
553                                 res = SQLSetEnvAttr(new->env, SQL_ATTR_ODBC_VERSION, (void *) SQL_OV_ODBC3, 0);
554
555                                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
556                                         ast_log(LOG_WARNING, "res_odbc: Error SetEnv\n");
557                                         ao2_ref(new, -1);
558                                         return res;
559                                 }
560
561                                 new->backslash_is_escape = bse ? 1 : 0;
562                                 new->forcecommit = forcecommit ? 1 : 0;
563                                 new->isolation = isolation;
564                                 new->conntimeout = conntimeout;
565                                 new->negative_connection_cache = ncache;
566
567                                 if (cat)
568                                         ast_copy_string(new->name, cat, sizeof(new->name));
569                                 if (dsn)
570                                         ast_copy_string(new->dsn, dsn, sizeof(new->dsn));
571                                 if (username && !(new->username = ast_strdup(username))) {
572                                         ao2_ref(new, -1);
573                                         break;
574                                 }
575                                 if (password && !(new->password = ast_strdup(password))) {
576                                         ao2_ref(new, -1);
577                                         break;
578                                 }
579                                 if (sanitysql && !(new->sanitysql = ast_strdup(sanitysql))) {
580                                         ao2_ref(new, -1);
581                                         break;
582                                 }
583
584                                 odbc_register_class(new, preconnect);
585                                 ast_log(LOG_NOTICE, "Registered ODBC class '%s' dsn->[%s]\n", cat, dsn);
586                                 ao2_ref(new, -1);
587                                 new = NULL;
588                         }
589                 }
590         }
591         ast_config_destroy(config);
592         return res;
593 }
594
595 static char *handle_cli_odbc_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
596 {
597         struct ao2_iterator aoi;
598         struct odbc_class *class;
599         int length = 0;
600         int which = 0;
601         char *ret = NULL;
602
603         switch (cmd) {
604         case CLI_INIT:
605                 e->command = "odbc show";
606                 e->usage =
607                                 "Usage: odbc show [class]\n"
608                                 "       List settings of a particular ODBC class or,\n"
609                                 "       if not specified, all classes.\n";
610                 return NULL;
611         case CLI_GENERATE:
612                 if (a->pos != 2)
613                         return NULL;
614                 length = strlen(a->word);
615                 aoi = ao2_iterator_init(class_container, 0);
616                 while ((class = ao2_iterator_next(&aoi))) {
617                         if (!strncasecmp(a->word, class->name, length) && ++which > a->n) {
618                                 ret = ast_strdup(class->name);
619                         }
620                         ao2_ref(class, -1);
621                         if (ret) {
622                                 break;
623                         }
624                 }
625                 ao2_iterator_destroy(&aoi);
626                 if (!ret && !strncasecmp(a->word, "all", length) && ++which > a->n) {
627                         ret = ast_strdup("all");
628                 }
629                 return ret;
630         }
631
632         ast_cli(a->fd, "\nODBC DSN Settings\n");
633         ast_cli(a->fd,   "-----------------\n\n");
634         aoi = ao2_iterator_init(class_container, 0);
635         while ((class = ao2_iterator_next(&aoi))) {
636                 if ((a->argc == 2) || (a->argc == 3 && !strcmp(a->argv[2], "all")) || (!strcmp(a->argv[2], class->name))) {
637                         char timestr[80];
638                         struct ast_tm tm;
639
640                         ast_localtime(&class->last_negative_connect, &tm, NULL);
641                         ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %T", &tm);
642                         ast_cli(a->fd, "  Name:   %s\n  DSN:    %s\n", class->name, class->dsn);
643                         ast_cli(a->fd, "    Last connection attempt: %s\n", timestr);
644                         ast_cli(a->fd, "\n");
645                 }
646                 ao2_ref(class, -1);
647         }
648         ao2_iterator_destroy(&aoi);
649
650         return CLI_SUCCESS;
651 }
652
653 static struct ast_cli_entry cli_odbc[] = {
654         AST_CLI_DEFINE(handle_cli_odbc_show, "List ODBC DSN(s)")
655 };
656
657 static int odbc_register_class(struct odbc_class *class, int preconnect)
658 {
659         struct odbc_obj *obj;
660         if (class) {
661                 ao2_link(class_container, class);
662                 /* I still have a reference in the caller, so a deref is NOT missing here. */
663
664                 if (preconnect) {
665                         /* Request and release builds a connection */
666                         obj = ast_odbc_request_obj(class->name, 0);
667                         if (obj) {
668                                 ast_odbc_release_obj(obj);
669                         }
670                 }
671
672                 return 0;
673         } else {
674                 ast_log(LOG_WARNING, "Attempted to register a NULL class?\n");
675                 return -1;
676         }
677 }
678
679 void ast_odbc_release_obj(struct odbc_obj *obj)
680 {
681         ast_debug(2, "Releasing ODBC handle %p\n", obj);
682
683 #ifdef DEBUG_THREADS
684         obj->file[0] = '\0';
685         obj->function[0] = '\0';
686         obj->lineno = 0;
687 #endif
688         ao2_ref(obj, -1);
689 }
690
691 int ast_odbc_backslash_is_escape(struct odbc_obj *obj)
692 {
693         return obj->parent->backslash_is_escape;
694 }
695
696 static int aoro2_class_cb(void *obj, void *arg, int flags)
697 {
698         struct odbc_class *class = obj;
699         char *name = arg;
700         if (!strcmp(class->name, name) && !class->delme) {
701                 return CMP_MATCH | CMP_STOP;
702         }
703         return 0;
704 }
705
706 struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags, const char *file, const char *function, int lineno)
707 {
708         struct odbc_obj *obj = NULL;
709         struct odbc_class *class;
710
711         if (!(class = ao2_callback(class_container, 0, aoro2_class_cb, (char *) name))) {
712                 ast_debug(1, "Class '%s' not found!\n", name);
713                 return NULL;
714         }
715
716         /* XXX ODBC connection objects do not have shared ownership, so there is no reason
717          * to use refcounted objects here.
718          */
719         obj = ao2_alloc(sizeof(*obj), odbc_obj_destructor);
720         /* Inherit reference from the ao2_callback from before */
721         obj->parent = class;
722         if (odbc_obj_connect(obj) == ODBC_FAIL) {
723                 ao2_ref(obj, -1);
724                 return NULL;
725         }
726
727         return obj;
728 }
729
730 struct odbc_obj *_ast_odbc_request_obj(const char *name, int check, const char *file, const char *function, int lineno)
731 {
732         struct ast_flags flags = { check ? RES_ODBC_SANITY_CHECK : 0 };
733         /* XXX New flow means that the "check" parameter doesn't do anything. We're requesting
734          * a connection from ODBC. We'll either get a new one, which obviously is already connected, or
735          * we'll get one from the ODBC connection pool. In that case, it will ensure to only give us a
736          * live connection
737          */
738         return _ast_odbc_request_obj2(name, flags, file, function, lineno);
739 }
740
741 static odbc_status odbc_obj_disconnect(struct odbc_obj *obj)
742 {
743         int res;
744         SQLINTEGER err;
745         short int mlen;
746         unsigned char msg[200], state[10];
747         SQLHDBC con;
748
749         /* Nothing to disconnect */
750         if (!obj->con) {
751                 return ODBC_SUCCESS;
752         }
753
754         con = obj->con;
755         obj->con = NULL;
756         res = SQLDisconnect(con);
757
758         if (obj->parent) {
759                 if (res == SQL_SUCCESS || res == SQL_SUCCESS_WITH_INFO) {
760                         ast_debug(3, "Disconnected %d from %s [%s](%p)\n", res, obj->parent->name, obj->parent->dsn, obj);
761                 } else {
762                         ast_debug(3, "res_odbc: %s [%s](%p) already disconnected\n", obj->parent->name, obj->parent->dsn, obj);
763                 }
764         }
765
766         if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con)) == SQL_SUCCESS) {
767                 ast_debug(3, "Database handle %p (connection %p) deallocated\n", obj, con);
768         } else {
769                 SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
770                 ast_log(LOG_WARNING, "Unable to deallocate database handle %p? %d errno=%d %s\n", con, res, (int)err, msg);
771         }
772
773         return ODBC_SUCCESS;
774 }
775
776 static odbc_status odbc_obj_connect(struct odbc_obj *obj)
777 {
778         int res;
779         SQLINTEGER err;
780         short int mlen;
781         unsigned char msg[200], state[10];
782 #ifdef NEEDTRACE
783         SQLINTEGER enable = 1;
784         char *tracefile = "/tmp/odbc.trace";
785 #endif
786         SQLHDBC con;
787         long int negative_cache_expiration;
788
789         ast_assert(obj->con == NULL);
790         ast_debug(3, "Connecting %s(%p)\n", obj->parent->name, obj);
791
792         /* Dont connect while server is marked as unreachable via negative_connection_cache */
793         negative_cache_expiration = obj->parent->last_negative_connect.tv_sec + obj->parent->negative_connection_cache.tv_sec;
794         if (time(NULL) < negative_cache_expiration) {
795                 ast_log(LOG_WARNING, "Not connecting to %s. Negative connection cache for %ld seconds\n", obj->parent->name, negative_cache_expiration - time(NULL));
796                 return ODBC_FAIL;
797         }
798
799         res = SQLAllocHandle(SQL_HANDLE_DBC, obj->parent->env, &con);
800
801         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
802                 ast_log(LOG_WARNING, "res_odbc: Error AllocHDB %d\n", res);
803                 obj->parent->last_negative_connect = ast_tvnow();
804                 return ODBC_FAIL;
805         }
806         SQLSetConnectAttr(con, SQL_LOGIN_TIMEOUT, (SQLPOINTER *)(long) obj->parent->conntimeout, 0);
807         SQLSetConnectAttr(con, SQL_ATTR_CONNECTION_TIMEOUT, (SQLPOINTER *)(long) obj->parent->conntimeout, 0);
808 #ifdef NEEDTRACE
809         SQLSetConnectAttr(con, SQL_ATTR_TRACE, &enable, SQL_IS_INTEGER);
810         SQLSetConnectAttr(con, SQL_ATTR_TRACEFILE, tracefile, strlen(tracefile));
811 #endif
812
813         res = SQLConnect(con,
814                    (SQLCHAR *) obj->parent->dsn, SQL_NTS,
815                    (SQLCHAR *) obj->parent->username, SQL_NTS,
816                    (SQLCHAR *) obj->parent->password, SQL_NTS);
817
818         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
819                 SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
820                 obj->parent->last_negative_connect = ast_tvnow();
821                 ast_log(LOG_WARNING, "res_odbc: Error SQLConnect=%d errno=%d %s\n", res, (int)err, msg);
822                 if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con)) != SQL_SUCCESS) {
823                         SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
824                         ast_log(LOG_WARNING, "Unable to deallocate database handle %p? %d errno=%d %s\n", con, res, (int)err, msg);
825                 }
826                 return ODBC_FAIL;
827         } else {
828                 ast_debug(3, "res_odbc: Connected to %s [%s (%p)]\n", obj->parent->name, obj->parent->dsn, obj);
829         }
830
831         obj->con = con;
832         return ODBC_SUCCESS;
833 }
834
835 /*!
836  * \internal
837  * \brief Implements the channels provider.
838  */
839 static int data_odbc_provider_handler(const struct ast_data_search *search,
840                 struct ast_data *root)
841 {
842         struct ao2_iterator aoi;
843         struct odbc_class *class;
844         struct ast_data *data_odbc_class, *data_odbc_connections;
845         struct ast_data *enum_node;
846
847         aoi = ao2_iterator_init(class_container, 0);
848         while ((class = ao2_iterator_next(&aoi))) {
849                 data_odbc_class = ast_data_add_node(root, "class");
850                 if (!data_odbc_class) {
851                         ao2_ref(class, -1);
852                         continue;
853                 }
854
855                 ast_data_add_structure(odbc_class, data_odbc_class, class);
856
857                 data_odbc_connections = ast_data_add_node(data_odbc_class, "connections");
858                 if (!data_odbc_connections) {
859                         ao2_ref(class, -1);
860                         continue;
861                 }
862
863                 /* isolation */
864                 enum_node = ast_data_add_node(data_odbc_class, "isolation");
865                 if (!enum_node) {
866                         ao2_ref(class, -1);
867                         continue;
868                 }
869                 ast_data_add_int(enum_node, "value", class->isolation);
870                 ast_data_add_str(enum_node, "text", ast_odbc_isolation2text(class->isolation));
871                 ao2_ref(class, -1);
872
873                 if (!ast_data_search_match(search, data_odbc_class)) {
874                         ast_data_remove_node(root, data_odbc_class);
875                 }
876         }
877         ao2_iterator_destroy(&aoi);
878         return 0;
879 }
880
881 /*!
882  * \internal
883  * \brief /asterisk/res/odbc/listprovider.
884  */
885 static const struct ast_data_handler odbc_provider = {
886         .version = AST_DATA_HANDLER_VERSION,
887         .get = data_odbc_provider_handler
888 };
889
890 static const struct ast_data_entry odbc_providers[] = {
891         AST_DATA_ENTRY("/asterisk/res/odbc", &odbc_provider),
892 };
893
894 static int reload(void)
895 {
896         struct odbc_cache_tables *table;
897         struct odbc_class *class;
898         struct ao2_iterator aoi = ao2_iterator_init(class_container, 0);
899
900         /* First, mark all to be purged */
901         while ((class = ao2_iterator_next(&aoi))) {
902                 class->delme = 1;
903                 ao2_ref(class, -1);
904         }
905         ao2_iterator_destroy(&aoi);
906
907         load_odbc_config();
908
909         aoi = ao2_iterator_init(class_container, 0);
910         while ((class = ao2_iterator_next(&aoi))) {
911                 if (class->delme) {
912                         ao2_unlink(class_container, class);
913                 }
914                 ao2_ref(class, -1);
915         }
916         ao2_iterator_destroy(&aoi);
917
918         /* Empty the cache; it will get rebuilt the next time the tables are needed. */
919         AST_RWLIST_WRLOCK(&odbc_tables);
920         while ((table = AST_RWLIST_REMOVE_HEAD(&odbc_tables, list))) {
921                 destroy_table_cache(table);
922         }
923         AST_RWLIST_UNLOCK(&odbc_tables);
924
925         return 0;
926 }
927
928 static int unload_module(void)
929 {
930         /* Prohibit unloading */
931         return -1;
932 }
933
934 /*!
935  * \brief Load the module
936  *
937  * Module loading including tests for configuration or dependencies.
938  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
939  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
940  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
941  * configuration file or other non-critical problem return 
942  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
943  */
944 static int load_module(void)
945 {
946         if (!(class_container = ao2_container_alloc(1, null_hash_fn, ao2_match_by_addr)))
947                 return AST_MODULE_LOAD_DECLINE;
948         if (load_odbc_config() == -1)
949                 return AST_MODULE_LOAD_DECLINE;
950         ast_cli_register_multiple(cli_odbc, ARRAY_LEN(cli_odbc));
951         ast_data_register_multiple(odbc_providers, ARRAY_LEN(odbc_providers));
952         ast_log(LOG_NOTICE, "res_odbc loaded.\n");
953         return 0;
954 }
955
956 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "ODBC resource",
957         .support_level = AST_MODULE_SUPPORT_CORE,
958         .load = load_module,
959         .unload = unload_module,
960         .reload = reload,
961         .load_pri = AST_MODPRI_REALTIME_DEPEND,
962 );