Fix DKIM signing to always ;-terminate. Bug 2295

[exim.git] / src / src / lookups / pgsql.c

diff --git a/src/src/lookups/pgsql.c b/src/src/lookups/pgsql.c
index eace0840d73ca9a0d016c4b26e2e161817097fd0..a7ea3d57a0957bd3c4415d9018d22abe72d2b0b8 100644 (file)
--- a/src/src/lookups/pgsql.c
+++ b/src/src/lookups/pgsql.c
@@ -1,10 +1,9 @@
-/* $Cambridge: exim/src/src/lookups/pgsql.c,v 1.10 2007/08/23 10:16:51 ph10 Exp $ */
-

 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 

-/* Copyright (c) University of Cambridge 1995 - 2007 */
+/* Copyright (c) University of Cambridge 1995 - 2018 */
+/* Copyright (c) The Exim Maintainers 2020 */

 /* See the file NOTICE for conditions of use and distribution. */
 
 /* Thanks to Petr Cech for contributing the original code for these
 /* See the file NOTICE for conditions of use and distribution. */
 
 /* Thanks to Petr Cech for contributing the original code for these


@@ -13,21 +12,6 @@ socket extension. */
 
 #include "../exim.h"
 #include "lf_functions.h"
 
 #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 <libpq-fe.h>       /* The system header */
 
 
 #include <libpq-fe.h>       /* The system header */
 


@@ -49,8 +33,8 @@ static pgsql_connection *pgsql_connections = NULL;
 
 /* See local README for interface description. */
 
 
 /* See local README for interface description. */
 

-void *
-pgsql_open(uschar *filename, uschar **errmsg)
+static void *
+pgsql_open(const uschar * filename, uschar ** errmsg)

 {
 return (void *)(1);    /* Just return something non-null */
 }
 {
 return (void *)(1);    /* Just return something non-null */
 }


@@ -63,14 +47,14 @@ return (void *)(1);    /* Just return something non-null */
 
 /* See local README for interface description. */
 
 
 /* See local README for interface description. */
 

-void
+static void

 pgsql_tidy(void)
 {
 pgsql_connection *cn;
 while ((cn = pgsql_connections) != NULL)
   {
   pgsql_connections = cn->next;
 pgsql_tidy(void)
 {
 pgsql_connection *cn;
 while ((cn = pgsql_connections) != NULL)
   {
   pgsql_connections = cn->next;

-  DEBUG(D_lookup) debug_printf("close PGSQL connection: %s\n", cn->server);
+  DEBUG(D_lookup) debug_printf_indent("close PGSQL connection: %s\n", cn->server);

   PQfinish(cn->handle);
   }
 }
   PQfinish(cn->handle);
   }
 }


@@ -94,7 +78,7 @@ static void
 notice_processor(void *arg, const char *message)
 {
 arg = arg;   /* Keep compiler happy */
 notice_processor(void *arg, const char *message)
 {
 arg = arg;   /* Keep compiler happy */

-DEBUG(D_lookup) debug_printf("PGSQL: %s\n", message);
+DEBUG(D_lookup) debug_printf_indent("PGSQL: %s\n", message);

 }
 
 
 }
 
 


@@ -114,7 +98,7 @@ configuration line for PostgreSQL via Unix domain sockets looks like this:
 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password[:<nextserver>]
 
 We enclose the path name in parentheses so that its slashes aren't visually
 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password[:<nextserver>]
 
 We enclose the path name in parentheses so that its slashes aren't visually

-confused with the delimeters for the other pgsql_server settings.
+confused with the delimiters for the other pgsql_server settings.

 
 For TCP/IP connections, the server is a host name and optional port (with a
 colon separator).
 
 For TCP/IP connections, the server is a host name and optional port (with a
 colon separator).


@@ -130,24 +114,23 @@ Arguments:
   errmsg       where to point an error message
   defer_break  set TRUE if no more servers are to be tried after DEFER
   do_cache     set FALSE if data is changed
   errmsg       where to point an error message
   defer_break  set TRUE if no more servers are to be tried after DEFER
   do_cache     set FALSE if data is changed

+  opts        options list

 
 Returns:       OK, FAIL, or DEFER
 */
 
 static int
 
 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, const uschar * opts)

 {
 PGconn *pg_conn = NULL;
 PGresult *pg_result = NULL;
 
 {
 PGconn *pg_conn = NULL;
 PGresult *pg_result = NULL;
 

-int i;
-int ssize = 0;
-int offset = 0;
+gstring * result = NULL;

 int yield = DEFER;
 unsigned int num_fields, num_tuples;
 int yield = DEFER;
 unsigned int num_fields, num_tuples;

-uschar *result = NULL;

 pgsql_connection *cn;
 pgsql_connection *cn;

+rmark reset_point = store_mark();

 uschar *server_copy = NULL;
 uschar *sdata[3];
 
 uschar *server_copy = NULL;
 uschar *sdata[3];
 


@@ -156,10 +139,10 @@ path, database, user, password. We can write to the string, since it is in a
 nextinlist temporary buffer. The copy of the string that is used for caching
 has the password removed. This copy is also used for debugging output. */
 
 nextinlist temporary buffer. The copy of the string that is used for caching
 has the password removed. This copy is also used for debugging output. */
 

-for (i = 2; i >= 0; i--)
+for (int i = 2; i >= 0; i--)

   {
   uschar *pp = Ustrrchr(server, '/');
   {
   uschar *pp = Ustrrchr(server, '/');

-  if (pp == NULL)
+  if (!pp)

     {
     *errmsg = string_sprintf("incomplete pgSQL server data: %s",
       (i == 2)? server : server_copy);
     {
     *errmsg = string_sprintf("incomplete pgSQL server data: %s",
       (i == 2)? server : server_copy);


@@ -175,18 +158,16 @@ for (i = 2; i >= 0; i--)
 start is the identification of the server (host or path). See if we have a
 cached connection to the server. */
 
 start is the identification of the server (host or path). See if we have a
 cached connection to the server. */
 

-for (cn = pgsql_connections; cn != NULL; cn = cn->next)
-  {
+for (cn = pgsql_connections; cn; cn = cn->next)

   if (Ustrcmp(cn->server, server_copy) == 0)
     {
     pg_conn = cn->handle;
     break;
     }
   if (Ustrcmp(cn->server, server_copy) == 0)
     {
     pg_conn = cn->handle;
     break;
     }

-  }

 
 /* If there is no cached connection, we must set one up. */
 
 
 /* If there is no cached connection, we must set one up. */
 

-if (cn == NULL)
+if (!cn)

   {
   uschar *port = US"";
 
   {
   uschar *port = US"";
 


@@ -197,23 +178,22 @@ if (cn == NULL)
     uschar *last_slash, *last_dot, *p;
 
     p = ++server;
     uschar *last_slash, *last_dot, *p;
 
     p = ++server;

-    while (*p != 0 && *p != ')') p++;
+    while (*p && *p != ')') p++;

     *p = 0;
 
     last_slash = Ustrrchr(server, '/');
     last_dot = Ustrrchr(server, '.');
 
     *p = 0;
 
     last_slash = Ustrrchr(server, '/');
     last_dot = Ustrrchr(server, '.');
 

-    DEBUG(D_lookup) debug_printf("PGSQL new connection: socket=%s "
+    DEBUG(D_lookup) debug_printf_indent("PGSQL new connection: socket=%s "

       "database=%s user=%s\n", server, sdata[0], sdata[1]);
 
     /* A valid socket name looks like this: /var/run/postgresql/.s.PGSQL.5432
     We have to call PQsetdbLogin with '/var/run/postgresql' as the hostname
     argument and put '5432' into the port variable. */
 
       "database=%s user=%s\n", server, sdata[0], sdata[1]);
 
     /* A valid socket name looks like this: /var/run/postgresql/.s.PGSQL.5432
     We have to call PQsetdbLogin with '/var/run/postgresql' as the hostname
     argument and put '5432' into the port variable. */
 

-    if (last_slash == NULL || last_dot == NULL)
+    if (!last_slash || !last_dot)

       {
       {

-      *errmsg = string_sprintf("PGSQL invalid filename for socket: %s",
-        server);
+      *errmsg = string_sprintf("PGSQL invalid filename for socket: %s", server);

       *defer_break = TRUE;
       return DEFER;
       }
       *defer_break = TRUE;
       return DEFER;
       }


@@ -230,13 +210,13 @@ if (cn == NULL)
   else
     {
     uschar *p;
   else
     {
     uschar *p;

-    if ((p = Ustrchr(server, ':')) != NULL)
+    if ((p = Ustrchr(server, ':')))

       {
       *p++ = 0;
       port = p;
       }
 
       {
       *p++ = 0;
       port = p;
       }
 

-    if (Ustrchr(server, '/') != NULL)
+    if (Ustrchr(server, '/'))

       {
       *errmsg = string_sprintf("unexpected slash in pgSQL server hostname: %s",
         server);
       {
       *errmsg = string_sprintf("unexpected slash in pgSQL server hostname: %s",
         server);


@@ -244,7 +224,7 @@ if (cn == NULL)
       return DEFER;
       }
 
       return DEFER;
       }
 

-    DEBUG(D_lookup) debug_printf("PGSQL new connection: host=%s port=%s "
+    DEBUG(D_lookup) debug_printf_indent("PGSQL new connection: host=%s port=%s "

       "database=%s user=%s\n", server, port, sdata[0], sdata[1]);
     }
 
       "database=%s user=%s\n", server, port, sdata[0], sdata[1]);
     }
 


@@ -261,7 +241,7 @@ if (cn == NULL)
 
   if(PQstatus(pg_conn) == CONNECTION_BAD)
     {
 
   if(PQstatus(pg_conn) == CONNECTION_BAD)
     {

-    store_reset(server_copy);
+    reset_point = store_reset(reset_point);

     *errmsg = string_sprintf("PGSQL connection failed: %s",
       PQerrorMessage(pg_conn));
     PQfinish(pg_conn);
     *errmsg = string_sprintf("PGSQL connection failed: %s",
       PQerrorMessage(pg_conn));
     PQfinish(pg_conn);


@@ -282,7 +262,7 @@ if (cn == NULL)
 
   /* Add the connection to the cache */
 
 
   /* Add the connection to the cache */
 

-  cn = store_get(sizeof(pgsql_connection));
+  cn = store_get(sizeof(pgsql_connection), FALSE);

   cn->server = server_copy;
   cn->handle = pg_conn;
   cn->next = pgsql_connections;
   cn->server = server_copy;
   cn->handle = pg_conn;
   cn->next = pgsql_connections;


@@ -293,42 +273,43 @@ if (cn == NULL)
 
 else
   {
 
 else
   {

-  DEBUG(D_lookup) debug_printf("PGSQL using cached connection for %s\n",
+  DEBUG(D_lookup) debug_printf_indent("PGSQL using cached connection for %s\n",

     server_copy);
   }
 
 /* Run the query */
 
     server_copy);
   }
 
 /* Run the query */
 

-  pg_result = PQexec(pg_conn, CS query);
-  switch(PQresultStatus(pg_result))
-    {
-    case PGRES_EMPTY_QUERY:
-    case PGRES_COMMAND_OK:
+pg_result = PQexec(pg_conn, CS query);
+switch(PQresultStatus(pg_result))
+  {
+  case PGRES_EMPTY_QUERY:
+  case PGRES_COMMAND_OK:

     /* The command was successful but did not return any data since it was
     /* 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. */
-    result = string_copy(US PQcmdTuples(pg_result));
-    offset = Ustrlen(result);
-    *do_cache = FALSE;
-    DEBUG(D_lookup) debug_printf("PGSQL: command does not return any data "
-      "but was successful. Rows affected: %s\n", result);
-
-    case PGRES_TUPLES_OK:
+    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 zero. */
+
+    result = string_cat(result, US PQcmdTuples(pg_result));
+    *do_cache = 0;
+    DEBUG(D_lookup) debug_printf_indent("PGSQL: command does not return any data "
+      "but was successful. Rows affected: %s\n", string_from_gstring(result));
+    break;
+
+  case PGRES_TUPLES_OK:

     break;
 
     break;
 

-    default:
+  default:

     /* This was the original code:
     *errmsg = string_sprintf("PGSQL: query failed: %s\n",
     /* This was the original code:
     *errmsg = string_sprintf("PGSQL: query failed: %s\n",

-                             PQresultErrorMessage(pg_result));
+                            PQresultErrorMessage(pg_result));

     This was suggested by a user:
     */
 
     *errmsg = string_sprintf("PGSQL: query failed: %s (%s) (%s)\n",
     This was suggested by a user:
     */
 
     *errmsg = string_sprintf("PGSQL: query failed: %s (%s) (%s)\n",

-                             PQresultErrorMessage(pg_result),
-                             PQresStatus(PQresultStatus(pg_result)), query);
+                          PQresultErrorMessage(pg_result),
+                          PQresStatus(PQresultStatus(pg_result)), query);

     goto PGSQL_EXIT;
     goto PGSQL_EXIT;

-    }
+  }

 
 /* Result is in pg_result. Find the number of fields returned. If this is one,
 we don't add field names to the data. Otherwise we do. If the query did not
 
 /* Result is in pg_result. Find the number of fields returned. If this is one,
 we don't add field names to the data. Otherwise we do. If the query did not


@@ -341,43 +322,29 @@ num_tuples = PQntuples(pg_result);
 /* Get the fields and construct the result string. If there is more than one
 row, we insert '\n' between them. */
 
 /* Get the fields and construct the result string. If there is more than one
 row, we insert '\n' between them. */
 

-for (i = 0; i < num_tuples; i++)
+for (int i = 0; i < num_tuples; i++)

   {
   {

-  if (result != NULL)
-    result = string_cat(result, &ssize, &offset, US"\n", 1);
+  if (result)
+    result = string_catn(result, US"\n", 1);

 
 

-   if (num_fields == 1)
-    {
-    result = string_cat(result, &ssize, &offset,
-      US PQgetvalue(pg_result, i, 0), PQgetlength(pg_result, i, 0));
-    }
-
-   else
-    {
-    int j;
-    for (j = 0; j < num_fields; j++)
+  if (num_fields == 1)
+    result = string_catn(result,
+       US PQgetvalue(pg_result, i, 0), PQgetlength(pg_result, i, 0));
+  else
+    for (int j = 0; j < num_fields; j++)

       {
       uschar *tmp = US PQgetvalue(pg_result, i, j);
       {
       uschar *tmp = US PQgetvalue(pg_result, i, j);

-      result = lf_quote(US PQfname(pg_result, j), tmp, Ustrlen(tmp), result,
-        &ssize, &offset);
+      result = lf_quote(US PQfname(pg_result, j), tmp, Ustrlen(tmp), result);

       }
       }

-    }

   }
 
   }
 

-/* If result is NULL then no data has been found and so we return FAIL.
-Otherwise, we must terminate the string which has been built; string_cat()
-always leaves enough room for a terminating zero. */
+/* If result is NULL then no data has been found and so we return FAIL. */

 
 

-if (result == NULL)
+if (!result)

   {
   yield = FAIL;
   *errmsg = US"PGSQL: no data found";
   }
   {
   yield = FAIL;
   *errmsg = US"PGSQL: no data found";
   }

-else
-  {
-  result[offset] = 0;
-  store_reset(result + offset + 1);
-  }

 
 /* Get here by goto from various error checks. */
 
 
 /* Get here by goto from various error checks. */
 


@@ -386,18 +353,19 @@ PGSQL_EXIT:
 /* Free store for any result that was got; don't close the connection, as
 it is cached. */
 
 /* Free store for any result that was got; don't close the connection, as
 it is cached. */
 

-if (pg_result != NULL) PQclear(pg_result);
+if (pg_result) PQclear(pg_result);

 
 

-/* Non-NULL result indicates a sucessful result */
+/* Non-NULL result indicates a successful result */

 
 

-if (result != NULL)
+if (result)

   {
   {

-  *resultptr = result;
+  gstring_release_unused(result);
+  *resultptr = string_from_gstring(result);

   return OK;
   }
 else
   {
   return OK;
   }
 else
   {

-  DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
+  DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);

   return yield;      /* FAIL or DEFER */
   }
 }
   return yield;      /* FAIL or DEFER */
   }
 }


@@ -414,12 +382,13 @@ 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. */
 
 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, const uschar * filename, const uschar * query,
+  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
+  const uschar * opts)

 {
 return lf_sqlperform(US"PostgreSQL", US"pgsql_servers", pgsql_servers, query,
 {
 return lf_sqlperform(US"PostgreSQL", US"pgsql_servers", pgsql_servers, query,

-  result, errmsg, do_cache, perform_pgsql_search);
+  result, errmsg, do_cache, opts, perform_pgsql_search);

 }
 
 
 }
 
 


@@ -430,12 +399,6 @@ return lf_sqlperform(US"PostgreSQL", US"pgsql_servers", pgsql_servers, query,
 
 /* The characters that always need to be quoted (with backslash) are newline,
 tab, carriage return, backspace, backslash itself, and the quote characters.
 
 /* 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
 
 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


@@ -454,7 +417,7 @@ Arguments:
 Returns:     the processed string or NULL for a bad option
 */
 
 Returns:     the processed string or NULL for a bad option
 */
 

-uschar *
+static uschar *

 pgsql_quote(uschar *s, uschar *opt)
 {
 register int c;
 pgsql_quote(uschar *s, uschar *opt)
 {
 register int c;


@@ -465,10 +428,10 @@ uschar *quoted;
 if (opt != NULL) return NULL;     /* No options recognized */
 
 while ((c = *t++) != 0)
 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;
 
 if (count == 0) return s;

-t = quoted = store_get(Ustrlen(s) + count + 1);
+t = quoted = store_get(Ustrlen(s) + count + 1, is_tainted(s));

 
 while ((c = *s++) != 0)
   {
 
 while ((c = *s++) != 0)
   {


@@ -477,7 +440,7 @@ while ((c = *s++) != 0)
     *t++ = '\'';
     *t++ = '\'';
     }
     *t++ = '\'';
     *t++ = '\'';
     }

-  else if (Ustrchr("\n\t\r\b\"\\%_", c) != NULL)
+  else if (Ustrchr("\n\t\r\b\"\\", c) != NULL)

     {
     *t++ = '\\';
     switch(c)
     {
     *t++ = '\\';
     switch(c)


@@ -501,6 +464,47 @@ while ((c = *s++) != 0)
 return quoted;
 }
 
 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 = {
+  .name = US"pgsql",                   /* lookup name */
+  .type = lookup_querystyle,           /* query-style lookup */
+  .open = pgsql_open,                  /* open function */
+  .check = NULL,                       /* no check function */
+  .find = pgsql_find,                  /* find function */
+  .close = NULL,                       /* no close function */
+  .tidy = pgsql_tidy,                  /* tidy function */
+  .quote = pgsql_quote,                        /* quoting function */
+  .version_report = 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 */
 
 /* End of lookups/pgsql.c */