1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Thanks to Paul Kelly for contributing the original code for these
13 #include "lf_functions.h"
15 #include <mysql.h> /* The system header */
16 #include <mysql_version.h>
19 /* Structure and anchor for caching connections. */
21 typedef struct mysql_connection {
22 struct mysql_connection *next;
27 static mysql_connection *mysql_connections = NULL;
31 /*************************************************
33 *************************************************/
35 /* See local README for interface description. */
38 mysql_open(uschar *filename, uschar **errmsg)
40 return (void *)(1); /* Just return something non-null */
45 /*************************************************
47 *************************************************/
49 /* See local README for interface description. */
55 while ((cn = mysql_connections) != NULL)
57 mysql_connections = cn->next;
58 DEBUG(D_lookup) debug_printf("close MYSQL connection: %s\n", cn->server);
59 mysql_close(cn->handle);
65 /*************************************************
66 * Internal search function *
67 *************************************************/
69 /* This function is called from the find entry point to do the search for a
73 query the query string
74 server the server string
75 resultptr where to store the result
76 errmsg where to point an error message
77 defer_break TRUE if no more servers are to be tried after DEFER
78 do_cache set zero if data is changed
80 The server string is of the form "host/dbname/user/password". The host can be
81 host:port. This string is in a nextinlist temporary buffer, so can be
84 Returns: OK, FAIL, or DEFER
88 perform_mysql_search(const uschar *query, uschar *server, uschar **resultptr,
89 uschar **errmsg, BOOL *defer_break, uint *do_cache)
91 MYSQL *mysql_handle = NULL; /* Keep compilers happy */
92 MYSQL_RES *mysql_result = NULL;
93 MYSQL_ROW mysql_row_data;
100 unsigned int num_fields;
101 uschar *result = NULL;
102 mysql_connection *cn;
103 uschar *server_copy = NULL;
106 /* Disaggregate the parameters from the server argument. The order is host,
107 database, user, password. We can write to the string, since it is in a
108 nextinlist temporary buffer. The copy of the string that is used for caching
109 has the password removed. This copy is also used for debugging output. */
111 for (i = 3; i > 0; i--)
113 uschar *pp = Ustrrchr(server, '/');
116 *errmsg = string_sprintf("incomplete MySQL server data: %s",
117 (i == 3)? server : server_copy);
123 if (i == 3) server_copy = string_copy(server); /* sans password */
125 sdata[0] = server; /* What's left at the start */
127 /* See if we have a cached connection to the server */
129 for (cn = mysql_connections; cn; cn = cn->next)
130 if (Ustrcmp(cn->server, server_copy) == 0)
132 mysql_handle = cn->handle;
136 /* If no cached connection, we must set one up. Mysql allows for a host name
137 and port to be specified. It also allows the name of a Unix socket to be used.
138 Unfortunately, this contains slashes, but its use is expected to be rare, so
139 the rather cumbersome syntax shouldn't inconvenience too many people. We use
140 this: host:port(socket)[group] where all the parts are optional.
141 The "group" parameter specifies an option group from a MySQL option file. */
146 uschar *socket = NULL;
148 uschar *group = US"exim";
150 if ((p = Ustrchr(sdata[0], '[')))
154 while (*p && *p != ']') p++;
158 if ((p = Ustrchr(sdata[0], '(')))
162 while (*p && *p != ')') p++;
166 if ((p = Ustrchr(sdata[0], ':')))
172 if (Ustrchr(sdata[0], '/'))
174 *errmsg = string_sprintf("unexpected slash in MySQL server hostname: %s",
180 /* If the database is the empty string, set it NULL - the query must then
183 if (sdata[1][0] == 0) sdata[1] = NULL;
186 debug_printf("MYSQL new connection: host=%s port=%d socket=%s "
187 "database=%s user=%s\n", sdata[0], port, socket, sdata[1], sdata[2]);
189 /* Get store for a new handle, initialize it, and connect to the server */
191 mysql_handle = store_get(sizeof(MYSQL));
192 mysql_init(mysql_handle);
193 mysql_options(mysql_handle, MYSQL_READ_DEFAULT_GROUP, CS group);
194 if (mysql_real_connect(mysql_handle,
195 /* host user passwd database */
196 CS sdata[0], CS sdata[2], CS sdata[3], CS sdata[1],
197 port, CS socket, CLIENT_MULTI_RESULTS) == NULL)
199 *errmsg = string_sprintf("MYSQL connection failed: %s",
200 mysql_error(mysql_handle));
201 *defer_break = FALSE;
205 /* Add the connection to the cache */
207 cn = store_get(sizeof(mysql_connection));
208 cn->server = server_copy;
209 cn->handle = mysql_handle;
210 cn->next = mysql_connections;
211 mysql_connections = cn;
214 /* Else use a previously cached connection */
219 debug_printf("MYSQL using cached connection for %s\n", server_copy);
224 if (mysql_query(mysql_handle, CS query) != 0)
226 *errmsg = string_sprintf("MYSQL: query failed: %s\n",
227 mysql_error(mysql_handle));
228 *defer_break = FALSE;
232 /* Pick up the result. If the query was not of the type that returns data,
233 namely INSERT, UPDATE, or DELETE, an error occurs here. However, this situation
234 can be detected by calling mysql_field_count(). If its result is zero, no data
235 was expected (this is all explained clearly in the MySQL manual). In this case,
236 we return the number of rows affected by the command. In this event, we do NOT
237 want to cache the result; also the whole cache for the handle must be cleaned
238 up. Setting do_cache zero requests this. */
240 if ((mysql_result = mysql_use_result(mysql_handle)) == NULL)
242 if ( mysql_field_count(mysql_handle) == 0 )
244 DEBUG(D_lookup) debug_printf("MYSQL: query was not one that returns data\n");
245 result = string_sprintf("%d", mysql_affected_rows(mysql_handle));
249 *errmsg = string_sprintf("MYSQL: lookup result failed: %s\n",
250 mysql_error(mysql_handle));
251 *defer_break = FALSE;
255 /* Find the number of fields returned. If this is one, we don't add field
256 names to the data. Otherwise we do. */
258 num_fields = mysql_num_fields(mysql_result);
260 /* Get the fields and construct the result string. If there is more than one
261 row, we insert '\n' between them. */
263 fields = mysql_fetch_fields(mysql_result);
265 while ((mysql_row_data = mysql_fetch_row(mysql_result)) != NULL)
267 unsigned long *lengths = mysql_fetch_lengths(mysql_result);
270 result = string_catn(result, &ssize, &offset, US"\n", 1);
274 if (mysql_row_data[0] != NULL) /* NULL value yields nothing */
275 result = string_catn(result, &ssize, &offset, US mysql_row_data[0],
279 else for (i = 0; i < num_fields; i++)
281 result = lf_quote(US fields[i].name, US mysql_row_data[i], lengths[i],
282 result, &ssize, &offset);
286 /* more results? -1 = no, >0 = error, 0 = yes (keep looping)
287 This is needed because of the CLIENT_MULTI_RESULTS on mysql_real_connect(),
288 we don't expect any more results. */
290 while((i = mysql_next_result(mysql_handle)) >= 0) {
291 if(i == 0) { /* Just ignore more results */
292 DEBUG(D_lookup) debug_printf("MYSQL: got unexpected more results\n");
296 *errmsg = string_sprintf("MYSQL: lookup result error when checking for more results: %s\n",
297 mysql_error(mysql_handle));
301 /* If result is NULL then no data has been found and so we return FAIL.
302 Otherwise, we must terminate the string which has been built; string_cat()
303 always leaves enough room for a terminating zero. */
308 *errmsg = US"MYSQL: no data found";
313 store_reset(result + offset + 1);
316 /* Get here by goto from various error checks and from the case where no data
317 was read (e.g. an update query). */
321 /* Free mysal store for any result that was got; don't close the connection, as
324 if (mysql_result != NULL) mysql_free_result(mysql_result);
326 /* Non-NULL result indicates a successful result */
335 DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
336 return yield; /* FAIL or DEFER */
343 /*************************************************
345 *************************************************/
347 /* See local README for interface description. The handle and filename
348 arguments are not used. The code to loop through a list of servers while the
349 query is deferred with a retryable error is now in a separate function that is
350 shared with other SQL lookups. */
353 mysql_find(void *handle, uschar *filename, const uschar *query, int length,
354 uschar **result, uschar **errmsg, uint *do_cache)
356 return lf_sqlperform(US"MySQL", US"mysql_servers", mysql_servers, query,
357 result, errmsg, do_cache, perform_mysql_search);
362 /*************************************************
363 * Quote entry point *
364 *************************************************/
366 /* The only characters that need to be quoted (with backslash) are newline,
367 tab, carriage return, backspace, backslash itself, and the quote characters.
368 Percent, and underscore and not escaped. They are only special in contexts
369 where they can be wild cards, and this isn't usually the case for data inserted
370 from messages, since that isn't likely to be treated as a pattern of any kind.
371 Sadly, MySQL doesn't seem to behave like other programs. If you use something
372 like "where id="ab\%cd" it does not treat the string as "ab%cd". So you really
373 can't quote "on spec".
376 s the string to be quoted
377 opt additional option text or NULL if none
379 Returns: the processed string or NULL for a bad option
383 mysql_quote(uschar *s, uschar *opt)
390 if (opt != NULL) return NULL; /* No options recognized */
392 while ((c = *t++) != 0)
393 if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++;
395 if (count == 0) return s;
396 t = quoted = store_get(Ustrlen(s) + count + 1);
398 while ((c = *s++) != 0)
400 if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL)
405 case '\n': *t++ = 'n';
407 case '\t': *t++ = 't';
409 case '\r': *t++ = 'r';
411 case '\b': *t++ = 'b';
425 /*************************************************
426 * Version reporting entry point *
427 *************************************************/
429 /* See local README for interface description. */
431 #include "../version.h"
434 mysql_version_report(FILE *f)
436 fprintf(f, "Library version: MySQL: Compile: %s [%s]\n"
438 MYSQL_SERVER_VERSION, MYSQL_COMPILATION_COMMENT,
439 mysql_get_client_info());
441 fprintf(f, " Exim version %s\n", EXIM_VERSION_STR);
445 /* These are the lookup_info blocks for this driver */
447 static lookup_info mysql_lookup_info = {
448 US"mysql", /* lookup name */
449 lookup_querystyle, /* query-style lookup */
450 mysql_open, /* open function */
451 NULL, /* no check function */
452 mysql_find, /* find function */
453 NULL, /* no close function */
454 mysql_tidy, /* tidy function */
455 mysql_quote, /* quoting function */
456 mysql_version_report /* version reporting */
460 #define mysql_lookup_module_info _lookup_module_info
463 static lookup_info *_lookup_list[] = { &mysql_lookup_info };
464 lookup_module_info mysql_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 };
466 /* End of lookups/mysql.c */