exit-time debug

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

diff --git a/src/src/lookups/mysql.c b/src/src/lookups/mysql.c
index 68b04dcc81d374a937187d5e1a2b8153a5e7e9bd..460ee2973e5e5e857d5a85f94246ed766394fc9f 100644 (file)
--- a/src/src/lookups/mysql.c
+++ b/src/src/lookups/mysql.c
@@ -2,7 +2,7 @@
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 

-/* Copyright (c) University of Cambridge 1995 - 2015 */
+/* Copyright (c) University of Cambridge 1995 - 2018 */

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


@@ -14,6 +14,53 @@ functions. */
 
 #include <mysql.h>       /* The system header */
 
 
 #include <mysql.h>       /* The system header */
 

+/* We define symbols for *_VERSION_ID (numeric), *_VERSION_STR (char*)
+and *_BASE_STR (char*). It's a bit of guesswork. Especially for mariadb
+with versions before 10.2, as they do not define there there specific symbols.
+*/
+
+/* Newer (>= 10.2) MariaDB */
+#if defined                   MARIADB_VERSION_ID
+#define EXIM_MxSQL_VERSION_ID MARIADB_VERSION_ID
+
+/* MySQL defines MYSQL_VERSION_ID, and MariaDB does so */
+/* https://dev.mysql.com/doc/refman/5.7/en/c-api-server-client-versions.html */
+#elif defined                 LIBMYSQL_VERSION_ID
+#define EXIM_MxSQL_VERSION_ID LIBMYSQL_VERSION_ID
+#elif defined                 MYSQL_VERSION_ID
+#define EXIM_MxSQL_VERSION_ID MYSQL_VERSION_ID
+
+#else
+#define EXIM_MYSQL_VERSION_ID  0
+#endif
+
+/* Newer (>= 10.2) MariaDB */
+#ifdef                         MARIADB_CLIENT_VERSION_STR
+#define EXIM_MxSQL_VERSION_STR MARIADB_CLIENT_VERSION_STR
+
+/* Mysql uses MYSQL_SERVER_VERSION */
+#elif defined                  LIBMYSQL_VERSION
+#define EXIM_MxSQL_VERSION_STR LIBMYSQL_VERSION
+#elif defined                  MYSQL_SERVER_VERSION
+#define EXIM_MxSQL_VERSION_STR MYSQL_SERVER_VERSION
+
+#else
+#define EXIM_MxSQL_VERSION_STR  "unknown"
+#endif
+
+#if defined                 MARIADB_BASE_VERSION
+#define EXIM_MxSQL_BASE_STR MARIADB_BASE_VERSION
+
+#elif defined               MARIADB_PACKAGE_VERSION
+#define EXIM_MxSQL_BASE_STR "mariadb"
+
+#elif defined               MYSQL_BASE_VERSION
+#define EXIM_MxSQL_BASE_STR MYSQL_BASE_VERSION
+
+#else
+#define EXIM_MxSQL_BASE_STR  "n.A."
+#endif
+

 
 /* Structure and anchor for caching connections. */
 
 
 /* Structure and anchor for caching connections. */
 


@@ -54,7 +101,7 @@ mysql_connection *cn;
 while ((cn = mysql_connections) != NULL)
   {
   mysql_connections = cn->next;
 while ((cn = mysql_connections) != NULL)
   {
   mysql_connections = cn->next;

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

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


@@ -93,11 +140,9 @@ MYSQL_ROW mysql_row_data;
 MYSQL_FIELD *fields;
 
 int i;
 MYSQL_FIELD *fields;
 
 int i;

-int ssize = 0;
-int offset = 0;

 int yield = DEFER;
 unsigned int num_fields;
 int yield = DEFER;
 unsigned int num_fields;

-uschar *result = NULL;
+gstring * result = NULL;

 mysql_connection *cn;
 uschar *server_copy = NULL;
 uschar *sdata[4];
 mysql_connection *cn;
 uschar *server_copy = NULL;
 uschar *sdata[4];


@@ -107,7 +152,7 @@ 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 = 3; i > 0; i--)
+for (int i = 3; i > 0; i--)

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


@@ -182,12 +227,12 @@ if (!cn)
   if (sdata[1][0] == 0) sdata[1] = NULL;
 
   DEBUG(D_lookup)
   if (sdata[1][0] == 0) sdata[1] = NULL;
 
   DEBUG(D_lookup)

-    debug_printf("MYSQL new connection: host=%s port=%d socket=%s "
+    debug_printf_indent("MYSQL new connection: host=%s port=%d socket=%s "

       "database=%s user=%s\n", sdata[0], port, socket, sdata[1], sdata[2]);
 
   /* Get store for a new handle, initialize it, and connect to the server */
 
       "database=%s user=%s\n", sdata[0], port, socket, sdata[1], sdata[2]);
 
   /* Get store for a new handle, initialize it, and connect to the server */
 

-  mysql_handle = store_get(sizeof(MYSQL));
+  mysql_handle = store_get(sizeof(MYSQL), FALSE);

   mysql_init(mysql_handle);
   mysql_options(mysql_handle, MYSQL_READ_DEFAULT_GROUP, CS group);
   if (mysql_real_connect(mysql_handle,
   mysql_init(mysql_handle);
   mysql_options(mysql_handle, MYSQL_READ_DEFAULT_GROUP, CS group);
   if (mysql_real_connect(mysql_handle,


@@ -203,7 +248,7 @@ if (!cn)
 
   /* Add the connection to the cache */
 
 
   /* Add the connection to the cache */
 

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

   cn->server = server_copy;
   cn->handle = mysql_handle;
   cn->next = mysql_connections;
   cn->server = server_copy;
   cn->handle = mysql_handle;
   cn->next = mysql_connections;


@@ -215,7 +260,7 @@ if (!cn)
 else
   {
   DEBUG(D_lookup)
 else
   {
   DEBUG(D_lookup)

-    debug_printf("MYSQL using cached connection for %s\n", server_copy);
+    debug_printf_indent("MYSQL using cached connection for %s\n", server_copy);

   }
 
 /* Run the query */
   }
 
 /* Run the query */


@@ -236,12 +281,13 @@ we return the number of rows affected by the command. In this event, we do NOT
 want to cache the result; also the whole cache for the handle must be cleaned
 up. Setting do_cache zero requests this. */
 
 want to cache the result; also the whole cache for the handle must be cleaned
 up. Setting do_cache zero requests this. */
 

-if ((mysql_result = mysql_use_result(mysql_handle)) == NULL)
+if (!(mysql_result = mysql_use_result(mysql_handle)))

   {
   if ( mysql_field_count(mysql_handle) == 0 )
     {
   {
   if ( mysql_field_count(mysql_handle) == 0 )
     {

-    DEBUG(D_lookup) debug_printf("MYSQL: query was not one that returns data\n");
-    result = string_sprintf("%d", mysql_affected_rows(mysql_handle));
+    DEBUG(D_lookup) debug_printf_indent("MYSQL: query was not one that returns data\n");
+    result = string_cat(result,
+              string_sprintf("%d", mysql_affected_rows(mysql_handle)));

     *do_cache = 0;
     goto MYSQL_EXIT;
     }
     *do_cache = 0;
     goto MYSQL_EXIT;
     }


@@ -261,56 +307,49 @@ row, we insert '\n' between them. */
 
 fields = mysql_fetch_fields(mysql_result);
 
 
 fields = mysql_fetch_fields(mysql_result);
 

-while ((mysql_row_data = mysql_fetch_row(mysql_result)) != NULL)
+while ((mysql_row_data = mysql_fetch_row(mysql_result)))

   {
   unsigned long *lengths = mysql_fetch_lengths(mysql_result);
 
   {
   unsigned long *lengths = mysql_fetch_lengths(mysql_result);
 

-  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)
-    {
-    if (mysql_row_data[0] != NULL)    /* NULL value yields nothing */
-      result = string_cat(result, &ssize, &offset, US mysql_row_data[0],
-        lengths[0]);
-    }
+  if (num_fields != 1)
+    for (int i = 0; i < num_fields; i++)
+      result = lf_quote(US fields[i].name, US mysql_row_data[i], lengths[i],
+                       result);

 
 

-  else for (i = 0; i < num_fields; i++)
-    {
-    result = lf_quote(US fields[i].name, US mysql_row_data[i], lengths[i],
-      result, &ssize, &offset);
-    }
+  else if (mysql_row_data[0] != NULL)    /* NULL value yields nothing */
+      result = string_catn(result, US mysql_row_data[0], lengths[0]);

   }
 
 /* more results? -1 = no, >0 = error, 0 = yes (keep looping)
    This is needed because of the CLIENT_MULTI_RESULTS on mysql_real_connect(),
    we don't expect any more results. */
 
   }
 
 /* more results? -1 = no, >0 = error, 0 = yes (keep looping)
    This is needed because of the CLIENT_MULTI_RESULTS on mysql_real_connect(),
    we don't expect any more results. */
 

-while((i = mysql_next_result(mysql_handle)) >= 0) {
-   if(i == 0) {   /* Just ignore more results */
-     DEBUG(D_lookup) debug_printf("MYSQL: got unexpected more results\n");
-     continue;
-   }
+while((i = mysql_next_result(mysql_handle)) >= 0)
+  {
+  if(i == 0)   /* Just ignore more results */
+    {
+    DEBUG(D_lookup) debug_printf_indent("MYSQL: got unexpected more results\n");
+    continue;
+    }

 
 

-   *errmsg = string_sprintf("MYSQL: lookup result error when checking for more results: %s\n",
-       mysql_error(mysql_handle));
-   goto MYSQL_EXIT;
-}
+  *errmsg = string_sprintf(
+       "MYSQL: lookup result error when checking for more results: %s\n",
+       mysql_error(mysql_handle));
+  goto MYSQL_EXIT;
+  }

 
 /* 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.
 Otherwise, we must terminate the string which has been built; string_cat()
 always leaves enough room for a terminating zero. */
 

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

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

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

 
 /* Get here by goto from various error checks and from the case where no data
 was read (e.g. an update query). */
 
 /* Get here by goto from various error checks and from the case where no data
 was read (e.g. an update query). */


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

-if (mysql_result != NULL) mysql_free_result(mysql_result);
+if (mysql_result) mysql_free_result(mysql_result);

 
 

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

 
 

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

   {
   {

-  *resultptr = result;
+  *resultptr = string_from_gstring(result);
+  gstring_release_unused(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 */
   }
 }


@@ -392,7 +432,7 @@ while ((c = *t++) != 0)
   if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++;
 
 if (count == 0) return s;
   if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++;
 
 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)
   {


@@ -432,10 +472,10 @@ return quoted;
 void
 mysql_version_report(FILE *f)
 {
 void
 mysql_version_report(FILE *f)
 {

-fprintf(f, "Library version: MySQL: Compile: %s [%s]\n"
-           "                        Runtime: %s\n",
-        MYSQL_SERVER_VERSION, MYSQL_COMPILATION_COMMENT,
-        mysql_get_client_info());
+fprintf(f, "Library version: MySQL: Compile: %lu %s [%s]\n"
+           "                        Runtime: %lu %s\n",
+        (long)EXIM_MxSQL_VERSION_ID, EXIM_MxSQL_VERSION_STR, EXIM_MxSQL_BASE_STR,
+        mysql_get_client_version(), mysql_get_client_info());

 #ifdef DYNLOOKUP
 fprintf(f, "                        Exim version %s\n", EXIM_VERSION_STR);
 #endif
 #ifdef DYNLOOKUP
 fprintf(f, "                        Exim version %s\n", EXIM_VERSION_STR);
 #endif