X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/16282d2b161d7a169cdbcafaea7222233ba3dab8..c2f669a4994192344613569e198c7b503d46d45e:/src/src/lookups/pgsql.c diff --git a/src/src/lookups/pgsql.c b/src/src/lookups/pgsql.c index 8b777f40b..53d17d7ad 100644 --- a/src/src/lookups/pgsql.c +++ b/src/src/lookups/pgsql.c @@ -1,10 +1,8 @@ -/* $Cambridge: exim/src/src/lookups/pgsql.c,v 1.6 2006/07/14 14:21:27 ph10 Exp $ */ - /************************************************* * Exim - an Internet mail transport agent * *************************************************/ -/* Copyright (c) University of Cambridge 1995 - 2006 */ +/* Copyright (c) University of Cambridge 1995 - 2015 */ /* See the file NOTICE for conditions of use and distribution. */ /* Thanks to Petr Cech for contributing the original code for these @@ -13,21 +11,6 @@ socket extension. */ #include "../exim.h" #include "lf_functions.h" -#include "pgsql.h" /* The local header */ - -/* We can't just compile this code and allow the library mechanism to omit the -functions if they are not wanted, because we need to have the PGSQL header -available for compiling. Therefore, compile these functions only if -LOOKUP_PGSQL is defined. However, some compilers don't like compiling empty -modules, so keep them happy with a dummy when skipping the rest. Make it -reference itself to stop picky compilers complaining that it is unused, and put -in a dummy argument to stop even pickier compilers complaining about infinite -loops. */ - -#ifndef LOOKUP_PGSQL -static void dummy(int x) { dummy(x-1); } -#else - #include /* The system header */ @@ -49,7 +32,7 @@ static pgsql_connection *pgsql_connections = NULL; /* See local README for interface description. */ -void * +static void * pgsql_open(uschar *filename, uschar **errmsg) { return (void *)(1); /* Just return something non-null */ @@ -63,7 +46,7 @@ return (void *)(1); /* Just return something non-null */ /* See local README for interface description. */ -void +static void pgsql_tidy(void) { pgsql_connection *cn; @@ -76,6 +59,28 @@ while ((cn = pgsql_connections) != NULL) } +/************************************************* +* Notice processor function for pgsql * +*************************************************/ + +/* This function is passed to pgsql below, and called for any PostgreSQL +"notices". By default they are written to stderr, which is undesirable. + +Arguments: + arg an opaque user cookie (not used) + message the notice + +Returns: nothing +*/ + +static void +notice_processor(void *arg, const char *message) +{ +arg = arg; /* Keep compiler happy */ +DEBUG(D_lookup) debug_printf("PGSQL: %s\n", message); +} + + /************************************************* * Internal search function * @@ -106,15 +111,15 @@ Arguments: server the server string; this is in dynamic memory and can be updated resultptr where to store the result errmsg where to point an error message - defer_break TRUE if no more servers are to be tried after DEFER + defer_break set TRUE if no more servers are to be tried after DEFER do_cache set FALSE if data is changed Returns: OK, FAIL, or DEFER */ static int -perform_pgsql_search(uschar *query, uschar *server, uschar **resultptr, - uschar **errmsg, BOOL *defer_break, BOOL *do_cache) +perform_pgsql_search(const uschar *query, uschar *server, uschar **resultptr, + uschar **errmsg, BOOL *defer_break, uint *do_cache) { PGconn *pg_conn = NULL; PGresult *pg_result = NULL; @@ -243,7 +248,6 @@ if (cn == NULL) *errmsg = string_sprintf("PGSQL connection failed: %s", PQerrorMessage(pg_conn)); PQfinish(pg_conn); - *defer_break = FALSE; goto PGSQL_EXIT; } @@ -253,6 +257,12 @@ if (cn == NULL) PQsetClientEncoding(pg_conn, "SQL_ASCII"); + /* Set the notice processor to prevent notices from being written to stderr + (which is what the default does). Our function (above) just produces debug + output. */ + + PQsetNoticeProcessor(pg_conn, notice_processor, NULL); + /* Add the connection to the cache */ cn = store_get(sizeof(pgsql_connection)); @@ -280,10 +290,10 @@ else /* The command was successful but did not return any data since it was * not SELECT but either an INSERT, UPDATE or DELETE statement. Tell the * high level code to not cache this query, and clean the current cache for - * this handle by setting *do_cache FALSE. */ + * this handle by setting *do_cache zero. */ result = string_copy(US PQcmdTuples(pg_result)); offset = Ustrlen(result); - *do_cache = FALSE; + *do_cache = 0; DEBUG(D_lookup) debug_printf("PGSQL: command does not return any data " "but was successful. Rows affected: %s\n", result); @@ -300,7 +310,6 @@ else *errmsg = string_sprintf("PGSQL: query failed: %s (%s) (%s)\n", PQresultErrorMessage(pg_result), PQresStatus(PQresultStatus(pg_result)), query); - *defer_break = FALSE; goto PGSQL_EXIT; } @@ -318,11 +327,11 @@ row, we insert '\n' between them. */ for (i = 0; i < num_tuples; i++) { if (result != NULL) - result = string_cat(result, &ssize, &offset, US"\n", 1); + result = string_catn(result, &ssize, &offset, US"\n", 1); if (num_fields == 1) { - result = string_cat(result, &ssize, &offset, + result = string_catn(result, &ssize, &offset, US PQgetvalue(pg_result, i, 0), PQgetlength(pg_result, i, 0)); } @@ -384,33 +393,16 @@ else *************************************************/ /* See local README for interface description. The handle and filename -arguments are not used. Loop through a list of servers while the query is -deferred with a retryable error. */ +arguments are not used. The code to loop through a list of servers while the +query is deferred with a retryable error is now in a separate function that is +shared with other SQL lookups. */ -int -pgsql_find(void *handle, uschar *filename, uschar *query, int length, - uschar **result, uschar **errmsg, BOOL *do_cache) +static int +pgsql_find(void *handle, uschar *filename, const uschar *query, int length, + uschar **result, uschar **errmsg, uint *do_cache) { -int sep = 0; -uschar *server; -uschar *list = pgsql_servers; -uschar buffer[512]; - -DEBUG(D_lookup) debug_printf("PGSQL query: %s\n", query); - -while ((server = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) - != NULL) - { - BOOL defer_break; - int rc = perform_pgsql_search(query, server, result, errmsg, &defer_break, - do_cache); - if (rc != DEFER || defer_break) return rc; - } - -if (pgsql_servers == NULL) - *errmsg = US"no PGSQL servers defined (pgsql_servers option)"; - -return DEFER; +return lf_sqlperform(US"PostgreSQL", US"pgsql_servers", pgsql_servers, query, + result, errmsg, do_cache, perform_pgsql_search); } @@ -421,12 +413,6 @@ return DEFER; /* The characters that always need to be quoted (with backslash) are newline, tab, carriage return, backspace, backslash itself, and the quote characters. -Percent and underscore are only special in contexts where they can be wild -cards, and this isn't usually the case for data inserted from messages, since -that isn't likely to be treated as a pattern of any kind. However, pgsql seems -to allow escaping "on spec". If you use something like "where id="ab\%cd" it -does treat the string as "ab%cd". So we can safely quote percent and -underscore. [This is different to MySQL, where you can't do this.] The original code quoted single quotes as \' which is documented as valid in the O'Reilly book "Practical PostgreSQL" (first edition) as an alternative to @@ -445,7 +431,7 @@ Arguments: Returns: the processed string or NULL for a bad option */ -uschar * +static uschar * pgsql_quote(uschar *s, uschar *opt) { register int c; @@ -456,7 +442,7 @@ uschar *quoted; if (opt != NULL) return NULL; /* No options recognized */ while ((c = *t++) != 0) - if (Ustrchr("\n\t\r\b\'\"\\%_", c) != NULL) count++; + if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++; if (count == 0) return s; t = quoted = store_get(Ustrlen(s) + count + 1); @@ -468,7 +454,7 @@ while ((c = *s++) != 0) *t++ = '\''; *t++ = '\''; } - else if (Ustrchr("\n\t\r\b\"\\%_", c) != NULL) + else if (Ustrchr("\n\t\r\b\"\\", c) != NULL) { *t++ = '\\'; switch(c) @@ -492,6 +478,47 @@ while ((c = *s++) != 0) return quoted; } -#endif /* PGSQL_LOOKUP */ + +/************************************************* +* Version reporting entry point * +*************************************************/ + +/* See local README for interface description. */ + +#include "../version.h" + +void +pgsql_version_report(FILE *f) +{ +#ifdef DYNLOOKUP +fprintf(f, "Library version: PostgreSQL: Exim version %s\n", EXIM_VERSION_STR); +#endif + +/* Version reporting: there appears to be no available information about +the client library in libpq-fe.h; once you have a connection object, you +can access the server version and the chosen protocol version, but those +aren't really what we want. It might make sense to debug_printf those +when the connection is established though? */ +} + + +static lookup_info _lookup_info = { + US"pgsql", /* lookup name */ + lookup_querystyle, /* query-style lookup */ + pgsql_open, /* open function */ + NULL, /* no check function */ + pgsql_find, /* find function */ + NULL, /* no close function */ + pgsql_tidy, /* tidy function */ + pgsql_quote, /* quoting function */ + pgsql_version_report /* version reporting */ +}; + +#ifdef DYNLOOKUP +#define pgsql_lookup_module_info _lookup_module_info +#endif + +static lookup_info *_lookup_list[] = { &_lookup_info }; +lookup_module_info pgsql_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 }; /* End of lookups/pgsql.c */