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