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