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