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