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