Merged revisions 78415 via svnmerge from
[asterisk/asterisk.git] / res / res_config_odbc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * Copyright (C) 2004 - 2005 Anthony Minessale II <anthmct@yahoo.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief odbc+odbc plugin for portable configuration engine
24  *
25  * \author Mark Spencer <markster@digium.com>
26  * \author Anthony Minessale II <anthmct@yahoo.com>
27  *
28  * \arg http://www.unixodbc.org
29  */
30
31 /*** MODULEINFO
32         <depend>unixodbc</depend>
33         <depend>ltdl</depend>
34         <depend>res_odbc</depend>
35  ***/
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <unistd.h>
44 #include <string.h>
45
46 #include "asterisk/file.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/channel.h"
49 #include "asterisk/pbx.h"
50 #include "asterisk/config.h"
51 #include "asterisk/module.h"
52 #include "asterisk/lock.h"
53 #include "asterisk/options.h"
54 #include "asterisk/res_odbc.h"
55 #include "asterisk/utils.h"
56
57 struct custom_prepare_struct {
58         const char *sql;
59         const char *extra;
60         va_list *ap;
61 };
62
63 static SQLHSTMT custom_prepare(struct odbc_obj *obj, void *data)
64 {
65         int res, x = 1;
66         struct custom_prepare_struct *cps = data;
67         const char *newparam, *newval;
68         SQLHSTMT stmt;
69         va_list ap;
70         va_copy(ap, *(cps->ap));
71
72         res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
73         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
74                 ast_log(LOG_WARNING, "SQL Alloc Handle failed!\n");
75                 return NULL;
76         }
77
78         res = SQLPrepare(stmt, (unsigned char *)cps->sql, SQL_NTS);
79         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
80                 ast_log(LOG_WARNING, "SQL Prepare failed![%s]\n", cps->sql);
81                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
82                 return NULL;
83         }
84
85         while ((newparam = va_arg(ap, const char *))) {
86                 newval = va_arg(ap, const char *);
87                 SQLBindParameter(stmt, x++, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(newval), 0, (void *)newval, 0, NULL);
88         }
89         va_end(ap);
90
91         if (!ast_strlen_zero(cps->extra))
92                 SQLBindParameter(stmt, x++, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(cps->extra), 0, (void *)cps->extra, 0, NULL);
93         return stmt;
94 }
95
96 /*!
97  * \brief Excute an SQL query and return ast_variable list
98  * \param database
99  * \param table
100  * \param ap list containing one or more field/operator/value set
101  * Select database and preform query on table, prepare the sql statement
102  * Sub-in the values to the prepared statement and execute it. Return results
103  * as a ast_variable list.
104  *
105  * \retval var on success
106  * \retval NULL on failure
107 */
108 static struct ast_variable *realtime_odbc(const char *database, const char *table, va_list ap)
109 {
110         struct odbc_obj *obj;
111         SQLHSTMT stmt;
112         char sql[1024];
113         char coltitle[256];
114         char rowdata[2048];
115         char *op;
116         const char *newparam, *newval;
117         char *stringp;
118         char *chunk;
119         SQLSMALLINT collen;
120         int res;
121         int x;
122         struct ast_variable *var=NULL, *prev=NULL;
123         SQLULEN colsize;
124         SQLSMALLINT colcount=0;
125         SQLSMALLINT datatype;
126         SQLSMALLINT decimaldigits;
127         SQLSMALLINT nullable;
128         SQLLEN indicator;
129         va_list aq;
130         struct custom_prepare_struct cps = { .sql = sql, .ap = &ap };
131         
132         va_copy(aq, ap);
133
134         if (!table)
135                 return NULL;
136
137         obj = ast_odbc_request_obj(database, 0);
138
139         if (!obj) {
140                 ast_log(LOG_ERROR, "No database handle available with the name of '%s' (check res_odbc.conf)\n", database);
141                 return NULL;
142         }
143
144         newparam = va_arg(aq, const char *);
145         if (!newparam)
146                 return NULL;
147         newval = va_arg(aq, const char *);
148         op = !strchr(newparam, ' ') ? " =" : "";
149         snprintf(sql, sizeof(sql), "SELECT * FROM %s WHERE %s%s ?", table, newparam, op);
150         while((newparam = va_arg(aq, const char *))) {
151                 op = !strchr(newparam, ' ') ? " =" : "";
152                 snprintf(sql + strlen(sql), sizeof(sql) - strlen(sql), " AND %s%s ?%s", newparam, op,
153                         strcasestr(newparam, "LIKE") ? " ESCAPE '\\'" : "");
154                 newval = va_arg(aq, const char *);
155         }
156         va_end(aq);
157
158         stmt = ast_odbc_prepare_and_execute(obj, custom_prepare, &cps);
159
160         if (!stmt) {
161                 ast_odbc_release_obj(obj);
162                 return NULL;
163         }
164
165         res = SQLNumResultCols(stmt, &colcount);
166         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
167                 ast_log(LOG_WARNING, "SQL Column Count error!\n[%s]\n\n", sql);
168                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
169                 ast_odbc_release_obj(obj);
170                 return NULL;
171         }
172
173         res = SQLFetch(stmt);
174         if (res == SQL_NO_DATA) {
175                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
176                 ast_odbc_release_obj(obj);
177                 return NULL;
178         }
179         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
180                 ast_log(LOG_WARNING, "SQL Fetch error!\n[%s]\n\n", sql);
181                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
182                 ast_odbc_release_obj(obj);
183                 return NULL;
184         }
185         for (x = 0; x < colcount; x++) {
186                 rowdata[0] = '\0';
187                 collen = sizeof(coltitle);
188                 res = SQLDescribeCol(stmt, x + 1, (unsigned char *)coltitle, sizeof(coltitle), &collen, 
189                                         &datatype, &colsize, &decimaldigits, &nullable);
190                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
191                         ast_log(LOG_WARNING, "SQL Describe Column error!\n[%s]\n\n", sql);
192                         if (var)
193                                 ast_variables_destroy(var);
194                         ast_odbc_release_obj(obj);
195                         return NULL;
196                 }
197
198                 indicator = 0;
199                 res = SQLGetData(stmt, x + 1, SQL_CHAR, rowdata, sizeof(rowdata), &indicator);
200                 if (indicator == SQL_NULL_DATA)
201                         rowdata[0] = '\0';
202                 else if (ast_strlen_zero(rowdata)) {
203                         /* Because we encode the empty string for a NULL, we will encode
204                          * actual empty strings as a string containing a single whitespace. */
205                         ast_copy_string(rowdata, " ", sizeof(rowdata));
206                 }
207
208                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
209                         ast_log(LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", sql);
210                         if (var)
211                                 ast_variables_destroy(var);
212                         ast_odbc_release_obj(obj);
213                         return NULL;
214                 }
215                 stringp = rowdata;
216                 while(stringp) {
217                         chunk = strsep(&stringp, ";");
218                         if (!ast_strlen_zero(ast_strip(chunk))) {
219                                 if (prev) {
220                                         prev->next = ast_variable_new(coltitle, chunk);
221                                         if (prev->next)
222                                                 prev = prev->next;
223                                 } else 
224                                         prev = var = ast_variable_new(coltitle, chunk);
225                         }
226                 }
227         }
228
229
230         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
231         ast_odbc_release_obj(obj);
232         return var;
233 }
234
235 /*!
236  * \brief Excute an Select query and return ast_config list
237  * \param database
238  * \param table
239  * \param ap list containing one or more field/operator/value set
240  * Select database and preform query on table, prepare the sql statement
241  * Sub-in the values to the prepared statement and execute it. 
242  * Execute this prepared query against several ODBC connected databases.
243  * Return results as an ast_config variable.
244  *
245  * \retval var on success
246  * \retval NULL on failure
247 */
248 static struct ast_config *realtime_multi_odbc(const char *database, const char *table, va_list ap)
249 {
250         struct odbc_obj *obj;
251         SQLHSTMT stmt;
252         char sql[1024];
253         char coltitle[256];
254         char rowdata[2048];
255         const char *initfield=NULL;
256         char *op;
257         const char *newparam, *newval;
258         char *stringp;
259         char *chunk;
260         SQLSMALLINT collen;
261         int res;
262         int x;
263         struct ast_variable *var=NULL;
264         struct ast_config *cfg=NULL;
265         struct ast_category *cat=NULL;
266         SQLULEN colsize;
267         SQLSMALLINT colcount=0;
268         SQLSMALLINT datatype;
269         SQLSMALLINT decimaldigits;
270         SQLSMALLINT nullable;
271         SQLLEN indicator;
272         struct custom_prepare_struct cps = { .sql = sql, .ap = &ap };
273
274         va_list aq;
275         va_copy(aq, ap);
276
277         if (!table)
278                 return NULL;
279
280         obj = ast_odbc_request_obj(database, 0);
281         if (!obj)
282                 return NULL;
283
284         newparam = va_arg(aq, const char *);
285         if (!newparam)  {
286                 ast_odbc_release_obj(obj);
287                 return NULL;
288         }
289         initfield = ast_strdupa(newparam);
290         if ((op = strchr(initfield, ' '))) 
291                 *op = '\0';
292         newval = va_arg(aq, const char *);
293         op = !strchr(newparam, ' ') ? " =" : "";
294         snprintf(sql, sizeof(sql), "SELECT * FROM %s WHERE %s%s ?", table, newparam, op);
295         while((newparam = va_arg(aq, const char *))) {
296                 op = !strchr(newparam, ' ') ? " =" : "";
297                 snprintf(sql + strlen(sql), sizeof(sql) - strlen(sql), " AND %s%s ?%s", newparam, op,
298                         strcasestr(newparam, "LIKE") ? " ESCAPE '\\'" : "");
299                 newval = va_arg(aq, const char *);
300         }
301         if (initfield)
302                 snprintf(sql + strlen(sql), sizeof(sql) - strlen(sql), " ORDER BY %s", initfield);
303         va_end(aq);
304
305         stmt = ast_odbc_prepare_and_execute(obj, custom_prepare, &cps);
306
307         if (!stmt) {
308                 ast_odbc_release_obj(obj);
309                 return NULL;
310         }
311
312         res = SQLNumResultCols(stmt, &colcount);
313         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
314                 ast_log(LOG_WARNING, "SQL Column Count error!\n[%s]\n\n", sql);
315                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
316                 ast_odbc_release_obj(obj);
317                 return NULL;
318         }
319
320         cfg = ast_config_new();
321         if (!cfg) {
322                 ast_log(LOG_WARNING, "Out of memory!\n");
323                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
324                 ast_odbc_release_obj(obj);
325                 return NULL;
326         }
327
328         while ((res=SQLFetch(stmt)) != SQL_NO_DATA) {
329                 var = NULL;
330                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
331                         ast_log(LOG_WARNING, "SQL Fetch error!\n[%s]\n\n", sql);
332                         continue;
333                 }
334                 cat = ast_category_new("");
335                 if (!cat) {
336                         ast_log(LOG_WARNING, "Out of memory!\n");
337                         continue;
338                 }
339                 for (x=0;x<colcount;x++) {
340                         rowdata[0] = '\0';
341                         collen = sizeof(coltitle);
342                         res = SQLDescribeCol(stmt, x + 1, (unsigned char *)coltitle, sizeof(coltitle), &collen, 
343                                                 &datatype, &colsize, &decimaldigits, &nullable);
344                         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
345                                 ast_log(LOG_WARNING, "SQL Describe Column error!\n[%s]\n\n", sql);
346                                 ast_category_destroy(cat);
347                                 continue;
348                         }
349
350                         indicator = 0;
351                         res = SQLGetData(stmt, x + 1, SQL_CHAR, rowdata, sizeof(rowdata), &indicator);
352                         if (indicator == SQL_NULL_DATA)
353                                 continue;
354
355                         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
356                                 ast_log(LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", sql);
357                                 ast_category_destroy(cat);
358                                 continue;
359                         }
360                         stringp = rowdata;
361                         while(stringp) {
362                                 chunk = strsep(&stringp, ";");
363                                 if (!ast_strlen_zero(ast_strip(chunk))) {
364                                         if (initfield && !strcmp(initfield, coltitle))
365                                                 ast_category_rename(cat, chunk);
366                                         var = ast_variable_new(coltitle, chunk);
367                                         ast_variable_append(cat, var);
368                                 }
369                         }
370                 }
371                 ast_category_append(cfg, cat);
372         }
373
374         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
375         ast_odbc_release_obj(obj);
376         return cfg;
377 }
378
379 /*!
380  * \brief Excute an UPDATE query
381  * \param database
382  * \param table
383  * \param keyfield where clause field
384  * \param lookup value of field for where clause
385  * \param ap list containing one or more field/value set(s)
386  * Update a database table, prepare the sql statement using keyfield and lookup
387  * control the number of records to change. All values to be changed are stored in ap list.
388  * Sub-in the values to the prepared statement and execute it.
389  *
390  * \retval number of rows affected
391  * \retval -1 on failure
392 */
393 static int update_odbc(const char *database, const char *table, const char *keyfield, const char *lookup, va_list ap)
394 {
395         struct odbc_obj *obj;
396         SQLHSTMT stmt;
397         char sql[256];
398         SQLLEN rowcount=0;
399         const char *newparam, *newval;
400         int res;
401         va_list aq;
402         struct custom_prepare_struct cps = { .sql = sql, .ap = &ap, .extra = lookup };
403         
404         va_copy(aq, ap);
405         
406         if (!table)
407                 return -1;
408
409         obj = ast_odbc_request_obj(database, 0);
410         if (!obj)
411                 return -1;
412
413         newparam = va_arg(aq, const char *);
414         if (!newparam)  {
415                 ast_odbc_release_obj(obj);
416                 return -1;
417         }
418         newval = va_arg(aq, const char *);
419         snprintf(sql, sizeof(sql), "UPDATE %s SET %s=?", table, newparam);
420         while((newparam = va_arg(aq, const char *))) {
421                 snprintf(sql + strlen(sql), sizeof(sql) - strlen(sql), ", %s=?", newparam);
422                 newval = va_arg(aq, const char *);
423         }
424         va_end(aq);
425         snprintf(sql + strlen(sql), sizeof(sql) - strlen(sql), " WHERE %s=?", keyfield);
426
427         stmt = ast_odbc_prepare_and_execute(obj, custom_prepare, &cps);
428
429         if (!stmt) {
430                 ast_odbc_release_obj(obj);
431                 return -1;
432         }
433
434         res = SQLRowCount(stmt, &rowcount);
435         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
436         ast_odbc_release_obj(obj);
437
438         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
439                 ast_log(LOG_WARNING, "SQL Row Count error!\n[%s]\n\n", sql);
440                 return -1;
441         }
442
443         if (rowcount >= 0)
444                 return (int)rowcount;
445
446         return -1;
447 }
448
449 struct config_odbc_obj {
450         char *sql;
451         unsigned long cat_metric;
452         char category[128];
453         char var_name[128];
454         char var_val[1024]; /* changed from 128 to 1024 via bug 8251 */
455         SQLLEN err;
456 };
457
458 static SQLHSTMT config_odbc_prepare(struct odbc_obj *obj, void *data)
459 {
460         struct config_odbc_obj *q = data;
461         SQLHSTMT sth;
462         int res;
463
464         res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &sth);
465         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
466                 ast_verb(4, "Failure in AllocStatement %d\n", res);
467                 return NULL;
468         }
469
470         res = SQLPrepare(sth, (unsigned char *)q->sql, SQL_NTS);
471         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
472                 ast_verb(4, "Error in PREPARE %d\n", res);
473                 SQLFreeHandle(SQL_HANDLE_STMT, sth);
474                 return NULL;
475         }
476
477         SQLBindCol(sth, 1, SQL_C_ULONG, &q->cat_metric, sizeof(q->cat_metric), &q->err);
478         SQLBindCol(sth, 2, SQL_C_CHAR, q->category, sizeof(q->category), &q->err);
479         SQLBindCol(sth, 3, SQL_C_CHAR, q->var_name, sizeof(q->var_name), &q->err);
480         SQLBindCol(sth, 4, SQL_C_CHAR, q->var_val, sizeof(q->var_val), &q->err);
481
482         return sth;
483 }
484
485 static struct ast_config *config_odbc(const char *database, const char *table, const char *file, struct ast_config *cfg, int withcomments)
486 {
487         struct ast_variable *new_v;
488         struct ast_category *cur_cat;
489         int res = 0;
490         struct odbc_obj *obj;
491         char sqlbuf[1024] = "";
492         char *sql = sqlbuf;
493         size_t sqlleft = sizeof(sqlbuf);
494         unsigned int last_cat_metric = 0;
495         SQLSMALLINT rowcount = 0;
496         SQLHSTMT stmt;
497         char last[128] = "";
498         struct config_odbc_obj q;
499
500         memset(&q, 0, sizeof(q));
501
502         if (!file || !strcmp (file, "res_config_odbc.conf"))
503                 return NULL;            /* cant configure myself with myself ! */
504
505         obj = ast_odbc_request_obj(database, 0);
506         if (!obj)
507                 return NULL;
508
509         ast_build_string(&sql, &sqlleft, "SELECT cat_metric, category, var_name, var_val FROM %s ", table);
510         ast_build_string(&sql, &sqlleft, "WHERE filename='%s' AND commented=0 ", file);
511         ast_build_string(&sql, &sqlleft, "ORDER BY cat_metric DESC, var_metric ASC, category, var_name ");
512         q.sql = sqlbuf;
513
514         stmt = ast_odbc_prepare_and_execute(obj, config_odbc_prepare, &q);
515
516         if (!stmt) {
517                 ast_log(LOG_WARNING, "SQL select error!\n[%s]\n\n", sql);
518                 ast_odbc_release_obj(obj);
519                 return NULL;
520         }
521
522         res = SQLNumResultCols(stmt, &rowcount);
523
524         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
525                 ast_log(LOG_WARNING, "SQL NumResultCols error!\n[%s]\n\n", sql);
526                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
527                 ast_odbc_release_obj(obj);
528                 return NULL;
529         }
530
531         if (!rowcount) {
532                 ast_log(LOG_NOTICE, "found nothing\n");
533                 ast_odbc_release_obj(obj);
534                 return cfg;
535         }
536
537         cur_cat = ast_config_get_current_category(cfg);
538
539         while ((res = SQLFetch(stmt)) != SQL_NO_DATA) {
540                 if (!strcmp (q.var_name, "#include")) {
541                         if (!ast_config_internal_load(q.var_val, cfg, 0)) {
542                                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
543                                 ast_odbc_release_obj(obj);
544                                 return NULL;
545                         }
546                         continue;
547                 } 
548                 if (strcmp(last, q.category) || last_cat_metric != q.cat_metric) {
549                         cur_cat = ast_category_new(q.category);
550                         if (!cur_cat) {
551                                 ast_log(LOG_WARNING, "Out of memory!\n");
552                                 break;
553                         }
554                         strcpy(last, q.category);
555                         last_cat_metric = q.cat_metric;
556                         ast_category_append(cfg, cur_cat);
557                 }
558
559                 new_v = ast_variable_new(q.var_name, q.var_val);
560                 ast_variable_append(cur_cat, new_v);
561         }
562
563         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
564         ast_odbc_release_obj(obj);
565         return cfg;
566 }
567
568 static struct ast_config_engine odbc_engine = {
569         .name = "odbc",
570         .load_func = config_odbc,
571         .realtime_func = realtime_odbc,
572         .realtime_multi_func = realtime_multi_odbc,
573         .update_func = update_odbc
574 };
575
576 static int unload_module (void)
577 {
578         ast_config_engine_deregister(&odbc_engine);
579         ast_verb(1, "res_config_odbc unloaded.\n");
580         return 0;
581 }
582
583 static int load_module (void)
584 {
585         ast_config_engine_register(&odbc_engine);
586         ast_verb(1, "res_config_odbc loaded.\n");
587         return 0;
588 }
589
590 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime ODBC configuration",
591                 .load = load_module,
592                 .unload = unload_module,
593                 );