Add option to hide console connect messages
[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 #define sql_table_structure "SELECT sql FROM sqlite_master WHERE type='table' AND tbl_name='%s'"
559
560 /*!
561  * SQL query format to fetch the static configuration of a file.
562  * Rows must be sorted by category.
563  *
564  * \see add_cfg_entry()
565  */
566 #define sql_get_config_table \
567         "SELECT *" \
568         "       FROM '%q'" \
569         "       WHERE filename = '%q' AND commented = 0" \
570         "       ORDER BY cat_metric ASC, var_metric ASC;"
571
572 static void free_table(struct sqlite_cache_tables *tblptr)
573 {
574         struct sqlite_cache_columns *col;
575
576         /* Obtain a write lock to ensure there are no read locks outstanding */
577         AST_RWLIST_WRLOCK(&(tblptr->columns));
578         while ((col = AST_RWLIST_REMOVE_HEAD(&(tblptr->columns), list))) {
579                 ast_free(col);
580         }
581         AST_RWLIST_UNLOCK(&(tblptr->columns));
582         AST_RWLIST_HEAD_DESTROY(&(tblptr->columns));
583         ast_free(tblptr);
584 }
585
586 static int find_table_cb(void *vtblptr, int argc, char **argv, char **columnNames)
587 {
588         struct sqlite_cache_tables *tblptr = vtblptr;
589         char *sql = ast_strdupa(argv[0]), *start, *end, *type, *remainder;
590         int i;
591         AST_DECLARE_APP_ARGS(fie,
592                 AST_APP_ARG(ld)[100]; /* This means we support up to 100 columns per table */
593         );
594         struct sqlite_cache_columns *col;
595
596         /* This is really fun.  We get to parse an SQL statement to figure out
597          * what columns are in the table.
598          */
599         if ((start = strchr(sql, '(')) && (end = strrchr(sql, ')'))) {
600                 start++;
601                 *end = '\0';
602         } else {
603                 /* Abort */
604                 return -1;
605         }
606
607         AST_STANDARD_APP_ARGS(fie, start);
608         for (i = 0; i < fie.argc; i++) {
609                 fie.ld[i] = ast_skip_blanks(fie.ld[i]);
610                 ast_debug(5, "Found field: %s\n", fie.ld[i]);
611                 if (strncasecmp(fie.ld[i], "PRIMARY KEY", 11) == 0 && (start = strchr(fie.ld[i], '(')) && (end = strchr(fie.ld[i], ')'))) {
612                         *end = '\0';
613                         AST_RWLIST_TRAVERSE(&(tblptr->columns), col, list) {
614                                 if (strcasecmp(start + 1, col->name) == 0 && strcasestr(col->type, "INTEGER")) {
615                                         col->isint = 1;
616                                 }
617                         }
618                         continue;
619                 }
620                 /* type delimiter could be any space character */
621                 for (type = fie.ld[i]; *type > 32; type++);
622                 *type++ = '\0';
623                 type = ast_skip_blanks(type);
624                 for (remainder = type; *remainder > 32; remainder++);
625                 *remainder = '\0';
626                 if (!(col = ast_calloc(1, sizeof(*col) + strlen(fie.ld[i]) + strlen(type) + 2))) {
627                         return -1;
628                 }
629                 col->name = (char *)col + sizeof(*col);
630                 col->type = (char *)col + sizeof(*col) + strlen(fie.ld[i]) + 1;
631                 strcpy(col->name, fie.ld[i]); /* SAFE */
632                 strcpy(col->type, type); /* SAFE */
633                 if (strcasestr(col->type, "INTEGER") && strcasestr(col->type, "PRIMARY KEY")) {
634                         col->isint = 1;
635                 }
636                 AST_LIST_INSERT_TAIL(&(tblptr->columns), col, list);
637         }
638         return 0;
639 }
640
641 static struct sqlite_cache_tables *find_table(const char *tablename)
642 {
643         struct sqlite_cache_tables *tblptr;
644         int i, err;
645         char *sql, *errstr = NULL;
646
647         AST_RWLIST_RDLOCK(&sqlite_tables);
648
649         for (i = 0; i < 2; i++) {
650                 AST_RWLIST_TRAVERSE(&sqlite_tables, tblptr, list) {
651                         if (strcmp(tblptr->name, tablename) == 0) {
652                                 break;
653                         }
654                 }
655                 if (tblptr) {
656                         AST_RWLIST_RDLOCK(&(tblptr->columns));
657                         AST_RWLIST_UNLOCK(&sqlite_tables);
658                         return tblptr;
659                 }
660
661                 if (i == 0) {
662                         AST_RWLIST_UNLOCK(&sqlite_tables);
663                         AST_RWLIST_WRLOCK(&sqlite_tables);
664                 }
665         }
666
667         /* Table structure not cached; build the structure now */
668         if (asprintf(&sql, sql_table_structure, tablename) < 0) {
669                 ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
670                 sql = NULL;
671         }
672         if (!(tblptr = ast_calloc(1, sizeof(*tblptr) + strlen(tablename) + 1))) {
673                 AST_RWLIST_UNLOCK(&sqlite_tables);
674                 ast_log(LOG_ERROR, "Memory error.  Cannot cache table '%s'\n", tablename);
675                 return NULL;
676         }
677         tblptr->name = (char *)tblptr + sizeof(*tblptr);
678         strcpy(tblptr->name, tablename); /* SAFE */
679         AST_RWLIST_HEAD_INIT(&(tblptr->columns));
680
681         ast_debug(1, "About to query table structure: %s\n", sql);
682
683         ast_mutex_lock(&mutex);
684         if ((err = sqlite_exec(db, sql, find_table_cb, tblptr, &errstr))) {
685                 ast_mutex_unlock(&mutex);
686                 ast_log(LOG_WARNING, "SQLite error %d: %s\n", err, errstr);
687                 ast_free(errstr);
688                 free_table(tblptr);
689                 return NULL;
690         }
691         ast_mutex_unlock(&mutex);
692
693         if (AST_LIST_EMPTY(&(tblptr->columns))) {
694                 free_table(tblptr);
695                 return NULL;
696         }
697
698         AST_RWLIST_INSERT_TAIL(&sqlite_tables, tblptr, list);
699         AST_RWLIST_RDLOCK(&(tblptr->columns));
700         AST_RWLIST_UNLOCK(&sqlite_tables);
701         return tblptr;
702 }
703
704 #define release_table(a)        AST_RWLIST_UNLOCK(&((a)->columns))
705
706 static int set_var(char **var, const char *name, const char *value)
707 {
708         if (*var)
709                 ast_free(*var);
710
711         *var = ast_strdup(value);
712
713         if (!*var) {
714                 ast_log(LOG_WARNING, "Unable to allocate variable %s\n", name);
715                 return 1;
716         }
717
718         return 0;
719 }
720
721 static int check_vars(void)
722 {
723         if (!dbfile) {
724                 ast_log(LOG_ERROR, "Required parameter undefined: dbfile\n");
725                 return 1;
726         }
727
728         use_cdr = (cdr_table != NULL);
729
730         return 0;
731 }
732
733 static int load_config(void)
734 {
735         struct ast_config *config;
736         struct ast_variable *var;
737         int error;
738         struct ast_flags config_flags = { 0 };
739
740         config = ast_config_load(RES_CONFIG_SQLITE_CONF_FILE, config_flags);
741
742         if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
743                 ast_log(LOG_ERROR, "Unable to load " RES_CONFIG_SQLITE_CONF_FILE "\n");
744                 return 1;
745         }
746
747         for (var = ast_variable_browse(config, "general"); var; var = var->next) {
748                 if (!strcasecmp(var->name, "dbfile"))
749                         SET_VAR(config, dbfile, var);
750                 else if (!strcasecmp(var->name, "config_table"))
751                         SET_VAR(config, config_table, var);
752                 else if (!strcasecmp(var->name, "cdr_table")) {
753                         SET_VAR(config, cdr_table, var);
754                 } else
755                         ast_log(LOG_WARNING, "Unknown parameter : %s\n", var->name);
756         }
757
758         ast_config_destroy(config);
759         error = check_vars();
760
761         if (error) {
762                 unload_config();
763                 return 1;
764         }
765
766         return 0;
767 }
768
769 static void unload_config(void)
770 {
771         struct sqlite_cache_tables *tbl;
772         ast_free(dbfile);
773         dbfile = NULL;
774         ast_free(config_table);
775         config_table = NULL;
776         ast_free(cdr_table);
777         cdr_table = NULL;
778         AST_RWLIST_WRLOCK(&sqlite_tables);
779         while ((tbl = AST_RWLIST_REMOVE_HEAD(&sqlite_tables, list))) {
780                 free_table(tbl);
781         }
782         AST_RWLIST_UNLOCK(&sqlite_tables);
783 }
784
785 static int cdr_handler(struct ast_cdr *cdr)
786 {
787         char *errormsg = NULL, *tmp, workspace[500];
788         int error, scannum;
789         struct sqlite_cache_tables *tbl = find_table(cdr_table);
790         struct sqlite_cache_columns *col;
791         struct ast_str *sql1 = ast_str_create(160), *sql2 = ast_str_create(16);
792         int first = 1;
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%s", first ? "" : ",", col->name);
810                                 ast_str_append(&sql2, 0, "%s%d", first ? "" : ",", 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%s", first ? "" : ",", col->name);
818                         tmp = sqlite_mprintf("%Q", tmp);
819                         ast_str_append(&sql2, 0, "%s%s", first ? "" : ",", tmp);
820                         sqlite_freemem(tmp);
821                 }
822         }
823         release_table(tbl);
824
825         ast_str_append(&sql1, 0, "%s)", ast_str_buffer(sql2));
826         ast_free(sql2);
827
828         ast_debug(1, "SQL query: %s\n", ast_str_buffer(sql1));
829
830         ast_mutex_lock(&mutex);
831
832         RES_CONFIG_SQLITE_BEGIN
833                 error = sqlite_exec(db, ast_str_buffer(sql1), NULL, NULL, &errormsg);
834         RES_CONFIG_SQLITE_END(error)
835
836         ast_mutex_unlock(&mutex);
837
838         ast_free(sql1);
839
840         if (error) {
841                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
842                 sqlite_freemem(errormsg);
843                 return 1;
844         }
845         sqlite_freemem(errormsg);
846
847         return 0;
848 }
849
850 static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
851 {
852         struct cfg_entry_args *args;
853         struct ast_variable *var;
854
855         if (argc != RES_CONFIG_SQLITE_CONFIG_COLUMNS) {
856                 ast_log(LOG_WARNING, "Corrupt table\n");
857                 return 1;
858         }
859
860         args = arg;
861
862         if (!strcmp(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], "#include")) {
863                 struct ast_config *cfg;
864                 char *val;
865
866                 val = argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL];
867                 cfg = ast_config_internal_load(val, args->cfg, args->flags, "", args->who_asked);
868
869                 if (!cfg) {
870                         ast_log(LOG_WARNING, "Unable to include %s\n", val);
871                         return 1;
872                 } else {
873                         args->cfg = cfg;
874                         return 0;
875                 }
876         }
877
878         if (!args->cat_name || strcmp(args->cat_name, argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY])) {
879                 args->cat = ast_category_new(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY], "", 99999);
880
881                 if (!args->cat) {
882                         ast_log(LOG_WARNING, "Unable to allocate category\n");
883                         return 1;
884                 }
885
886                 ast_free(args->cat_name);
887                 args->cat_name = ast_strdup(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY]);
888
889                 if (!args->cat_name) {
890                         ast_category_destroy(args->cat);
891                         return 1;
892                 }
893
894                 ast_category_append(args->cfg, args->cat);
895         }
896
897         var = ast_variable_new(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL], "");
898
899         if (!var) {
900                 ast_log(LOG_WARNING, "Unable to allocate variable");
901                 return 1;
902         }
903
904         ast_variable_append(args->cat, var);
905
906         return 0;
907 }
908
909 static struct ast_config *config_handler(const char *database,  const char *table, const char *file,
910         struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked)
911 {
912         struct cfg_entry_args args;
913         char *query, *errormsg = NULL;
914         int error;
915
916         if (!config_table) {
917                 if (!table) {
918                         ast_log(LOG_ERROR, "Table name unspecified\n");
919                         return NULL;
920                 }
921         } else
922                 table = config_table;
923
924         query = sqlite_mprintf(sql_get_config_table, table, file);
925
926         if (!query) {
927                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
928                 return NULL;
929         }
930
931         ast_debug(1, "SQL query: %s\n", query);
932         args.cfg = cfg;
933         args.cat = NULL;
934         args.cat_name = NULL;
935         args.flags = flags;
936         args.who_asked = who_asked;
937
938         ast_mutex_lock(&mutex);
939
940         RES_CONFIG_SQLITE_BEGIN
941                 error = sqlite_exec(db, query, add_cfg_entry, &args, &errormsg);
942         RES_CONFIG_SQLITE_END(error)
943
944         ast_mutex_unlock(&mutex);
945
946         ast_free(args.cat_name);
947         sqlite_freemem(query);
948
949         if (error) {
950                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
951                 sqlite_freemem(errormsg);
952                 return NULL;
953         }
954         sqlite_freemem(errormsg);
955
956         return cfg;
957 }
958
959 static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr, int warn)
960 {
961         const char **tmp, *param, *val, **params, **vals;
962         size_t params_count;
963
964         params = NULL;
965         vals = NULL;
966         params_count = 0;
967
968         while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
969                 if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
970                         ast_free(params);
971                         ast_free(vals);
972                         return 0;
973                 }
974                 params = tmp;
975
976                 if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
977                         ast_free(params);
978                         ast_free(vals);
979                         return 0;
980                 }
981                 vals = tmp;
982
983                 params[params_count] = param;
984                 vals[params_count] = val;
985                 params_count++;
986         }
987
988         if (params_count > 0) {
989                 *params_ptr = params;
990                 *vals_ptr = vals;
991         } else if (warn) {
992                 ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
993         }
994
995         return params_count;
996 }
997
998 static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
999 {
1000         struct rt_cfg_entry_args *args;
1001         struct ast_variable *var;
1002         int i;
1003
1004         args = arg;
1005
1006         for (i = 0; i < argc; i++) {
1007                 if (!argv[i])
1008                         continue;
1009
1010                 if (!(var = ast_variable_new(columnNames[i], argv[i], "")))
1011                         return 1;
1012
1013                 if (!args->var)
1014                         args->var = var;
1015
1016                 if (!args->last)
1017                         args->last = var;
1018                 else {
1019                         args->last->next = var;
1020                         args->last = var;
1021                 }
1022         }
1023
1024         return 0;
1025 }
1026
1027 static struct ast_variable * realtime_handler(const char *database, const char *table, va_list ap)
1028 {
1029         char *query, *errormsg = NULL, *op, *tmp_str;
1030         struct rt_cfg_entry_args args;
1031         const char **params, **vals;
1032         size_t params_count;
1033         int error;
1034
1035         if (!table) {
1036                 ast_log(LOG_WARNING, "Table name unspecified\n");
1037                 return NULL;
1038         }
1039
1040         params_count = get_params(ap, &params, &vals, 1);
1041
1042         if (params_count == 0)
1043                 return NULL;
1044
1045         op = (strchr(params[0], ' ') == NULL) ? " =" : "";
1046
1047 /* \cond DOXYGEN_CAN_PARSE_THIS */
1048 #undef QUERY
1049 #define QUERY "SELECT * FROM '%q' WHERE%s %q%s '%q'"
1050 /* \endcond */
1051
1052         query = sqlite_mprintf(QUERY, table, !strcmp(config_table, table) ? " commented = 0 AND" : "", params[0], op, vals[0]);
1053
1054         if (!query) {
1055                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1056                 ast_free(params);
1057                 ast_free(vals);
1058                 return NULL;
1059         }
1060
1061         if (params_count > 1) {
1062                 size_t i;
1063
1064                 for (i = 1; i < params_count; i++) {
1065                         op = (strchr(params[i], ' ') == NULL) ? " =" : "";
1066                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1067                         sqlite_freemem(query);
1068
1069                         if (!tmp_str) {
1070                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1071                                 ast_free(params);
1072                                 ast_free(vals);
1073                                 return NULL;
1074                         }
1075
1076                         query = tmp_str;
1077                 }
1078         }
1079
1080         ast_free(params);
1081         ast_free(vals);
1082
1083         tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
1084         sqlite_freemem(query);
1085
1086         if (!tmp_str) {
1087                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1088                 return NULL;
1089         }
1090
1091         query = tmp_str;
1092         ast_debug(1, "SQL query: %s\n", query);
1093         args.var = NULL;
1094         args.last = NULL;
1095
1096         ast_mutex_lock(&mutex);
1097
1098         RES_CONFIG_SQLITE_BEGIN
1099                 error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
1100         RES_CONFIG_SQLITE_END(error)
1101
1102         ast_mutex_unlock(&mutex);
1103
1104         sqlite_freemem(query);
1105
1106         if (error) {
1107                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1108                 sqlite_freemem(errormsg);
1109                 ast_variables_destroy(args.var);
1110                 return NULL;
1111         }
1112         sqlite_freemem(errormsg);
1113
1114         return args.var;
1115 }
1116
1117 static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
1118 {
1119         struct rt_multi_cfg_entry_args *args;
1120         struct ast_category *cat;
1121         struct ast_variable *var;
1122         char *cat_name;
1123         size_t i;
1124
1125         args = arg;
1126         cat_name = NULL;
1127
1128         /*
1129          * cat_name should always be set here, since initfield is forged from
1130          * params[0] in realtime_multi_handler(), which is a search parameter
1131          * of the SQL query.
1132          */
1133         for (i = 0; i < argc; i++) {
1134                 if (!strcmp(args->initfield, columnNames[i]))
1135                         cat_name = argv[i];
1136         }
1137
1138         if (!cat_name) {
1139                 ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
1140                 return 1;
1141         }
1142
1143         if (!(cat = ast_category_new(cat_name, "", 99999))) {
1144                 ast_log(LOG_WARNING, "Unable to allocate category\n");
1145                 return 1;
1146         }
1147
1148         ast_category_append(args->cfg, cat);
1149
1150         for (i = 0; i < argc; i++) {
1151                 if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
1152                         continue;
1153
1154                 if (!(var = ast_variable_new(columnNames[i], argv[i], ""))) {
1155                         ast_log(LOG_WARNING, "Unable to allocate variable\n");
1156                         return 1;
1157                 }
1158
1159                 ast_variable_append(cat, var);
1160         }
1161
1162         return 0;
1163 }
1164
1165 static struct ast_config *realtime_multi_handler(const char *database,
1166         const char *table, va_list ap)
1167 {
1168         char *query, *errormsg = NULL, *op, *tmp_str, *initfield;
1169         struct rt_multi_cfg_entry_args args;
1170         const char **params, **vals;
1171         struct ast_config *cfg;
1172         size_t params_count;
1173         int error;
1174
1175         if (!table) {
1176                 ast_log(LOG_WARNING, "Table name unspecified\n");
1177                 return NULL;
1178         }
1179
1180         if (!(cfg = ast_config_new())) {
1181                 ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
1182                 return NULL;
1183         }
1184
1185         if (!(params_count = get_params(ap, &params, &vals, 1))) {
1186                 ast_config_destroy(cfg);
1187                 return NULL;
1188         }
1189
1190         if (!(initfield = ast_strdup(params[0]))) {
1191                 ast_config_destroy(cfg);
1192                 ast_free(params);
1193                 ast_free(vals);
1194                 return NULL;
1195         }
1196
1197         tmp_str = strchr(initfield, ' ');
1198
1199         if (tmp_str)
1200                 *tmp_str = '\0';
1201
1202         op = (!strchr(params[0], ' ')) ? " =" : "";
1203
1204         /*
1205          * Asterisk sends us an already escaped string when searching for
1206          * "exten LIKE" (uh!). Handle it separately.
1207          */
1208         tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
1209
1210 /* \cond DOXYGEN_CAN_PARSE_THIS */
1211 #undef QUERY
1212 #define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
1213 /* \endcond */
1214
1215         if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
1216                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1217                 ast_config_destroy(cfg);
1218                 ast_free(params);
1219                 ast_free(vals);
1220                 ast_free(initfield);
1221                 return NULL;
1222         }
1223
1224         if (params_count > 1) {
1225                 size_t i;
1226
1227                 for (i = 1; i < params_count; i++) {
1228                         op = (!strchr(params[i], ' ')) ? " =" : "";
1229                         tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
1230                         sqlite_freemem(query);
1231
1232                         if (!tmp_str) {
1233                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1234                                 ast_config_destroy(cfg);
1235                                 ast_free(params);
1236                                 ast_free(vals);
1237                                 ast_free(initfield);
1238                                 return NULL;
1239                         }
1240
1241                         query = tmp_str;
1242                 }
1243         }
1244
1245         ast_free(params);
1246         ast_free(vals);
1247
1248         if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
1249                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1250                 sqlite_freemem(query);
1251                 ast_config_destroy(cfg);
1252                 ast_free(initfield);
1253                 return NULL;
1254         }
1255
1256         sqlite_freemem(query);
1257         query = tmp_str;
1258         ast_debug(1, "SQL query: %s\n", query);
1259         args.cfg = cfg;
1260         args.initfield = initfield;
1261
1262         ast_mutex_lock(&mutex);
1263
1264         RES_CONFIG_SQLITE_BEGIN
1265                 error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
1266         RES_CONFIG_SQLITE_END(error)
1267
1268         ast_mutex_unlock(&mutex);
1269
1270         sqlite_freemem(query);
1271         ast_free(initfield);
1272
1273         if (error) {
1274                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1275                 sqlite_freemem(errormsg);
1276                 ast_config_destroy(cfg);
1277                 return NULL;
1278         }
1279         sqlite_freemem(errormsg);
1280
1281         return cfg;
1282 }
1283
1284 static int realtime_update_handler(const char *database, const char *table,
1285         const char *keyfield, const char *entity, va_list ap)
1286 {
1287         char *query, *errormsg = NULL, *tmp_str;
1288         const char **params, **vals;
1289         size_t params_count;
1290         int error, rows_num;
1291
1292         if (!table) {
1293                 ast_log(LOG_WARNING, "Table name unspecified\n");
1294                 return -1;
1295         }
1296
1297         if (!(params_count = get_params(ap, &params, &vals, 1)))
1298                 return -1;
1299
1300 /* \cond DOXYGEN_CAN_PARSE_THIS */
1301 #undef QUERY
1302 #define QUERY "UPDATE '%q' SET %q = '%q'"
1303 /* \endcond */
1304
1305         if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
1306                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1307                 ast_free(params);
1308                 ast_free(vals);
1309                 return -1;
1310         }
1311
1312         if (params_count > 1) {
1313                 size_t i;
1314
1315                 for (i = 1; i < params_count; i++) {
1316                         tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i], vals[i]);
1317                         sqlite_freemem(query);
1318
1319                         if (!tmp_str) {
1320                                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1321                                 ast_free(params);
1322                                 ast_free(vals);
1323                                 return -1;
1324                         }
1325
1326                         query = tmp_str;
1327                 }
1328         }
1329
1330         ast_free(params);
1331         ast_free(vals);
1332
1333         if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
1334                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1335                 sqlite_freemem(query);
1336                 return -1;
1337         }
1338
1339         sqlite_freemem(query);
1340         query = tmp_str;
1341         ast_debug(1, "SQL query: %s\n", query);
1342
1343         ast_mutex_lock(&mutex);
1344
1345         RES_CONFIG_SQLITE_BEGIN
1346                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1347         RES_CONFIG_SQLITE_END(error)
1348
1349         if (!error)
1350                 rows_num = sqlite_changes(db);
1351         else
1352                 rows_num = -1;
1353
1354         ast_mutex_unlock(&mutex);
1355
1356         sqlite_freemem(query);
1357
1358         if (error) {
1359                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1360         }
1361         sqlite_freemem(errormsg);
1362
1363         return rows_num;
1364 }
1365
1366 static int realtime_update2_handler(const char *database, const char *table,
1367         va_list ap)
1368 {
1369         char *errormsg = NULL, *tmp1, *tmp2;
1370         int error, rows_num, first = 1;
1371         struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
1372         struct ast_str *where = ast_str_thread_get(&where_buf, 100);
1373         const char *param, *value;
1374
1375         if (!table) {
1376                 ast_log(LOG_WARNING, "Table name unspecified\n");
1377                 return -1;
1378         }
1379
1380         if (!sql) {
1381                 return -1;
1382         }
1383
1384         ast_str_set(&sql, 0, "UPDATE %s SET", table);
1385         ast_str_set(&where, 0, " WHERE");
1386
1387         while ((param = va_arg(ap, const char *))) {
1388                 value = va_arg(ap, const char *);
1389                 ast_str_append(&where, 0, "%s %s = %s",
1390                         first ? "" : " AND",
1391                         tmp1 = sqlite_mprintf("%q", param),
1392                         tmp2 = sqlite_mprintf("%Q", value));
1393                 sqlite_freemem(tmp1);
1394                 sqlite_freemem(tmp2);
1395                 first = 0;
1396         }
1397
1398         if (first) {
1399                 ast_log(LOG_ERROR, "No criteria specified on update to '%s@%s'!\n", table, database);
1400                 return -1;
1401         }
1402
1403         first = 1;
1404         while ((param = va_arg(ap, const char *))) {
1405                 value = va_arg(ap, const char *);
1406                 ast_str_append(&sql, 0, "%s %s = %s",
1407                         first ? "" : ",",
1408                         tmp1 = sqlite_mprintf("%q", param),
1409                         tmp2 = sqlite_mprintf("%Q", value));
1410                 sqlite_freemem(tmp1);
1411                 sqlite_freemem(tmp2);
1412                 first = 0;
1413         }
1414
1415         ast_str_append(&sql, 0, " %s", ast_str_buffer(where));
1416         ast_debug(1, "SQL query: %s\n", ast_str_buffer(sql));
1417
1418         ast_mutex_lock(&mutex);
1419
1420         RES_CONFIG_SQLITE_BEGIN
1421                 error = sqlite_exec(db, ast_str_buffer(sql), NULL, NULL, &errormsg);
1422         RES_CONFIG_SQLITE_END(error)
1423
1424         if (!error) {
1425                 rows_num = sqlite_changes(db);
1426         } else {
1427                 rows_num = -1;
1428         }
1429
1430         ast_mutex_unlock(&mutex);
1431
1432         if (error) {
1433                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1434         }
1435         sqlite_freemem(errormsg);
1436
1437         return rows_num;
1438 }
1439
1440 static int realtime_store_handler(const char *database, const char *table, va_list ap)
1441 {
1442         char *errormsg = NULL, *tmp_str, *tmp_keys = NULL, *tmp_keys2 = NULL, *tmp_vals = NULL, *tmp_vals2 = NULL;
1443         const char **params, **vals;
1444         size_t params_count;
1445         int error, rows_id;
1446         size_t i;
1447
1448         if (!table) {
1449                 ast_log(LOG_WARNING, "Table name unspecified\n");
1450                 return -1;
1451         }
1452
1453         if (!(params_count = get_params(ap, &params, &vals, 1)))
1454                 return -1;
1455
1456 /* \cond DOXYGEN_CAN_PARSE_THIS */
1457 #undef QUERY
1458 #define QUERY "INSERT into '%q' (%s) VALUES (%s);"
1459 /* \endcond */
1460
1461         for (i = 0; i < params_count; i++) {
1462                 if ( tmp_keys2 ) {
1463                         tmp_keys = sqlite_mprintf("%s, %q", tmp_keys2, params[i]);
1464                         sqlite_freemem(tmp_keys2);
1465                 } else {
1466                         tmp_keys = sqlite_mprintf("%q", params[i]);
1467                 }
1468                 if (!tmp_keys) {
1469                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1470                         sqlite_freemem(tmp_vals);
1471                         ast_free(params);
1472                         ast_free(vals);
1473                         return -1;
1474                 }
1475
1476                 if ( tmp_vals2 ) {
1477                         tmp_vals = sqlite_mprintf("%s, '%q'", tmp_vals2, vals[i]);
1478                         sqlite_freemem(tmp_vals2);
1479                 } else {
1480                         tmp_vals = sqlite_mprintf("'%q'", vals[i]);
1481                 }
1482                 if (!tmp_vals) {
1483                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1484                         sqlite_freemem(tmp_keys);
1485                         ast_free(params);
1486                         ast_free(vals);
1487                         return -1;
1488                 }
1489
1490
1491                 tmp_keys2 = tmp_keys;
1492                 tmp_vals2 = tmp_vals;
1493         }
1494
1495         ast_free(params);
1496         ast_free(vals);
1497
1498         if (!(tmp_str = sqlite_mprintf(QUERY, table, tmp_keys, tmp_vals))) {
1499                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1500                 sqlite_freemem(tmp_keys);
1501                 sqlite_freemem(tmp_vals);
1502                 return -1;
1503         }
1504
1505         sqlite_freemem(tmp_keys);
1506         sqlite_freemem(tmp_vals);
1507
1508         ast_debug(1, "SQL query: %s\n", tmp_str);
1509
1510         ast_mutex_lock(&mutex);
1511
1512         RES_CONFIG_SQLITE_BEGIN
1513                 error = sqlite_exec(db, tmp_str, NULL, NULL, &errormsg);
1514         RES_CONFIG_SQLITE_END(error)
1515
1516         if (!error) {
1517                 rows_id = sqlite_last_insert_rowid(db);
1518         } else {
1519                 rows_id = -1;
1520         }
1521
1522         ast_mutex_unlock(&mutex);
1523
1524         sqlite_freemem(tmp_str);
1525
1526         if (error) {
1527                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1528         }
1529         sqlite_freemem(errormsg);
1530
1531         return rows_id;
1532 }
1533
1534 static int realtime_destroy_handler(const char *database, const char *table,
1535         const char *keyfield, const char *entity, va_list ap)
1536 {
1537         char *query, *errormsg = NULL, *tmp_str;
1538         const char **params = NULL, **vals = NULL;
1539         size_t params_count;
1540         int error, rows_num;
1541         size_t i;
1542
1543         if (!table) {
1544                 ast_log(LOG_WARNING, "Table name unspecified\n");
1545                 return -1;
1546         }
1547
1548         params_count = get_params(ap, &params, &vals, 0);
1549
1550 /* \cond DOXYGEN_CAN_PARSE_THIS */
1551 #undef QUERY
1552 #define QUERY "DELETE FROM '%q' WHERE"
1553 /* \endcond */
1554
1555         if (!(query = sqlite_mprintf(QUERY, table))) {
1556                 ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
1557                 ast_free(params);
1558                 ast_free(vals);
1559                 return -1;
1560         }
1561
1562         for (i = 0; i < params_count; i++) {
1563                 tmp_str = sqlite_mprintf("%s %q = '%q' AND", query, params[i], vals[i]);
1564                 sqlite_freemem(query);
1565
1566                 if (!tmp_str) {
1567                         ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1568                         ast_free(params);
1569                         ast_free(vals);
1570                         return -1;
1571                 }
1572
1573                 query = tmp_str;
1574         }
1575
1576         ast_free(params);
1577         ast_free(vals);
1578         if (!(tmp_str = sqlite_mprintf("%s %q = '%q';", query, keyfield, entity))) {
1579                 ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
1580                 sqlite_freemem(query);
1581                 return -1;
1582         }
1583         sqlite_freemem(query);
1584         query = tmp_str;
1585         ast_debug(1, "SQL query: %s\n", query);
1586
1587         ast_mutex_lock(&mutex);
1588
1589         RES_CONFIG_SQLITE_BEGIN
1590                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1591         RES_CONFIG_SQLITE_END(error)
1592
1593         if (!error) {
1594                 rows_num = sqlite_changes(db);
1595         } else {
1596                 rows_num = -1;
1597         }
1598
1599         ast_mutex_unlock(&mutex);
1600
1601         sqlite_freemem(query);
1602
1603         if (error) {
1604                 ast_log(LOG_WARNING, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1605         }
1606         sqlite_freemem(errormsg);
1607
1608         return rows_num;
1609 }
1610
1611 static int realtime_require_handler(const char *unused, const char *tablename, va_list ap)
1612 {
1613         struct sqlite_cache_tables *tbl = find_table(tablename);
1614         struct sqlite_cache_columns *col;
1615         char *elm;
1616         int type, size, res = 0;
1617
1618         if (!tbl) {
1619                 return -1;
1620         }
1621
1622         while ((elm = va_arg(ap, char *))) {
1623                 type = va_arg(ap, require_type);
1624                 size = va_arg(ap, int);
1625                 /* Check if the field matches the criteria */
1626                 AST_RWLIST_TRAVERSE(&tbl->columns, col, list) {
1627                         if (strcmp(col->name, elm) == 0) {
1628                                 /* SQLite only has two types - the 32-bit integer field that
1629                                  * is the key column, and everything else (everything else
1630                                  * being a string).
1631                                  */
1632                                 if (col->isint && !ast_rq_is_int(type)) {
1633                                         ast_log(LOG_WARNING, "Realtime table %s: column '%s' is an integer field, but Asterisk requires that it not be!\n", tablename, col->name);
1634                                         res = -1;
1635                                 }
1636                                 break;
1637                         }
1638                 }
1639                 if (!col) {
1640                         ast_log(LOG_WARNING, "Realtime table %s requires column '%s', but that column does not exist!\n", tablename, elm);
1641                 }
1642         }
1643         AST_RWLIST_UNLOCK(&(tbl->columns));
1644         return res;
1645 }
1646
1647 static int realtime_unload_handler(const char *unused, const char *tablename)
1648 {
1649         struct sqlite_cache_tables *tbl;
1650         AST_RWLIST_WRLOCK(&sqlite_tables);
1651         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&sqlite_tables, tbl, list) {
1652                 if (!strcasecmp(tbl->name, tablename)) {
1653                         AST_RWLIST_REMOVE_CURRENT(list);
1654                         free_table(tbl);
1655                 }
1656         }
1657         AST_RWLIST_TRAVERSE_SAFE_END
1658         AST_RWLIST_UNLOCK(&sqlite_tables);
1659         return 0;
1660 }
1661
1662 static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1663 {
1664         switch (cmd) {
1665         case CLI_INIT:
1666                 e->command = "sqlite show status";
1667                 e->usage =
1668                         "Usage: sqlite show status\n"
1669                         "       Show status information about the SQLite 2 driver\n";
1670                 return NULL;
1671         case CLI_GENERATE:
1672                 return NULL;
1673         }
1674
1675         if (a->argc != 3)
1676                 return CLI_SHOWUSAGE;
1677
1678         ast_cli(a->fd, "SQLite database path: %s\n", dbfile);
1679         ast_cli(a->fd, "config_table: ");
1680
1681         if (!config_table)
1682                 ast_cli(a->fd, "unspecified, must be present in extconfig.conf\n");
1683         else
1684                 ast_cli(a->fd, "%s\n", config_table);
1685
1686         ast_cli(a->fd, "cdr_table: ");
1687
1688         if (!cdr_table)
1689                 ast_cli(a->fd, "unspecified, CDR support disabled\n");
1690         else
1691                 ast_cli(a->fd, "%s\n", cdr_table);
1692
1693         return CLI_SUCCESS;
1694 }
1695
1696 static char *handle_cli_sqlite_show_tables(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1697 {
1698         struct sqlite_cache_tables *tbl;
1699         struct sqlite_cache_columns *col;
1700         int found = 0;
1701
1702         switch (cmd) {
1703         case CLI_INIT:
1704                 e->command = "sqlite show tables";
1705                 e->usage =
1706                         "Usage: sqlite show tables\n"
1707                         "       Show table information about the SQLite 2 driver\n";
1708                 return NULL;
1709         case CLI_GENERATE:
1710                 return NULL;
1711         }
1712
1713         if (a->argc != 3)
1714                 return CLI_SHOWUSAGE;
1715
1716         AST_RWLIST_RDLOCK(&sqlite_tables);
1717         AST_RWLIST_TRAVERSE(&sqlite_tables, tbl, list) {
1718                 found++;
1719                 ast_cli(a->fd, "Table %s:\n", tbl->name);
1720                 AST_RWLIST_TRAVERSE(&(tbl->columns), col, list) {
1721                         fprintf(stderr, "%s\n", col->name);
1722                         ast_cli(a->fd, "  %20.20s  %-30.30s\n", col->name, col->type);
1723                 }
1724         }
1725         AST_RWLIST_UNLOCK(&sqlite_tables);
1726
1727         if (!found) {
1728                 ast_cli(a->fd, "No tables currently in cache\n");
1729         }
1730
1731         return CLI_SUCCESS;
1732 }
1733
1734 static int unload_module(void)
1735 {
1736         if (cli_status_registered)
1737                 ast_cli_unregister_multiple(cli_status, ARRAY_LEN(cli_status));
1738
1739         if (cdr_registered)
1740                 ast_cdr_unregister(RES_CONFIG_SQLITE_NAME);
1741
1742         ast_config_engine_deregister(&sqlite_engine);
1743
1744         if (db)
1745                 sqlite_close(db);
1746
1747         unload_config();
1748
1749         return 0;
1750 }
1751
1752 static int load_module(void)
1753 {
1754         char *errormsg = NULL;
1755         int error;
1756
1757         db = NULL;
1758         cdr_registered = 0;
1759         cli_status_registered = 0;
1760         dbfile = NULL;
1761         config_table = NULL;
1762         cdr_table = NULL;
1763         error = load_config();
1764
1765         if (error)
1766                 return AST_MODULE_LOAD_DECLINE;
1767
1768         if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
1769                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1770                 sqlite_freemem(errormsg);
1771                 unload_module();
1772                 return 1;
1773         }
1774
1775         sqlite_freemem(errormsg);
1776         errormsg = NULL;
1777         ast_config_engine_register(&sqlite_engine);
1778
1779         if (use_cdr) {
1780                 char *query;
1781
1782 /* \cond DOXYGEN_CAN_PARSE_THIS */
1783 #undef QUERY
1784 #define QUERY "SELECT COUNT(id) FROM %Q;"
1785 /* \endcond */
1786
1787                 query = sqlite_mprintf(QUERY, cdr_table);
1788
1789                 if (!query) {
1790                         ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1791                         unload_module();
1792                         return 1;
1793                 }
1794
1795                 ast_debug(1, "SQL query: %s\n", query);
1796
1797                 RES_CONFIG_SQLITE_BEGIN
1798                         error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1799                 RES_CONFIG_SQLITE_END(error)
1800
1801                 sqlite_freemem(query);
1802
1803                 if (error) {
1804                         /*
1805                          * Unexpected error.
1806                          */
1807                         if (error != SQLITE_ERROR) {
1808                                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1809                                 sqlite_freemem(errormsg);
1810                                 unload_module();
1811                                 return 1;
1812                         }
1813
1814                         sqlite_freemem(errormsg);
1815                         errormsg = NULL;
1816                         query = sqlite_mprintf(sql_create_cdr_table, cdr_table);
1817
1818                         if (!query) {
1819                                 ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
1820                                 unload_module();
1821                                 return 1;
1822                         }
1823
1824                         ast_debug(1, "SQL query: %s\n", query);
1825
1826                         RES_CONFIG_SQLITE_BEGIN
1827                                 error = sqlite_exec(db, query, NULL, NULL, &errormsg);
1828                         RES_CONFIG_SQLITE_END(error)
1829
1830                         sqlite_freemem(query);
1831
1832                         if (error) {
1833                                 ast_log(LOG_ERROR, "%s\n", S_OR(errormsg, sqlite_error_string(error)));
1834                                 sqlite_freemem(errormsg);
1835                                 unload_module();
1836                                 return 1;
1837                         }
1838                 }
1839                 sqlite_freemem(errormsg);
1840                 errormsg = NULL;
1841
1842                 error = ast_cdr_register(RES_CONFIG_SQLITE_NAME, RES_CONFIG_SQLITE_DESCRIPTION, cdr_handler);
1843
1844                 if (error) {
1845                         unload_module();
1846                         return 1;
1847                 }
1848
1849                 cdr_registered = 1;
1850         }
1851
1852         error = ast_cli_register_multiple(cli_status, ARRAY_LEN(cli_status));
1853
1854         if (error) {
1855                 unload_module();
1856                 return 1;
1857         }
1858
1859         cli_status_registered = 1;
1860
1861         return 0;
1862 }
1863
1864 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
1865                 .load = load_module,
1866                 .unload = unload_module,
1867 );