Create a new config file status, CONFIG_STATUS_FILEINVALID for differentiating
[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
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)       \
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 == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
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 = NULL, *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", S_OR(errormsg, sqlite_error_string(error)));
834                 sqlite_freemem(errormsg);
835                 return 1;
836         }
837         sqlite_freemem(errormsg);
838
839         return 0;
840 }
841
842 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
843 {
844         struct cfg_entry_args *args;
845         struct ast_variable *var;
846
847         if (argc != RES_CONFIG_SQLITE_CONFIG_COLUMNS) {
848                 ast_log(LOG_WARNING, "Corrupt table\n");
849                 return 1;
850         }
851
852         args = arg;
853
854         if (!strcmp(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], "#include")) {
855                 struct ast_config *cfg;
856                 char *val;
857
858                 val = argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL];
859                 cfg = ast_config_internal_load(val, args->cfg, args->flags, "", args->who_asked);
860
861                 if (!cfg) {
862                         ast_log(LOG_WARNING, "Unable to include %s\n", val);
863                         return 1;
864                 } else {
865                         args->cfg = cfg;
866                         return 0;
867                 }
868         }
869
870         if (!args->cat_name || strcmp(args->cat_name, argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY])) {
871                 args->cat = ast_category_new(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY], "", 99999);
872
873                 if (!args->cat) {
874                         ast_log(LOG_WARNING, "Unable to allocate category\n");
875                         return 1;
876                 }
877
878                 ast_free(args->cat_name);
879                 args->cat_name = ast_strdup(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY]);
880
881                 if (!args->cat_name) {
882                         ast_category_destroy(args->cat);
883                         return 1;
884                 }
885
886                 ast_category_append(args->cfg, args->cat);
887         }
888
889         var = ast_variable_new(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL], "");
890
891         if (!var) {
892                 ast_log(LOG_WARNING, "Unable to allocate variable");
893                 return 1;
894         }
895
896         ast_variable_append(args->cat, var);
897
898         return 0;
899 }
900
901 static struct ast_config *config_handler(const char *database,  const char *table, const char *file,
902         struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked)
903 {
904         struct cfg_entry_args args;
905         char *query, *errormsg = NULL;
906         int error;
907
908         if (!config_table) {
909                 if (!table) {
910                         ast_log(LOG_ERROR, "Table name unspecified\n");
911                         return NULL;
912                 }
913         } else
914                 table = config_table;
915
916         query = sqlite_mprintf(sql_get_config_table, table, file);
917
918         if (!query) {
919                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
920                 return NULL;
921         }
922
923         ast_debug(1, "SQL query: %s\n", query);
924         args.cfg = cfg;
925         args.cat = NULL;
926         args.cat_name = NULL;
927         args.flags = flags;
928         args.who_asked = who_asked;
929
930         ast_mutex_lock(&mutex);
931
932         RES_CONFIG_SQLITE_BEGIN
933                 error = sqlite_exec(db, query, add_cfg_entry, &args, &errormsg);
934         RES_CONFIG_SQLITE_END(error)
935
936         ast_mutex_unlock(&mutex);
937
938         ast_free(args.cat_name);
939         sqlite_freemem(query);
940
941         if (error) {
942                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
943                 sqlite_freemem(errormsg);
944                 return NULL;
945         }
946         sqlite_freemem(errormsg);
947
948         return cfg;
949 }
950
951 static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr)
952 {
953         const char **tmp, *param, *val, **params, **vals;
954         size_t params_count;
955
956         params = NULL;
957         vals = NULL;
958         params_count = 0;
959
960         while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
961                 if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
962                         ast_free(params);
963                         ast_free(vals);
964                         return 0;
965                 }
966                 params = tmp;
967
968                 if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
969                         ast_free(params);
970                         ast_free(vals);
971                         return 0;
972                 }
973                 vals = tmp;
974
975                 params[params_count] = param;
976                 vals[params_count] = val;
977                 params_count++;
978         }
979
980         if (params_count > 0) {
981                 *params_ptr = params;
982                 *vals_ptr = vals;
983         } else
984                 ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
985
986         return params_count;
987 }
988
989 static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
990 {
991         struct rt_cfg_entry_args *args;
992         struct ast_variable *var;
993         int i;
994
995         args = arg;
996
997         for (i = 0; i < argc; i++) {
998                 if (!argv[i])
999                         continue;
1000
1001                 if (!(var = ast_variable_new(columnNames[i], argv[i], "")))
1002                         return 1;
1003
1004                 if (!args->var)
1005                         args->var = var;
1006
1007                 if (!args->last)
1008                         args->last = var;
1009                 else {
1010                         args->last->next = var;
1011                         args->last = var;
1012                 }
1013         }
1014
1015         return 0;
1016 }
1017
1018 static struct ast_variable * realtime_handler(const char *database, const char *table, va_list ap)
1019 {
1020         char *query, *errormsg = NULL, *op, *tmp_str;
1021         struct rt_cfg_entry_args args;
1022         const char **params, **vals;
1023         size_t params_count;
1024         int error;
1025
1026         if (!table) {
1027                 ast_log(LOG_WARNING, "Table name unspecified\n");
1028                 return NULL;
1029         }
1030
1031         params_count = get_params(ap, &params, &vals);
1032
1033         if (params_count == 0)
1034                 return NULL;
1035
1036         op = (strchr(params[0], ' ') == NULL) ? " =" : "";
1037
1038 /* \cond DOXYGEN_CAN_PARSE_THIS */
1039 #undef QUERY
1040 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1041 /* \endcond */
1042
1043         query = sqlite_mprintf(QUERY, table, params[0], op, vals[0]);
1044
1045         if (!query) {
1046                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1047                 ast_free(params);
1048                 ast_free(vals);
1049                 return NULL;
1050         }
1051
1052         if (params_count > 1) {
1053                 size_t i;
1054
1055                 for (i = 1; i < params_count; i++) {
1056                         op = (strchr(params[i], ' ') == NULL) ? " =" : "";
1057                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1058                         sqlite_freemem(query);
1059
1060                         if (!tmp_str) {
1061                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1062                                 ast_free(params);
1063                                 ast_free(vals);
1064                                 return NULL;
1065                         }
1066
1067                         query = tmp_str;
1068                 }
1069         }
1070
1071         ast_free(params);
1072         ast_free(vals);
1073
1074         tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
1075         sqlite_freemem(query);
1076
1077         if (!tmp_str) {
1078                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1079                 return NULL;
1080         }
1081
1082         query = tmp_str;
1083         ast_debug(1, "SQL query: %s\n", query);
1084         args.var = NULL;
1085         args.last = NULL;
1086
1087         ast_mutex_lock(&mutex);
1088
1089         RES_CONFIG_SQLITE_BEGIN
1090                 error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
1091         RES_CONFIG_SQLITE_END(error)
1092
1093         ast_mutex_unlock(&mutex);
1094
1095         sqlite_freemem(query);
1096
1097         if (error) {
1098                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1099                 sqlite_freemem(errormsg);
1100                 ast_variables_destroy(args.var);
1101                 return NULL;
1102         }
1103         sqlite_freemem(errormsg);
1104
1105         return args.var;
1106 }
1107
1108 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
1109 {
1110         struct rt_multi_cfg_entry_args *args;
1111         struct ast_category *cat;
1112         struct ast_variable *var;
1113         char *cat_name;
1114         size_t i;
1115
1116         args = arg;
1117         cat_name = NULL;
1118
1119         /*
1120          * cat_name should always be set here, since initfield is forged from
1121          * params[0] in realtime_multi_handler(), which is a search parameter
1122          * of the SQL query.
1123          */
1124         for (i = 0; i < argc; i++) {
1125                 if (!strcmp(args->initfield, columnNames[i]))
1126                         cat_name = argv[i];
1127         }
1128
1129         if (!cat_name) {
1130                 ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
1131                 return 1;
1132         }
1133
1134         if (!(cat = ast_category_new(cat_name, "", 99999))) {
1135                 ast_log(LOG_WARNING, "Unable to allocate category\n");
1136                 return 1;
1137         }
1138
1139         ast_category_append(args->cfg, cat);
1140
1141         for (i = 0; i < argc; i++) {
1142                 if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
1143                         continue;
1144
1145                 if (!(var = ast_variable_new(columnNames[i], argv[i], ""))) {
1146                         ast_log(LOG_WARNING, "Unable to allocate variable\n");
1147                         return 1;
1148                 }
1149
1150                 ast_variable_append(cat, var);
1151         }
1152
1153         return 0;
1154 }
1155
1156 static struct ast_config *realtime_multi_handler(const char *database,
1157         const char *table, va_list ap)
1158 {
1159         char *query, *errormsg = NULL, *op, *tmp_str, *initfield;
1160         struct rt_multi_cfg_entry_args args;
1161         const char **params, **vals;
1162         struct ast_config *cfg;
1163         size_t params_count;
1164         int error;
1165
1166         if (!table) {
1167                 ast_log(LOG_WARNING, "Table name unspecified\n");
1168                 return NULL;
1169         }
1170
1171         if (!(cfg = ast_config_new())) {
1172                 ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
1173                 return NULL;
1174         }
1175
1176         if (!(params_count = get_params(ap, &params, &vals))) {
1177                 ast_config_destroy(cfg);
1178                 return NULL;
1179         }
1180
1181         if (!(initfield = ast_strdup(params[0]))) {
1182                 ast_config_destroy(cfg);
1183                 ast_free(params);
1184                 ast_free(vals);
1185                 return NULL;
1186         }
1187
1188         tmp_str = strchr(initfield, ' ');
1189
1190         if (tmp_str)
1191                 *tmp_str = '\0';
1192
1193         op = (!strchr(params[0], ' ')) ? " =" : "";
1194
1195         /*
1196          * Asterisk sends us an already escaped string when searching for
1197          * "exten LIKE" (uh!). Handle it separately.
1198          */
1199         tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
1200
1201 /* \cond DOXYGEN_CAN_PARSE_THIS */
1202 #undef QUERY
1203 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1204 /* \endcond */
1205
1206         if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
1207                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1208                 ast_config_destroy(cfg);
1209                 ast_free(params);
1210                 ast_free(vals);
1211                 ast_free(initfield);
1212                 return NULL;
1213         }
1214
1215         if (params_count > 1) {
1216                 size_t i;
1217
1218                 for (i = 1; i < params_count; i++) {
1219                         op = (!strchr(params[i], ' ')) ? " =" : "";
1220                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1221                         sqlite_freemem(query);
1222
1223                         if (!tmp_str) {
1224                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1225                                 ast_config_destroy(cfg);
1226                                 ast_free(params);
1227                                 ast_free(vals);
1228                                 ast_free(initfield);
1229                                 return NULL;
1230                         }
1231
1232                         query = tmp_str;
1233                 }
1234         }
1235
1236         ast_free(params);
1237         ast_free(vals);
1238
1239         if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
1240                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1241                 sqlite_freemem(query);
1242                 ast_config_destroy(cfg);
1243                 ast_free(initfield);
1244                 return NULL;
1245         }
1246
1247         sqlite_freemem(query);
1248         query = tmp_str;
1249         ast_debug(1, "SQL query: %s\n", query);
1250         args.cfg = cfg;
1251         args.initfield = initfield;
1252
1253         ast_mutex_lock(&mutex);
1254
1255         RES_CONFIG_SQLITE_BEGIN
1256                 error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
1257         RES_CONFIG_SQLITE_END(error)
1258
1259         ast_mutex_unlock(&mutex);
1260
1261         sqlite_freemem(query);
1262         ast_free(initfield);
1263
1264         if (error) {
1265                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1266                 sqlite_freemem(errormsg);
1267                 ast_config_destroy(cfg);
1268                 return NULL;
1269         }
1270         sqlite_freemem(errormsg);
1271
1272         return cfg;
1273 }
1274
1275 static int realtime_update_handler(const char *database, const char *table,
1276         const char *keyfield, const char *entity, va_list ap)
1277 {
1278         char *query, *errormsg = NULL, *tmp_str;
1279         const char **params, **vals;
1280         size_t params_count;
1281         int error, rows_num;
1282
1283         if (!table) {
1284                 ast_log(LOG_WARNING, "Table name unspecified\n");
1285                 return -1;
1286         }
1287
1288         if (!(params_count = get_params(ap, &params, &vals)))
1289                 return -1;
1290
1291 /* \cond DOXYGEN_CAN_PARSE_THIS */
1292 #undef QUERY
1293 #define QUERY "UPDATE '%q' SET %q = '%q'"
1294 /* \endcond */
1295
1296         if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
1297                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1298                 ast_free(params);
1299                 ast_free(vals);
1300                 return -1;
1301         }
1302
1303         if (params_count > 1) {
1304                 size_t i;
1305
1306                 for (i = 1; i < params_count; i++) {
1307                         tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i], vals[i]);
1308                         sqlite_freemem(query);
1309
1310                         if (!tmp_str) {
1311                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1312                                 ast_free(params);
1313                                 ast_free(vals);
1314                                 return -1;
1315                         }
1316
1317                         query = tmp_str;
1318                 }
1319         }
1320
1321         ast_free(params);
1322         ast_free(vals);
1323
1324         if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
1325                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1326                 sqlite_freemem(query);
1327                 return -1;
1328         }
1329
1330         sqlite_freemem(query);
1331         query = tmp_str;
1332         ast_debug(1, "SQL query: %s\n", query);
1333
1334         ast_mutex_lock(&mutex);
1335
1336         RES_CONFIG_SQLITE_BEGIN
1337                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1338         RES_CONFIG_SQLITE_END(error)
1339
1340         if (!error)
1341                 rows_num = sqlite_changes(db);
1342         else
1343                 rows_num = -1;
1344
1345         ast_mutex_unlock(&mutex);
1346
1347         sqlite_freemem(query);
1348
1349         if (error) {
1350                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1351         }
1352         sqlite_freemem(errormsg);
1353
1354         return rows_num;
1355 }
1356
1357 static int realtime_store_handler(const char *database, const char *table, va_list ap)
1358 {
1359         char *errormsg = NULL, *tmp_str, *tmp_keys = NULL, *tmp_keys2 = NULL, *tmp_vals = NULL, *tmp_vals2 = NULL;
1360         const char **params, **vals;
1361         size_t params_count;
1362         int error, rows_id;
1363         size_t i;
1364
1365         if (!table) {
1366                 ast_log(LOG_WARNING, "Table name unspecified\n");
1367                 return -1;
1368         }
1369
1370         if (!(params_count = get_params(ap, &params, &vals)))
1371                 return -1;
1372
1373 /* \cond DOXYGEN_CAN_PARSE_THIS */
1374 #undef QUERY
1375 #define QUERY "INSERT into '%q' (%s) VALUES (%s);"
1376 /* \endcond */
1377
1378         for (i = 0; i < params_count; i++) {
1379                 if ( tmp_keys2 ) {
1380                         tmp_keys = sqlite_mprintf("%s, %q", tmp_keys2, params[i]);
1381                         sqlite_freemem(tmp_keys2);
1382                 } else {
1383                         tmp_keys = sqlite_mprintf("%q", params[i]);
1384                 }
1385                 if (!tmp_keys) {
1386                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1387                         sqlite_freemem(tmp_vals);
1388                         ast_free(params);
1389                         ast_free(vals);
1390                         return -1;
1391                 }
1392
1393                 if ( tmp_vals2 ) {
1394                         tmp_vals = sqlite_mprintf("%s, '%q'", tmp_vals2, params[i]);
1395                         sqlite_freemem(tmp_vals2);
1396                 } else {
1397                         tmp_vals = sqlite_mprintf("'%q'", params[i]);
1398                 }
1399                 if (!tmp_vals) {
1400                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1401                         sqlite_freemem(tmp_keys);
1402                         ast_free(params);
1403                         ast_free(vals);
1404                         return -1;
1405                 }
1406
1407
1408                 tmp_keys2 = tmp_keys;
1409                 tmp_vals2 = tmp_vals;
1410         }
1411
1412         ast_free(params);
1413         ast_free(vals);
1414
1415         if (!(tmp_str = sqlite_mprintf(QUERY, table, tmp_keys, tmp_vals))) {
1416                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1417                 sqlite_freemem(tmp_keys);
1418                 sqlite_freemem(tmp_vals);
1419                 return -1;
1420         }
1421
1422         sqlite_freemem(tmp_keys);
1423         sqlite_freemem(tmp_vals);
1424
1425         ast_debug(1, "SQL query: %s\n", tmp_str);
1426
1427         ast_mutex_lock(&mutex);
1428
1429         RES_CONFIG_SQLITE_BEGIN
1430                 error = sqlite_exec(db, tmp_str, NULL, NULL, &errormsg);
1431         RES_CONFIG_SQLITE_END(error)
1432
1433         if (!error) {
1434                 rows_id = sqlite_last_insert_rowid(db);
1435         } else {
1436                 rows_id = -1;
1437         }
1438
1439         ast_mutex_unlock(&mutex);
1440
1441         sqlite_freemem(tmp_str);
1442
1443         if (error) {
1444                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1445         }
1446         sqlite_freemem(errormsg);
1447
1448         return rows_id;
1449 }
1450
1451 static int realtime_destroy_handler(const char *database, const char *table,
1452         const char *keyfield, const char *entity, va_list ap)
1453 {
1454         char *query, *errormsg = NULL, *tmp_str;
1455         const char **params, **vals;
1456         size_t params_count;
1457         int error, rows_num;
1458         size_t i;
1459
1460         if (!table) {
1461                 ast_log(LOG_WARNING, "Table name unspecified\n");
1462                 return -1;
1463         }
1464
1465         if (!(params_count = get_params(ap, &params, &vals)))
1466                 return -1;
1467
1468 /* \cond DOXYGEN_CAN_PARSE_THIS */
1469 #undef QUERY
1470 #define QUERY "DELETE FROM '%q' WHERE"
1471 /* \endcond */
1472
1473         if (!(query = sqlite_mprintf(QUERY, table))) {
1474                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1475                 ast_free(params);
1476                 ast_free(vals);
1477                 return -1;
1478         }
1479
1480         for (i = 0; i < params_count; i++) {
1481                 tmp_str = sqlite_mprintf("%s %q = '%q' AND", query, params[i], vals[i]);
1482                 sqlite_freemem(query);
1483
1484                 if (!tmp_str) {
1485                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1486                         ast_free(params);
1487                         ast_free(vals);
1488                         return -1;
1489                 }
1490
1491                 query = tmp_str;
1492         }
1493
1494         ast_free(params);
1495         ast_free(vals);
1496         if (!(tmp_str = sqlite_mprintf("%s %q = '%q';", query, keyfield, entity))) {
1497                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1498                 sqlite_freemem(query);
1499                 return -1;
1500         }
1501         sqlite_freemem(query);
1502         query = tmp_str;
1503         ast_debug(1, "SQL query: %s\n", query);
1504
1505         ast_mutex_lock(&mutex);
1506
1507         RES_CONFIG_SQLITE_BEGIN
1508                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1509         RES_CONFIG_SQLITE_END(error)
1510
1511         if (!error)
1512                 rows_num = sqlite_changes(db);
1513         else
1514                 rows_num = -1;
1515
1516         ast_mutex_unlock(&mutex);
1517
1518         sqlite_freemem(query);
1519
1520         if (error) {
1521                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1522         }
1523         sqlite_freemem(errormsg);
1524
1525         return rows_num;
1526 }
1527
1528 static int realtime_require_handler(const char *unused, const char *tablename, va_list ap)
1529 {
1530         struct sqlite_cache_tables *tbl = find_table(tablename);
1531         struct sqlite_cache_columns *col;
1532         char *elm;
1533         int type, size, res = 0;
1534
1535         if (!tbl) {
1536                 return -1;
1537         }
1538
1539         while ((elm = va_arg(ap, char *))) {
1540                 type = va_arg(ap, require_type);
1541                 size = va_arg(ap, int);
1542                 /* Check if the field matches the criteria */
1543                 AST_RWLIST_TRAVERSE(&tbl->columns, col, list) {
1544                         if (strcmp(col->name, elm) == 0) {
1545                                 /* SQLite only has two types - the 32-bit integer field that
1546                                  * is the key column, and everything else (everything else
1547                                  * being a string).
1548                                  */
1549                                 if (col->isint && !ast_rq_is_int(type)) {
1550                                         ast_log(LOG_WARNING, "Realtime table %s: column '%s' is an integer field, but Asterisk requires that it not be!\n", tablename, col->name);
1551                                         res = -1;
1552                                 }
1553                                 break;
1554                         }
1555                 }
1556                 if (!col) {
1557                         ast_log(LOG_WARNING, "Realtime table %s requires column '%s', but that column does not exist!\n", tablename, elm);
1558                 }
1559         }
1560         AST_RWLIST_UNLOCK(&(tbl->columns));
1561         return res;
1562 }
1563
1564 static int realtime_unload_handler(const char *unused, const char *tablename)
1565 {
1566         struct sqlite_cache_tables *tbl;
1567         AST_RWLIST_WRLOCK(&sqlite_tables);
1568         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&sqlite_tables, tbl, list) {
1569                 if (!strcasecmp(tbl->name, tablename)) {
1570                         AST_RWLIST_REMOVE_CURRENT(list);
1571                         free_table(tbl);
1572                 }
1573         }
1574         AST_RWLIST_TRAVERSE_SAFE_END
1575         AST_RWLIST_UNLOCK(&sqlite_tables);
1576         return 0;
1577 }
1578
1579 static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1580 {
1581         switch (cmd) {
1582         case CLI_INIT:
1583                 e->command = "sqlite show status";
1584                 e->usage =
1585                         "Usage: sqlite show status\n"
1586                         "       Show status information about the SQLite 2 driver\n";
1587                 return NULL;
1588         case CLI_GENERATE:
1589                 return NULL;
1590         }
1591
1592         if (a->argc != 3)
1593                 return CLI_SHOWUSAGE;
1594
1595         ast_cli(a->fd, "SQLite database path: %s\n", dbfile);
1596         ast_cli(a->fd, "config_table: ");
1597
1598         if (!config_table)
1599                 ast_cli(a->fd, "unspecified, must be present in extconfig.conf\n");
1600         else
1601                 ast_cli(a->fd, "%s\n", config_table);
1602
1603         ast_cli(a->fd, "cdr_table: ");
1604
1605         if (!cdr_table)
1606                 ast_cli(a->fd, "unspecified, CDR support disabled\n");
1607         else
1608                 ast_cli(a->fd, "%s\n", cdr_table);
1609
1610         return CLI_SUCCESS;
1611 }
1612
1613 static char *handle_cli_sqlite_show_tables(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1614 {
1615         struct sqlite_cache_tables *tbl;
1616         struct sqlite_cache_columns *col;
1617         int found = 0;
1618
1619         switch (cmd) {
1620         case CLI_INIT:
1621                 e->command = "sqlite show tables";
1622                 e->usage =
1623                         "Usage: sqlite show tables\n"
1624                         "       Show table information about the SQLite 2 driver\n";
1625                 return NULL;
1626         case CLI_GENERATE:
1627                 return NULL;
1628         }
1629
1630         if (a->argc != 3)
1631                 return CLI_SHOWUSAGE;
1632
1633         AST_RWLIST_RDLOCK(&sqlite_tables);
1634         AST_RWLIST_TRAVERSE(&sqlite_tables, tbl, list) {
1635                 found++;
1636                 ast_cli(a->fd, "Table %s:\n", tbl->name);
1637                 AST_RWLIST_TRAVERSE(&(tbl->columns), col, list) {
1638                         fprintf(stderr, "%s\n", col->name);
1639                         ast_cli(a->fd, "  %20.20s  %-30.30s\n", col->name, col->type);
1640                 }
1641         }
1642         AST_RWLIST_UNLOCK(&sqlite_tables);
1643
1644         if (!found) {
1645                 ast_cli(a->fd, "No tables currently in cache\n");
1646         }
1647
1648         return CLI_SUCCESS;
1649 }
1650
1651 static int unload_module(void)
1652 {
1653         if (cli_status_registered)
1654                 ast_cli_unregister_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
1655
1656         if (cdr_registered)
1657                 ast_cdr_unregister(RES_CONFIG_SQLITE_NAME);
1658
1659         ast_config_engine_deregister(&sqlite_engine);
1660
1661         if (db)
1662                 sqlite_close(db);
1663
1664         unload_config();
1665
1666         return 0;
1667 }
1668
1669 static int load_module(void)
1670 {
1671         char *errormsg = NULL;
1672         int error;
1673
1674         db = NULL;
1675         cdr_registered = 0;
1676         cli_status_registered = 0;
1677         dbfile = NULL;
1678         config_table = NULL;
1679         cdr_table = NULL;
1680         error = load_config();
1681
1682         if (error)
1683                 return AST_MODULE_LOAD_DECLINE;
1684
1685         if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
1686                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1687                 sqlite_freemem(errormsg);
1688                 unload_module();
1689                 return 1;
1690         }
1691
1692         sqlite_freemem(errormsg);
1693         errormsg = NULL;
1694         ast_config_engine_register(&sqlite_engine);
1695
1696         if (use_cdr) {
1697                 char *query;
1698
1699 /* \cond DOXYGEN_CAN_PARSE_THIS */
1700 #undef QUERY
1701 #define QUERY "SELECT COUNT(id) FROM %Q;"
1702 /* \endcond */
1703
1704                 query = sqlite_mprintf(QUERY, cdr_table);
1705
1706                 if (!query) {
1707                         ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1708                         unload_module();
1709                         return 1;
1710                 }
1711
1712                 ast_debug(1, "SQL query: %s\n", query);
1713
1714                 RES_CONFIG_SQLITE_BEGIN
1715                         error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1716                 RES_CONFIG_SQLITE_END(error)
1717
1718                 sqlite_freemem(query);
1719
1720                 if (error) {
1721                         /*
1722                          * Unexpected error.
1723                          */
1724                         if (error != SQLITE_ERROR) {
1725                                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1726                                 sqlite_freemem(errormsg);
1727                                 unload_module();
1728                                 return 1;
1729                         }
1730
1731                         sqlite_freemem(errormsg);
1732                         errormsg = NULL;
1733                         query = sqlite_mprintf(sql_create_cdr_table, cdr_table);
1734
1735                         if (!query) {
1736                                 ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1737                                 unload_module();
1738                                 return 1;
1739                         }
1740
1741                         ast_debug(1, "SQL query: %s\n", query);
1742
1743                         RES_CONFIG_SQLITE_BEGIN
1744                                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1745                         RES_CONFIG_SQLITE_END(error)
1746
1747                         sqlite_freemem(query);
1748
1749                         if (error) {
1750                                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1751                                 sqlite_freemem(errormsg);
1752                                 unload_module();
1753                                 return 1;
1754                         }
1755                 }
1756                 sqlite_freemem(errormsg);
1757                 errormsg = NULL;
1758
1759                 error = ast_cdr_register(RES_CONFIG_SQLITE_NAME, RES_CONFIG_SQLITE_DESCRIPTION, cdr_handler);
1760
1761                 if (error) {
1762                         unload_module();
1763                         return 1;
1764                 }
1765
1766                 cdr_registered = 1;
1767         }
1768
1769         error = ast_cli_register_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
1770
1771         if (error) {
1772                 unload_module();
1773                 return 1;
1774         }
1775
1776         cli_status_registered = 1;
1777
1778         return 0;
1779 }
1780
1781 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
1782                 .load = load_module,
1783                 .unload = unload_module,
1784 );