src/src/lookups/mysql.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8 /* Thanks to Paul Kelly for contributing the original code for these
   9 functions. */
  10
  11
  12 #include "../exim.h"
  13 #include "lf_functions.h"
  14
  15 #include <mysql.h>       /* The system header */
  16
  17 /* We define symbols for *_VERSION_ID (numeric), *_VERSION_STR (char*)
  18 and *_BASE_STR (char*). It's a bit of guesswork. Especially for mariadb
  19 with versions before 10.2, as they do not define there there specific symbols.
  20 */
  21
  22 /* Newer (>= 10.2) MariaDB */
  23 #if defined                   MARIADB_VERSION_ID
  24 #define EXIM_MxSQL_VERSION_ID MARIADB_VERSION_ID
  25
  26 /* MySQL defines MYSQL_VERSION_ID, and MariaDB does so */
  27 /* https://dev.mysql.com/doc/refman/5.7/en/c-api-server-client-versions.html */
  28 #elif defined                 LIBMYSQL_VERSION_ID
  29 #define EXIM_MxSQL_VERSION_ID LIBMYSQL_VERSION_ID
  30 #elif defined                 MYSQL_VERSION_ID
  31 #define EXIM_MxSQL_VERSION_ID MYSQL_VERSION_ID
  32
  33 #else
  34 #define EXIM_MYSQL_VERSION_ID  0
  35 #endif
  36
  37 /* Newer (>= 10.2) MariaDB */
  38 #ifdef                         MARIADB_CLIENT_VERSION_STR
  39 #define EXIM_MxSQL_VERSION_STR MARIADB_CLIENT_VERSION_STR
  40
  41 /* Mysql uses MYSQL_SERVER_VERSION */
  42 #elif defined                  LIBMYSQL_VERSION
  43 #define EXIM_MxSQL_VERSION_STR LIBMYSQL_VERSION
  44 #elif defined                  MYSQL_SERVER_VERSION
  45 #define EXIM_MxSQL_VERSION_STR MYSQL_SERVER_VERSION
  46
  47 #else
  48 #define EXIM_MxSQL_VERSION_STR  "unknown"
  49 #endif
  50
  51 #if defined                 MARIADB_BASE_VERSION
  52 #define EXIM_MxSQL_BASE_STR MARIADB_BASE_VERSION
  53
  54 #elif defined               MARIADB_PACKAGE_VERSION
  55 #define EXIM_MxSQL_BASE_STR "mariadb"
  56
  57 #elif defined               MYSQL_BASE_VERSION
  58 #define EXIM_MxSQL_BASE_STR MYSQL_BASE_VERSION
  59
  60 #else
  61 #define EXIM_MxSQL_BASE_STR  "n.A."
  62 #endif
  63
  64
  65 /* Structure and anchor for caching connections. */
  66
  67 typedef struct mysql_connection {
  68   struct mysql_connection *next;
  69   uschar  *server;
  70   MYSQL *handle;
  71 } mysql_connection;
  72
  73 static mysql_connection *mysql_connections = NULL;
  74
  75
  76
  77 /*************************************************
  78 *              Open entry point                  *
  79 *************************************************/
  80
  81 /* See local README for interface description. */
  82
  83 static void *
  84 mysql_open(uschar *filename, uschar **errmsg)
  85 {
  86 return (void *)(1);    /* Just return something non-null */
  87 }
  88
  89
  90
  91 /*************************************************
  92 *               Tidy entry point                 *
  93 *************************************************/
  94
  95 /* See local README for interface description. */
  96
  97 static void
  98 mysql_tidy(void)
  99 {
 100 mysql_connection *cn;
 101 while ((cn = mysql_connections) != NULL)
 102   {
 103   mysql_connections = cn->next;
 104   DEBUG(D_lookup) debug_printf("close MYSQL connection: %s\n", cn->server);
 105   mysql_close(cn->handle);
 106   }
 107 }
 108
 109
 110
 111 /*************************************************
 112 *        Internal search function                *
 113 *************************************************/
 114
 115 /* This function is called from the find entry point to do the search for a
 116 single server.
 117
 118 Arguments:
 119   query        the query string
 120   server       the server string
 121   resultptr    where to store the result
 122   errmsg       where to point an error message
 123   defer_break  TRUE if no more servers are to be tried after DEFER
 124   do_cache     set zero if data is changed
 125
 126 The server string is of the form "host/dbname/user/password". The host can be
 127 host:port. This string is in a nextinlist temporary buffer, so can be
 128 overwritten.
 129
 130 Returns:       OK, FAIL, or DEFER
 131 */
 132
 133 static int
 134 perform_mysql_search(const uschar *query, uschar *server, uschar **resultptr,
 135   uschar **errmsg, BOOL *defer_break, uint *do_cache)
 136 {
 137 MYSQL *mysql_handle = NULL;        /* Keep compilers happy */
 138 MYSQL_RES *mysql_result = NULL;
 139 MYSQL_ROW mysql_row_data;
 140 MYSQL_FIELD *fields;
 141
 142 int i;
 143 int yield = DEFER;
 144 unsigned int num_fields;
 145 gstring * result = NULL;
 146 mysql_connection *cn;
 147 uschar *server_copy = NULL;
 148 uschar *sdata[4];
 149
 150 /* Disaggregate the parameters from the server argument. The order is host,
 151 database, user, password. We can write to the string, since it is in a
 152 nextinlist temporary buffer. The copy of the string that is used for caching
 153 has the password removed. This copy is also used for debugging output. */
 154
 155 for (i = 3; i > 0; i--)
 156   {
 157   uschar *pp = Ustrrchr(server, '/');
 158   if (pp == NULL)
 159     {
 160     *errmsg = string_sprintf("incomplete MySQL server data: %s",
 161       (i == 3)? server : server_copy);
 162     *defer_break = TRUE;
 163     return DEFER;
 164     }
 165   *pp++ = 0;
 166   sdata[i] = pp;
 167   if (i == 3) server_copy = string_copy(server);  /* sans password */
 168   }
 169 sdata[0] = server;   /* What's left at the start */
 170
 171 /* See if we have a cached connection to the server */
 172
 173 for (cn = mysql_connections; cn; cn = cn->next)
 174   if (Ustrcmp(cn->server, server_copy) == 0)
 175     {
 176     mysql_handle = cn->handle;
 177     break;
 178     }
 179
 180 /* If no cached connection, we must set one up. Mysql allows for a host name
 181 and port to be specified. It also allows the name of a Unix socket to be used.
 182 Unfortunately, this contains slashes, but its use is expected to be rare, so
 183 the rather cumbersome syntax shouldn't inconvenience too many people. We use
 184 this:  host:port(socket)[group]  where all the parts are optional.
 185 The "group" parameter specifies an option group from a MySQL option file. */
 186
 187 if (!cn)
 188   {
 189   uschar *p;
 190   uschar *socket = NULL;
 191   int port = 0;
 192   uschar *group = US"exim";
 193
 194   if ((p = Ustrchr(sdata[0], '[')))
 195     {
 196     *p++ = 0;
 197     group = p;
 198     while (*p && *p != ']') p++;
 199     *p = 0;
 200     }
 201
 202   if ((p = Ustrchr(sdata[0], '(')))
 203     {
 204     *p++ = 0;
 205     socket = p;
 206     while (*p && *p != ')') p++;
 207     *p = 0;
 208     }
 209
 210   if ((p = Ustrchr(sdata[0], ':')))
 211     {
 212     *p++ = 0;
 213     port = Uatoi(p);
 214     }
 215
 216   if (Ustrchr(sdata[0], '/'))
 217     {
 218     *errmsg = string_sprintf("unexpected slash in MySQL server hostname: %s",
 219       sdata[0]);
 220     *defer_break = TRUE;
 221     return DEFER;
 222     }
 223
 224   /* If the database is the empty string, set it NULL - the query must then
 225   define it. */
 226
 227   if (sdata[1][0] == 0) sdata[1] = NULL;
 228
 229   DEBUG(D_lookup)
 230     debug_printf("MYSQL new connection: host=%s port=%d socket=%s "
 231       "database=%s user=%s\n", sdata[0], port, socket, sdata[1], sdata[2]);
 232
 233   /* Get store for a new handle, initialize it, and connect to the server */
 234
 235   mysql_handle = store_get(sizeof(MYSQL));
 236   mysql_init(mysql_handle);
 237   mysql_options(mysql_handle, MYSQL_READ_DEFAULT_GROUP, CS group);
 238   if (mysql_real_connect(mysql_handle,
 239       /*  host        user         passwd     database */
 240       CS sdata[0], CS sdata[2], CS sdata[3], CS sdata[1],
 241       port, CS socket, CLIENT_MULTI_RESULTS) == NULL)
 242     {
 243     *errmsg = string_sprintf("MYSQL connection failed: %s",
 244       mysql_error(mysql_handle));
 245     *defer_break = FALSE;
 246     goto MYSQL_EXIT;
 247     }
 248
 249   /* Add the connection to the cache */
 250
 251   cn = store_get(sizeof(mysql_connection));
 252   cn->server = server_copy;
 253   cn->handle = mysql_handle;
 254   cn->next = mysql_connections;
 255   mysql_connections = cn;
 256   }
 257
 258 /* Else use a previously cached connection */
 259
 260 else
 261   {
 262   DEBUG(D_lookup)
 263     debug_printf("MYSQL using cached connection for %s\n", server_copy);
 264   }
 265
 266 /* Run the query */
 267
 268 if (mysql_query(mysql_handle, CS query) != 0)
 269   {
 270   *errmsg = string_sprintf("MYSQL: query failed: %s\n",
 271     mysql_error(mysql_handle));
 272   *defer_break = FALSE;
 273   goto MYSQL_EXIT;
 274   }
 275
 276 /* Pick up the result. If the query was not of the type that returns data,
 277 namely INSERT, UPDATE, or DELETE, an error occurs here. However, this situation
 278 can be detected by calling mysql_field_count(). If its result is zero, no data
 279 was expected (this is all explained clearly in the MySQL manual). In this case,
 280 we return the number of rows affected by the command. In this event, we do NOT
 281 want to cache the result; also the whole cache for the handle must be cleaned
 282 up. Setting do_cache zero requests this. */
 283
 284 if (!(mysql_result = mysql_use_result(mysql_handle)))
 285   {
 286   if ( mysql_field_count(mysql_handle) == 0 )
 287     {
 288     DEBUG(D_lookup) debug_printf("MYSQL: query was not one that returns data\n");
 289     result = string_cat(result,
 290                string_sprintf("%d", mysql_affected_rows(mysql_handle)));
 291     *do_cache = 0;
 292     goto MYSQL_EXIT;
 293     }
 294   *errmsg = string_sprintf("MYSQL: lookup result failed: %s\n",
 295     mysql_error(mysql_handle));
 296   *defer_break = FALSE;
 297   goto MYSQL_EXIT;
 298   }
 299
 300 /* Find the number of fields returned. If this is one, we don't add field
 301 names to the data. Otherwise we do. */
 302
 303 num_fields = mysql_num_fields(mysql_result);
 304
 305 /* Get the fields and construct the result string. If there is more than one
 306 row, we insert '\n' between them. */
 307
 308 fields = mysql_fetch_fields(mysql_result);
 309
 310 while ((mysql_row_data = mysql_fetch_row(mysql_result)))
 311   {
 312   unsigned long *lengths = mysql_fetch_lengths(mysql_result);
 313
 314   if (result)
 315     result = string_catn(result, US"\n", 1);
 316
 317   if (num_fields != 1)
 318     for (i = 0; i < num_fields; i++)
 319       result = lf_quote(US fields[i].name, US mysql_row_data[i], lengths[i],
 320                         result);
 321
 322   else if (mysql_row_data[0] != NULL)    /* NULL value yields nothing */
 323       result = string_catn(result, US mysql_row_data[0], lengths[0]);
 324   }
 325
 326 /* more results? -1 = no, >0 = error, 0 = yes (keep looping)
 327    This is needed because of the CLIENT_MULTI_RESULTS on mysql_real_connect(),
 328    we don't expect any more results. */
 329
 330 while((i = mysql_next_result(mysql_handle)) >= 0)
 331   {
 332   if(i == 0)    /* Just ignore more results */
 333     {
 334     DEBUG(D_lookup) debug_printf("MYSQL: got unexpected more results\n");
 335     continue;
 336     }
 337
 338   *errmsg = string_sprintf(
 339         "MYSQL: lookup result error when checking for more results: %s\n",
 340         mysql_error(mysql_handle));
 341   goto MYSQL_EXIT;
 342   }
 343
 344 /* If result is NULL then no data has been found and so we return FAIL.
 345 Otherwise, we must terminate the string which has been built; string_cat()
 346 always leaves enough room for a terminating zero. */
 347
 348 if (!result)
 349   {
 350   yield = FAIL;
 351   *errmsg = US"MYSQL: no data found";
 352   }
 353
 354 /* Get here by goto from various error checks and from the case where no data
 355 was read (e.g. an update query). */
 356
 357 MYSQL_EXIT:
 358
 359 /* Free mysal store for any result that was got; don't close the connection, as
 360 it is cached. */
 361
 362 if (mysql_result) mysql_free_result(mysql_result);
 363
 364 /* Non-NULL result indicates a successful result */
 365
 366 if (result)
 367   {
 368   *resultptr = string_from_gstring(result);
 369   store_reset(result->s + (result->size = result->ptr + 1));
 370   return OK;
 371   }
 372 else
 373   {
 374   DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
 375   return yield;      /* FAIL or DEFER */
 376   }
 377 }
 378
 379
 380
 381
 382 /*************************************************
 383 *               Find entry point                 *
 384 *************************************************/
 385
 386 /* See local README for interface description. The handle and filename
 387 arguments are not used. The code to loop through a list of servers while the
 388 query is deferred with a retryable error is now in a separate function that is
 389 shared with other SQL lookups. */
 390
 391 static int
 392 mysql_find(void *handle, uschar *filename, const uschar *query, int length,
 393   uschar **result, uschar **errmsg, uint *do_cache)
 394 {
 395 return lf_sqlperform(US"MySQL", US"mysql_servers", mysql_servers, query,
 396   result, errmsg, do_cache, perform_mysql_search);
 397 }
 398
 399
 400
 401 /*************************************************
 402 *               Quote entry point                *
 403 *************************************************/
 404
 405 /* The only characters that need to be quoted (with backslash) are newline,
 406 tab, carriage return, backspace, backslash itself, and the quote characters.
 407 Percent, and underscore and not escaped. They are only special in contexts
 408 where they can be wild cards, and this isn't usually the case for data inserted
 409 from messages, since that isn't likely to be treated as a pattern of any kind.
 410 Sadly, MySQL doesn't seem to behave like other programs. If you use something
 411 like "where id="ab\%cd" it does not treat the string as "ab%cd". So you really
 412 can't quote "on spec".
 413
 414 Arguments:
 415   s          the string to be quoted
 416   opt        additional option text or NULL if none
 417
 418 Returns:     the processed string or NULL for a bad option
 419 */
 420
 421 static uschar *
 422 mysql_quote(uschar *s, uschar *opt)
 423 {
 424 register int c;
 425 int count = 0;
 426 uschar *t = s;
 427 uschar *quoted;
 428
 429 if (opt != NULL) return NULL;     /* No options recognized */
 430
 431 while ((c = *t++) != 0)
 432   if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++;
 433
 434 if (count == 0) return s;
 435 t = quoted = store_get(Ustrlen(s) + count + 1);
 436
 437 while ((c = *s++) != 0)
 438   {
 439   if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL)
 440     {
 441     *t++ = '\\';
 442     switch(c)
 443       {
 444       case '\n': *t++ = 'n';
 445       break;
 446       case '\t': *t++ = 't';
 447       break;
 448       case '\r': *t++ = 'r';
 449       break;
 450       case '\b': *t++ = 'b';
 451       break;
 452       default:   *t++ = c;
 453       break;
 454       }
 455     }
 456   else *t++ = c;
 457   }
 458
 459 *t = 0;
 460 return quoted;
 461 }
 462
 463
 464 /*************************************************
 465 *         Version reporting entry point          *
 466 *************************************************/
 467
 468 /* See local README for interface description. */
 469
 470 #include "../version.h"
 471
 472 void
 473 mysql_version_report(FILE *f)
 474 {
 475 fprintf(f, "Library version: MySQL: Compile: %lu %s [%s]\n"
 476            "                        Runtime: %lu %s\n",
 477         (long)EXIM_MxSQL_VERSION_ID, EXIM_MxSQL_VERSION_STR, EXIM_MxSQL_BASE_STR,
 478         mysql_get_client_version(), mysql_get_client_info());
 479 #ifdef DYNLOOKUP
 480 fprintf(f, "                        Exim version %s\n", EXIM_VERSION_STR);
 481 #endif
 482 }
 483
 484 /* These are the lookup_info blocks for this driver */
 485
 486 static lookup_info mysql_lookup_info = {
 487   US"mysql",                     /* lookup name */
 488   lookup_querystyle,             /* query-style lookup */
 489   mysql_open,                    /* open function */
 490   NULL,                          /* no check function */
 491   mysql_find,                    /* find function */
 492   NULL,                          /* no close function */
 493   mysql_tidy,                    /* tidy function */
 494   mysql_quote,                   /* quoting function */
 495   mysql_version_report           /* version reporting */
 496 };
 497
 498 #ifdef DYNLOOKUP
 499 #define mysql_lookup_module_info _lookup_module_info
 500 #endif
 501
 502 static lookup_info *_lookup_list[] = { &mysql_lookup_info };
 503 lookup_module_info mysql_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 };
 504
 505 /* End of lookups/mysql.c */