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