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