b3a44a9a585e6923d642628d97d7d8935c9f6f89
[asterisk/asterisk.git] / res / res_config_sqlite.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Proformatique
5  *
6  * Written by Richard Braun <rbraun@proformatique.com>
7  *
8  * Based on res_sqlite3 by Anthony Minessale II, 
9  * and res_config_mysql by Matthew Boehm
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 /*!
23  * \mainpage res_sqlite
24  * 
25  * \section intro_sec Presentation
26  * 
27  * res_sqlite is a module for the Asterisk Open Source PBX to support SQLite 2
28  * databases. It can be used to fetch configuration from a database (static
29  * configuration files and/or using the Asterisk RealTime Architecture - ARA).
30  * It can also be used to log CDR entries. Finally, it can be used for simple
31  * queries in the Dialplan. Note that Asterisk already comes with a module
32  * named cdr_sqlite. There are two reasons for including it in res_sqlite:
33  * the first is that rewriting it was a training to learn how to write a
34  * simple module for Asterisk, the other is to have the same database open for
35  * all kinds of operations, which improves reliability and performance.
36  * 
37  * There is already a module for SQLite 3 (named res_sqlite3) in the Asterisk
38  * addons. res_sqlite was developed because we, at Proformatique, are using
39  * PHP 4 in our embedded systems, and PHP 4 has no stable support for SQLite 3
40  * at this time. We also needed RealTime support.
41  * 
42  * \section build_install_sec Building and installing
43  * 
44  * To build res_sqlite, simply enter <code>make</code>. To install it,
45  * enter make install. The Makefile has been slightly designed for
46  * cross compilation and installation in non standard locations, to ease
47  * the work of packagers. Read it for more details.
48  * 
49  * \section conf_sec Configuration
50  * 
51  * The main configuration file is res_config_sqlite.conf. It must be readable or
52  * res_sqlite will fail to start. It is suggested to use the sample file
53  * in this package as a starting point. The file has only one section
54  * named <code>general</code>. Here are the supported parameters :
55  * 
56  * <dl>
57  *      <dt><code>dbfile</code></dt>
58  *      <dd>The absolute path to the SQLite database (the file can be non existent,
59  *                      res_sqlite will create it if is has the appropriate rights)</dd>
60  *      <dt><code>config_table</code></dt>
61  *      <dd>The table used for static configuration</dd>
62  *      <dt><code>cdr_table</code></dt>
63  *      <dd>The table used to store CDR entries (if ommitted, CDR support is
64  *                      disabled)</dd>
65  * </dl>
66  * 
67  * To use res_sqlite for static and/or RealTime configuration, refer to the
68  * Asterisk documentation. The file tables.sql can be used to create the
69  * needed tables.
70  * 
71  * The SQLITE() application is very similar to the MYSQL() application. You
72  * can find more details at
73  * <a href="http://voip-info.org/wiki/view/Asterisk+cmd+MYSQL">http://voip-info.org/wiki/view/Asterisk+cmd+MYSQL</a>.
74  * The main difference is that you cannot choose your database - it's the
75  * file set in the <code>dbfile</code> parameter. As a result, there is no
76  * Connect or Disconnect command, and there is no connid variable.
77  * 
78  * \section status_sec Driver status
79  * 
80  * The CLI command <code>show sqlite status</code> returns status information
81  * about the running driver. One information is more important than others:
82  * the number of registered virtual machines. A SQLite virtual machine is
83  * created each time a SQLITE() query command is used. If the number of
84  * registered virtual machines isn't 0 (or near 0, since one or more SQLITE()
85  * commands can be running when requesting the module status) and increases
86  * over time, this probably means that you're badly using the application
87  * and you're creating resource leaks. You should check your Dialplan and
88  * reload res_sqlite (by unloading and then loading again - reloading isn't
89  * supported)
90  * 
91  * \section credits_sec Credits
92  * 
93  * res_sqlite was developed by Richard Braun at the Proformatique company.
94  */
95
96 /*!
97  * \file res_sqlite.c
98  * \brief res_sqlite module.
99  */
100
101 /*** MODULEINFO
102         <depend>sqlite</depend>
103  ***/
104
105 #include "asterisk.h"
106
107 #include <stdio.h>
108 #include <stdarg.h>
109 #include <stdlib.h>
110 #include <string.h>
111 #include <sqlite.h>
112
113 #include "asterisk/pbx.h"
114 #include "asterisk/cdr.h"
115 #include "asterisk/cli.h"
116 #include "asterisk/lock.h"
117 #include "asterisk/config.h"
118 #include "asterisk/logger.h"
119 #include "asterisk/module.h"
120 #include "asterisk/options.h"
121 #include "asterisk/linkedlists.h"
122
123 #define RES_SQLITE_NAME "res_sqlite"
124 #define RES_SQLITE_DRIVER "sqlite"
125 #define RES_SQLITE_APP_DRIVER "SQLITE"
126 #define RES_SQLITE_DESCRIPTION "Resource Module for SQLite 2"
127 #define RES_SQLITE_CONF_FILE "res_config_sqlite.conf"
128 #define RES_SQLITE_APP_SYNOPSIS "Dialplan access to SQLite 2"
129 #define RES_SQLITE_APP_DESCRIPTION \
130 "SQLITE(): " RES_SQLITE_APP_SYNOPSIS "\n"
131 #define RES_SQLITE_STATUS_SUMMARY \
132 "Show status information about the SQLite 2 driver"
133 #define RES_SQLITE_STATUS_USAGE \
134 "Usage: show sqlite status\n" \
135 "       " RES_SQLITE_STATUS_SUMMARY "\n"
136
137 enum {
138         RES_SQLITE_CONFIG_ID,
139         RES_SQLITE_CONFIG_COMMENTED,
140         RES_SQLITE_CONFIG_FILENAME,
141         RES_SQLITE_CONFIG_CATEGORY,
142         RES_SQLITE_CONFIG_VAR_NAME,
143         RES_SQLITE_CONFIG_VAR_VAL,
144         RES_SQLITE_CONFIG_COLUMNS,
145 };
146
147 /*!
148  * Limit the number of maximum simultaneous registered SQLite VMs to avoid
149  * a denial of service attack.
150  */
151 #define RES_SQLITE_VM_MAX 1024
152
153 #define SET_VAR(config, to, from) \
154 do \
155         { \
156                 int __error; \
157                 __error = set_var(&to, #to, from->value); \
158                 if (__error) \
159                         { \
160                                 ast_config_destroy(config); \
161                                 unload_config(); \
162                                 return 1; \
163                         } \
164         } \
165 while (0)
166
167 /*!
168  * Maximum number of loops before giving up executing a query. Calls to
169  * sqlite_xxx() functions which can return SQLITE_BUSY or SQLITE_LOCKED
170  * are enclosed by RES_SQLITE_BEGIN and RES_SQLITE_END, e.g.
171  * <pre>
172  * char *errormsg;
173  * int error;
174  * 
175  * RES_SQLITE_BEGIN
176  *       error = sqlite_exec(db, query, NULL, NULL, &errormsg);
177  * RES_SQLITE_END(error)
178  * 
179  * if (error)
180  *       ...;
181  * </pre>
182  */
183 #define RES_SQLITE_MAX_LOOPS 10
184
185 /*!
186  * Macro used before executing a query.
187  * 
188  * \see RES_SQLITE_MAX_LOOPS.
189  */
190 #define RES_SQLITE_BEGIN \
191 { \
192         int __i; \
193         for (__i = 0; __i < RES_SQLITE_MAX_LOOPS; __i++) \
194                 {
195
196 /*!
197  * Macro used after executing a query.
198  * 
199  * \see RES_SQLITE_MAX_LOOPS.
200  */
201 #define RES_SQLITE_END(error) \
202                         if (error != SQLITE_BUSY && error != SQLITE_LOCKED) \
203                                 break; \
204                         usleep(1000); \
205                 } \
206 }
207
208 /*!
209  * Structure sent to the SQLite callback function for static configuration.
210  * 
211  * \see add_cfg_entry()
212  */
213 struct cfg_entry_args {
214         struct ast_config *cfg;
215         struct ast_category *cat;
216         char *cat_name;
217 };
218
219 /*!
220  * Structure sent to the SQLite callback function for RealTime configuration.
221  * 
222  * \see add_rt_cfg_entry()
223  */
224 struct rt_cfg_entry_args {
225         struct ast_variable *var;
226         struct ast_variable *last;
227 };
228
229 /*!
230  * Structure sent to the SQLite callback function for RealTime configuration
231  * (realtime_multi_handler()).
232  * 
233  * \see add_rt_multi_cfg_entry()
234  */
235 struct rt_multi_cfg_entry_args {
236         struct ast_config *cfg;
237         char *initfield;
238 };
239
240 /*!
241  * Allocate a variable.
242  * 
243  * \param var    the address of the variable to set (it will be allocated)
244  * \param name  the name of the variable (for error handling)
245  * \param value the value to store in var
246  * \return 1 if an allocation error occurred, 0 otherwise
247  */
248 static int set_var(char **var, char *name, char *value);
249
250 /*!
251  * Load the configuration file.
252  * 
253  * This function sets dbfile, config_table, and cdr_table. It calls
254  * check_vars() before returning, and unload_config() if an error occurred.
255  * 
256  * \return 1 if an error occurred, 0 otherwise
257  * \see unload_config()
258  */
259 static int load_config(void);
260
261 /*!
262  * Free resources related to configuration.
263  * 
264  * \see load_config()
265  */
266 static void unload_config(void);
267
268 /*!
269  * Asterisk callback function for CDR support.
270  * 
271  * Asterisk will call this function each time a CDR entry must be logged if
272  * CDR support is enabled.
273  * 
274  * \param cdr the CDR entry Asterisk sends us
275  * \return 1 if an error occurred, 0 otherwise
276  */
277 static int cdr_handler(struct ast_cdr *cdr);
278
279 /*!
280  * SQLite callback function for static configuration.
281  * 
282  * This function is passed to the SQLite engine as a callback function to
283  * parse a row and store it in a struct ast_config object. It relies on
284  * resulting rows       being sorted by category.
285  * 
286  * \param arg                            a pointer to a struct cfg_entry_args object
287  * \param argc                          number of columns
288  * \param argv                          values in the row
289  * \param columnNames names and types of the columns
290  * \return 1 if an error occurred, 0 otherwise
291  * \see cfg_entry_args
292  * \see sql_get_config_table
293  * \see config_handler()
294  */
295 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames);
296
297 /*!
298  * Asterisk callback function for static configuration.
299  * 
300  * Asterisk will call this function when it loads its static configuration,
301  * which usually happens at startup and reload.
302  * 
303  * \param database the database to use (ignored)
304  * \param table         the table to use
305  * \param file           the file to load from the database
306  * \param cfg                   the struct ast_config object to use when storing variables
307  * \return NULL if an error occurred, cfg otherwise
308  * \see add_cfg_entry()
309  */
310 static struct ast_config * config_handler(const char *database,
311         const char *table, const char *file,
312         struct ast_config *cfg, int withcomments);
313
314 /*!
315  * Helper function to parse a va_list object into 2 dynamic arrays of
316  * strings, parameters and values.
317  * 
318  * ap must have the following format : param1 val1 param2 val2 param3 val3 ...
319  * arguments will be extracted to create 2 arrays:
320  * 
321  * <ul>
322  *      <li>params : param1 param2 param3 ...</li>
323  *      <li>vals : val1 val2 val3 ...</li>
324  * </ul>
325  * 
326  * The address of these arrays are stored in params_ptr and vals_ptr. It
327  * is the responsibility of the caller to release the memory of these arrays.
328  * It is considered an error that va_list has a null or odd number of strings.
329  * 
330  * \param ap                             the va_list object to parse
331  * \param params_ptr where the address of the params array is stored
332  * \param vals_ptr       where the address of the vals array is stored
333  * \return 0 if an error occurred, the number of elements in the arrays (which
334  *                               have the same size) otherwise
335  */
336 static size_t get_params(va_list ap, const char ***params_ptr,
337         const char ***vals_ptr);
338
339 /*!
340  * SQLite callback function for RealTime configuration.
341  * 
342  * This function is passed to the SQLite engine as a callback function to
343  * parse a row and store it in a linked list of struct ast_variable objects.
344  * 
345  * \param arg                            a pointer to a struct rt_cfg_entry_args object
346  * \param argc                          number of columns
347  * \param argv                          values in the row
348  * \param columnNames names and types of the columns
349  * \return 1 if an error occurred, 0 otherwise
350  * \see rt_cfg_entry_args
351  * \see realtime_handler()
352  */
353 static int add_rt_cfg_entry(void *arg, int argc, char **argv,
354         char **columnNames);
355
356 /*!
357  * Asterisk callback function for RealTime configuration.
358  * 
359  * Asterisk will call this function each time it requires a variable
360  * through the RealTime architecture. ap is a list of parameters and
361  * values used to find a specific row, e.g one parameter "name" and
362  * one value "123" so that the SQL query becomes <code>SELECT * FROM
363  * table WHERE name = '123';</code>.
364  * 
365  * \param database the database to use (ignored)
366  * \param table         the table to use
367  * \param ap                     list of parameters and values to match
368  * \return NULL if an error occurred, a linked list of struct ast_variable
369  *                               objects otherwise
370  * \see add_rt_cfg_entry()
371  */
372 static struct ast_variable * realtime_handler(const char *database,
373         const char *table, va_list ap);
374
375 /*!
376  * SQLite callback function for RealTime configuration.
377  * 
378  * This function performs the same actions as add_rt_cfg_entry() except
379  * that the rt_multi_cfg_entry_args structure is designed to store
380  * categories in addition of variables.
381  * 
382  * \param arg                            a pointer to a struct rt_multi_cfg_entry_args object
383  * \param argc                          number of columns
384  * \param argv                          values in the row
385  * \param columnNames names and types of the columns
386  * \return 1 if an error occurred, 0 otherwise
387  * \see rt_multi_cfg_entry_args
388  * \see realtime_multi_handler()
389  */
390 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv,
391         char **columnNames);
392
393 /*!
394  * Asterisk callback function for RealTime configuration.
395  * 
396  * This function performs the same actions as realtime_handler() except
397  * that it can store variables per category, and can return several
398  * categories.
399  * 
400  * \param database the database to use (ignored)
401  * \param table         the table to use
402  * \param ap                     list of parameters and values to match
403  * \return NULL if an error occurred, a struct ast_config object storing
404  *                               categories and variables
405  * \see add_rt_multi_cfg_entry()
406  */
407 static struct ast_config * realtime_multi_handler(const char *database,
408         const char *table,
409         va_list ap);
410
411 /*!
412  * Asterisk callback function for RealTime configuration (variable
413  * update).
414  * 
415  * Asterisk will call this function each time a variable has been modified
416  * internally and must be updated in the backend engine. keyfield and entity
417  * are used to find the row to update, e.g. <code>UPDATE table SET ... WHERE
418  * keyfield = 'entity';</code>. ap is a list of parameters and values with the
419  * same format as the other realtime functions.
420  * 
421  * \param database the database to use (ignored)
422  * \param table         the table to use
423  * \param keyfield the column of the matching cell
424  * \param entity         the value of the matching cell
425  * \param ap                     list of parameters and new values to update in the database
426  * \return -1 if an error occurred, the number of affected rows otherwise
427  */
428 static int realtime_update_handler(const char *database, const char *table,
429         const char *keyfield, const char *entity,
430         va_list ap);
431
432 /*!
433  * Asterisk callback function for the CLI status command.
434  * 
435  * \param fd     file descriptor provided by Asterisk to use with ast_cli()
436  * \param argc number of arguments
437  * \param argv arguments list
438  * \return RESULT_SUCCESS
439  */
440 static int cli_status(int fd, int argc, char *argv[]);
441
442 /*!
443  * The SQLite database object.
444  */
445 static sqlite *db;
446
447 /*!
448  * Set to 1 if CDR support is enabled.
449  */
450 static int use_cdr;
451
452 /*!
453  * Set to 1 if the CDR callback function was registered.
454  */
455 static int cdr_registered;
456
457 /*!
458  * Set to 1 if the CLI status command callback function was registered.
459  */
460 static int cli_status_registered;
461
462 /*!
463  * The path of the database file.
464  */
465 static char *dbfile;
466
467 /*!
468  * The name of the static configuration table.
469  */
470 static char *config_table;
471
472 /*!
473  * The name of the table used to store CDR entries.
474  */
475 static char *cdr_table;
476
477 /*!
478  * The number of registered virtual machines.
479  */
480 static int vm_count;
481
482 /*!
483  * The structure specifying all callback functions used by Asterisk for static
484  * and RealTime configuration.
485  */
486 static struct ast_config_engine sqlite_engine =
487 {
488         .name = RES_SQLITE_DRIVER,
489         .load_func = config_handler,
490         .realtime_func = realtime_handler,
491         .realtime_multi_func = realtime_multi_handler,
492         .update_func = realtime_update_handler
493 };
494
495 /*!
496  * The mutex used to prevent simultaneous access to the SQLite database.
497  * SQLite isn't always compiled with thread safety.
498  */
499 AST_MUTEX_DEFINE_STATIC(mutex);
500
501 /*!
502  * Structure containing details and callback functions for the CLI status
503  * command.
504  */
505 static struct ast_cli_entry cli_status_cmd =
506 {
507         .cmda = {"show", "sqlite", "status", NULL},
508         .handler = cli_status,
509         .summary = RES_SQLITE_STATUS_SUMMARY,
510         .usage = RES_SQLITE_STATUS_USAGE
511 };
512
513 /*
514  * Taken from Asterisk 1.2 cdr_sqlite.so.
515  */
516
517 /*!
518  * SQL query format to create the CDR table if non existent.
519  */
520 static char *sql_create_cdr_table =
521 "CREATE TABLE '%q' ("
522 "       id              INTEGER PRIMARY KEY,"
523 "       clid            VARCHAR(80) NOT NULL DEFAULT '',"
524 "       src             VARCHAR(80) NOT NULL DEFAULT '',"
525 "       dst             VARCHAR(80) NOT NULL DEFAULT '',"
526 "       dcontext        VARCHAR(80) NOT NULL DEFAULT '',"
527 "       channel         VARCHAR(80) NOT NULL DEFAULT '',"
528 "       dstchannel      VARCHAR(80) NOT NULL DEFAULT '',"
529 "       lastapp         VARCHAR(80) NOT NULL DEFAULT '',"
530 "       lastdata        VARCHAR(80) NOT NULL DEFAULT '',"
531 "       start           CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
532 "       answer          CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
533 "       end             CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
534 "       duration        INT(11) NOT NULL DEFAULT '0',"
535 "       billsec         INT(11) NOT NULL DEFAULT '0',"
536 "       disposition     INT(11) NOT NULL DEFAULT '0',"
537 "       amaflags        INT(11) NOT NULL DEFAULT '0',"
538 "       accountcode     VARCHAR(20) NOT NULL DEFAULT '',"
539 "       uniqueid        VARCHAR(32) NOT NULL DEFAULT '',"
540 "       userfield       VARCHAR(255) NOT NULL DEFAULT ''"
541 ");";
542
543 /*!
544  * SQL query format to insert a CDR entry.
545  */
546 static char *sql_add_cdr_entry =
547 "INSERT INTO '%q' ("
548 "                        clid,"
549 "       src,"
550 "       dst,"
551 "       dcontext,"
552 "       channel,"
553 "       dstchannel,"
554 "       lastapp,"
555 "       lastdata,"
556 "       start,"
557 "       answer,"
558 "       end,"
559 "       duration,"
560 "       billsec,"
561 "       disposition,"
562 "       amaflags,"
563 "       accountcode,"
564 "       uniqueid,"
565 "       userfield"
566 ") VALUES ("
567 "       '%q',"
568 "       '%q',"
569 "       '%q',"
570 "       '%q',"
571 "       '%q',"
572 "       '%q',"
573 "       '%q',"
574 "       '%q',"
575 "       datetime(%d,'unixepoch'),"
576 "       datetime(%d,'unixepoch'),"
577 "       datetime(%d,'unixepoch'),"
578 "       '%ld',"
579 "       '%ld',"
580 "       '%ld',"
581 "       '%ld',"
582 "       '%q',"
583 "       '%q',"
584 "       '%q'"
585 ");";
586
587 /*!
588  * SQL query format to fetch the static configuration of a file.
589  * Rows must be sorted by category.
590  * 
591  * @see add_cfg_entry()
592  */
593 static char *sql_get_config_table =
594 "SELECT *"
595 "       FROM '%q'"
596 "       WHERE filename = '%q' AND commented = 0"
597 "       ORDER BY category;";
598
599 static int set_var(char **var, char *name, char *value)
600 {
601         if (*var)
602                 free(*var);
603
604         *var = ast_strdup(value);
605
606         if (!*var) {
607                 ast_log(LOG_WARNING, "Unable to allocate variable %s\n", name);
608                 return 1;
609         }
610
611         return 0;
612 }
613
614 static int check_vars(void)
615 {
616         if (!dbfile) {
617                 ast_log(LOG_ERROR, "Undefined parameter %s\n", dbfile);
618                 return 1;
619         }
620
621         use_cdr = (cdr_table != NULL);
622
623         return 0;
624 }
625
626 static int load_config(void)
627 {
628         struct ast_config *config;
629         struct ast_variable *var;
630         int error;
631
632         config = ast_config_load(RES_SQLITE_CONF_FILE);
633
634         if (!config) {
635                 ast_log(LOG_ERROR, "Unable to load " RES_SQLITE_CONF_FILE "\n");
636                 return 1;
637         }
638
639         for (var = ast_variable_browse(config, "general"); var; var = var->next) {
640                 if (!strcasecmp(var->name, "dbfile"))
641                         SET_VAR(config, dbfile, var);
642                 else if (!strcasecmp(var->name, "config_table"))
643                         SET_VAR(config, config_table, var);
644                 else if (!strcasecmp(var->name, "cdr_table"))
645                         SET_VAR(config, cdr_table, var);
646                 else
647                         ast_log(LOG_WARNING, "Unknown parameter : %s\n", var->name);
648         }
649
650         ast_config_destroy(config);
651         error = check_vars();
652
653         if (error) {
654                 unload_config();
655                 return 1;
656         }
657
658         return 0;
659 }
660
661 static void unload_config(void)
662 {
663         free(dbfile);
664         dbfile = NULL;
665         free(config_table);
666         config_table = NULL;
667         free(cdr_table);
668         cdr_table = NULL;
669 }
670
671 static int cdr_handler(struct ast_cdr *cdr)
672 {
673         char *errormsg;
674         int error;
675
676         ast_mutex_lock(&mutex);
677
678         RES_SQLITE_BEGIN
679                 error = sqlite_exec_printf(db, sql_add_cdr_entry, NULL, NULL, &errormsg,
680                                          cdr_table, cdr->clid, cdr->src, cdr->dst,
681                                          cdr->dcontext, cdr->channel, cdr->dstchannel,
682                                          cdr->lastapp, cdr->lastdata, cdr->start.tv_sec,
683                                          cdr->answer.tv_sec, cdr->end.tv_sec,
684                                          cdr->duration, cdr->billsec, cdr->disposition,
685                                          cdr->amaflags, cdr->accountcode, cdr->uniqueid,
686                                          cdr->userfield);
687         RES_SQLITE_END(error)
688
689         ast_mutex_unlock(&mutex);
690
691         if (error) {
692                 ast_log(LOG_ERROR, "%s\n", errormsg);
693                 free(errormsg);
694                 return 1;
695         }
696
697         return 0;
698 }
699
700 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
701 {
702         struct cfg_entry_args *args;
703         struct ast_variable *var;
704
705         if (argc != RES_SQLITE_CONFIG_COLUMNS) {
706                 ast_log(LOG_WARNING, "Corrupt table\n");
707                 return 1;
708         }
709
710         args = arg;
711
712         if (!args->cat_name || strcmp(args->cat_name, argv[RES_SQLITE_CONFIG_CATEGORY])) {
713                 args->cat = ast_category_new(argv[RES_SQLITE_CONFIG_CATEGORY]);
714
715                 if (!args->cat) {
716                         ast_log(LOG_WARNING, "Unable to allocate category\n");
717                         return 1;
718                 }
719
720                 free(args->cat_name);
721                 args->cat_name = ast_strdup(argv[RES_SQLITE_CONFIG_CATEGORY]);
722
723                 if (!args->cat_name) {
724                         ast_category_destroy(args->cat);
725                         return 1;
726                 }
727
728                 ast_category_append(args->cfg, args->cat);
729         }
730
731         var = ast_variable_new(argv[RES_SQLITE_CONFIG_VAR_NAME],
732                  argv[RES_SQLITE_CONFIG_VAR_VAL]);
733
734         if (!var) {
735                 ast_log(LOG_WARNING, "Unable to allocate variable");
736                 return 1;
737         }
738
739         ast_variable_append(args->cat, var);
740         
741         return 0;
742 }
743
744 static struct ast_config *config_handler(const char *database, 
745         const char *table, const char *file, struct ast_config *cfg, int withcomments)
746 {
747         struct cfg_entry_args args;
748         char *errormsg;
749         int error;
750
751         if (!config_table) {
752                 if (!table) {
753                         ast_log(LOG_ERROR, "Table name unspecified\n");
754                         return NULL;
755                 }
756         } else
757                 table = config_table;
758
759         args.cfg = cfg;
760         args.cat = NULL;
761         args.cat_name = NULL;
762
763         ast_mutex_lock(&mutex);
764
765         RES_SQLITE_BEGIN
766                 error = sqlite_exec_printf(db, sql_get_config_table, add_cfg_entry,
767                                         &args, &errormsg, table, file);
768         RES_SQLITE_END(error)
769
770         ast_mutex_unlock(&mutex);
771
772         free(args.cat_name);
773
774         if (error) {
775                 ast_log(LOG_ERROR, "%s\n", errormsg);
776                 free(errormsg);
777                 return NULL;
778         }
779
780         return cfg;
781 }
782
783 static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr)
784 {
785         const char **tmp, *param, *val, **params, **vals;
786         size_t params_count;
787
788         params = NULL;
789         vals = NULL;
790         params_count = 0;
791
792         while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
793                 if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
794                         free(params);
795                         free(vals);
796                         return 0;
797                 }
798                 params = tmp;
799
800                 if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
801                         free(params);
802                         free(vals);
803                         return 0;
804                 }
805                 vals = tmp;
806
807                 params[params_count] = param;
808                 vals[params_count] = val;
809                 params_count++;
810         }
811
812         if (params_count)
813                 ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
814         else {
815                 *params_ptr = params;
816                 *vals_ptr = vals;
817         }
818
819         return params_count;
820 }
821
822 static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
823 {
824         struct rt_cfg_entry_args *args;
825         struct ast_variable *var;
826         int i;
827
828         args = arg;
829
830         for (i = 0; i < argc; i++) {
831                 if (!argv[i])
832                         continue;
833
834                 if (!(var = ast_variable_new(columnNames[i], argv[i])))
835                         return 1;
836
837                 if (!args->var)
838                         args->var = var;
839
840                 if (!args->last)
841                         args->last = var;
842                 else {
843                         args->last->next = var;
844                         args->last = var;
845                 }
846         }
847
848         return 0;
849 }
850
851 static struct ast_variable *
852 realtime_handler(const char *database, const char *table, va_list ap)
853 {
854         char *query, *errormsg, *op, *tmp_str;
855         struct rt_cfg_entry_args args;
856         const char **params, **vals;
857         size_t params_count;
858         int error;
859
860         if (!table) {
861                 ast_log(LOG_WARNING, "Table name unspecified\n");
862                 return NULL;
863         }
864
865         params_count = get_params(ap, &params, &vals);
866
867         if (params_count == 0)
868                 return NULL;
869
870         op = (strchr(params[0], ' ') == NULL) ? " =" : "";
871
872 /* \cond DOXYGEN_CAN_PARSE_THIS */
873 #undef QUERY
874 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
875 /* \endcond */
876
877         query = sqlite_mprintf(QUERY, table, params[0], op, vals[0]);
878
879         if (!query) {
880                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
881                 free(params);
882                 free(vals);
883                 return NULL;
884         }
885
886         if (params_count > 1) {
887                 size_t i;
888
889                 for (i = 1; i < params_count; i++) {
890                         op = (strchr(params[i], ' ') == NULL) ? " =" : "";
891                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op,
892                                                                                                                          vals[i]);
893                         sqlite_freemem(query);
894
895                         if (!tmp_str) {
896                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
897                                 free(params);
898                                 free(vals);
899                                 return NULL;
900                         }
901
902                         query = tmp_str;
903                 }
904         }
905
906         free(params);
907         free(vals);
908
909         tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
910         sqlite_freemem(query);
911
912         if (!tmp_str) {
913                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
914                 return NULL;
915         }
916
917         query = tmp_str;
918         ast_log(LOG_DEBUG, "SQL query: %s\n", query);
919         args.var = NULL;
920         args.last = NULL;
921
922         ast_mutex_lock(&mutex);
923
924         RES_SQLITE_BEGIN
925                 error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
926         RES_SQLITE_END(error)
927
928         ast_mutex_unlock(&mutex);
929
930         sqlite_freemem(query);
931
932         if (error) {
933                 ast_log(LOG_WARNING, "%s\n", errormsg);
934                 free(errormsg);
935                 ast_variables_destroy(args.var);
936                 return NULL;
937         }
938
939         return args.var;
940 }
941
942 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
943 {
944         struct rt_multi_cfg_entry_args *args;
945         struct ast_category *cat;
946         struct ast_variable *var;
947         char *cat_name;
948         size_t i;
949
950         args = (struct rt_multi_cfg_entry_args *)arg;
951         cat_name = NULL;
952
953         /*
954          * cat_name should always be set here, since initfield is forged from
955          * params[0] in realtime_multi_handler(), which is a search parameter
956          * of the SQL query.
957          */
958         for (i = 0; i < argc; i++) {
959                 if (!strcmp(args->initfield, columnNames[i]))
960                         cat_name = argv[i];
961         }
962
963         if (!cat_name) {
964                 ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
965                 return 1;
966         }
967
968         if (!(cat = ast_category_new(cat_name))) {
969                 ast_log(LOG_WARNING, "Unable to allocate category\n");
970                 return 1;
971         }
972
973         ast_category_append(args->cfg, cat);
974
975         for (i = 0; i < argc; i++) {
976                 if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
977                         continue;
978
979                 if (!(var = ast_variable_new(columnNames[i], argv[i]))) {
980                         ast_log(LOG_WARNING, "Unable to allocate variable\n");
981                         return 1;
982                 }
983
984                 ast_variable_append(cat, var);
985         }
986
987         return 0;
988 }
989
990 static struct ast_config *realtime_multi_handler(const char *database, 
991         const char *table, va_list ap)
992 {
993         char *query, *errormsg, *op, *tmp_str, *initfield;
994         struct rt_multi_cfg_entry_args args;
995         const char **params, **vals;
996         struct ast_config *cfg;
997         size_t params_count;
998         int error;
999
1000         if (!table) {
1001                 ast_log(LOG_WARNING, "Table name unspecified\n");
1002                 return NULL;
1003         }
1004
1005         if (!(cfg = ast_config_new())) {
1006                 ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
1007                 return NULL;
1008         }
1009
1010         if (!(params_count = get_params(ap, &params, &vals))) {
1011                 ast_config_destroy(cfg);
1012                 return NULL;
1013         }
1014
1015         if (!(initfield = ast_strdup(params[0]))) {
1016                 ast_config_destroy(cfg);
1017                 free(params);
1018                 free(vals);
1019                 return NULL;
1020         }
1021
1022         tmp_str = strchr(initfield, ' ');
1023
1024         if (tmp_str)
1025                 *tmp_str = '\0';
1026
1027         op = (!strchr(params[0], ' ')) ? " =" : "";
1028
1029         /*
1030          * Asterisk sends us an already escaped string when searching for
1031          * "exten LIKE" (uh!). Handle it separately.
1032          */
1033         tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
1034
1035 /* \cond DOXYGEN_CAN_PARSE_THIS */
1036 #undef QUERY
1037 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1038 /* \endcond */
1039
1040         if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
1041                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1042                 ast_config_destroy(cfg);
1043                 free(params);
1044                 free(vals);
1045                 free(initfield);
1046                 return NULL;
1047         }
1048
1049         if (params_count > 1) {
1050                 size_t i;
1051
1052                 for (i = 1; i < params_count; i++) {
1053                         op = (!strchr(params[i], ' ')) ? " =" : "";
1054                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op,
1055                                                                                                                          vals[i]);
1056                         sqlite_freemem(query);
1057
1058                         if (!tmp_str) {
1059                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1060                                 ast_config_destroy(cfg);
1061                                 free(params);
1062                                 free(vals);
1063                                 free(initfield);
1064                                 return NULL;
1065                         }
1066
1067                         query = tmp_str;
1068                 }
1069         }
1070
1071         free(params);
1072         free(vals);
1073
1074         if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
1075                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1076                 ast_config_destroy(cfg);
1077                 free(initfield);
1078                 return NULL;
1079         }
1080
1081         sqlite_freemem(query);
1082         query = tmp_str;
1083         ast_log(LOG_DEBUG, "SQL query: %s\n", query);
1084         args.cfg = cfg;
1085         args.initfield = initfield;
1086
1087         ast_mutex_lock(&mutex);
1088
1089         RES_SQLITE_BEGIN
1090                 error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
1091         RES_SQLITE_END(error)
1092
1093         ast_mutex_unlock(&mutex);
1094
1095         sqlite_freemem(query);
1096         free(initfield);
1097
1098         if (error) {
1099                 ast_log(LOG_WARNING, "%s\n", errormsg);
1100                 free(errormsg);
1101                 ast_config_destroy(cfg);
1102                 return NULL;
1103         }
1104
1105         return cfg;
1106 }
1107
1108 static int realtime_update_handler(const char *database, const char *table,
1109         const char *keyfield, const char *entity,
1110         va_list ap)
1111 {
1112         char *query, *errormsg, *tmp_str;
1113         const char **params, **vals;
1114         size_t params_count;
1115         int error, rows_num;
1116
1117         if (!table) {
1118                 ast_log(LOG_WARNING, "Table name unspecified\n");
1119                 return -1;
1120         }
1121
1122         if (!(params_count = get_params(ap, &params, &vals)))
1123                 return -1;
1124
1125 /* \cond DOXYGEN_CAN_PARSE_THIS */
1126 #undef QUERY
1127 #define QUERY "UPDATE '%q' SET %q = '%q'"
1128 /* \endcond */
1129
1130         if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
1131                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1132                 free(params);
1133                 free(vals);
1134                 return -1;
1135         }
1136
1137         if (params_count > 1) {
1138                 size_t i;
1139
1140                 for (i = 1; i < params_count; i++) {
1141                         tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i],
1142                                                                                                                          vals[i]);
1143                         sqlite_freemem(query);
1144
1145                         if (!tmp_str) {
1146                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1147                                 free(params);
1148                                 free(vals);
1149                                 return -1;
1150                         }
1151
1152                         query = tmp_str;
1153                 }
1154         }
1155
1156         free(params);
1157         free(vals);
1158
1159         if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
1160                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1161                 return -1;
1162         }
1163
1164         sqlite_freemem(query);
1165         query = tmp_str;
1166         ast_log(LOG_DEBUG, "SQL query: %s\n", query);
1167
1168         ast_mutex_lock(&mutex);
1169
1170         RES_SQLITE_BEGIN
1171                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1172         RES_SQLITE_END(error)
1173
1174         if (!error)
1175                 rows_num = sqlite_changes(db);
1176         else
1177                 rows_num = -1;
1178
1179         ast_mutex_unlock(&mutex);
1180
1181         sqlite_freemem(query);
1182
1183         if (error) {
1184                 ast_log(LOG_WARNING, "%s\n", errormsg);
1185                 free(errormsg);
1186         }
1187
1188         return rows_num;
1189 }
1190
1191 static int cli_status(int fd, int argc, char *argv[])
1192 {
1193         ast_cli(fd, "SQLite database path: %s\n", dbfile);
1194         ast_cli(fd, "config_table: ");
1195
1196         if (!config_table)
1197                 ast_cli(fd, "unspecified, must be present in extconfig.conf\n");
1198         else
1199                 ast_cli(fd, "%s\n", config_table);
1200
1201         ast_cli(fd, "cdr_table: ");
1202
1203         if (!cdr_table)
1204                 ast_cli(fd, "unspecified, CDR support disabled\n");
1205         else
1206                 ast_cli(fd, "%s\n", cdr_table);
1207
1208         return RESULT_SUCCESS;
1209 }
1210
1211 static int unload_module(void)
1212 {
1213         if (cli_status_registered)
1214                 ast_cli_unregister(&cli_status_cmd);
1215
1216         if (cdr_registered)
1217                 ast_cdr_unregister(RES_SQLITE_NAME);
1218
1219         ast_config_engine_deregister(&sqlite_engine);
1220
1221         if (db)
1222                 sqlite_close(db);
1223
1224         unload_config();
1225
1226         return 0;
1227 }
1228
1229 static int load_module(void)
1230 {
1231         char *errormsg;
1232         int error;
1233
1234         db = NULL;
1235         cdr_registered = 0;
1236         cli_status_registered = 0;
1237         dbfile = NULL;
1238         config_table = NULL;
1239         cdr_table = NULL;
1240         vm_count = 0;
1241         error = load_config();
1242
1243         if (error)
1244                 return AST_MODULE_LOAD_DECLINE;
1245
1246         if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
1247                 ast_log(LOG_ERROR, "%s\n", errormsg);
1248                 free(errormsg);
1249                 unload_module();
1250                 return 1;
1251         }
1252
1253         ast_config_engine_register(&sqlite_engine);
1254
1255         if (use_cdr) {
1256                 RES_SQLITE_BEGIN
1257                         error = sqlite_exec_printf(db, "SELECT COUNT(id) FROM %Q;", NULL, NULL,
1258                                                                                                                                  &errormsg, cdr_table);
1259                 RES_SQLITE_END(error)
1260
1261                 if (error) {
1262                         /*
1263                          * Unexpected error.
1264                          */
1265                         if (error != SQLITE_ERROR) {
1266                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1267                                 free(errormsg);
1268                                 unload_module();
1269                                 return 1;
1270                         }
1271
1272                         RES_SQLITE_BEGIN
1273                                 error = sqlite_exec_printf(db, sql_create_cdr_table, NULL, NULL,
1274                                                                 &errormsg, cdr_table);
1275                         RES_SQLITE_END(error)
1276
1277                         if (error) {
1278                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1279                                 free(errormsg);
1280                                 unload_module();
1281                                 return 1;
1282                         }
1283                 }
1284
1285                 error = ast_cdr_register(RES_SQLITE_NAME, RES_SQLITE_DESCRIPTION,
1286                                                                                                                  cdr_handler);
1287
1288                 if (error) {
1289                         unload_module();
1290                         return 1;
1291                 }
1292
1293                 cdr_registered = 1;
1294         }
1295
1296         error = ast_cli_register(&cli_status_cmd);
1297
1298         if (error) {
1299                 unload_module();
1300                 return 1;
1301         }
1302
1303         cli_status_registered = 1;
1304
1305         return 0;
1306 }
1307
1308 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
1309                 .load = load_module,
1310                 .unload = unload_module,
1311 );