2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2016, Digium, Inc.
6 * Manuel Guesdon <mguesdon@oxymium.net> - PostgreSQL RealTime Driver Author/Adaptor
7 * Mark Spencer <markster@digium.com> - Asterisk Author
8 * Matthew Boehm <mboehm@cytelcom.com> - MySQL RealTime Driver Author
10 * res_config_pgsql.c <PostgreSQL plugin for RealTime configuration engine>
12 * v1.0 - (07-11-05) - Initial version based on res_config_mysql v2.0
17 * \brief PostgreSQL plugin for Asterisk RealTime Architecture
19 * \author Mark Spencer <markster@digium.com>
20 * \author Manuel Guesdon <mguesdon@oxymium.net> - PostgreSQL RealTime Driver Author/Adaptor
22 * PostgreSQL http://www.postgresql.org
26 <depend>pgsql</depend>
27 <support_level>extended</support_level>
32 #include <libpq-fe.h> /* PostgreSQL */
34 #include "asterisk/file.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/config.h"
38 #include "asterisk/module.h"
39 #include "asterisk/lock.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/cli.h"
43 AST_MUTEX_DEFINE_STATIC(pgsql_lock);
44 AST_THREADSTORAGE(sql_buf);
45 AST_THREADSTORAGE(findtable_buf);
46 AST_THREADSTORAGE(where_buf);
47 AST_THREADSTORAGE(escapebuf_buf);
48 AST_THREADSTORAGE(semibuf_buf);
50 #define RES_CONFIG_PGSQL_CONF "res_pgsql.conf"
52 static PGconn *pgsqlConn = NULL;
54 #define has_schema_support (version > 70300 ? 1 : 0)
56 #define MAX_DB_OPTION_SIZE 64
62 unsigned int notnull:1;
63 unsigned int hasdefault:1;
64 AST_LIST_ENTRY(columns) list;
69 AST_LIST_HEAD_NOLOCK(psql_columns, columns) columns;
70 AST_LIST_ENTRY(tables) list;
74 static AST_LIST_HEAD_STATIC(psql_tables, tables);
76 static char dbhost[MAX_DB_OPTION_SIZE] = "";
77 static char dbuser[MAX_DB_OPTION_SIZE] = "";
78 static char dbpass[MAX_DB_OPTION_SIZE] = "";
79 static char dbname[MAX_DB_OPTION_SIZE] = "";
80 static char dbappname[MAX_DB_OPTION_SIZE] = "";
81 static char dbsock[MAX_DB_OPTION_SIZE] = "";
82 static int dbport = 5432;
83 static time_t connect_time = 0;
85 static int parse_config(int reload);
86 static int pgsql_reconnect(const char *database);
87 static char *handle_cli_realtime_pgsql_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
88 static char *handle_cli_realtime_pgsql_cache(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
90 static enum { RQ_WARN, RQ_CREATECLOSE, RQ_CREATECHAR } requirements;
92 static struct ast_cli_entry cli_realtime[] = {
93 AST_CLI_DEFINE(handle_cli_realtime_pgsql_status, "Shows connection information for the PostgreSQL RealTime driver"),
94 AST_CLI_DEFINE(handle_cli_realtime_pgsql_cache, "Shows cached tables within the PostgreSQL realtime driver"),
97 #define ESCAPE_STRING(buffer, stringname) \
99 int len = strlen(stringname); \
100 struct ast_str *semi = ast_str_thread_get(&semibuf_buf, len * 3 + 1); \
101 const char *chunk = stringname; \
102 ast_str_reset(semi); \
103 for (; *chunk; chunk++) { \
104 if (strchr(";^", *chunk)) { \
105 ast_str_append(&semi, 0, "^%02hhX", *chunk); \
107 ast_str_append(&semi, 0, "%c", *chunk); \
110 if (ast_str_strlen(semi) > (ast_str_size(buffer) - 1) / 2) { \
111 ast_str_make_space(&buffer, ast_str_strlen(semi) * 2 + 1); \
113 PQescapeStringConn(pgsqlConn, ast_str_buffer(buffer), ast_str_buffer(semi), ast_str_size(buffer), &pgresult); \
116 static void destroy_table(struct tables *table)
118 struct columns *column;
119 ast_rwlock_wrlock(&table->lock);
120 while ((column = AST_LIST_REMOVE_HEAD(&table->columns, list))) {
123 ast_rwlock_unlock(&table->lock);
124 ast_rwlock_destroy(&table->lock);
128 /*! \brief Helper function for pgsql_exec. For running querys, use pgsql_exec()
130 * Connect if not currently connected. Run the given query.
132 * \param database database name we are connected to (used for error logging)
133 * \param tablename table name we are connected to (used for error logging)
134 * \param sql sql query string to execute
135 * \param result pointer for where to store the result handle
137 * \return -1 on fatal query error
138 * \return -2 on query failure that resulted in disconnection
139 * \return 0 on success
141 * \note see pgsql_exec for full example
143 static int _pgsql_exec(const char *database, const char *tablename, const char *sql, PGresult **result)
145 ExecStatusType result_status;
148 ast_debug(1, "PostgreSQL connection not defined, connecting\n");
150 if (pgsql_reconnect(database) != 1) {
151 ast_log(LOG_NOTICE, "reconnect failed\n");
156 ast_debug(1, "PostgreSQL connection successful\n");
159 *result = PQexec(pgsqlConn, sql);
160 result_status = PQresultStatus(*result);
161 if (result_status != PGRES_COMMAND_OK
162 && result_status != PGRES_TUPLES_OK
163 && result_status != PGRES_NONFATAL_ERROR) {
165 ast_log(LOG_ERROR, "PostgreSQL RealTime: Failed to query '%s@%s'.\n", tablename, database);
166 ast_log(LOG_ERROR, "PostgreSQL RealTime: Query Failed: %s\n", sql);
167 ast_log(LOG_ERROR, "PostgreSQL RealTime: Query Failed because: %s (%s)\n",
168 PQresultErrorMessage(*result),
169 PQresStatus(result_status));
171 /* we may have tried to run a command on a disconnected/disconnecting handle */
172 /* are we no longer connected to the database... if not try again */
173 if (PQstatus(pgsqlConn) != CONNECTION_OK) {
179 /* connection still okay, which means the query is just plain bad */
183 ast_debug(1, "PostgreSQL query successful: %s\n", sql);
187 /*! \brief Do a postgres query, with reconnection support
189 * Connect if not currently connected. Run the given query
190 * and if we're disconnected afterwards, reconnect and query again.
192 * \param database database name we are connected to (used for error logging)
193 * \param tablename table name we are connected to (used for error logging)
194 * \param sql sql query string to execute
195 * \param result pointer for where to store the result handle
197 * \return -1 on query failure
198 * \return 0 on success
203 * char *field_name, *field_type, *field_len, *field_notnull, *field_default;
205 * pgsql_exec("db", "table", "SELECT 1", &result)
207 * rows = PQntuples(result);
208 * for (i = 0; i < rows; i++) {
209 * field_name = PQgetvalue(result, i, 0);
210 * field_type = PQgetvalue(result, i, 1);
211 * field_len = PQgetvalue(result, i, 2);
212 * field_notnull = PQgetvalue(result, i, 3);
213 * field_default = PQgetvalue(result, i, 4);
217 static int pgsql_exec(const char *database, const char *tablename, const char *sql, PGresult **result)
222 /* Try the query, note failure if any */
223 /* On first failure, reconnect and try again (_pgsql_exec handles reconnect) */
224 /* On second failure, treat as fatal query error */
226 while (attempts++ < 2) {
227 ast_debug(1, "PostgreSQL query attempt %d\n", attempts);
228 res = _pgsql_exec(database, tablename, sql, result);
232 ast_log(LOG_NOTICE, "PostgreSQL RealTime: Query finally succeeded: %s\n", sql);
239 return -1; /* Still connected to db, but could not process query (fatal error) */
242 /* res == -2 (query on a disconnected handle) */
243 ast_debug(1, "PostgreSQL query attempt %d failed, trying again\n", attempts);
249 static struct tables *find_table(const char *database, const char *orig_tablename)
251 struct columns *column;
252 struct tables *table;
253 struct ast_str *sql = ast_str_thread_get(&findtable_buf, 330);
254 RAII_VAR(PGresult *, result, NULL, PQclear);
256 char *fname, *ftype, *flen, *fnotnull, *fdef;
259 AST_LIST_LOCK(&psql_tables);
260 AST_LIST_TRAVERSE(&psql_tables, table, list) {
261 if (!strcasecmp(table->name, orig_tablename)) {
262 ast_debug(1, "Found table in cache; now locking\n");
263 ast_rwlock_rdlock(&table->lock);
264 ast_debug(1, "Lock cached table; now returning\n");
265 AST_LIST_UNLOCK(&psql_tables);
270 if (database == NULL) {
271 AST_LIST_UNLOCK(&psql_tables);
275 ast_debug(1, "Table '%s' not found in cache, querying now\n", orig_tablename);
277 /* Not found, scan the table */
278 if (has_schema_support) {
279 char *schemaname, *tablename, *tmp_schemaname, *tmp_tablename;
280 if (strchr(orig_tablename, '.')) {
281 tmp_schemaname = ast_strdupa(orig_tablename);
282 tmp_tablename = strchr(tmp_schemaname, '.');
283 *tmp_tablename++ = '\0';
286 tmp_tablename = ast_strdupa(orig_tablename);
289 tablename = ast_alloca(strlen(tmp_tablename) * 2 + 1);
290 PQescapeStringConn(pgsqlConn, tablename, tmp_tablename, strlen(tmp_tablename), NULL);
291 schemaname = ast_alloca(strlen(tmp_schemaname) * 2 + 1);
292 PQescapeStringConn(pgsqlConn, schemaname, tmp_schemaname, strlen(tmp_schemaname), NULL);
294 ast_str_set(&sql, 0, "SELECT a.attname, t.typname, a.attlen, a.attnotnull, d.adsrc, a.atttypmod FROM (((pg_catalog.pg_class c INNER JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace AND c.relname = '%s' AND n.nspname = %s%s%s) INNER JOIN pg_catalog.pg_attribute a ON (NOT a.attisdropped) AND a.attnum > 0 AND a.attrelid = c.oid) INNER JOIN pg_catalog.pg_type t ON t.oid = a.atttypid) LEFT OUTER JOIN pg_attrdef d ON a.atthasdef AND d.adrelid = a.attrelid AND d.adnum = a.attnum ORDER BY n.nspname, c.relname, attnum",
296 ast_strlen_zero(schemaname) ? "" : "'", ast_strlen_zero(schemaname) ? "current_schema()" : schemaname, ast_strlen_zero(schemaname) ? "" : "'");
299 tablename = ast_alloca(strlen(orig_tablename) * 2 + 1);
300 PQescapeStringConn(pgsqlConn, tablename, orig_tablename, strlen(orig_tablename), NULL);
302 ast_str_set(&sql, 0, "SELECT a.attname, t.typname, a.attlen, a.attnotnull, d.adsrc, a.atttypmod FROM pg_class c, pg_type t, pg_attribute a LEFT OUTER JOIN pg_attrdef d ON a.atthasdef AND d.adrelid = a.attrelid AND d.adnum = a.attnum WHERE c.oid = a.attrelid AND a.atttypid = t.oid AND (a.attnum > 0) AND c.relname = '%s' ORDER BY c.relname, attnum", tablename);
305 ast_mutex_lock(&pgsql_lock);
306 exec_result = pgsql_exec(database, orig_tablename, ast_str_buffer(sql), &result);
307 ast_mutex_unlock(&pgsql_lock);
308 ast_debug(1, "Query of table structure complete. Now retrieving results.\n");
309 if (exec_result != 0) {
310 ast_log(LOG_ERROR, "Failed to query database columns for table %s\n", orig_tablename);
311 AST_LIST_UNLOCK(&psql_tables);
315 if (!(table = ast_calloc(1, sizeof(*table) + strlen(orig_tablename) + 1))) {
316 ast_log(LOG_ERROR, "Unable to allocate memory for new table structure\n");
317 AST_LIST_UNLOCK(&psql_tables);
320 strcpy(table->name, orig_tablename); /* SAFE */
321 ast_rwlock_init(&table->lock);
322 AST_LIST_HEAD_INIT_NOLOCK(&table->columns);
324 rows = PQntuples(result);
325 for (i = 0; i < rows; i++) {
326 fname = PQgetvalue(result, i, 0);
327 ftype = PQgetvalue(result, i, 1);
328 flen = PQgetvalue(result, i, 2);
329 fnotnull = PQgetvalue(result, i, 3);
330 fdef = PQgetvalue(result, i, 4);
331 ast_verb(4, "Found column '%s' of type '%s'\n", fname, ftype);
333 if (!(column = ast_calloc(1, sizeof(*column) + strlen(fname) + strlen(ftype) + 2))) {
334 ast_log(LOG_ERROR, "Unable to allocate column element for %s, %s\n", orig_tablename, fname);
335 destroy_table(table);
336 AST_LIST_UNLOCK(&psql_tables);
340 if (strcmp(flen, "-1") == 0) {
341 /* Some types, like chars, have the length stored in a different field */
342 flen = PQgetvalue(result, i, 5);
343 sscanf(flen, "%30d", &column->len);
346 sscanf(flen, "%30d", &column->len);
348 column->name = (char *)column + sizeof(*column);
349 column->type = (char *)column + sizeof(*column) + strlen(fname) + 1;
350 strcpy(column->name, fname);
351 strcpy(column->type, ftype);
352 if (*fnotnull == 't') {
357 if (!ast_strlen_zero(fdef)) {
358 column->hasdefault = 1;
360 column->hasdefault = 0;
362 AST_LIST_INSERT_TAIL(&table->columns, column, list);
365 AST_LIST_INSERT_TAIL(&psql_tables, table, list);
366 ast_rwlock_rdlock(&table->lock);
367 AST_LIST_UNLOCK(&psql_tables);
371 #define release_table(table) ast_rwlock_unlock(&(table)->lock);
373 static struct columns *find_column(struct tables *t, const char *colname)
375 struct columns *column;
377 /* Check that the column exists in the table */
378 AST_LIST_TRAVERSE(&t->columns, column, list) {
379 if (strcmp(column->name, colname) == 0) {
386 #define IS_SQL_LIKE_CLAUSE(x) ((x) && ast_ends_with(x, " LIKE"))
387 static char *ESCAPE_CLAUSE = " ESCAPE '\\'";
389 static struct ast_variable *realtime_pgsql(const char *database, const char *tablename, const struct ast_variable *fields)
391 RAII_VAR(PGresult *, result, NULL, PQclear);
392 int num_rows = 0, pgresult;
393 struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
394 struct ast_str *escapebuf = ast_str_thread_get(&escapebuf_buf, 100);
399 const struct ast_variable *field = fields;
400 struct ast_variable *var = NULL, *prev = NULL;
403 * Ignore database from the extconfig.conf since it was
404 * configured by res_pgsql.conf.
409 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
414 * Must connect to the server before anything else as ESCAPE_STRING()
417 ast_mutex_lock(&pgsql_lock);
418 if (!pgsql_reconnect(database)) {
419 ast_mutex_unlock(&pgsql_lock);
423 /* Get the first parameter and first value in our list of passed paramater/value pairs */
426 "PostgreSQL RealTime: Realtime retrieval requires at least 1 parameter and 1 value to search on.\n");
431 ast_mutex_unlock(&pgsql_lock);
435 /* Create the first part of the query using the first parameter/value pairs we just extracted
436 If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
437 if (!strchr(field->name, ' ')) {
441 if (IS_SQL_LIKE_CLAUSE(field->name)) {
442 escape = ESCAPE_CLAUSE;
446 ESCAPE_STRING(escapebuf, field->value);
448 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
449 ast_mutex_unlock(&pgsql_lock);
453 ast_str_set(&sql, 0, "SELECT * FROM %s WHERE %s%s '%s'%s", tablename, field->name, op, ast_str_buffer(escapebuf), escape);
454 while ((field = field->next)) {
456 if (!strchr(field->name, ' ')) {
460 if (IS_SQL_LIKE_CLAUSE(field->name)) {
461 escape = ESCAPE_CLAUSE;
465 ESCAPE_STRING(escapebuf, field->value);
467 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
468 ast_mutex_unlock(&pgsql_lock);
472 ast_str_append(&sql, 0, " AND %s%s '%s'%s", field->name, op, ast_str_buffer(escapebuf), escape);
475 /* We now have our complete statement; Lets connect to the server and execute it. */
476 if (pgsql_exec(database, tablename, ast_str_buffer(sql), &result) != 0) {
477 ast_mutex_unlock(&pgsql_lock);
481 ast_debug(1, "PostgreSQL RealTime: Result=%p Query: %s\n", result, ast_str_buffer(sql));
483 if ((num_rows = PQntuples(result)) > 0) {
486 int numFields = PQnfields(result);
487 char **fieldnames = NULL;
489 ast_debug(1, "PostgreSQL RealTime: Found %d rows.\n", num_rows);
491 if (!(fieldnames = ast_calloc(1, numFields * sizeof(char *)))) {
492 ast_mutex_unlock(&pgsql_lock);
495 for (i = 0; i < numFields; i++)
496 fieldnames[i] = PQfname(result, i);
497 for (rowIndex = 0; rowIndex < num_rows; rowIndex++) {
498 for (i = 0; i < numFields; i++) {
499 stringp = PQgetvalue(result, rowIndex, i);
501 chunk = strsep(&stringp, ";");
502 if (chunk && !ast_strlen_zero(ast_realtime_decode_chunk(ast_strip(chunk)))) {
504 prev->next = ast_variable_new(fieldnames[i], chunk, "");
509 prev = var = ast_variable_new(fieldnames[i], chunk, "");
515 ast_free(fieldnames);
517 ast_debug(1, "Postgresql RealTime: Could not find any rows in table %s@%s.\n", tablename, database);
520 ast_mutex_unlock(&pgsql_lock);
525 static struct ast_config *realtime_multi_pgsql(const char *database, const char *table, const struct ast_variable *fields)
527 RAII_VAR(PGresult *, result, NULL, PQclear);
528 int num_rows = 0, pgresult;
529 struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
530 struct ast_str *escapebuf = ast_str_thread_get(&escapebuf_buf, 100);
531 const struct ast_variable *field = fields;
532 const char *initfield = NULL;
537 struct ast_variable *var = NULL;
538 struct ast_config *cfg = NULL;
539 struct ast_category *cat = NULL;
542 * Ignore database from the extconfig.conf since it was
543 * configured by res_pgsql.conf.
548 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
552 if (!(cfg = ast_config_new()))
556 * Must connect to the server before anything else as ESCAPE_STRING()
559 ast_mutex_lock(&pgsql_lock);
560 if (!pgsql_reconnect(database)) {
561 ast_mutex_unlock(&pgsql_lock);
565 /* Get the first parameter and first value in our list of passed paramater/value pairs */
568 "PostgreSQL RealTime: Realtime retrieval requires at least 1 parameter and 1 value to search on.\n");
573 ast_mutex_unlock(&pgsql_lock);
574 ast_config_destroy(cfg);
578 initfield = ast_strdupa(field->name);
579 if ((op = strchr(initfield, ' '))) {
583 /* Create the first part of the query using the first parameter/value pairs we just extracted
584 If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
586 if (!strchr(field->name, ' ')) {
591 if (IS_SQL_LIKE_CLAUSE(field->name)) {
592 escape = ESCAPE_CLAUSE;
596 ESCAPE_STRING(escapebuf, field->value);
598 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
599 ast_mutex_unlock(&pgsql_lock);
600 ast_config_destroy(cfg);
604 ast_str_set(&sql, 0, "SELECT * FROM %s WHERE %s%s '%s'%s", table, field->name, op, ast_str_buffer(escapebuf), escape);
605 while ((field = field->next)) {
607 if (!strchr(field->name, ' ')) {
612 if (IS_SQL_LIKE_CLAUSE(field->name)) {
613 escape = ESCAPE_CLAUSE;
617 ESCAPE_STRING(escapebuf, field->value);
619 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
620 ast_mutex_unlock(&pgsql_lock);
621 ast_config_destroy(cfg);
625 ast_str_append(&sql, 0, " AND %s%s '%s'%s", field->name, op, ast_str_buffer(escapebuf), escape);
629 ast_str_append(&sql, 0, " ORDER BY %s", initfield);
632 /* We now have our complete statement; Lets connect to the server and execute it. */
633 if (pgsql_exec(database, table, ast_str_buffer(sql), &result) != 0) {
634 ast_mutex_unlock(&pgsql_lock);
635 ast_config_destroy(cfg);
638 ExecStatusType result_status = PQresultStatus(result);
639 if (result_status != PGRES_COMMAND_OK
640 && result_status != PGRES_TUPLES_OK
641 && result_status != PGRES_NONFATAL_ERROR) {
643 "PostgreSQL RealTime: Failed to query %s@%s. Check debug for more info.\n", table, database);
644 ast_debug(1, "PostgreSQL RealTime: Query: %s\n", ast_str_buffer(sql));
645 ast_debug(1, "PostgreSQL RealTime: Query Failed because: %s (%s)\n",
646 PQresultErrorMessage(result), PQresStatus(result_status));
647 ast_mutex_unlock(&pgsql_lock);
648 ast_config_destroy(cfg);
653 ast_debug(1, "PostgreSQL RealTime: Result=%p Query: %s\n", result, ast_str_buffer(sql));
655 if ((num_rows = PQntuples(result)) > 0) {
656 int numFields = PQnfields(result);
659 char **fieldnames = NULL;
661 ast_debug(1, "PostgreSQL RealTime: Found %d rows.\n", num_rows);
663 if (!(fieldnames = ast_calloc(1, numFields * sizeof(char *)))) {
664 ast_mutex_unlock(&pgsql_lock);
665 ast_config_destroy(cfg);
668 for (i = 0; i < numFields; i++)
669 fieldnames[i] = PQfname(result, i);
671 for (rowIndex = 0; rowIndex < num_rows; rowIndex++) {
673 cat = ast_category_new_anonymous();
677 for (i = 0; i < numFields; i++) {
678 stringp = PQgetvalue(result, rowIndex, i);
680 chunk = strsep(&stringp, ";");
681 if (chunk && !ast_strlen_zero(ast_realtime_decode_chunk(ast_strip(chunk)))) {
682 if (initfield && !strcmp(initfield, fieldnames[i])) {
683 ast_category_rename(cat, chunk);
685 var = ast_variable_new(fieldnames[i], chunk, "");
686 ast_variable_append(cat, var);
690 ast_category_append(cfg, cat);
692 ast_free(fieldnames);
694 ast_debug(1, "PostgreSQL RealTime: Could not find any rows in table %s.\n", table);
697 ast_mutex_unlock(&pgsql_lock);
702 static int update_pgsql(const char *database, const char *tablename, const char *keyfield,
703 const char *lookup, const struct ast_variable *fields)
705 RAII_VAR(PGresult *, result, NULL, PQclear);
706 int numrows = 0, pgresult;
707 const struct ast_variable *field = fields;
708 struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
709 struct ast_str *escapebuf = ast_str_thread_get(&escapebuf_buf, 100);
710 struct tables *table;
711 struct columns *column = NULL;
714 * Ignore database from the extconfig.conf since it was
715 * configured by res_pgsql.conf.
720 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
724 if (!(table = find_table(database, tablename))) {
725 ast_log(LOG_ERROR, "Table '%s' does not exist!!\n", tablename);
730 * Must connect to the server before anything else as ESCAPE_STRING()
733 ast_mutex_lock(&pgsql_lock);
734 if (!pgsql_reconnect(database)) {
735 ast_mutex_unlock(&pgsql_lock);
736 release_table(table);
740 /* Get the first parameter and first value in our list of passed paramater/value pairs */
743 "PostgreSQL RealTime: Realtime retrieval requires at least 1 parameter and 1 value to search on.\n");
748 ast_mutex_unlock(&pgsql_lock);
749 release_table(table);
753 /* Check that the column exists in the table */
754 AST_LIST_TRAVERSE(&table->columns, column, list) {
755 if (strcmp(column->name, field->name) == 0) {
761 ast_log(LOG_ERROR, "PostgreSQL RealTime: Updating on column '%s', but that column does not exist within the table '%s'!\n", field->name, tablename);
762 ast_mutex_unlock(&pgsql_lock);
763 release_table(table);
767 /* Create the first part of the query using the first parameter/value pairs we just extracted
768 If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
770 ESCAPE_STRING(escapebuf, field->value);
772 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
773 ast_mutex_unlock(&pgsql_lock);
774 release_table(table);
777 ast_str_set(&sql, 0, "UPDATE %s SET %s = '%s'", tablename, field->name, ast_str_buffer(escapebuf));
779 while ((field = field->next)) {
780 if (!find_column(table, field->name)) {
781 ast_log(LOG_NOTICE, "Attempted to update column '%s' in table '%s', but column does not exist!\n", field->name, tablename);
785 ESCAPE_STRING(escapebuf, field->value);
787 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
788 ast_mutex_unlock(&pgsql_lock);
789 release_table(table);
793 ast_str_append(&sql, 0, ", %s = '%s'", field->name, ast_str_buffer(escapebuf));
795 release_table(table);
797 ESCAPE_STRING(escapebuf, lookup);
799 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", lookup);
800 ast_mutex_unlock(&pgsql_lock);
804 ast_str_append(&sql, 0, " WHERE %s = '%s'", keyfield, ast_str_buffer(escapebuf));
806 ast_debug(1, "PostgreSQL RealTime: Update SQL: %s\n", ast_str_buffer(sql));
808 /* We now have our complete statement; Lets connect to the server and execute it. */
809 if (pgsql_exec(database, tablename, ast_str_buffer(sql), &result) != 0) {
810 ast_mutex_unlock(&pgsql_lock);
813 ExecStatusType result_status = PQresultStatus(result);
814 if (result_status != PGRES_COMMAND_OK
815 && result_status != PGRES_TUPLES_OK
816 && result_status != PGRES_NONFATAL_ERROR) {
818 "PostgreSQL RealTime: Failed to query database. Check debug for more info.\n");
819 ast_debug(1, "PostgreSQL RealTime: Query: %s\n", ast_str_buffer(sql));
820 ast_debug(1, "PostgreSQL RealTime: Query Failed because: %s (%s)\n",
821 PQresultErrorMessage(result), PQresStatus(result_status));
822 ast_mutex_unlock(&pgsql_lock);
827 numrows = atoi(PQcmdTuples(result));
828 ast_mutex_unlock(&pgsql_lock);
830 ast_debug(1, "PostgreSQL RealTime: Updated %d rows on table: %s\n", numrows, tablename);
832 /* From http://dev.pgsql.com/doc/pgsql/en/pgsql-affected-rows.html
833 * An integer greater than zero indicates the number of rows affected
834 * Zero indicates that no records were updated
835 * -1 indicates that the query returned an error (although, if the query failed, it should have been caught above.)
839 return (int) numrows;
844 static int update2_pgsql(const char *database, const char *tablename, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields)
846 RAII_VAR(PGresult *, result, NULL, PQclear);
847 int numrows = 0, pgresult, first = 1;
848 struct ast_str *escapebuf = ast_str_thread_get(&escapebuf_buf, 16);
849 const struct ast_variable *field;
850 struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
851 struct ast_str *where = ast_str_thread_get(&where_buf, 100);
852 struct tables *table;
855 * Ignore database from the extconfig.conf since it was
856 * configured by res_pgsql.conf.
861 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
865 if (!escapebuf || !sql || !where) {
866 /* Memory error, already handled */
870 if (!(table = find_table(database, tablename))) {
871 ast_log(LOG_ERROR, "Table '%s' does not exist!!\n", tablename);
876 * Must connect to the server before anything else as ESCAPE_STRING()
879 ast_mutex_lock(&pgsql_lock);
880 if (!pgsql_reconnect(database)) {
881 ast_mutex_unlock(&pgsql_lock);
882 release_table(table);
886 ast_str_set(&sql, 0, "UPDATE %s SET", tablename);
887 ast_str_set(&where, 0, " WHERE");
889 for (field = lookup_fields; field; field = field->next) {
890 if (!find_column(table, field->name)) {
891 ast_log(LOG_ERROR, "Attempted to update based on criteria column '%s' (%s@%s), but that column does not exist!\n", field->name, tablename, database);
892 ast_mutex_unlock(&pgsql_lock);
893 release_table(table);
897 ESCAPE_STRING(escapebuf, field->value);
899 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
900 ast_mutex_unlock(&pgsql_lock);
901 release_table(table);
904 ast_str_append(&where, 0, "%s %s='%s'", first ? "" : " AND", field->name, ast_str_buffer(escapebuf));
910 "PostgreSQL RealTime: Realtime update requires at least 1 parameter and 1 value to search on.\n");
915 ast_mutex_unlock(&pgsql_lock);
916 release_table(table);
920 /* Now retrieve the columns to update */
922 for (field = update_fields; field; field = field->next) {
923 /* If the column is not within the table, then skip it */
924 if (!find_column(table, field->name)) {
925 ast_log(LOG_NOTICE, "Attempted to update column '%s' in table '%s@%s', but column does not exist!\n", field->name, tablename, database);
929 ESCAPE_STRING(escapebuf, field->value);
931 ast_log(LOG_ERROR, "PostgreSQL RealTime: detected invalid input: '%s'\n", field->value);
932 ast_mutex_unlock(&pgsql_lock);
933 release_table(table);
937 ast_str_append(&sql, 0, "%s %s='%s'", first ? "" : ",", field->name, ast_str_buffer(escapebuf));
940 release_table(table);
942 ast_str_append(&sql, 0, "%s", ast_str_buffer(where));
944 ast_debug(1, "PostgreSQL RealTime: Update SQL: %s\n", ast_str_buffer(sql));
946 /* We now have our complete statement; Lets connect to the server and execute it. */
947 if (pgsql_exec(database, tablename, ast_str_buffer(sql), &result) != 0) {
948 ast_mutex_unlock(&pgsql_lock);
952 numrows = atoi(PQcmdTuples(result));
953 ast_mutex_unlock(&pgsql_lock);
955 ast_debug(1, "PostgreSQL RealTime: Updated %d rows on table: %s\n", numrows, tablename);
957 /* From http://dev.pgsql.com/doc/pgsql/en/pgsql-affected-rows.html
958 * An integer greater than zero indicates the number of rows affected
959 * Zero indicates that no records were updated
960 * -1 indicates that the query returned an error (although, if the query failed, it should have been caught above.)
964 return (int) numrows;
970 static int store_pgsql(const char *database, const char *table, const struct ast_variable *fields)
972 RAII_VAR(PGresult *, result, NULL, PQclear);
974 struct ast_str *buf = ast_str_thread_get(&escapebuf_buf, 256);
975 struct ast_str *sql1 = ast_str_thread_get(&sql_buf, 256);
976 struct ast_str *sql2 = ast_str_thread_get(&where_buf, 256);
978 const struct ast_variable *field = fields;
981 * Ignore database from the extconfig.conf since it was
982 * configured by res_pgsql.conf.
987 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
992 * Must connect to the server before anything else as ESCAPE_STRING()
995 ast_mutex_lock(&pgsql_lock);
996 if (!pgsql_reconnect(database)) {
997 ast_mutex_unlock(&pgsql_lock);
1001 /* Get the first parameter and first value in our list of passed paramater/value pairs */
1003 ast_log(LOG_WARNING,
1004 "PostgreSQL RealTime: Realtime storage requires at least 1 parameter and 1 value to store.\n");
1006 PQfinish(pgsqlConn);
1009 ast_mutex_unlock(&pgsql_lock);
1013 /* Create the first part of the query using the first parameter/value pairs we just extracted
1014 If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
1015 ESCAPE_STRING(buf, field->name);
1016 ast_str_set(&sql1, 0, "INSERT INTO %s (%s", table, ast_str_buffer(buf));
1017 ESCAPE_STRING(buf, field->value);
1018 ast_str_set(&sql2, 0, ") VALUES ('%s'", ast_str_buffer(buf));
1019 while ((field = field->next)) {
1020 ESCAPE_STRING(buf, field->name);
1021 ast_str_append(&sql1, 0, ", %s", ast_str_buffer(buf));
1022 ESCAPE_STRING(buf, field->value);
1023 ast_str_append(&sql2, 0, ", '%s'", ast_str_buffer(buf));
1025 ast_str_append(&sql1, 0, "%s)", ast_str_buffer(sql2));
1027 ast_debug(1, "PostgreSQL RealTime: Insert SQL: %s\n", ast_str_buffer(sql1));
1029 /* We now have our complete statement; Lets connect to the server and execute it. */
1030 if (pgsql_exec(database, table, ast_str_buffer(sql1), &result) != 0) {
1031 ast_mutex_unlock(&pgsql_lock);
1035 numrows = atoi(PQcmdTuples(result));
1036 ast_mutex_unlock(&pgsql_lock);
1038 ast_debug(1, "PostgreSQL RealTime: row inserted on table: %s.", table);
1040 /* From http://dev.pgsql.com/doc/pgsql/en/pgsql-affected-rows.html
1041 * An integer greater than zero indicates the number of rows affected
1042 * Zero indicates that no records were updated
1043 * -1 indicates that the query returned an error (although, if the query failed, it should have been caught above.)
1053 static int destroy_pgsql(const char *database, const char *table, const char *keyfield, const char *lookup, const struct ast_variable *fields)
1055 RAII_VAR(PGresult *, result, NULL, PQclear);
1058 struct ast_str *sql = ast_str_thread_get(&sql_buf, 256);
1059 struct ast_str *buf1 = ast_str_thread_get(&where_buf, 60), *buf2 = ast_str_thread_get(&escapebuf_buf, 60);
1060 const struct ast_variable *field;
1063 * Ignore database from the extconfig.conf since it was
1064 * configured by res_pgsql.conf.
1069 ast_log(LOG_WARNING, "PostgreSQL RealTime: No table specified.\n");
1074 * Must connect to the server before anything else as ESCAPE_STRING()
1077 ast_mutex_lock(&pgsql_lock);
1078 if (!pgsql_reconnect(database)) {
1079 ast_mutex_unlock(&pgsql_lock);
1083 /* Get the first parameter and first value in our list of passed paramater/value pairs */
1084 if (ast_strlen_zero(keyfield) || ast_strlen_zero(lookup)) {
1085 ast_log(LOG_WARNING,
1086 "PostgreSQL RealTime: Realtime destroy requires at least 1 parameter and 1 value to search on.\n");
1088 PQfinish(pgsqlConn);
1091 ast_mutex_unlock(&pgsql_lock);
1095 /* Create the first part of the query using the first parameter/value pairs we just extracted
1096 If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
1098 ESCAPE_STRING(buf1, keyfield);
1099 ESCAPE_STRING(buf2, lookup);
1100 ast_str_set(&sql, 0, "DELETE FROM %s WHERE %s = '%s'", table, ast_str_buffer(buf1), ast_str_buffer(buf2));
1101 for (field = fields; field; field = field->next) {
1102 ESCAPE_STRING(buf1, field->name);
1103 ESCAPE_STRING(buf2, field->value);
1104 ast_str_append(&sql, 0, " AND %s = '%s'", ast_str_buffer(buf1), ast_str_buffer(buf2));
1107 ast_debug(1, "PostgreSQL RealTime: Delete SQL: %s\n", ast_str_buffer(sql));
1109 /* We now have our complete statement; Lets connect to the server and execute it. */
1110 if (pgsql_exec(database, table, ast_str_buffer(sql), &result) != 0) {
1111 ast_mutex_unlock(&pgsql_lock);
1115 numrows = atoi(PQcmdTuples(result));
1116 ast_mutex_unlock(&pgsql_lock);
1118 ast_debug(1, "PostgreSQL RealTime: Deleted %d rows on table: %s\n", numrows, table);
1120 /* From http://dev.pgsql.com/doc/pgsql/en/pgsql-affected-rows.html
1121 * An integer greater than zero indicates the number of rows affected
1122 * Zero indicates that no records were updated
1123 * -1 indicates that the query returned an error (although, if the query failed, it should have been caught above.)
1127 return (int) numrows;
1133 static struct ast_config *config_pgsql(const char *database, const char *table,
1134 const char *file, struct ast_config *cfg,
1135 struct ast_flags flags, const char *suggested_incl, const char *who_asked)
1137 RAII_VAR(PGresult *, result, NULL, PQclear);
1139 struct ast_variable *new_v;
1140 struct ast_category *cur_cat = NULL;
1141 struct ast_str *sql = ast_str_thread_get(&sql_buf, 100);
1143 int last_cat_metric = 0;
1148 * Ignore database from the extconfig.conf since it is
1149 * configured by res_pgsql.conf.
1153 if (!file || !strcmp(file, RES_CONFIG_PGSQL_CONF)) {
1154 ast_log(LOG_WARNING, "PostgreSQL RealTime: Cannot configure myself.\n");
1158 ast_str_set(&sql, 0, "SELECT category, var_name, var_val, cat_metric FROM %s "
1159 "WHERE filename='%s' and commented=0 "
1160 "ORDER BY cat_metric DESC, var_metric ASC, category, var_name ", table, file);
1162 ast_debug(1, "PostgreSQL RealTime: Static SQL: %s\n", ast_str_buffer(sql));
1164 ast_mutex_lock(&pgsql_lock);
1166 /* We now have our complete statement; Lets connect to the server and execute it. */
1167 if (pgsql_exec(database, table, ast_str_buffer(sql), &result) != 0) {
1168 ast_mutex_unlock(&pgsql_lock);
1172 if ((num_rows = PQntuples(result)) > 0) {
1175 ast_debug(1, "PostgreSQL RealTime: Found %ld rows.\n", num_rows);
1177 for (rowIndex = 0; rowIndex < num_rows; rowIndex++) {
1178 char *field_category = PQgetvalue(result, rowIndex, 0);
1179 char *field_var_name = PQgetvalue(result, rowIndex, 1);
1180 char *field_var_val = PQgetvalue(result, rowIndex, 2);
1181 char *field_cat_metric = PQgetvalue(result, rowIndex, 3);
1182 if (!strcmp(field_var_name, "#include")) {
1183 if (!ast_config_internal_load(field_var_val, cfg, flags, "", who_asked)) {
1184 ast_mutex_unlock(&pgsql_lock);
1190 if (strcmp(last, field_category) || last_cat_metric != atoi(field_cat_metric)) {
1191 cur_cat = ast_category_new_dynamic(field_category);
1195 ast_copy_string(last, field_category, sizeof(last));
1196 last_cat_metric = atoi(field_cat_metric);
1197 ast_category_append(cfg, cur_cat);
1199 new_v = ast_variable_new(field_var_name, field_var_val, "");
1200 ast_variable_append(cur_cat, new_v);
1203 ast_log(LOG_WARNING,
1204 "PostgreSQL RealTime: Could not find config '%s' in database.\n", file);
1207 ast_mutex_unlock(&pgsql_lock);
1212 static int require_pgsql(const char *database, const char *tablename, va_list ap)
1214 struct columns *column;
1215 struct tables *table;
1217 int type, size, res = 0;
1220 * Ignore database from the extconfig.conf since it was
1221 * configured by res_pgsql.conf.
1225 table = find_table(database, tablename);
1227 ast_log(LOG_WARNING, "Table %s not found in database. This table should exist if you're using realtime.\n", tablename);
1231 while ((elm = va_arg(ap, char *))) {
1232 type = va_arg(ap, require_type);
1233 size = va_arg(ap, int);
1234 AST_LIST_TRAVERSE(&table->columns, column, list) {
1235 if (strcmp(column->name, elm) == 0) {
1236 /* Char can hold anything, as long as it is large enough */
1237 if ((strncmp(column->type, "char", 4) == 0 || strncmp(column->type, "varchar", 7) == 0 || strcmp(column->type, "bpchar") == 0)) {
1238 if ((size > column->len) && column->len != -1) {
1239 ast_log(LOG_WARNING, "Column '%s' should be at least %d long, but is only %d long.\n", column->name, size, column->len);
1242 } else if (strncmp(column->type, "int", 3) == 0) {
1243 int typesize = atoi(column->type + 3);
1244 /* Integers can hold only other integers */
1245 if ((type == RQ_INTEGER8 || type == RQ_UINTEGER8 ||
1246 type == RQ_INTEGER4 || type == RQ_UINTEGER4 ||
1247 type == RQ_INTEGER3 || type == RQ_UINTEGER3 ||
1248 type == RQ_UINTEGER2) && typesize == 2) {
1249 ast_log(LOG_WARNING, "Column '%s' may not be large enough for the required data length: %d\n", column->name, size);
1251 } else if ((type == RQ_INTEGER8 || type == RQ_UINTEGER8 ||
1252 type == RQ_UINTEGER4) && typesize == 4) {
1253 ast_log(LOG_WARNING, "Column '%s' may not be large enough for the required data length: %d\n", column->name, size);
1255 } else if (type == RQ_CHAR || type == RQ_DATETIME || type == RQ_FLOAT || type == RQ_DATE) {
1256 ast_log(LOG_WARNING, "Column '%s' is of the incorrect type: (need %s(%d) but saw %s)\n",
1258 type == RQ_CHAR ? "char" :
1259 type == RQ_DATETIME ? "datetime" :
1260 type == RQ_DATE ? "date" :
1261 type == RQ_FLOAT ? "float" :
1262 "a rather stiff drink ",
1263 size, column->type);
1266 } else if (strncmp(column->type, "float", 5) == 0) {
1267 if (!ast_rq_is_int(type) && type != RQ_FLOAT) {
1268 ast_log(LOG_WARNING, "Column %s cannot be a %s\n", column->name, column->type);
1271 } else if (strncmp(column->type, "timestamp", 9) == 0) {
1272 if (type != RQ_DATETIME && type != RQ_DATE) {
1273 ast_log(LOG_WARNING, "Column %s cannot be a %s\n", column->name, column->type);
1276 } else { /* There are other types that no module implements yet */
1277 ast_log(LOG_WARNING, "Possibly unsupported column type '%s' on column '%s'\n", column->type, column->name);
1285 if (requirements == RQ_WARN) {
1286 ast_log(LOG_WARNING, "Table %s requires a column '%s' of size '%d', but no such column exists.\n", tablename, elm, size);
1289 struct ast_str *sql = ast_str_create(100);
1293 if (requirements == RQ_CREATECHAR || type == RQ_CHAR) {
1294 /* Size is minimum length; make it at least 50% greater,
1295 * just to be sure, because PostgreSQL doesn't support
1296 * resizing columns. */
1297 snprintf(fieldtype, sizeof(fieldtype), "CHAR(%hhu)",
1298 size < 15 ? size * 2 :
1299 (size * 3 / 2 > 255) ? 255 : size * 3 / 2);
1300 } else if (type == RQ_INTEGER1 || type == RQ_UINTEGER1 || type == RQ_INTEGER2) {
1301 snprintf(fieldtype, sizeof(fieldtype), "INT2");
1302 } else if (type == RQ_UINTEGER2 || type == RQ_INTEGER3 || type == RQ_UINTEGER3 || type == RQ_INTEGER4) {
1303 snprintf(fieldtype, sizeof(fieldtype), "INT4");
1304 } else if (type == RQ_UINTEGER4 || type == RQ_INTEGER8) {
1305 snprintf(fieldtype, sizeof(fieldtype), "INT8");
1306 } else if (type == RQ_UINTEGER8) {
1307 /* No such type on PostgreSQL */
1308 snprintf(fieldtype, sizeof(fieldtype), "CHAR(20)");
1309 } else if (type == RQ_FLOAT) {
1310 snprintf(fieldtype, sizeof(fieldtype), "FLOAT8");
1311 } else if (type == RQ_DATE) {
1312 snprintf(fieldtype, sizeof(fieldtype), "DATE");
1313 } else if (type == RQ_DATETIME) {
1314 snprintf(fieldtype, sizeof(fieldtype), "TIMESTAMP");
1316 ast_log(LOG_ERROR, "Unrecognized request type %d\n", type);
1320 ast_str_set(&sql, 0, "ALTER TABLE %s ADD COLUMN %s %s", tablename, elm, fieldtype);
1321 ast_debug(1, "About to lock pgsql_lock (running alter on table '%s' to add column '%s')\n", tablename, elm);
1323 ast_mutex_lock(&pgsql_lock);
1324 ast_debug(1, "About to run ALTER query on table '%s' to add column '%s'\n", tablename, elm);
1326 if (pgsql_exec(database, tablename, ast_str_buffer(sql), &result) != 0) {
1327 ast_mutex_unlock(&pgsql_lock);
1328 release_table(table);
1332 ast_debug(1, "Finished running ALTER query on table '%s'\n", tablename);
1333 if (PQresultStatus(result) != PGRES_COMMAND_OK) {
1334 ast_log(LOG_ERROR, "Unable to add column: %s\n", ast_str_buffer(sql));
1337 ast_mutex_unlock(&pgsql_lock);
1343 release_table(table);
1347 static int unload_pgsql(const char *database, const char *tablename)
1352 * Ignore database from the extconfig.conf since it was
1353 * configured by res_pgsql.conf.
1357 ast_debug(2, "About to lock table cache list\n");
1358 AST_LIST_LOCK(&psql_tables);
1359 ast_debug(2, "About to traverse table cache list\n");
1360 AST_LIST_TRAVERSE_SAFE_BEGIN(&psql_tables, cur, list) {
1361 if (strcmp(cur->name, tablename) == 0) {
1362 ast_debug(2, "About to remove matching cache entry\n");
1363 AST_LIST_REMOVE_CURRENT(list);
1364 ast_debug(2, "About to destroy matching cache entry\n");
1366 ast_debug(1, "Cache entry '%s@%s' destroyed\n", tablename, database);
1370 AST_LIST_TRAVERSE_SAFE_END
1371 AST_LIST_UNLOCK(&psql_tables);
1372 ast_debug(2, "About to return\n");
1373 return cur ? 0 : -1;
1376 static struct ast_config_engine pgsql_engine = {
1378 .load_func = config_pgsql,
1379 .realtime_func = realtime_pgsql,
1380 .realtime_multi_func = realtime_multi_pgsql,
1381 .store_func = store_pgsql,
1382 .destroy_func = destroy_pgsql,
1383 .update_func = update_pgsql,
1384 .update2_func = update2_pgsql,
1385 .require_func = require_pgsql,
1386 .unload_func = unload_pgsql,
1389 static int load_module(void)
1391 if(!parse_config(0))
1392 return AST_MODULE_LOAD_DECLINE;
1394 ast_config_engine_register(&pgsql_engine);
1396 ast_cli_register_multiple(cli_realtime, ARRAY_LEN(cli_realtime));
1401 static int unload_module(void)
1403 struct tables *table;
1404 /* Acquire control before doing anything to the module itself. */
1405 ast_mutex_lock(&pgsql_lock);
1408 PQfinish(pgsqlConn);
1411 ast_cli_unregister_multiple(cli_realtime, ARRAY_LEN(cli_realtime));
1412 ast_config_engine_deregister(&pgsql_engine);
1414 /* Unlock so something else can destroy the lock. */
1415 ast_mutex_unlock(&pgsql_lock);
1417 /* Destroy cached table info */
1418 AST_LIST_LOCK(&psql_tables);
1419 while ((table = AST_LIST_REMOVE_HEAD(&psql_tables, list))) {
1420 destroy_table(table);
1422 AST_LIST_UNLOCK(&psql_tables);
1427 static int reload(void)
1434 static int parse_config(int is_reload)
1436 struct ast_config *config;
1438 struct ast_flags config_flags = { is_reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1440 config = ast_config_load(RES_CONFIG_PGSQL_CONF, config_flags);
1441 if (config == CONFIG_STATUS_FILEUNCHANGED) {
1442 if (is_reload && pgsqlConn && PQstatus(pgsqlConn) != CONNECTION_OK) {
1443 ast_log(LOG_WARNING, "PostgreSQL RealTime: Not connected\n");
1448 if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
1449 ast_log(LOG_WARNING, "Unable to load config %s\n", RES_CONFIG_PGSQL_CONF);
1453 ast_mutex_lock(&pgsql_lock);
1455 /* XXX: Why would we do this before we're ready to establish a new connection? */
1457 PQfinish(pgsqlConn);
1461 if (!(s = ast_variable_retrieve(config, "general", "dbuser"))) {
1462 ast_log(LOG_WARNING,
1463 "PostgreSQL RealTime: No database user found, using 'asterisk' as default.\n");
1464 strcpy(dbuser, "asterisk");
1466 ast_copy_string(dbuser, s, sizeof(dbuser));
1469 if (!(s = ast_variable_retrieve(config, "general", "dbpass"))) {
1470 ast_log(LOG_WARNING,
1471 "PostgreSQL RealTime: No database password found, using 'asterisk' as default.\n");
1472 strcpy(dbpass, "asterisk");
1474 ast_copy_string(dbpass, s, sizeof(dbpass));
1477 if (!(s = ast_variable_retrieve(config, "general", "dbhost"))) {
1478 ast_log(LOG_WARNING,
1479 "PostgreSQL RealTime: No database host found, using localhost via socket.\n");
1482 ast_copy_string(dbhost, s, sizeof(dbhost));
1485 if (!(s = ast_variable_retrieve(config, "general", "dbname"))) {
1486 ast_log(LOG_WARNING,
1487 "PostgreSQL RealTime: No database name found, using 'asterisk' as default.\n");
1488 strcpy(dbname, "asterisk");
1490 ast_copy_string(dbname, s, sizeof(dbname));
1493 if (!(s = ast_variable_retrieve(config, "general", "dbport"))) {
1494 ast_log(LOG_WARNING,
1495 "PostgreSQL RealTime: No database port found, using 5432 as default.\n");
1501 if (!(s = ast_variable_retrieve(config, "general", "dbappname"))) {
1502 dbappname[0] = '\0';
1504 ast_copy_string(dbappname, s, sizeof(dbappname));
1507 if (!ast_strlen_zero(dbhost)) {
1508 /* No socket needed */
1509 } else if (!(s = ast_variable_retrieve(config, "general", "dbsock"))) {
1510 ast_log(LOG_WARNING,
1511 "PostgreSQL RealTime: No database socket found, using '/tmp/.s.PGSQL.%d' as default.\n", dbport);
1512 strcpy(dbsock, "/tmp");
1514 ast_copy_string(dbsock, s, sizeof(dbsock));
1517 if (!(s = ast_variable_retrieve(config, "general", "requirements"))) {
1518 ast_log(LOG_WARNING,
1519 "PostgreSQL RealTime: no requirements setting found, using 'warn' as default.\n");
1520 requirements = RQ_WARN;
1521 } else if (!strcasecmp(s, "createclose")) {
1522 requirements = RQ_CREATECLOSE;
1523 } else if (!strcasecmp(s, "createchar")) {
1524 requirements = RQ_CREATECHAR;
1527 ast_config_destroy(config);
1530 if (!ast_strlen_zero(dbhost)) {
1531 ast_debug(1, "PostgreSQL RealTime Host: %s\n", dbhost);
1532 ast_debug(1, "PostgreSQL RealTime Port: %i\n", dbport);
1534 ast_debug(1, "PostgreSQL RealTime Socket: %s\n", dbsock);
1536 ast_debug(1, "PostgreSQL RealTime User: %s\n", dbuser);
1537 ast_debug(1, "PostgreSQL RealTime Password: %s\n", dbpass);
1538 ast_debug(1, "PostgreSQL RealTime DBName: %s\n", dbname);
1541 if (!pgsql_reconnect(NULL)) {
1542 ast_log(LOG_WARNING,
1543 "PostgreSQL RealTime: Couldn't establish connection. Check debug.\n");
1544 ast_debug(1, "PostgreSQL RealTime: Cannot Connect: %s\n", PQerrorMessage(pgsqlConn));
1547 ast_verb(2, "PostgreSQL RealTime reloaded.\n");
1549 /* Done reloading. Release lock so others can now use driver. */
1550 ast_mutex_unlock(&pgsql_lock);
1555 static int pgsql_reconnect(const char *database)
1557 char my_database[50];
1559 ast_copy_string(my_database, S_OR(database, dbname), sizeof(my_database));
1561 /* mutex lock should have been locked before calling this function. */
1564 if (PQstatus(pgsqlConn) == CONNECTION_OK) {
1569 PQfinish(pgsqlConn);
1573 /* DB password can legitimately be 0-length */
1574 if ((!ast_strlen_zero(dbhost) || !ast_strlen_zero(dbsock)) && !ast_strlen_zero(dbuser) && !ast_strlen_zero(my_database)) {
1575 struct ast_str *conn_info = ast_str_create(128);
1578 ast_log(LOG_ERROR, "PostgreSQL RealTime: Failed to allocate memory for connection string.\n");
1582 ast_str_set(&conn_info, 0, "host=%s port=%d dbname=%s user=%s",
1583 S_OR(dbhost, dbsock), dbport, my_database, dbuser);
1585 if (!ast_strlen_zero(dbappname)) {
1586 ast_str_append(&conn_info, 0, " application_name=%s", dbappname);
1589 if (!ast_strlen_zero(dbpass)) {
1590 ast_str_append(&conn_info, 0, " password=%s", dbpass);
1593 pgsqlConn = PQconnectdb(ast_str_buffer(conn_info));
1594 ast_free(conn_info);
1597 ast_debug(1, "pgsqlConn=%p\n", pgsqlConn);
1598 if (pgsqlConn && PQstatus(pgsqlConn) == CONNECTION_OK) {
1599 ast_debug(1, "PostgreSQL RealTime: Successfully connected to database.\n");
1600 connect_time = time(NULL);
1601 version = PQserverVersion(pgsqlConn);
1605 "PostgreSQL RealTime: Failed to connect database %s on %s: %s\n",
1606 my_database, dbhost, PQresultErrorMessage(NULL));
1610 ast_debug(1, "PostgreSQL RealTime: One or more of the parameters in the config does not pass our validity checks.\n");
1615 static char *handle_cli_realtime_pgsql_cache(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1623 e->command = "realtime show pgsql cache";
1625 "Usage: realtime show pgsql cache [<table>]\n"
1626 " Shows table cache for the PostgreSQL RealTime driver\n";
1632 l = strlen(a->word);
1634 AST_LIST_LOCK(&psql_tables);
1635 AST_LIST_TRAVERSE(&psql_tables, cur, list) {
1636 if (!strncasecmp(a->word, cur->name, l) && ++which > a->n) {
1637 ret = ast_strdup(cur->name);
1641 AST_LIST_UNLOCK(&psql_tables);
1646 /* List of tables */
1647 AST_LIST_LOCK(&psql_tables);
1648 AST_LIST_TRAVERSE(&psql_tables, cur, list) {
1649 ast_cli(a->fd, "%s\n", cur->name);
1651 AST_LIST_UNLOCK(&psql_tables);
1652 } else if (a->argc == 5) {
1653 /* List of columns */
1654 if ((cur = find_table(NULL, a->argv[4]))) {
1655 struct columns *col;
1656 ast_cli(a->fd, "Columns for Table Cache '%s':\n", a->argv[4]);
1657 ast_cli(a->fd, "%-20.20s %-20.20s %-3.3s %-8.8s\n", "Name", "Type", "Len", "Nullable");
1658 AST_LIST_TRAVERSE(&cur->columns, col, list) {
1659 ast_cli(a->fd, "%-20.20s %-20.20s %3d %-8.8s\n", col->name, col->type, col->len, col->notnull ? "NOT NULL" : "");
1663 ast_cli(a->fd, "No such table '%s'\n", a->argv[4]);
1669 static char *handle_cli_realtime_pgsql_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1671 char connection_info[256];
1672 char credentials[100] = "";
1673 char buf[376]; /* 256+100+"Connected to "+" for "+NULL */
1674 int is_connected = 0, ctimesec = time(NULL) - connect_time;
1678 e->command = "realtime show pgsql status";
1680 "Usage: realtime show pgsql status\n"
1681 " Shows connection information for the PostgreSQL RealTime driver\n";
1688 return CLI_SHOWUSAGE;
1690 if (!ast_strlen_zero(dbhost))
1691 snprintf(connection_info, sizeof(connection_info), "%s@%s, port %d", dbname, dbhost, dbport);
1692 else if (!ast_strlen_zero(dbsock))
1693 snprintf(connection_info, sizeof(connection_info), "%s on socket file %s", dbname, dbsock);
1695 snprintf(connection_info, sizeof(connection_info), "%s@%s", dbname, dbhost);
1697 if (!ast_strlen_zero(dbuser))
1698 snprintf(credentials, sizeof(credentials), " with username %s", dbuser);
1700 ast_mutex_lock(&pgsql_lock);
1701 is_connected = (pgsqlConn && PQstatus(pgsqlConn) == CONNECTION_OK);
1702 ast_mutex_unlock(&pgsql_lock);
1705 snprintf(buf, sizeof(buf), "Connected to %s%s for ", connection_info, credentials);
1706 ast_cli_print_timestr_fromseconds(a->fd, ctimesec, buf);
1709 ast_cli(a->fd, "Unable to connect %s%s\n", connection_info, credentials);
1714 /* needs usecount semantics defined */
1715 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PostgreSQL RealTime Configuration Driver",
1716 .support_level = AST_MODULE_SUPPORT_EXTENDED,
1717 .load = load_module,
1718 .unload = unload_module,
1720 .load_pri = AST_MODPRI_REALTIME_DRIVER,