Add adaptive capabilities to the sqlite realtime driver
[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).  It can also be used to log CDR entries. 
31  * Note that Asterisk already comes with a module named cdr_sqlite.
32  * There are two reasons for including it in res_config_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  * \section conf_sec Configuration
38  *
39  * The main configuration file is res_config_sqlite.conf. It must be readable or
40  * res_config_sqlite will fail to start. It is suggested to use the sample file
41  * in this package as a starting point. The file has only one section
42  * named <code>general</code>. Here are the supported parameters :
43  *
44  * <dl>
45  *      <dt><code>dbfile</code></dt>
46  *      <dd>The absolute path to the SQLite database (the file can be non existent,
47  *                      res_config_sqlite will create it if it has the appropriate rights)</dd>
48  *      <dt><code>config_table</code></dt>
49  *      <dd>The table used for static configuration</dd>
50  *      <dt><code>cdr_table</code></dt>
51  *      <dd>The table used to store CDR entries (if ommitted, CDR support is
52  *                      disabled)</dd>
53  * </dl>
54  *
55  * To use res_config_sqlite for static and/or RealTime configuration, refer to the
56  * Asterisk documentation. The file tables.sql can be used to create the
57  * needed tables.
58  *
59  * \section status_sec Driver status
60  *
61  * The CLI command <code>show sqlite status</code> returns status information
62  * about the running driver.
63  *
64  * \section credits_sec Credits
65  *
66  * res_config_sqlite was developed by Richard Braun at the Proformatique company.
67  */
68
69 /*!
70  * \file
71  * \brief res_config_sqlite module.
72  */
73
74 /*** MODULEINFO
75         <depend>sqlite</depend>
76  ***/
77
78 #include "asterisk.h"
79 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
80
81 #include <sqlite.h>
82
83 #include "asterisk/app.h"
84 #include "asterisk/pbx.h"
85 #include "asterisk/cdr.h"
86 #include "asterisk/cli.h"
87 #include "asterisk/lock.h"
88 #include "asterisk/config.h"
89 #include "asterisk/module.h"
90 #include "asterisk/linkedlists.h"
91
92 #define MACRO_BEGIN     do {
93 #define MACRO_END       } while (0)
94
95 #define RES_CONFIG_SQLITE_NAME "res_config_sqlite"
96 #define RES_CONFIG_SQLITE_DRIVER "sqlite"
97 #define RES_CONFIG_SQLITE_DESCRIPTION "Resource Module for SQLite 2"
98 #define RES_CONFIG_SQLITE_CONF_FILE "res_config_sqlite.conf"
99
100 enum {
101         RES_CONFIG_SQLITE_CONFIG_ID,
102         RES_CONFIG_SQLITE_CONFIG_CAT_METRIC,
103         RES_CONFIG_SQLITE_CONFIG_VAR_METRIC,
104         RES_CONFIG_SQLITE_CONFIG_COMMENTED,
105         RES_CONFIG_SQLITE_CONFIG_FILENAME,
106         RES_CONFIG_SQLITE_CONFIG_CATEGORY,
107         RES_CONFIG_SQLITE_CONFIG_VAR_NAME,
108         RES_CONFIG_SQLITE_CONFIG_VAR_VAL,
109         RES_CONFIG_SQLITE_CONFIG_COLUMNS,
110 };
111
112 #define SET_VAR(config, to, from)                       \
113 MACRO_BEGIN                                             \
114         int __error;                                    \
115                                                         \
116         __error = set_var(&to, #to, from->value);       \
117                                                         \
118         if (__error) {                                  \
119                 ast_config_destroy(config);             \
120                 unload_config();                        \
121                 return 1;                               \
122         }                                               \
123 MACRO_END
124
125 /*!
126  * Maximum number of loops before giving up executing a query. Calls to
127  * sqlite_xxx() functions which can return SQLITE_BUSY or SQLITE_LOCKED
128  * are enclosed by RES_CONFIG_SQLITE_BEGIN and RES_CONFIG_SQLITE_END, e.g.
129  * <pre>
130  * char *errormsg;
131  * int error;
132  *
133  * RES_CONFIG_SQLITE_BEGIN
134  *       error = sqlite_exec(db, query, NULL, NULL, &errormsg);
135  * RES_CONFIG_SQLITE_END(error)
136  *
137  * if (error)
138  *       ...;
139  * </pre>
140  */
141 #define RES_CONFIG_SQLITE_MAX_LOOPS 10
142
143 /*!
144  * Macro used before executing a query.
145  *
146  * \see RES_CONFIG_SQLITE_MAX_LOOPS.
147  */
148 #define RES_CONFIG_SQLITE_BEGIN                                         \
149 MACRO_BEGIN                                                             \
150         int __i;                                                        \
151                                                                         \
152         for (__i = 0; __i < RES_CONFIG_SQLITE_MAX_LOOPS; __i++) {
153
154 /*!
155  * Macro used after executing a query.
156  *
157  * \see RES_CONFIG_SQLITE_MAX_LOOPS.
158  */
159 #define RES_CONFIG_SQLITE_END(error)                                    \
160                 if (error != SQLITE_BUSY && error != SQLITE_LOCKED)     \
161                         break;                                          \
162                 usleep(1000);                                           \
163         }                                                               \
164 MACRO_END;
165
166 /*!
167  * Structure sent to the SQLite callback function for static configuration.
168  *
169  * \see add_cfg_entry()
170  */
171 struct cfg_entry_args {
172         struct ast_config *cfg;
173         struct ast_category *cat;
174         char *cat_name;
175         struct ast_flags flags;
176         const char *who_asked;
177 };
178
179 /*!
180  * Structure sent to the SQLite callback function for RealTime configuration.
181  *
182  * \see add_rt_cfg_entry()
183  */
184 struct rt_cfg_entry_args {
185         struct ast_variable *var;
186         struct ast_variable *last;
187 };
188
189 /*!
190  * Structure sent to the SQLite callback function for RealTime configuration
191  * (realtime_multi_handler()).
192  *
193  * \see add_rt_multi_cfg_entry()
194  */
195 struct rt_multi_cfg_entry_args {
196         struct ast_config *cfg;
197         char *initfield;
198 };
199
200 /*!
201  * \brief Allocate a variable.
202  * \param var the address of the variable to set (it will be allocated)
203  * \param name the name of the variable (for error handling)
204  * \param value the value to store in var
205  * \retval 0 on success
206  * \retval 1 if an allocation error occurred
207  */
208 static int set_var(char **var, const char *name, const char *value);
209
210 /*!
211  * \brief Load the configuration file.
212  * \see unload_config()
213  *
214  * This function sets dbfile, config_table, and cdr_table. It calls
215  * check_vars() before returning, and unload_config() if an error occurred.
216  *
217  * \retval 0 on success
218  * \retval 1 if an error occurred
219  */
220 static int load_config(void);
221
222 /*!
223  * \brief Free resources related to configuration.
224  * \see load_config()
225  */
226 static void unload_config(void);
227
228 /*!
229  * \brief Asterisk callback function for CDR support.
230  * \param cdr the CDR entry Asterisk sends us.
231  *
232  * Asterisk will call this function each time a CDR entry must be logged if
233  * CDR support is enabled.
234  *
235  * \retval 0 on success
236  * \retval 1 if an error occurred
237  */
238 static int cdr_handler(struct ast_cdr *cdr);
239
240 /*!
241  * \brief SQLite callback function for static configuration.
242  *
243  * This function is passed to the SQLite engine as a callback function to
244  * parse a row and store it in a struct ast_config object. It relies on
245  * resulting rows being sorted by category.
246  *
247  * \param arg a pointer to a struct cfg_entry_args object
248  * \param argc number of columns
249  * \param argv values in the row
250  * \param columnNames names and types of the columns
251  * \retval 0 on success
252  * \retval 1 if an error occurred
253  * \see cfg_entry_args
254  * \see sql_get_config_table
255  * \see config_handler()
256  */
257 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames);
258
259 /*!
260  * \brief Asterisk callback function for static configuration.
261  *
262  * Asterisk will call this function when it loads its static configuration,
263  * which usually happens at startup and reload.
264  *
265  * \param database the database to use (ignored)
266  * \param table the table to use
267  * \param file the file to load from the database
268  * \param cfg the struct ast_config object to use when storing variables
269  * \param flags Optional flags.  Not used.
270  * \param suggested_incl suggest include.
271  * \retval cfg object
272  * \retval NULL if an error occurred
273  * \see add_cfg_entry()
274  */
275 static struct ast_config * config_handler(const char *database, const char *table, const char *file,
276         struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked);
277
278 /*!
279  * \brief Helper function to parse a va_list object into 2 dynamic arrays of
280  * strings, parameters and values.
281  *
282  * ap must have the following format : param1 val1 param2 val2 param3 val3 ...
283  * arguments will be extracted to create 2 arrays:
284  *
285  * <ul>
286  *      <li>params : param1 param2 param3 ...</li>
287  *      <li>vals : val1 val2 val3 ...</li>
288  * </ul>
289  *
290  * The address of these arrays are stored in params_ptr and vals_ptr. It
291  * is the responsibility of the caller to release the memory of these arrays.
292  * It is considered an error that va_list has a null or odd number of strings.
293  *
294  * \param ap the va_list object to parse
295  * \param params_ptr where the address of the params array is stored
296  * \param vals_ptr where the address of the vals array is stored
297  * \retval the number of elements in the arrays (which have the same size).
298  * \retval 0 if an error occurred.
299  */
300 static size_t get_params(va_list ap, const char ***params_ptr,
301         const char ***vals_ptr);
302
303 /*!
304  * \brief SQLite callback function for RealTime configuration.
305  *
306  * This function is passed to the SQLite engine as a callback function to
307  * parse a row and store it in a linked list of struct ast_variable objects.
308  *
309  * \param arg a pointer to a struct rt_cfg_entry_args object
310  * \param argc number of columns
311  * \param argv values in the row
312  * \param columnNames names and types of the columns
313  * \retval 0 on success.
314  * \retval 1 if an error occurred.
315  * \see rt_cfg_entry_args
316  * \see realtime_handler()
317  */
318 static int add_rt_cfg_entry(void *arg, int argc, char **argv,
319         char **columnNames);
320
321 /*!
322  * \brief Asterisk callback function for RealTime configuration.
323  *
324  * Asterisk will call this function each time it requires a variable
325  * through the RealTime architecture. ap is a list of parameters and
326  * values used to find a specific row, e.g one parameter "name" and
327  * one value "123" so that the SQL query becomes <code>SELECT * FROM
328  * table WHERE name = '123';</code>.
329  *
330  * \param database the database to use (ignored)
331  * \param table the table to use
332  * \param ap list of parameters and values to match
333  *
334  * \retval a linked list of struct ast_variable objects
335  * \retval NULL if an error occurred
336  * \see add_rt_cfg_entry()
337  */
338 static struct ast_variable * realtime_handler(const char *database,
339         const char *table, va_list ap);
340
341 /*!
342  * \brief SQLite callback function for RealTime configuration.
343  *
344  * This function performs the same actions as add_rt_cfg_entry() except
345  * that the rt_multi_cfg_entry_args structure is designed to store
346  * categories in addition to variables.
347  *
348  * \param arg a pointer to a struct rt_multi_cfg_entry_args object
349  * \param argc number of columns
350  * \param argv values in the row
351  * \param columnNames names and types of the columns
352  * \retval 0 on success.
353  * \retval 1 if an error occurred.
354  * \see rt_multi_cfg_entry_args
355  * \see realtime_multi_handler()
356  */
357 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv,
358         char **columnNames);
359
360 /*!
361  * \brief Asterisk callback function for RealTime configuration.
362  *
363  * This function performs the same actions as realtime_handler() except
364  * that it can store variables per category, and can return several
365  * categories.
366  *
367  * \param database the database to use (ignored)
368  * \param table the table to use
369  * \param ap list of parameters and values to match
370  * \retval a struct ast_config object storing categories and variables.
371  * \retval NULL if an error occurred.
372  *
373  * \see add_rt_multi_cfg_entry()
374  */
375 static struct ast_config * realtime_multi_handler(const char *database,
376         const char *table, va_list ap);
377
378 /*!
379  * \brief Asterisk callback function for RealTime configuration (variable
380  * update).
381  *
382  * Asterisk will call this function each time a variable has been modified
383  * internally and must be updated in the backend engine. keyfield and entity
384  * are used to find the row to update, e.g. <code>UPDATE table SET ... WHERE
385  * keyfield = 'entity';</code>. ap is a list of parameters and values with the
386  * same format as the other realtime functions.
387  *
388  * \param database the database to use (ignored)
389  * \param table the table to use
390  * \param keyfield the column of the matching cell
391  * \param entity the value of the matching cell
392  * \param ap list of parameters and new values to update in the database
393  * \retval the number of affected rows.
394  * \retval -1 if an error occurred.
395  */
396 static int realtime_update_handler(const char *database, const char *table,
397         const char *keyfield, const char *entity, va_list ap);
398
399 /*!
400  * \brief Asterisk callback function for RealTime configuration (variable
401  * create/store).
402  *
403  * Asterisk will call this function each time a variable has been created
404  * internally and must be stored in the backend engine.
405  * are used to find the row to update, e.g. ap is a list of parameters and
406  * values with the same format as the other realtime functions.
407  *
408  * \param database the database to use (ignored)
409  * \param table the table to use
410  * \param ap list of parameters and new values to insert into the database
411  * \retval the rowid of inserted row.
412  * \retval -1 if an error occurred.
413  */
414 static int realtime_store_handler(const char *database, const char *table,
415         va_list ap);
416
417 /*!
418  * \brief Asterisk callback function for RealTime configuration (destroys
419  * variable).
420  *
421  * Asterisk will call this function each time a variable has been destroyed
422  * internally and must be removed from the backend engine. keyfield and entity
423  * are used to find the row to delete, e.g. <code>DELETE FROM table WHERE
424  * keyfield = 'entity';</code>. ap is a list of parameters and values with the
425  * same format as the other realtime functions.
426  *
427  * \param database the database to use (ignored)
428  * \param table the table to use
429  * \param keyfield the column of the matching cell
430  * \param entity the value of the matching cell
431  * \param ap list of additional parameters for cell matching
432  * \retval the number of affected rows.
433  * \retval -1 if an error occurred.
434  */
435 static int realtime_destroy_handler(const char *database, const char *table,
436         const char *keyfield, const char *entity, va_list ap);
437
438 /*!
439  * \brief Asterisk callback function for the CLI status command.
440  *
441  * \param e CLI command
442  * \param cmd 
443  * \param a CLI argument list
444  * \return RESULT_SUCCESS
445  */
446 static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
447 static char *handle_cli_sqlite_show_tables(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
448
449 static int realtime_require_handler(const char *database, const char *table, va_list ap);
450 static int realtime_unload_handler(const char *unused, const char *tablename);
451
452 /*! The SQLite database object. */
453 static sqlite *db;
454
455 /*! Set to 1 if CDR support is enabled. */
456 static int use_cdr;
457
458 /*! Set to 1 if the CDR callback function was registered. */
459 static int cdr_registered;
460
461 /*! Set to 1 if the CLI status command callback function was registered. */
462 static int cli_status_registered;
463
464 /*! The path of the database file. */
465 static char *dbfile;
466
467 /*! The name of the static configuration table. */
468 static char *config_table;
469
470 /*! The name of the table used to store CDR entries. */
471 static char *cdr_table;
472
473 /*!
474  * The structure specifying all callback functions used by Asterisk for static
475  * and RealTime configuration.
476  */
477 static struct ast_config_engine sqlite_engine =
478 {
479         .name = RES_CONFIG_SQLITE_DRIVER,
480         .load_func = config_handler,
481         .realtime_func = realtime_handler,
482         .realtime_multi_func = realtime_multi_handler,
483         .store_func = realtime_store_handler,
484         .destroy_func = realtime_destroy_handler,
485         .update_func = realtime_update_handler,
486         .require_func = realtime_require_handler,
487         .unload_func = realtime_unload_handler,
488 };
489
490 /*!
491  * The mutex used to prevent simultaneous access to the SQLite database.
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[] = {
500         AST_CLI_DEFINE(handle_cli_show_sqlite_status, "Show status information about the SQLite 2 driver"),
501         AST_CLI_DEFINE(handle_cli_sqlite_show_tables, "Cached table information about the SQLite 2 driver"),
502 };
503
504 struct sqlite_cache_columns {
505         char *name;
506         char *type;
507         unsigned char isint;    /*!< By definition, only INTEGER PRIMARY KEY is an integer; everything else is a string. */
508         AST_RWLIST_ENTRY(sqlite_cache_columns) list;
509 };
510
511 struct sqlite_cache_tables {
512         char *name;
513         AST_RWLIST_HEAD(_columns, sqlite_cache_columns) columns;
514         AST_RWLIST_ENTRY(sqlite_cache_tables) list;
515 };
516
517 static AST_RWLIST_HEAD_STATIC(sqlite_tables, sqlite_cache_tables);
518
519 /*
520  * Taken from Asterisk 1.2 cdr_sqlite.so.
521  */
522
523 /*! SQL query format to create the CDR table if non existent. */
524 static char *sql_create_cdr_table =
525 "CREATE TABLE '%q' (\n"
526 "       id              INTEGER,\n"
527 "       clid            VARCHAR(80)     NOT NULL        DEFAULT '',\n"
528 "       src             VARCHAR(80)     NOT NULL        DEFAULT '',\n"
529 "       dst             VARCHAR(80)     NOT NULL        DEFAULT '',\n"
530 "       dcontext        VARCHAR(80)     NOT NULL        DEFAULT '',\n"
531 "       channel         VARCHAR(80)     NOT NULL        DEFAULT '',\n"
532 "       dstchannel      VARCHAR(80)     NOT NULL        DEFAULT '',\n"
533 "       lastapp         VARCHAR(80)     NOT NULL        DEFAULT '',\n"
534 "       lastdata        VARCHAR(80)     NOT NULL        DEFAULT '',\n"
535 "       start           DATETIME        NOT NULL        DEFAULT '0000-00-00 00:00:00',\n"
536 "       answer          DATETIME        NOT NULL        DEFAULT '0000-00-00 00:00:00',\n"
537 "       end             DATETIME        NOT NULL        DEFAULT '0000-00-00 00:00:00',\n"
538 "       duration        INT(11)         NOT NULL        DEFAULT 0,\n"
539 "       billsec         INT(11)         NOT NULL        DEFAULT 0,\n"
540 "       disposition     VARCHAR(45)     NOT NULL        DEFAULT '',\n"
541 "       amaflags        INT(11)         NOT NULL        DEFAULT 0,\n"
542 "       accountcode     VARCHAR(20)     NOT NULL        DEFAULT '',\n"
543 "       uniqueid        VARCHAR(32)     NOT NULL        DEFAULT '',\n"
544 "       userfield       VARCHAR(255)    NOT NULL        DEFAULT '',\n"
545 "       PRIMARY KEY     (id)\n"
546 ");";
547
548 /*!
549  * SQL query format to describe the table structure
550  */
551 static char *sql_table_structure =
552 "SELECT sql FROM sqlite_master WHERE type='table' AND tbl_name='%s'";
553
554 /*!
555  * SQL query format to fetch the static configuration of a file.
556  * Rows must be sorted by category.
557  *
558  * \see add_cfg_entry()
559  */
560 static const char *sql_get_config_table =
561 "SELECT *"
562 "       FROM '%q'"
563 "       WHERE filename = '%q' AND commented = 0"
564 "       ORDER BY cat_metric ASC, var_metric ASC;";
565
566 static void free_table(struct sqlite_cache_tables *tblptr)
567 {
568         struct sqlite_cache_columns *col;
569
570         /* Obtain a write lock to ensure there are no read locks outstanding */
571         AST_RWLIST_WRLOCK(&(tblptr->columns));
572         while ((col = AST_RWLIST_REMOVE_HEAD(&(tblptr->columns), list))) {
573                 ast_free(col);
574         }
575         AST_RWLIST_UNLOCK(&(tblptr->columns));
576         AST_RWLIST_HEAD_DESTROY(&(tblptr->columns));
577         ast_free(tblptr);
578 }
579
580 static int find_table_cb(void *vtblptr, int argc, char **argv, char **columnNames)
581 {
582         struct sqlite_cache_tables *tblptr = vtblptr;
583         char *sql = ast_strdupa(argv[0]), *start, *end, *type, *remainder;
584         int i;
585         AST_DECLARE_APP_ARGS(fie,
586                 AST_APP_ARG(ld)[100]; /* This means we support up to 100 columns per table */
587         );
588         struct sqlite_cache_columns *col;
589
590         /* This is really fun.  We get to parse an SQL statement to figure out
591          * what columns are in the table.
592          */
593         if ((start = strchr(sql, '(')) && (end = strrchr(sql, ')'))) {
594                 start++;
595                 *end = '\0';
596         } else {
597                 /* Abort */
598                 return -1;
599         }
600
601         AST_STANDARD_APP_ARGS(fie, start);
602         for (i = 0; i < fie.argc; i++) {
603                 fie.ld[i] = ast_skip_blanks(fie.ld[i]);
604                 ast_debug(5, "Found field: %s\n", fie.ld[i]);
605                 if (strncasecmp(fie.ld[i], "PRIMARY KEY", 11) == 0 && (start = strchr(fie.ld[i], '(')) && (end = strchr(fie.ld[i], ')'))) {
606                         *end = '\0';
607                         AST_RWLIST_TRAVERSE(&(tblptr->columns), col, list) {
608                                 if (strcasecmp(start + 1, col->name) == 0 && strcasestr(col->type, "INTEGER")) {
609                                         col->isint = 1;
610                                 }
611                         }
612                         continue;
613                 }
614                 /* type delimiter could be any space character */
615                 for (type = fie.ld[i]; *type > 32; type++);
616                 *type++ = '\0';
617                 type = ast_skip_blanks(type);
618                 for (remainder = type; *remainder > 32; remainder++);
619                 *remainder = '\0';
620                 if (!(col = ast_calloc(1, sizeof(*col) + strlen(fie.ld[i]) + strlen(type) + 2))) {
621                         return -1;
622                 }
623                 col->name = (char *)col + sizeof(*col);
624                 col->type = (char *)col + sizeof(*col) + strlen(fie.ld[i]) + 1;
625                 strcpy(col->name, fie.ld[i]); /* SAFE */
626                 strcpy(col->type, type); /* SAFE */
627                 if (strcasestr(col->type, "INTEGER") && strcasestr(col->type, "PRIMARY KEY")) {
628                         col->isint = 1;
629                 }
630                 AST_LIST_INSERT_TAIL(&(tblptr->columns), col, list);
631         }
632         return 0;
633 }
634
635 static struct sqlite_cache_tables *find_table(const char *tablename)
636 {
637         struct sqlite_cache_tables *tblptr;
638         int i, err;
639         char *sql, *errstr = NULL;
640
641         AST_RWLIST_RDLOCK(&sqlite_tables);
642
643         for (i = 0; i < 2; i++) {
644                 AST_RWLIST_TRAVERSE(&sqlite_tables, tblptr, list) {
645                         if (strcmp(tblptr->name, tablename) == 0) {
646                                 break;
647                         }
648                 }
649                 if (tblptr) {
650                         AST_RWLIST_RDLOCK(&(tblptr->columns));
651                         AST_RWLIST_UNLOCK(&sqlite_tables);
652                         return tblptr;
653                 }
654
655                 if (i == 0) {
656                         AST_RWLIST_UNLOCK(&sqlite_tables);
657                         AST_RWLIST_WRLOCK(&sqlite_tables);
658                 }
659         }
660
661         /* Table structure not cached; build the structure now */
662         asprintf(&sql, sql_table_structure, tablename);
663         if (!(tblptr = ast_calloc(1, sizeof(*tblptr) + strlen(tablename) + 1))) {
664                 AST_RWLIST_UNLOCK(&sqlite_tables);
665                 ast_log(LOG_ERROR, "Memory error.  Cannot cache table '%s'\n", tablename);
666                 return NULL;
667         }
668         tblptr->name = (char *)tblptr + sizeof(*tblptr);
669         strcpy(tblptr->name, tablename); /* SAFE */
670         AST_RWLIST_HEAD_INIT(&(tblptr->columns));
671
672         ast_debug(1, "About to query table structure: %s\n", sql);
673
674         ast_mutex_lock(&mutex);
675         if ((err = sqlite_exec(db, sql, find_table_cb, tblptr, &errstr))) {
676                 ast_mutex_unlock(&mutex);
677                 ast_log(LOG_WARNING, "SQLite error %d: %s\n", err, errstr);
678                 ast_free(errstr);
679                 free_table(tblptr);
680                 return NULL;
681         }
682         ast_mutex_unlock(&mutex);
683
684         if (AST_LIST_EMPTY(&(tblptr->columns))) {
685                 free_table(tblptr);
686                 return NULL;
687         }
688
689         AST_RWLIST_INSERT_TAIL(&sqlite_tables, tblptr, list);
690         AST_RWLIST_RDLOCK(&(tblptr->columns));
691         AST_RWLIST_UNLOCK(&sqlite_tables);
692         return tblptr;
693 }
694
695 #define release_table(a)        AST_RWLIST_UNLOCK(&((a)->columns))
696
697 static int set_var(char **var, const char *name, const char *value)
698 {
699         if (*var)
700                 ast_free(*var);
701
702         *var = ast_strdup(value);
703
704         if (!*var) {
705                 ast_log(LOG_WARNING, "Unable to allocate variable %s\n", name);
706                 return 1;
707         }
708
709         return 0;
710 }
711
712 static int check_vars(void)
713 {
714         if (!dbfile) {
715                 ast_log(LOG_ERROR, "Required parameter undefined: dbfile\n");
716                 return 1;
717         }
718
719         use_cdr = (cdr_table != NULL);
720
721         return 0;
722 }
723
724 static int load_config(void)
725 {
726         struct ast_config *config;
727         struct ast_variable *var;
728         int error;
729         struct ast_flags config_flags = { 0 };
730
731         config = ast_config_load(RES_CONFIG_SQLITE_CONF_FILE, config_flags);
732
733         if (!config) {
734                 ast_log(LOG_ERROR, "Unable to load " RES_CONFIG_SQLITE_CONF_FILE "\n");
735                 return 1;
736         }
737
738         for (var = ast_variable_browse(config, "general"); var; var = var->next) {
739                 if (!strcasecmp(var->name, "dbfile"))
740                         SET_VAR(config, dbfile, var);
741                 else if (!strcasecmp(var->name, "config_table"))
742                         SET_VAR(config, config_table, var);
743                 else if (!strcasecmp(var->name, "cdr_table")) {
744                         SET_VAR(config, cdr_table, var);
745                 } else
746                         ast_log(LOG_WARNING, "Unknown parameter : %s\n", var->name);
747         }
748
749         ast_config_destroy(config);
750         error = check_vars();
751
752         if (error) {
753                 unload_config();
754                 return 1;
755         }
756
757         return 0;
758 }
759
760 static void unload_config(void)
761 {
762         struct sqlite_cache_tables *tbl;
763         ast_free(dbfile);
764         dbfile = NULL;
765         ast_free(config_table);
766         config_table = NULL;
767         ast_free(cdr_table);
768         cdr_table = NULL;
769         AST_RWLIST_WRLOCK(&sqlite_tables);
770         while ((tbl = AST_RWLIST_REMOVE_HEAD(&sqlite_tables, list))) {
771                 free_table(tbl);
772         }
773         AST_RWLIST_UNLOCK(&sqlite_tables);
774 }
775
776 static int cdr_handler(struct ast_cdr *cdr)
777 {
778         char *errormsg, *tmp, workspace[500];
779         int error, scannum;
780         struct sqlite_cache_tables *tbl = find_table(cdr_table);
781         struct sqlite_cache_columns *col;
782         struct ast_str *sql1 = ast_str_create(160), *sql2 = ast_str_create(16);
783
784         if (!tbl) {
785                 ast_log(LOG_WARNING, "No such table: %s\n", cdr_table);
786                 return -1;
787         }
788
789         ast_str_set(&sql1, 0, "INSERT INTO %s (", cdr_table);
790         ast_str_set(&sql2, 0, ") VALUES (");
791
792         AST_RWLIST_TRAVERSE(&(tbl->columns), col, list) {
793                 if (col->isint) {
794                         ast_cdr_getvar(cdr, col->name, &tmp, workspace, sizeof(workspace), 0, 1);
795                         if (!tmp) {
796                                 continue;
797                         }
798                         if (sscanf(tmp, "%d", &scannum) == 1) {
799                                 ast_str_append(&sql1, 0, "%s,", col->name);
800                                 ast_str_append(&sql2, 0, "%d,", scannum);
801                         }
802                 } else {
803                         ast_cdr_getvar(cdr, col->name, &tmp, workspace, sizeof(workspace), 0, 0);
804                         if (!tmp) {
805                                 continue;
806                         }
807                         ast_str_append(&sql1, 0, "%s,", col->name);
808                         tmp = sqlite_mprintf("%Q", tmp);
809                         ast_str_append(&sql2, 0, "%s,", tmp);
810                         sqlite_freemem(tmp);
811                 }
812         }
813         release_table(tbl);
814
815         sql1->str[--sql1->used] = '\0';
816         sql2->str[--sql2->used] = '\0';
817         ast_str_append(&sql1, 0, "%s)", sql2->str);
818         ast_free(sql2);
819
820         ast_debug(1, "SQL query: %s\n", sql1->str);
821
822         ast_mutex_lock(&mutex);
823
824         RES_CONFIG_SQLITE_BEGIN
825                 error = sqlite_exec(db, sql1->str, NULL, NULL, &errormsg);
826         RES_CONFIG_SQLITE_END(error)
827
828         ast_mutex_unlock(&mutex);
829
830         ast_free(sql1);
831
832         if (error) {
833                 ast_log(LOG_ERROR, "%s\n", errormsg);
834                 sqlite_freemem(errormsg);
835                 return 1;
836         }
837
838         return 0;
839 }
840
841 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
842 {
843         struct cfg_entry_args *args;
844         struct ast_variable *var;
845
846         if (argc != RES_CONFIG_SQLITE_CONFIG_COLUMNS) {
847                 ast_log(LOG_WARNING, "Corrupt table\n");
848                 return 1;
849         }
850
851         args = arg;
852
853         if (!strcmp(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], "#include")) {
854                 struct ast_config *cfg;
855                 char *val;
856
857                 val = argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL];
858                 cfg = ast_config_internal_load(val, args->cfg, args->flags, "", args->who_asked);
859
860                 if (!cfg) {
861                         ast_log(LOG_WARNING, "Unable to include %s\n", val);
862                         return 1;
863                 } else {
864                         args->cfg = cfg;
865                         return 0;
866                 }
867         }
868
869         if (!args->cat_name || strcmp(args->cat_name, argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY])) {
870                 args->cat = ast_category_new(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY], "", 99999);
871
872                 if (!args->cat) {
873                         ast_log(LOG_WARNING, "Unable to allocate category\n");
874                         return 1;
875                 }
876
877                 ast_free(args->cat_name);
878                 args->cat_name = ast_strdup(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY]);
879
880                 if (!args->cat_name) {
881                         ast_category_destroy(args->cat);
882                         return 1;
883                 }
884
885                 ast_category_append(args->cfg, args->cat);
886         }
887
888         var = ast_variable_new(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL], "");
889
890         if (!var) {
891                 ast_log(LOG_WARNING, "Unable to allocate variable");
892                 return 1;
893         }
894
895         ast_variable_append(args->cat, var);
896
897         return 0;
898 }
899
900 static struct ast_config *config_handler(const char *database,  const char *table, const char *file,
901         struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked)
902 {
903         struct cfg_entry_args args;
904         char *query, *errormsg;
905         int error;
906
907         if (!config_table) {
908                 if (!table) {
909                         ast_log(LOG_ERROR, "Table name unspecified\n");
910                         return NULL;
911                 }
912         } else
913                 table = config_table;
914
915         query = sqlite_mprintf(sql_get_config_table, table, file);
916
917         if (!query) {
918                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
919                 return NULL;
920         }
921
922         ast_debug(1, "SQL query: %s\n", query);
923         args.cfg = cfg;
924         args.cat = NULL;
925         args.cat_name = NULL;
926         args.flags = flags;
927         args.who_asked = who_asked;
928
929         ast_mutex_lock(&mutex);
930
931         RES_CONFIG_SQLITE_BEGIN
932                 error = sqlite_exec(db, query, add_cfg_entry, &args, &errormsg);
933         RES_CONFIG_SQLITE_END(error)
934
935         ast_mutex_unlock(&mutex);
936
937         ast_free(args.cat_name);
938         sqlite_freemem(query);
939
940         if (error) {
941                 ast_log(LOG_ERROR, "%s\n", errormsg);
942                 sqlite_freemem(errormsg);
943                 return NULL;
944         }
945
946         return cfg;
947 }
948
949 static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr)
950 {
951         const char **tmp, *param, *val, **params, **vals;
952         size_t params_count;
953
954         params = NULL;
955         vals = NULL;
956         params_count = 0;
957
958         while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
959                 if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
960                         ast_free(params);
961                         ast_free(vals);
962                         return 0;
963                 }
964                 params = tmp;
965
966                 if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
967                         ast_free(params);
968                         ast_free(vals);
969                         return 0;
970                 }
971                 vals = tmp;
972
973                 params[params_count] = param;
974                 vals[params_count] = val;
975                 params_count++;
976         }
977
978         if (params_count > 0) {
979                 *params_ptr = params;
980                 *vals_ptr = vals;
981         } else
982                 ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
983
984         return params_count;
985 }
986
987 static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
988 {
989         struct rt_cfg_entry_args *args;
990         struct ast_variable *var;
991         int i;
992
993         args = arg;
994
995         for (i = 0; i < argc; i++) {
996                 if (!argv[i])
997                         continue;
998
999                 if (!(var = ast_variable_new(columnNames[i], argv[i], "")))
1000                         return 1;
1001
1002                 if (!args->var)
1003                         args->var = var;
1004
1005                 if (!args->last)
1006                         args->last = var;
1007                 else {
1008                         args->last->next = var;
1009                         args->last = var;
1010                 }
1011         }
1012
1013         return 0;
1014 }
1015
1016 static struct ast_variable * realtime_handler(const char *database, const char *table, va_list ap)
1017 {
1018         char *query, *errormsg, *op, *tmp_str;
1019         struct rt_cfg_entry_args args;
1020         const char **params, **vals;
1021         size_t params_count;
1022         int error;
1023
1024         if (!table) {
1025                 ast_log(LOG_WARNING, "Table name unspecified\n");
1026                 return NULL;
1027         }
1028
1029         params_count = get_params(ap, &params, &vals);
1030
1031         if (params_count == 0)
1032                 return NULL;
1033
1034         op = (strchr(params[0], ' ') == NULL) ? " =" : "";
1035
1036 /* \cond DOXYGEN_CAN_PARSE_THIS */
1037 #undef QUERY
1038 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1039 /* \endcond */
1040
1041         query = sqlite_mprintf(QUERY, table, params[0], op, vals[0]);
1042
1043         if (!query) {
1044                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1045                 ast_free(params);
1046                 ast_free(vals);
1047                 return NULL;
1048         }
1049
1050         if (params_count > 1) {
1051                 size_t i;
1052
1053                 for (i = 1; i < params_count; i++) {
1054                         op = (strchr(params[i], ' ') == NULL) ? " =" : "";
1055                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1056                         sqlite_freemem(query);
1057
1058                         if (!tmp_str) {
1059                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1060                                 ast_free(params);
1061                                 ast_free(vals);
1062                                 return NULL;
1063                         }
1064
1065                         query = tmp_str;
1066                 }
1067         }
1068
1069         ast_free(params);
1070         ast_free(vals);
1071
1072         tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
1073         sqlite_freemem(query);
1074
1075         if (!tmp_str) {
1076                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1077                 return NULL;
1078         }
1079
1080         query = tmp_str;
1081         ast_debug(1, "SQL query: %s\n", query);
1082         args.var = NULL;
1083         args.last = NULL;
1084
1085         ast_mutex_lock(&mutex);
1086
1087         RES_CONFIG_SQLITE_BEGIN
1088                 error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
1089         RES_CONFIG_SQLITE_END(error)
1090
1091         ast_mutex_unlock(&mutex);
1092
1093         sqlite_freemem(query);
1094
1095         if (error) {
1096                 ast_log(LOG_WARNING, "%s\n", errormsg);
1097                 sqlite_freemem(errormsg);
1098                 ast_variables_destroy(args.var);
1099                 return NULL;
1100         }
1101
1102         return args.var;
1103 }
1104
1105 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
1106 {
1107         struct rt_multi_cfg_entry_args *args;
1108         struct ast_category *cat;
1109         struct ast_variable *var;
1110         char *cat_name;
1111         size_t i;
1112
1113         args = arg;
1114         cat_name = NULL;
1115
1116         /*
1117          * cat_name should always be set here, since initfield is forged from
1118          * params[0] in realtime_multi_handler(), which is a search parameter
1119          * of the SQL query.
1120          */
1121         for (i = 0; i < argc; i++) {
1122                 if (!strcmp(args->initfield, columnNames[i]))
1123                         cat_name = argv[i];
1124         }
1125
1126         if (!cat_name) {
1127                 ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
1128                 return 1;
1129         }
1130
1131         if (!(cat = ast_category_new(cat_name, "", 99999))) {
1132                 ast_log(LOG_WARNING, "Unable to allocate category\n");
1133                 return 1;
1134         }
1135
1136         ast_category_append(args->cfg, cat);
1137
1138         for (i = 0; i < argc; i++) {
1139                 if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
1140                         continue;
1141
1142                 if (!(var = ast_variable_new(columnNames[i], argv[i], ""))) {
1143                         ast_log(LOG_WARNING, "Unable to allocate variable\n");
1144                         return 1;
1145                 }
1146
1147                 ast_variable_append(cat, var);
1148         }
1149
1150         return 0;
1151 }
1152
1153 static struct ast_config *realtime_multi_handler(const char *database,
1154         const char *table, va_list ap)
1155 {
1156         char *query, *errormsg, *op, *tmp_str, *initfield;
1157         struct rt_multi_cfg_entry_args args;
1158         const char **params, **vals;
1159         struct ast_config *cfg;
1160         size_t params_count;
1161         int error;
1162
1163         if (!table) {
1164                 ast_log(LOG_WARNING, "Table name unspecified\n");
1165                 return NULL;
1166         }
1167
1168         if (!(cfg = ast_config_new())) {
1169                 ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
1170                 return NULL;
1171         }
1172
1173         if (!(params_count = get_params(ap, &params, &vals))) {
1174                 ast_config_destroy(cfg);
1175                 return NULL;
1176         }
1177
1178         if (!(initfield = ast_strdup(params[0]))) {
1179                 ast_config_destroy(cfg);
1180                 ast_free(params);
1181                 ast_free(vals);
1182                 return NULL;
1183         }
1184
1185         tmp_str = strchr(initfield, ' ');
1186
1187         if (tmp_str)
1188                 *tmp_str = '\0';
1189
1190         op = (!strchr(params[0], ' ')) ? " =" : "";
1191
1192         /*
1193          * Asterisk sends us an already escaped string when searching for
1194          * "exten LIKE" (uh!). Handle it separately.
1195          */
1196         tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
1197
1198 /* \cond DOXYGEN_CAN_PARSE_THIS */
1199 #undef QUERY
1200 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1201 /* \endcond */
1202
1203         if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
1204                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1205                 ast_config_destroy(cfg);
1206                 ast_free(params);
1207                 ast_free(vals);
1208                 ast_free(initfield);
1209                 return NULL;
1210         }
1211
1212         if (params_count > 1) {
1213                 size_t i;
1214
1215                 for (i = 1; i < params_count; i++) {
1216                         op = (!strchr(params[i], ' ')) ? " =" : "";
1217                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1218                         sqlite_freemem(query);
1219
1220                         if (!tmp_str) {
1221                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1222                                 ast_config_destroy(cfg);
1223                                 ast_free(params);
1224                                 ast_free(vals);
1225                                 ast_free(initfield);
1226                                 return NULL;
1227                         }
1228
1229                         query = tmp_str;
1230                 }
1231         }
1232
1233         ast_free(params);
1234         ast_free(vals);
1235
1236         if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
1237                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1238                 sqlite_freemem(query);
1239                 ast_config_destroy(cfg);
1240                 ast_free(initfield);
1241                 return NULL;
1242         }
1243
1244         sqlite_freemem(query);
1245         query = tmp_str;
1246         ast_debug(1, "SQL query: %s\n", query);
1247         args.cfg = cfg;
1248         args.initfield = initfield;
1249
1250         ast_mutex_lock(&mutex);
1251
1252         RES_CONFIG_SQLITE_BEGIN
1253                 error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
1254         RES_CONFIG_SQLITE_END(error)
1255
1256         ast_mutex_unlock(&mutex);
1257
1258         sqlite_freemem(query);
1259         ast_free(initfield);
1260
1261         if (error) {
1262                 ast_log(LOG_WARNING, "%s\n", errormsg);
1263                 sqlite_freemem(errormsg);
1264                 ast_config_destroy(cfg);
1265                 return NULL;
1266         }
1267
1268         return cfg;
1269 }
1270
1271 static int realtime_update_handler(const char *database, const char *table,
1272         const char *keyfield, const char *entity, va_list ap)
1273 {
1274         char *query, *errormsg, *tmp_str;
1275         const char **params, **vals;
1276         size_t params_count;
1277         int error, rows_num;
1278
1279         if (!table) {
1280                 ast_log(LOG_WARNING, "Table name unspecified\n");
1281                 return -1;
1282         }
1283
1284         if (!(params_count = get_params(ap, &params, &vals)))
1285                 return -1;
1286
1287 /* \cond DOXYGEN_CAN_PARSE_THIS */
1288 #undef QUERY
1289 #define QUERY "UPDATE '%q' SET %q = '%q'"
1290 /* \endcond */
1291
1292         if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
1293                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1294                 ast_free(params);
1295                 ast_free(vals);
1296                 return -1;
1297         }
1298
1299         if (params_count > 1) {
1300                 size_t i;
1301
1302                 for (i = 1; i < params_count; i++) {
1303                         tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i], vals[i]);
1304                         sqlite_freemem(query);
1305
1306                         if (!tmp_str) {
1307                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1308                                 ast_free(params);
1309                                 ast_free(vals);
1310                                 return -1;
1311                         }
1312
1313                         query = tmp_str;
1314                 }
1315         }
1316
1317         ast_free(params);
1318         ast_free(vals);
1319
1320         if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
1321                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1322                 sqlite_freemem(query);
1323                 return -1;
1324         }
1325
1326         sqlite_freemem(query);
1327         query = tmp_str;
1328         ast_debug(1, "SQL query: %s\n", query);
1329
1330         ast_mutex_lock(&mutex);
1331
1332         RES_CONFIG_SQLITE_BEGIN
1333                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1334         RES_CONFIG_SQLITE_END(error)
1335
1336         if (!error)
1337                 rows_num = sqlite_changes(db);
1338         else
1339                 rows_num = -1;
1340
1341         ast_mutex_unlock(&mutex);
1342
1343         sqlite_freemem(query);
1344
1345         if (error) {
1346                 ast_log(LOG_WARNING, "%s\n", errormsg);
1347                 sqlite_freemem(errormsg);
1348         }
1349
1350         return rows_num;
1351 }
1352
1353 static int realtime_store_handler(const char *database, const char *table, va_list ap)
1354 {
1355         char *errormsg, *tmp_str, *tmp_keys = NULL, *tmp_keys2 = NULL, *tmp_vals = NULL, *tmp_vals2 = NULL;
1356         const char **params, **vals;
1357         size_t params_count;
1358         int error, rows_id;
1359         size_t i;
1360
1361         if (!table) {
1362                 ast_log(LOG_WARNING, "Table name unspecified\n");
1363                 return -1;
1364         }
1365
1366         if (!(params_count = get_params(ap, &params, &vals)))
1367                 return -1;
1368
1369 /* \cond DOXYGEN_CAN_PARSE_THIS */
1370 #undef QUERY
1371 #define QUERY "INSERT into '%q' (%s) VALUES (%s);"
1372 /* \endcond */
1373
1374         for (i = 0; i < params_count; i++) {
1375                 if ( tmp_keys2 ) {
1376                         tmp_keys = sqlite_mprintf("%s, %q", tmp_keys2, params[i]);
1377                         sqlite_freemem(tmp_keys2);
1378                 } else {
1379                         tmp_keys = sqlite_mprintf("%q", params[i]);
1380                 }
1381                 if (!tmp_keys) {
1382                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1383                         sqlite_freemem(tmp_vals);
1384                         ast_free(params);
1385                         ast_free(vals);
1386                         return -1;
1387                 }
1388
1389                 if ( tmp_vals2 ) {
1390                         tmp_vals = sqlite_mprintf("%s, '%q'", tmp_vals2, params[i]);
1391                         sqlite_freemem(tmp_vals2);
1392                 } else {
1393                         tmp_vals = sqlite_mprintf("'%q'", params[i]);
1394                 }
1395                 if (!tmp_vals) {
1396                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1397                         sqlite_freemem(tmp_keys);
1398                         ast_free(params);
1399                         ast_free(vals);
1400                         return -1;
1401                 }
1402
1403
1404                 tmp_keys2 = tmp_keys;
1405                 tmp_vals2 = tmp_vals;
1406         }
1407
1408         ast_free(params);
1409         ast_free(vals);
1410
1411         if (!(tmp_str = sqlite_mprintf(QUERY, table, tmp_keys, tmp_vals))) {
1412                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1413                 sqlite_freemem(tmp_keys);
1414                 sqlite_freemem(tmp_vals);
1415                 return -1;
1416         }
1417
1418         sqlite_freemem(tmp_keys);
1419         sqlite_freemem(tmp_vals);
1420
1421         ast_debug(1, "SQL query: %s\n", tmp_str);
1422
1423         ast_mutex_lock(&mutex);
1424
1425         RES_CONFIG_SQLITE_BEGIN
1426                 error = sqlite_exec(db, tmp_str, NULL, NULL, &errormsg);
1427         RES_CONFIG_SQLITE_END(error)
1428
1429         if (!error) {
1430                 rows_id = sqlite_last_insert_rowid(db);
1431         } else {
1432                 rows_id = -1;
1433         }
1434
1435         ast_mutex_unlock(&mutex);
1436
1437         sqlite_freemem(tmp_str);
1438
1439         if (error) {
1440                 ast_log(LOG_WARNING, "%s\n", errormsg);
1441                 sqlite_freemem(errormsg);
1442         }
1443
1444         return rows_id;
1445 }
1446
1447 static int realtime_destroy_handler(const char *database, const char *table,
1448         const char *keyfield, const char *entity, va_list ap)
1449 {
1450         char *query, *errormsg, *tmp_str;
1451         const char **params, **vals;
1452         size_t params_count;
1453         int error, rows_num;
1454         size_t i;
1455
1456         if (!table) {
1457                 ast_log(LOG_WARNING, "Table name unspecified\n");
1458                 return -1;
1459         }
1460
1461         if (!(params_count = get_params(ap, &params, &vals)))
1462                 return -1;
1463
1464 /* \cond DOXYGEN_CAN_PARSE_THIS */
1465 #undef QUERY
1466 #define QUERY "DELETE FROM '%q' WHERE"
1467 /* \endcond */
1468
1469         if (!(query = sqlite_mprintf(QUERY, table))) {
1470                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1471                 ast_free(params);
1472                 ast_free(vals);
1473                 return -1;
1474         }
1475
1476         for (i = 0; i < params_count; i++) {
1477                 tmp_str = sqlite_mprintf("%s %q = '%q' AND", query, params[i], vals[i]);
1478                 sqlite_freemem(query);
1479
1480                 if (!tmp_str) {
1481                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1482                         ast_free(params);
1483                         ast_free(vals);
1484                         return -1;
1485                 }
1486
1487                 query = tmp_str;
1488         }
1489
1490         ast_free(params);
1491         ast_free(vals);
1492         if (!(tmp_str = sqlite_mprintf("%s %q = '%q';", query, keyfield, entity))) {
1493                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1494                 sqlite_freemem(query);
1495                 return -1;
1496         }
1497         sqlite_freemem(query);
1498         query = tmp_str;
1499         ast_debug(1, "SQL query: %s\n", query);
1500
1501         ast_mutex_lock(&mutex);
1502
1503         RES_CONFIG_SQLITE_BEGIN
1504                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1505         RES_CONFIG_SQLITE_END(error)
1506
1507         if (!error)
1508                 rows_num = sqlite_changes(db);
1509         else
1510                 rows_num = -1;
1511
1512         ast_mutex_unlock(&mutex);
1513
1514         sqlite_freemem(query);
1515
1516         if (error) {
1517                 ast_log(LOG_WARNING, "%s\n", errormsg);
1518                 sqlite_freemem(errormsg);
1519         }
1520
1521         return rows_num;
1522 }
1523
1524 static int realtime_require_handler(const char *unused, const char *tablename, va_list ap)
1525 {
1526         struct sqlite_cache_tables *tbl = find_table(tablename);
1527         struct sqlite_cache_columns *col;
1528         char *elm;
1529         int type, size, res = 0;
1530
1531         if (!tbl) {
1532                 return -1;
1533         }
1534
1535         while ((elm = va_arg(ap, char *))) {
1536                 type = va_arg(ap, require_type);
1537                 size = va_arg(ap, int);
1538                 /* Check if the field matches the criteria */
1539                 AST_RWLIST_TRAVERSE(&tbl->columns, col, list) {
1540                         if (strcmp(col->name, elm) == 0) {
1541                                 /* SQLite only has two types - the 32-bit integer field that
1542                                  * is the key column, and everything else (everything else
1543                                  * being a string).
1544                                  */
1545                                 if (col->isint && !ast_rq_is_int(type)) {
1546                                         ast_log(LOG_WARNING, "Realtime table %s: column '%s' is an integer field, but Asterisk requires that it not be!\n", tablename, col->name);
1547                                         res = -1;
1548                                 }
1549                                 break;
1550                         }
1551                 }
1552                 if (!col) {
1553                         ast_log(LOG_WARNING, "Realtime table %s requires column '%s', but that column does not exist!\n", tablename, elm);
1554                 }
1555         }
1556         AST_RWLIST_UNLOCK(&(tbl->columns));
1557         return res;
1558 }
1559
1560 static int realtime_unload_handler(const char *unused, const char *tablename)
1561 {
1562         struct sqlite_cache_tables *tbl;
1563         AST_RWLIST_WRLOCK(&sqlite_tables);
1564         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&sqlite_tables, tbl, list) {
1565                 if (!strcasecmp(tbl->name, tablename)) {
1566                         AST_RWLIST_REMOVE_CURRENT(list);
1567                         free_table(tbl);
1568                 }
1569         }
1570         AST_RWLIST_TRAVERSE_SAFE_END
1571         AST_RWLIST_UNLOCK(&sqlite_tables);
1572         return 0;
1573 }
1574
1575 static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1576 {
1577         switch (cmd) {
1578         case CLI_INIT:
1579                 e->command = "show sqlite status";
1580                 e->usage =
1581                         "Usage: show sqlite status\n"
1582                         "       Show status information about the SQLite 2 driver\n";
1583                 return NULL;
1584         case CLI_GENERATE:
1585                 return NULL;
1586         }
1587
1588         if (a->argc != 3)
1589                 return CLI_SHOWUSAGE;
1590
1591         ast_cli(a->fd, "SQLite database path: %s\n", dbfile);
1592         ast_cli(a->fd, "config_table: ");
1593
1594         if (!config_table)
1595                 ast_cli(a->fd, "unspecified, must be present in extconfig.conf\n");
1596         else
1597                 ast_cli(a->fd, "%s\n", config_table);
1598
1599         ast_cli(a->fd, "cdr_table: ");
1600
1601         if (!cdr_table)
1602                 ast_cli(a->fd, "unspecified, CDR support disabled\n");
1603         else
1604                 ast_cli(a->fd, "%s\n", cdr_table);
1605
1606         return CLI_SUCCESS;
1607 }
1608
1609 static char *handle_cli_sqlite_show_tables(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1610 {
1611         struct sqlite_cache_tables *tbl;
1612         struct sqlite_cache_columns *col;
1613         int found = 0;
1614
1615         switch (cmd) {
1616         case CLI_INIT:
1617                 e->command = "sqlite show tables";
1618                 e->usage =
1619                         "Usage: sqlite show tables\n"
1620                         "       Show table information about the SQLite 2 driver\n";
1621                 return NULL;
1622         case CLI_GENERATE:
1623                 return NULL;
1624         }
1625
1626         if (a->argc != 3)
1627                 return CLI_SHOWUSAGE;
1628
1629         AST_RWLIST_RDLOCK(&sqlite_tables);
1630         AST_RWLIST_TRAVERSE(&sqlite_tables, tbl, list) {
1631                 found++;
1632                 ast_cli(a->fd, "Table %s:\n", tbl->name);
1633                 AST_RWLIST_TRAVERSE(&(tbl->columns), col, list) {
1634                         fprintf(stderr, "%s\n", col->name);
1635                         ast_cli(a->fd, "  %20.20s  %-30.30s\n", col->name, col->type);
1636                 }
1637         }
1638         AST_RWLIST_UNLOCK(&sqlite_tables);
1639
1640         if (!found) {
1641                 ast_cli(a->fd, "No tables currently in cache\n");
1642         }
1643
1644         return CLI_SUCCESS;
1645 }
1646
1647 static int unload_module(void)
1648 {
1649         if (cli_status_registered)
1650                 ast_cli_unregister_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
1651
1652         if (cdr_registered)
1653                 ast_cdr_unregister(RES_CONFIG_SQLITE_NAME);
1654
1655         ast_config_engine_deregister(&sqlite_engine);
1656
1657         if (db)
1658                 sqlite_close(db);
1659
1660         unload_config();
1661
1662         return 0;
1663 }
1664
1665 static int load_module(void)
1666 {
1667         char *errormsg;
1668         int error;
1669
1670         db = NULL;
1671         cdr_registered = 0;
1672         cli_status_registered = 0;
1673         dbfile = NULL;
1674         config_table = NULL;
1675         cdr_table = NULL;
1676         error = load_config();
1677
1678         if (error)
1679                 return AST_MODULE_LOAD_DECLINE;
1680
1681         if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
1682                 ast_log(LOG_ERROR, "%s\n", errormsg);
1683                 sqlite_freemem(errormsg);
1684                 unload_module();
1685                 return 1;
1686         }
1687
1688         ast_config_engine_register(&sqlite_engine);
1689
1690         if (use_cdr) {
1691                 char *query;
1692
1693 /* \cond DOXYGEN_CAN_PARSE_THIS */
1694 #undef QUERY
1695 #define QUERY "SELECT COUNT(id) FROM %Q;"
1696 /* \endcond */
1697
1698                 query = sqlite_mprintf(QUERY, cdr_table);
1699
1700                 if (!query) {
1701                         ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1702                         unload_module();
1703                         return 1;
1704                 }
1705
1706                 ast_debug(1, "SQL query: %s\n", query);
1707
1708                 RES_CONFIG_SQLITE_BEGIN
1709                         error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1710                 RES_CONFIG_SQLITE_END(error)
1711
1712                 sqlite_freemem(query);
1713
1714                 if (error) {
1715                         /*
1716                          * Unexpected error.
1717                          */
1718                         if (error != SQLITE_ERROR) {
1719                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1720                                 sqlite_freemem(errormsg);
1721                                 unload_module();
1722                                 return 1;
1723                         }
1724
1725                         sqlite_freemem(errormsg);
1726                         query = sqlite_mprintf(sql_create_cdr_table, cdr_table);
1727
1728                         if (!query) {
1729                                 ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1730                                 unload_module();
1731                                 return 1;
1732                         }
1733
1734                         ast_debug(1, "SQL query: %s\n", query);
1735
1736                         RES_CONFIG_SQLITE_BEGIN
1737                                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1738                         RES_CONFIG_SQLITE_END(error)
1739
1740                         sqlite_freemem(query);
1741
1742                         if (error) {
1743                                 ast_log(LOG_ERROR, "%s\n", errormsg);
1744                                 sqlite_freemem(errormsg);
1745                                 unload_module();
1746                                 return 1;
1747                         }
1748                 }
1749
1750                 error = ast_cdr_register(RES_CONFIG_SQLITE_NAME, RES_CONFIG_SQLITE_DESCRIPTION, cdr_handler);
1751
1752                 if (error) {
1753                         unload_module();
1754                         return 1;
1755                 }
1756
1757                 cdr_registered = 1;
1758         }
1759
1760         error = ast_cli_register_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
1761
1762         if (error) {
1763                 unload_module();
1764                 return 1;
1765         }
1766
1767         cli_status_registered = 1;
1768
1769         return 0;
1770 }
1771
1772 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
1773                 .load = load_module,
1774                 .unload = unload_module,
1775 );