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