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