(closes issue #10271)
[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  * \page 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 
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  * \brief Allocate a variable.
236  * \param var the address of the variable to set (it will be allocated)
237  * \param name the name of the variable (for error handling)
238  * \param value the value to store in var
239  * \retval 0 on success
240  * \retval 1 if an allocation error occurred
241  */
242 static int set_var(char **var, char *name, char *value);
243
244 /*!
245  * \brief Load the configuration file.
246  * \see unload_config()
247  * 
248  * This function sets dbfile, config_table, and cdr_table. It calls
249  * check_vars() before returning, and unload_config() if an error occurred.
250  * 
251  * \retval 0 on success
252  * \retval 1 if an error occurred
253  */
254 static int load_config(void);
255
256 /*!
257  * \brief Free resources related to configuration.
258  * \see load_config()
259  */
260 static void unload_config(void);
261
262 /*!
263  * \brief Asterisk callback function for CDR support.
264  * \param cdr the CDR entry Asterisk sends us
265  * 
266  * Asterisk will call this function each time a CDR entry must be logged if
267  * CDR support is enabled.
268  * 
269  * \retval 0 on success
270  * \retval 1 if an error occurred
271  */
272 static int cdr_handler(struct ast_cdr *cdr);
273
274 /*!
275  * \brief SQLite callback function for static configuration.
276  * 
277  * This function is passed to the SQLite engine as a callback function to
278  * parse a row and store it in a struct ast_config object. It relies on
279  * resulting rows       being sorted by category.
280  * 
281  * \param arg a pointer to a struct cfg_entry_args object
282  * \param argc number of columns
283  * \param argv values in the row
284  * \param columnNames names and types of the columns
285  * \retval 0 on success
286  * \retval 1 if an error occurred
287  * \see cfg_entry_args
288  * \see sql_get_config_table
289  * \see config_handler()
290  */
291 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames);
292
293 /*!
294  * \brief Asterisk callback function for static configuration.
295  * 
296  * Asterisk will call this function when it loads its static configuration,
297  * which usually happens at startup and reload.
298  * 
299  * \param database the database to use (ignored)
300  * \param table the table to use
301  * \param file the file to load from the database
302  * \param cfg the struct ast_config object to use when storing variables
303  * \param withcomments  Integer. Flag
304  * \retval cfg object
305  * \retval NULL if an error occurred
306  * \see add_cfg_entry()
307  */
308 static struct ast_config * config_handler(const char *database,
309         const char *table, const char *file,
310         struct ast_config *cfg, int withcomments);
311
312 /*!
313  * \brief Helper function to parse a va_list object into 2 dynamic arrays of
314  * strings, parameters and values.
315  * 
316  * ap must have the following format : param1 val1 param2 val2 param3 val3 ...
317  * arguments will be extracted to create 2 arrays:
318  * 
319  * <ul>
320  *      <li>params : param1 param2 param3 ...</li>
321  *      <li>vals : val1 val2 val3 ...</li>
322  * </ul>
323  * 
324  * The address of these arrays are stored in params_ptr and vals_ptr. It
325  * is the responsibility of the caller to release the memory of these arrays.
326  * It is considered an error that va_list has a null or odd number of strings.
327  * 
328  * \param ap the va_list object to parse
329  * \param params_ptr where the address of the params array is stored
330  * \param vals_ptr where the address of the vals array is stored
331  * \retval the number of elements in the arrays (which have the same size).
332  * \retval 0 if an error occurred.
333  */
334 static size_t get_params(va_list ap, const char ***params_ptr,
335         const char ***vals_ptr);
336
337 /*!
338  * \brief SQLite callback function for RealTime configuration.
339  * 
340  * This function is passed to the SQLite engine as a callback function to
341  * parse a row and store it in a linked list of struct ast_variable objects.
342  * 
343  * \param arg a pointer to a struct rt_cfg_entry_args object
344  * \param argc number of columns
345  * \param argv values in the row
346  * \param columnNames names and types of the columns
347  * \retval 0 on success.
348  * \retval 1 if an error occurred.
349  * \see rt_cfg_entry_args
350  * \see realtime_handler()
351  */
352 static int add_rt_cfg_entry(void *arg, int argc, char **argv,
353         char **columnNames);
354
355 /*!
356  * Asterisk callback function for RealTime configuration.
357  * 
358  * Asterisk will call this function each time it requires a variable
359  * through the RealTime architecture. ap is a list of parameters and
360  * values used to find a specific row, e.g one parameter "name" and
361  * one value "123" so that the SQL query becomes <code>SELECT * FROM
362  * table WHERE name = '123';</code>.
363  * 
364  * \param database the database to use (ignored)
365  * \param table         the table to use
366  * \param ap                     list of parameters and values to match
367  *
368  * \retval a linked list of struct ast_variable objects
369  * \retval NULL if an error occurred
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  * \brief 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  * \retval 0 on success.
387  * \retval 1 if an error occurred.
388  * \see rt_multi_cfg_entry_args
389  * \see realtime_multi_handler()
390  */
391 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv,
392         char **columnNames);
393
394 /*!
395  * \brief Asterisk callback function for RealTime configuration.
396  * 
397  * This function performs the same actions as realtime_handler() except
398  * that it can store variables per category, and can return several
399  * categories.
400  * 
401  * \param database the database to use (ignored)
402  * \param table the table to use
403  * \param ap list of parameters and values to match
404  * \retval a struct ast_config object storing categories and variables.
405  * \retval NULL if an error occurred.
406  *
407  * \see add_rt_multi_cfg_entry()
408  */
409 static struct ast_config * realtime_multi_handler(const char *database,
410         const char *table,
411         va_list ap);
412
413 /*!
414  * \brief Asterisk callback function for RealTime configuration (variable
415  * update).
416  * 
417  * Asterisk will call this function each time a variable has been modified
418  * internally and must be updated in the backend engine. keyfield and entity
419  * are used to find the row to update, e.g. <code>UPDATE table SET ... WHERE
420  * keyfield = 'entity';</code>. ap is a list of parameters and values with the
421  * same format as the other realtime functions.
422  * 
423  * \param database the database to use (ignored)
424  * \param table the table to use
425  * \param keyfield the column of the matching cell
426  * \param entity the value of the matching cell
427  * \param ap list of parameters and new values to update in the database
428  * \retval the number of affected rows.
429  * \retval -1 if an error occurred.
430  */
431 static int realtime_update_handler(const char *database, const char *table,
432         const char *keyfield, const char *entity,
433         va_list ap);
434
435 /*!
436  * \brief Asterisk callback function for the CLI status command.
437  * 
438  * \param fd file descriptor provided by Asterisk to use with ast_cli()
439  * \param argc number of arguments
440  * \param argv arguments list
441  * \return RESULT_SUCCESS
442  */
443 static int cli_status(int fd, int argc, char *argv[]);
444
445 /*! The SQLite database object. */
446 static sqlite *db;
447
448 /*! Set to 1 if CDR support is enabled. */
449 static int use_cdr;
450
451 /*! Set to 1 if the CDR callback function was registered. */
452 static int cdr_registered;
453
454 /*! Set to 1 if the CLI status command callback function was registered. */
455 static int cli_status_registered;
456
457 /*! The path of the database file. */
458 static char *dbfile;
459
460 /*! The name of the static configuration table. */
461 static char *config_table;
462
463 /*! The name of the table used to store CDR entries. */
464 static char *cdr_table;
465
466 /*! The number of registered virtual machines. */
467 static int vm_count;
468
469 /*!
470  * The structure specifying all callback functions used by Asterisk for static
471  * and RealTime configuration.
472  */
473 static struct ast_config_engine sqlite_engine =
474 {
475         .name = RES_SQLITE_DRIVER,
476         .load_func = config_handler,
477         .realtime_func = realtime_handler,
478         .realtime_multi_func = realtime_multi_handler,
479         .update_func = realtime_update_handler
480 };
481
482 /*!
483  * The mutex used to prevent simultaneous access to the SQLite database.
484  * SQLite isn't always compiled with thread safety.
485  */
486 AST_MUTEX_DEFINE_STATIC(mutex);
487
488 /*!
489  * Structure containing details and callback functions for the CLI status
490  * command.
491  */
492 static struct ast_cli_entry cli_status_cmd =
493 {
494         .cmda = {"show", "sqlite", "status", NULL},
495         .handler = cli_status,
496         .summary = RES_SQLITE_STATUS_SUMMARY,
497         .usage = RES_SQLITE_STATUS_USAGE
498 };
499
500 /*
501  * Taken from Asterisk 1.2 cdr_sqlite.so.
502  */
503
504 /*! SQL query format to create the CDR table if non existent. */
505 static char *sql_create_cdr_table =
506 "CREATE TABLE '%q' ("
507 "       id              INTEGER PRIMARY KEY,"
508 "       clid            VARCHAR(80) NOT NULL DEFAULT '',"
509 "       src             VARCHAR(80) NOT NULL DEFAULT '',"
510 "       dst             VARCHAR(80) NOT NULL DEFAULT '',"
511 "       dcontext        VARCHAR(80) NOT NULL DEFAULT '',"
512 "       channel         VARCHAR(80) NOT NULL DEFAULT '',"
513 "       dstchannel      VARCHAR(80) NOT NULL DEFAULT '',"
514 "       lastapp         VARCHAR(80) NOT NULL DEFAULT '',"
515 "       lastdata        VARCHAR(80) NOT NULL DEFAULT '',"
516 "       start           CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
517 "       answer          CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
518 "       end             CHAR(19) NOT NULL DEFAULT '0000-00-00 00:00:00',"
519 "       duration        INT(11) NOT NULL DEFAULT '0',"
520 "       billsec         INT(11) NOT NULL DEFAULT '0',"
521 "       disposition     INT(11) NOT NULL DEFAULT '0',"
522 "       amaflags        INT(11) NOT NULL DEFAULT '0',"
523 "       accountcode     VARCHAR(20) NOT NULL DEFAULT '',"
524 "       uniqueid        VARCHAR(32) NOT NULL DEFAULT '',"
525 "       userfield       VARCHAR(255) NOT NULL DEFAULT ''"
526 ");";
527
528 /*! SQL query format to insert a CDR entry. */
529 static char *sql_add_cdr_entry =
530 "INSERT INTO '%q' ("
531 "                        clid,"
532 "       src,"
533 "       dst,"
534 "       dcontext,"
535 "       channel,"
536 "       dstchannel,"
537 "       lastapp,"
538 "       lastdata,"
539 "       start,"
540 "       answer,"
541 "       end,"
542 "       duration,"
543 "       billsec,"
544 "       disposition,"
545 "       amaflags,"
546 "       accountcode,"
547 "       uniqueid,"
548 "       userfield"
549 ") VALUES ("
550 "       '%q',"
551 "       '%q',"
552 "       '%q',"
553 "       '%q',"
554 "       '%q',"
555 "       '%q',"
556 "       '%q',"
557 "       '%q',"
558 "       datetime(%d,'unixepoch'),"
559 "       datetime(%d,'unixepoch'),"
560 "       datetime(%d,'unixepoch'),"
561 "       '%ld',"
562 "       '%ld',"
563 "       '%ld',"
564 "       '%ld',"
565 "       '%q',"
566 "       '%q',"
567 "       '%q'"
568 ");";
569
570 /*!
571  * SQL query format to fetch the static configuration of a file.
572  * Rows must be sorted by category.
573  * 
574  * \see add_cfg_entry()
575  */
576 static char *sql_get_config_table =
577 "SELECT *"
578 "       FROM '%q'"
579 "       WHERE filename = '%q' AND commented = 0"
580 "       ORDER BY category;";
581
582 static int set_var(char **var, char *name, char *value)
583 {
584         if (*var)
585                 ast_free(*var);
586
587         *var = ast_strdup(value);
588
589         if (!*var) {
590                 ast_log(LOG_WARNING, "Unable to allocate variable %s\n", name);
591                 return 1;
592         }
593
594         return 0;
595 }
596
597 static int check_vars(void)
598 {
599         if (!dbfile) {
600                 ast_log(LOG_ERROR, "Undefined parameter %s\n", dbfile);
601                 return 1;
602         }
603
604         use_cdr = (cdr_table != NULL);
605
606         return 0;
607 }
608
609 static int load_config(void)
610 {
611         struct ast_config *config;
612         struct ast_variable *var;
613         int error;
614
615         config = ast_config_load(RES_SQLITE_CONF_FILE);
616
617         if (!config) {
618                 ast_log(LOG_ERROR, "Unable to load " RES_SQLITE_CONF_FILE "\n");
619                 return 1;
620         }
621
622         for (var = ast_variable_browse(config, "general"); var; var = var->next) {
623                 if (!strcasecmp(var->name, "dbfile"))
624                         SET_VAR(config, dbfile, var);
625                 else if (!strcasecmp(var->name, "config_table"))
626                         SET_VAR(config, config_table, var);
627                 else if (!strcasecmp(var->name, "cdr_table"))
628                         SET_VAR(config, cdr_table, var);
629                 else
630                         ast_log(LOG_WARNING, "Unknown parameter : %s\n", var->name);
631         }
632
633         ast_config_destroy(config);
634         error = check_vars();
635
636         if (error) {
637                 unload_config();
638                 return 1;
639         }
640
641         return 0;
642 }
643
644 static void unload_config(void)
645 {
646         ast_free(dbfile);
647         dbfile = NULL;
648         ast_free(config_table);
649         config_table = NULL;
650         ast_free(cdr_table);
651         cdr_table = NULL;
652 }
653
654 static int cdr_handler(struct ast_cdr *cdr)
655 {
656         char *errormsg;
657         int error;
658
659         ast_mutex_lock(&mutex);
660
661         RES_SQLITE_BEGIN
662                 error = sqlite_exec_printf(db, sql_add_cdr_entry, NULL, NULL, &errormsg,
663                                          cdr_table, cdr->clid, cdr->src, cdr->dst,
664                                          cdr->dcontext, cdr->channel, cdr->dstchannel,
665                                          cdr->lastapp, cdr->lastdata, cdr->start.tv_sec,
666                                          cdr->answer.tv_sec, cdr->end.tv_sec,
667                                          cdr->duration, cdr->billsec, cdr->disposition,
668                                          cdr->amaflags, cdr->accountcode, cdr->uniqueid,
669                                          cdr->userfield);
670         RES_SQLITE_END(error)
671
672         ast_mutex_unlock(&mutex);
673
674         if (error) {
675                 ast_log(LOG_ERROR, "%s\n", errormsg);
676                 ast_free(errormsg);
677                 return 1;
678         }
679
680         return 0;
681 }
682
683 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
684 {
685         struct cfg_entry_args *args;
686         struct ast_variable *var;
687
688         if (argc != RES_SQLITE_CONFIG_COLUMNS) {
689                 ast_log(LOG_WARNING, "Corrupt table\n");
690                 return 1;
691         }
692
693         args = arg;
694
695         if (!args->cat_name || strcmp(args->cat_name, argv[RES_SQLITE_CONFIG_CATEGORY])) {
696                 args->cat = ast_category_new(argv[RES_SQLITE_CONFIG_CATEGORY]);
697
698                 if (!args->cat) {
699                         ast_log(LOG_WARNING, "Unable to allocate category\n");
700                         return 1;
701                 }
702
703                 ast_free(args->cat_name);
704                 args->cat_name = ast_strdup(argv[RES_SQLITE_CONFIG_CATEGORY]);
705
706                 if (!args->cat_name) {
707                         ast_category_destroy(args->cat);
708                         return 1;
709                 }
710
711                 ast_category_append(args->cfg, args->cat);
712         }
713
714         var = ast_variable_new(argv[RES_SQLITE_CONFIG_VAR_NAME],
715                  argv[RES_SQLITE_CONFIG_VAR_VAL]);
716
717         if (!var) {
718                 ast_log(LOG_WARNING, "Unable to allocate variable");
719                 return 1;
720         }
721
722         ast_variable_append(args->cat, var);
723         
724         return 0;
725 }
726
727 static struct ast_config *config_handler(const char *database, 
728         const char *table, const char *file, struct ast_config *cfg, int withcomments)
729 {
730         struct cfg_entry_args args;
731         char *errormsg;
732         int error;
733
734         if (!config_table) {
735                 if (!table) {
736                         ast_log(LOG_ERROR, "Table name unspecified\n");
737                         return NULL;
738                 }
739         } else
740                 table = config_table;
741
742         args.cfg = cfg;
743         args.cat = NULL;
744         args.cat_name = NULL;
745
746         ast_mutex_lock(&mutex);
747
748         RES_SQLITE_BEGIN
749                 error = sqlite_exec_printf(db, sql_get_config_table, add_cfg_entry,
750                                         &args, &errormsg, table, file);
751         RES_SQLITE_END(error)
752
753         ast_mutex_unlock(&mutex);
754
755         ast_free(args.cat_name);
756
757         if (error) {
758                 ast_log(LOG_ERROR, "%s\n", errormsg);
759                 ast_free(errormsg);
760                 return NULL;
761         }
762
763         return cfg;
764 }
765
766 static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr)
767 {
768         const char **tmp, *param, *val, **params, **vals;
769         size_t params_count;
770
771         params = NULL;
772         vals = NULL;
773         params_count = 0;
774
775         while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
776                 if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
777                         ast_free(params);
778                         ast_free(vals);
779                         return 0;
780                 }
781                 params = tmp;
782
783                 if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
784                         ast_free(params);
785                         ast_free(vals);
786                         return 0;
787                 }
788                 vals = tmp;
789
790                 params[params_count] = param;
791                 vals[params_count] = val;
792                 params_count++;
793         }
794
795         if (params_count > 0) {
796                 *params_ptr = params;
797                 *vals_ptr = vals;
798         } else
799                 ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
800
801         return params_count;
802 }
803
804 static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
805 {
806         struct rt_cfg_entry_args *args;
807         struct ast_variable *var;
808         int i;
809
810         args = arg;
811
812         for (i = 0; i < argc; i++) {
813                 if (!argv[i])
814                         continue;
815
816                 if (!(var = ast_variable_new(columnNames[i], argv[i])))
817                         return 1;
818
819                 if (!args->var)
820                         args->var = var;
821
822                 if (!args->last)
823                         args->last = var;
824                 else {
825                         args->last->next = var;
826                         args->last = var;
827                 }
828         }
829
830         return 0;
831 }
832
833 static struct ast_variable *
834 realtime_handler(const char *database, const char *table, va_list ap)
835 {
836         char *query, *errormsg, *op, *tmp_str;
837         struct rt_cfg_entry_args args;
838         const char **params, **vals;
839         size_t params_count;
840         int error;
841
842         if (!table) {
843                 ast_log(LOG_WARNING, "Table name unspecified\n");
844                 return NULL;
845         }
846
847         params_count = get_params(ap, &params, &vals);
848
849         if (params_count == 0)
850                 return NULL;
851
852         op = (strchr(params[0], ' ') == NULL) ? " =" : "";
853
854 /* \cond DOXYGEN_CAN_PARSE_THIS */
855 #undef QUERY
856 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
857 /* \endcond */
858
859         query = sqlite_mprintf(QUERY, table, params[0], op, vals[0]);
860
861         if (!query) {
862                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
863                 ast_free(params);
864                 ast_free(vals);
865                 return NULL;
866         }
867
868         if (params_count > 1) {
869                 size_t i;
870
871                 for (i = 1; i < params_count; i++) {
872                         op = (strchr(params[i], ' ') == NULL) ? " =" : "";
873                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op,
874                                                                                                                          vals[i]);
875                         sqlite_freemem(query);
876
877                         if (!tmp_str) {
878                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
879                                 ast_free(params);
880                                 ast_free(vals);
881                                 return NULL;
882                         }
883
884                         query = tmp_str;
885                 }
886         }
887
888         ast_free(params);
889         ast_free(vals);
890
891         tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
892         sqlite_freemem(query);
893
894         if (!tmp_str) {
895                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
896                 return NULL;
897         }
898
899         query = tmp_str;
900         ast_debug(1, "SQL query: %s\n", query);
901         args.var = NULL;
902         args.last = NULL;
903
904         ast_mutex_lock(&mutex);
905
906         RES_SQLITE_BEGIN
907                 error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
908         RES_SQLITE_END(error)
909
910         ast_mutex_unlock(&mutex);
911
912         sqlite_freemem(query);
913
914         if (error) {
915                 ast_log(LOG_WARNING, "%s\n", errormsg);
916                 ast_free(errormsg);
917                 ast_variables_destroy(args.var);
918                 return NULL;
919         }
920
921         return args.var;
922 }
923
924 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
925 {
926         struct rt_multi_cfg_entry_args *args;
927         struct ast_category *cat;
928         struct ast_variable *var;
929         char *cat_name;
930         size_t i;
931
932         args = (struct rt_multi_cfg_entry_args *)arg;
933         cat_name = NULL;
934
935         /*
936          * cat_name should always be set here, since initfield is forged from
937          * params[0] in realtime_multi_handler(), which is a search parameter
938          * of the SQL query.
939          */
940         for (i = 0; i < argc; i++) {
941                 if (!strcmp(args->initfield, columnNames[i]))
942                         cat_name = argv[i];
943         }
944
945         if (!cat_name) {
946                 ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
947                 return 1;
948         }
949
950         if (!(cat = ast_category_new(cat_name))) {
951                 ast_log(LOG_WARNING, "Unable to allocate category\n");
952                 return 1;
953         }
954
955         ast_category_append(args->cfg, cat);
956
957         for (i = 0; i < argc; i++) {
958                 if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
959                         continue;
960
961                 if (!(var = ast_variable_new(columnNames[i], argv[i]))) {
962                         ast_log(LOG_WARNING, "Unable to allocate variable\n");
963                         return 1;
964                 }
965
966                 ast_variable_append(cat, var);
967         }
968
969         return 0;
970 }
971
972 static struct ast_config *realtime_multi_handler(const char *database, 
973         const char *table, va_list ap)
974 {
975         char *query, *errormsg, *op, *tmp_str, *initfield;
976         struct rt_multi_cfg_entry_args args;
977         const char **params, **vals;
978         struct ast_config *cfg;
979         size_t params_count;
980         int error;
981
982         if (!table) {
983                 ast_log(LOG_WARNING, "Table name unspecified\n");
984                 return NULL;
985         }
986
987         if (!(cfg = ast_config_new())) {
988                 ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
989                 return NULL;
990         }
991
992         if (!(params_count = get_params(ap, &params, &vals))) {
993                 ast_config_destroy(cfg);
994                 return NULL;
995         }
996
997         if (!(initfield = ast_strdup(params[0]))) {
998                 ast_config_destroy(cfg);
999                 ast_free(params);
1000                 ast_free(vals);
1001                 return NULL;
1002         }
1003
1004         tmp_str = strchr(initfield, ' ');
1005
1006         if (tmp_str)
1007                 *tmp_str = '\0';
1008
1009         op = (!strchr(params[0], ' ')) ? " =" : "";
1010
1011         /*
1012          * Asterisk sends us an already escaped string when searching for
1013          * "exten LIKE" (uh!). Handle it separately.
1014          */
1015         tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
1016
1017 /* \cond DOXYGEN_CAN_PARSE_THIS */
1018 #undef QUERY
1019 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1020 /* \endcond */
1021
1022         if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
1023                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1024                 ast_config_destroy(cfg);
1025                 ast_free(params);
1026                 ast_free(vals);
1027                 ast_free(initfield);
1028                 return NULL;
1029         }
1030
1031         if (params_count > 1) {
1032                 size_t i;
1033
1034                 for (i = 1; i < params_count; i++) {
1035                         op = (!strchr(params[i], ' ')) ? " =" : "";
1036                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op,
1037                                                                                                                          vals[i]);
1038                         sqlite_freemem(query);
1039
1040                         if (!tmp_str) {
1041                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1042                                 ast_config_destroy(cfg);
1043                                 ast_free(params);
1044                                 ast_free(vals);
1045                                 ast_free(initfield);
1046                                 return NULL;
1047                         }
1048
1049                         query = tmp_str;
1050                 }
1051         }
1052
1053         ast_free(params);
1054         ast_free(vals);
1055
1056         if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
1057                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1058                 ast_config_destroy(cfg);
1059                 ast_free(initfield);
1060                 return NULL;
1061         }
1062
1063         sqlite_freemem(query);
1064         query = tmp_str;
1065         ast_debug(1, "SQL query: %s\n", query);
1066         args.cfg = cfg;
1067         args.initfield = initfield;
1068
1069         ast_mutex_lock(&mutex);
1070
1071         RES_SQLITE_BEGIN
1072                 error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
1073         RES_SQLITE_END(error)
1074
1075         ast_mutex_unlock(&mutex);
1076
1077         sqlite_freemem(query);
1078         ast_free(initfield);
1079
1080         if (error) {
1081                 ast_log(LOG_WARNING, "%s\n", errormsg);
1082                 ast_free(errormsg);
1083                 ast_config_destroy(cfg);
1084                 return NULL;
1085         }
1086
1087         return cfg;
1088 }
1089
1090 static int realtime_update_handler(const char *database, const char *table,
1091         const char *keyfield, const char *entity,
1092         va_list ap)
1093 {
1094         char *query, *errormsg, *tmp_str;
1095         const char **params, **vals;
1096         size_t params_count;
1097         int error, rows_num;
1098
1099         if (!table) {
1100                 ast_log(LOG_WARNING, "Table name unspecified\n");
1101                 return -1;
1102         }
1103
1104         if (!(params_count = get_params(ap, &params, &vals)))
1105                 return -1;
1106
1107 /* \cond DOXYGEN_CAN_PARSE_THIS */
1108 #undef QUERY
1109 #define QUERY "UPDATE '%q' SET %q = '%q'"
1110 /* \endcond */
1111
1112         if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
1113                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1114                 ast_free(params);
1115                 ast_free(vals);
1116                 return -1;
1117         }
1118
1119         if (params_count > 1) {
1120                 size_t i;
1121
1122                 for (i = 1; i < params_count; i++) {
1123                         tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i],
1124                                                                                                                          vals[i]);
1125                         sqlite_freemem(query);
1126
1127                         if (!tmp_str) {
1128                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1129                                 ast_free(params);
1130                                 ast_free(vals);
1131                                 return -1;
1132                         }
1133
1134                         query = tmp_str;
1135                 }
1136         }
1137
1138         ast_free(params);
1139         ast_free(vals);
1140
1141         if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
1142                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1143                 return -1;
1144         }
1145
1146         sqlite_freemem(query);
1147         query = tmp_str;
1148         ast_debug(1, "SQL query: %s\n", query);
1149
1150         ast_mutex_lock(&mutex);
1151
1152         RES_SQLITE_BEGIN
1153                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1154         RES_SQLITE_END(error)
1155
1156         if (!error)
1157                 rows_num = sqlite_changes(db);
1158         else
1159                 rows_num = -1;
1160
1161         ast_mutex_unlock(&mutex);
1162
1163         sqlite_freemem(query);
1164
1165         if (error) {
1166                 ast_log(LOG_WARNING, "%s\n", errormsg);
1167                 ast_free(errormsg);
1168         }
1169
1170         return rows_num;
1171 }
1172
1173 static int cli_status(int fd, int argc, char *argv[])
1174 {
1175         ast_cli(fd, "SQLite database path: %s\n", dbfile);
1176         ast_cli(fd, "config_table: ");
1177
1178         if (!config_table)
1179                 ast_cli(fd, "unspecified, must be present in extconfig.conf\n");
1180         else
1181                 ast_cli(fd, "%s\n", config_table);
1182
1183         ast_cli(fd, "cdr_table: ");
1184
1185         if (!cdr_table)
1186                 ast_cli(fd, "unspecified, CDR support disabled\n");
1187         else
1188                 ast_cli(fd, "%s\n", cdr_table);
1189
1190         return RESULT_SUCCESS;
1191 }
1192
1193 static int unload_module(void)
1194 {
1195         if (cli_status_registered)
1196                 ast_cli_unregister(&cli_status_cmd);
1197
1198         if (cdr_registered)
1199                 ast_cdr_unregister(RES_SQLITE_NAME);
1200
1201         ast_config_engine_deregister(&sqlite_engine);
1202
1203         if (db)
1204                 sqlite_close(db);
1205
1206         unload_config();
1207
1208         return 0;
1209 }
1210
1211 static int load_module(void)
1212 {
1213         char *errormsg;
1214         int error;
1215
1216         db = NULL;
1217         cdr_registered = 0;
1218         cli_status_registered = 0;
1219         dbfile = NULL;
1220         config_table = NULL;
1221         cdr_table = NULL;
1222         vm_count = 0;
1223         error = load_config();
1224
1225         if (error)
1226                 return AST_MODULE_LOAD_DECLINE;
1227
1228         if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
1229                 ast_log(LOG_ERROR, "%s\n", errormsg);
1230                 ast_free(errormsg);
1231                 unload_module();
1232                 return 1;
1233         }
1234
1235         ast_config_engine_register(&sqlite_engine);
1236
1237         if (use_cdr) {
1238                 RES_SQLITE_BEGIN
1239                         error = sqlite_exec_printf(db, "SELECT COUNT(id) FROM %Q;", NULL, NULL,
1240                                                                                                                                  &errormsg, cdr_table);
1241                 RES_SQLITE_END(error)
1242
1243                 if (error) {
1244                         /*
1245                          * Unexpected error.
1246                          */
1247                         if (error != SQLITE_ERROR) {
1248                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1249                                 ast_free(errormsg);
1250                                 unload_module();
1251                                 return 1;
1252                         }
1253
1254                         RES_SQLITE_BEGIN
1255                                 error = sqlite_exec_printf(db, sql_create_cdr_table, NULL, NULL,
1256                                                                 &errormsg, cdr_table);
1257                         RES_SQLITE_END(error)
1258
1259                         if (error) {
1260                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1261                                 ast_free(errormsg);
1262                                 unload_module();
1263                                 return 1;
1264                         }
1265                 }
1266
1267                 error = ast_cdr_register(RES_SQLITE_NAME, RES_SQLITE_DESCRIPTION,
1268                                                                                                                  cdr_handler);
1269
1270                 if (error) {
1271                         unload_module();
1272                         return 1;
1273                 }
1274
1275                 cdr_registered = 1;
1276         }
1277
1278         error = ast_cli_register(&cli_status_cmd);
1279
1280         if (error) {
1281                 unload_module();
1282                 return 1;
1283         }
1284
1285         cli_status_registered = 1;
1286
1287         return 0;
1288 }
1289
1290 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
1291                 .load = load_module,
1292                 .unload = unload_module,
1293 );