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