Commit | Line | Data |
---|---|---|
0756eb3c PH |
1 | /************************************************* |
2 | * Exim - an Internet mail transport agent * | |
3 | *************************************************/ | |
4 | ||
9242a7e8 | 5 | /* Copyright (c) University of Cambridge 1995 - 2017 */ |
0756eb3c PH |
6 | /* See the file NOTICE for conditions of use and distribution. */ |
7 | ||
8 | /* Thanks to Petr Cech for contributing the original code for these | |
9 | functions. Thanks to Joachim Wieland for the initial patch for the Unix domain | |
10 | socket extension. */ | |
11 | ||
12 | #include "../exim.h" | |
13 | #include "lf_functions.h" | |
0756eb3c PH |
14 | |
15 | #include <libpq-fe.h> /* The system header */ | |
16 | ||
17 | /* Structure and anchor for caching connections. */ | |
18 | ||
19 | typedef struct pgsql_connection { | |
20 | struct pgsql_connection *next; | |
21 | uschar *server; | |
22 | PGconn *handle; | |
23 | } pgsql_connection; | |
24 | ||
25 | static pgsql_connection *pgsql_connections = NULL; | |
26 | ||
27 | ||
28 | ||
29 | /************************************************* | |
30 | * Open entry point * | |
31 | *************************************************/ | |
32 | ||
33 | /* See local README for interface description. */ | |
34 | ||
e6d225ae | 35 | static void * |
0756eb3c PH |
36 | pgsql_open(uschar *filename, uschar **errmsg) |
37 | { | |
38 | return (void *)(1); /* Just return something non-null */ | |
39 | } | |
40 | ||
41 | ||
42 | ||
43 | /************************************************* | |
44 | * Tidy entry point * | |
45 | *************************************************/ | |
46 | ||
47 | /* See local README for interface description. */ | |
48 | ||
e6d225ae | 49 | static void |
0756eb3c PH |
50 | pgsql_tidy(void) |
51 | { | |
52 | pgsql_connection *cn; | |
53 | while ((cn = pgsql_connections) != NULL) | |
54 | { | |
55 | pgsql_connections = cn->next; | |
56 | DEBUG(D_lookup) debug_printf("close PGSQL connection: %s\n", cn->server); | |
57 | PQfinish(cn->handle); | |
58 | } | |
59 | } | |
60 | ||
61 | ||
034d99ab PH |
62 | /************************************************* |
63 | * Notice processor function for pgsql * | |
64 | *************************************************/ | |
65 | ||
66 | /* This function is passed to pgsql below, and called for any PostgreSQL | |
67 | "notices". By default they are written to stderr, which is undesirable. | |
68 | ||
69 | Arguments: | |
70 | arg an opaque user cookie (not used) | |
71 | message the notice | |
72 | ||
73 | Returns: nothing | |
74 | */ | |
75 | ||
76 | static void | |
77 | notice_processor(void *arg, const char *message) | |
78 | { | |
79 | arg = arg; /* Keep compiler happy */ | |
80 | DEBUG(D_lookup) debug_printf("PGSQL: %s\n", message); | |
81 | } | |
82 | ||
83 | ||
0756eb3c PH |
84 | |
85 | /************************************************* | |
86 | * Internal search function * | |
87 | *************************************************/ | |
88 | ||
89 | /* This function is called from the find entry point to do the search for a | |
90 | single server. The server string is of the form "server/dbname/user/password". | |
91 | ||
92 | PostgreSQL supports connections through Unix domain sockets. This is usually | |
93 | faster and costs less cpu time than a TCP/IP connection. However it can only be | |
94 | used if the mail server runs on the same machine as the database server. A | |
95 | configuration line for PostgreSQL via Unix domain sockets looks like this: | |
96 | ||
97 | hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password[:<nextserver>] | |
98 | ||
99 | We enclose the path name in parentheses so that its slashes aren't visually | |
4c04137d | 100 | confused with the delimiters for the other pgsql_server settings. |
0756eb3c PH |
101 | |
102 | For TCP/IP connections, the server is a host name and optional port (with a | |
103 | colon separator). | |
104 | ||
105 | NOTE: | |
106 | 1) All three '/' must be present. | |
107 | 2) If host is omitted the local unix socket is used. | |
108 | ||
109 | Arguments: | |
110 | query the query string | |
111 | server the server string; this is in dynamic memory and can be updated | |
112 | resultptr where to store the result | |
113 | errmsg where to point an error message | |
91ecef39 | 114 | defer_break set TRUE if no more servers are to be tried after DEFER |
0756eb3c PH |
115 | do_cache set FALSE if data is changed |
116 | ||
117 | Returns: OK, FAIL, or DEFER | |
118 | */ | |
119 | ||
120 | static int | |
55414b25 | 121 | perform_pgsql_search(const uschar *query, uschar *server, uschar **resultptr, |
14b3c5bc | 122 | uschar **errmsg, BOOL *defer_break, uint *do_cache) |
0756eb3c PH |
123 | { |
124 | PGconn *pg_conn = NULL; | |
125 | PGresult *pg_result = NULL; | |
126 | ||
127 | int i; | |
acec9514 | 128 | gstring * result = NULL; |
0756eb3c PH |
129 | int yield = DEFER; |
130 | unsigned int num_fields, num_tuples; | |
0756eb3c PH |
131 | pgsql_connection *cn; |
132 | uschar *server_copy = NULL; | |
133 | uschar *sdata[3]; | |
134 | ||
135 | /* Disaggregate the parameters from the server argument. The order is host or | |
136 | path, database, user, password. We can write to the string, since it is in a | |
137 | nextinlist temporary buffer. The copy of the string that is used for caching | |
138 | has the password removed. This copy is also used for debugging output. */ | |
139 | ||
140 | for (i = 2; i >= 0; i--) | |
141 | { | |
142 | uschar *pp = Ustrrchr(server, '/'); | |
8143ff45 | 143 | if (!pp) |
0756eb3c PH |
144 | { |
145 | *errmsg = string_sprintf("incomplete pgSQL server data: %s", | |
146 | (i == 2)? server : server_copy); | |
147 | *defer_break = TRUE; | |
148 | return DEFER; | |
149 | } | |
150 | *pp++ = 0; | |
151 | sdata[i] = pp; | |
152 | if (i == 2) server_copy = string_copy(server); /* sans password */ | |
153 | } | |
154 | ||
155 | /* The total server string has now been truncated so that what is left at the | |
156 | start is the identification of the server (host or path). See if we have a | |
157 | cached connection to the server. */ | |
158 | ||
8143ff45 | 159 | for (cn = pgsql_connections; cn; cn = cn->next) |
0756eb3c PH |
160 | if (Ustrcmp(cn->server, server_copy) == 0) |
161 | { | |
162 | pg_conn = cn->handle; | |
163 | break; | |
164 | } | |
0756eb3c PH |
165 | |
166 | /* If there is no cached connection, we must set one up. */ | |
167 | ||
8143ff45 | 168 | if (!cn) |
0756eb3c PH |
169 | { |
170 | uschar *port = US""; | |
171 | ||
172 | /* For a Unix domain socket connection, the path is in parentheses */ | |
173 | ||
174 | if (*server == '(') | |
175 | { | |
176 | uschar *last_slash, *last_dot, *p; | |
177 | ||
178 | p = ++server; | |
8143ff45 | 179 | while (*p && *p != ')') p++; |
0756eb3c PH |
180 | *p = 0; |
181 | ||
182 | last_slash = Ustrrchr(server, '/'); | |
183 | last_dot = Ustrrchr(server, '.'); | |
184 | ||
185 | DEBUG(D_lookup) debug_printf("PGSQL new connection: socket=%s " | |
186 | "database=%s user=%s\n", server, sdata[0], sdata[1]); | |
187 | ||
188 | /* A valid socket name looks like this: /var/run/postgresql/.s.PGSQL.5432 | |
189 | We have to call PQsetdbLogin with '/var/run/postgresql' as the hostname | |
190 | argument and put '5432' into the port variable. */ | |
191 | ||
8143ff45 | 192 | if (!last_slash || !last_dot) |
0756eb3c | 193 | { |
8143ff45 | 194 | *errmsg = string_sprintf("PGSQL invalid filename for socket: %s", server); |
0756eb3c PH |
195 | *defer_break = TRUE; |
196 | return DEFER; | |
197 | } | |
198 | ||
199 | /* Terminate the path name and set up the port: we'll have something like | |
200 | server = "/var/run/postgresql" and port = "5432". */ | |
201 | ||
202 | *last_slash = 0; | |
203 | port = last_dot + 1; | |
204 | } | |
205 | ||
206 | /* Host connection; sort out the port */ | |
207 | ||
208 | else | |
209 | { | |
210 | uschar *p; | |
8143ff45 | 211 | if ((p = Ustrchr(server, ':'))) |
0756eb3c PH |
212 | { |
213 | *p++ = 0; | |
214 | port = p; | |
215 | } | |
216 | ||
8143ff45 | 217 | if (Ustrchr(server, '/')) |
0756eb3c PH |
218 | { |
219 | *errmsg = string_sprintf("unexpected slash in pgSQL server hostname: %s", | |
220 | server); | |
221 | *defer_break = TRUE; | |
222 | return DEFER; | |
223 | } | |
224 | ||
225 | DEBUG(D_lookup) debug_printf("PGSQL new connection: host=%s port=%s " | |
226 | "database=%s user=%s\n", server, port, sdata[0], sdata[1]); | |
227 | } | |
228 | ||
229 | /* If the database is the empty string, set it NULL - the query must then | |
230 | define it. */ | |
231 | ||
232 | if (sdata[0][0] == 0) sdata[0] = NULL; | |
233 | ||
234 | /* Get store for a new handle, initialize it, and connect to the server */ | |
235 | ||
236 | pg_conn=PQsetdbLogin( | |
237 | /* host port options tty database user passwd */ | |
238 | CS server, CS port, NULL, NULL, CS sdata[0], CS sdata[1], CS sdata[2]); | |
239 | ||
240 | if(PQstatus(pg_conn) == CONNECTION_BAD) | |
241 | { | |
242 | store_reset(server_copy); | |
243 | *errmsg = string_sprintf("PGSQL connection failed: %s", | |
244 | PQerrorMessage(pg_conn)); | |
245 | PQfinish(pg_conn); | |
0756eb3c PH |
246 | goto PGSQL_EXIT; |
247 | } | |
248 | ||
16282d2b PH |
249 | /* Set the client encoding to SQL_ASCII, which means that the server will |
250 | not try to interpret the query as being in any fancy encoding such as UTF-8 | |
251 | or other multibyte code that might cause problems with escaping. */ | |
252 | ||
253 | PQsetClientEncoding(pg_conn, "SQL_ASCII"); | |
254 | ||
034d99ab PH |
255 | /* Set the notice processor to prevent notices from being written to stderr |
256 | (which is what the default does). Our function (above) just produces debug | |
257 | output. */ | |
258 | ||
259 | PQsetNoticeProcessor(pg_conn, notice_processor, NULL); | |
260 | ||
0756eb3c PH |
261 | /* Add the connection to the cache */ |
262 | ||
263 | cn = store_get(sizeof(pgsql_connection)); | |
264 | cn->server = server_copy; | |
265 | cn->handle = pg_conn; | |
266 | cn->next = pgsql_connections; | |
267 | pgsql_connections = cn; | |
268 | } | |
269 | ||
270 | /* Else use a previously cached connection */ | |
271 | ||
272 | else | |
273 | { | |
274 | DEBUG(D_lookup) debug_printf("PGSQL using cached connection for %s\n", | |
275 | server_copy); | |
276 | } | |
277 | ||
278 | /* Run the query */ | |
279 | ||
8143ff45 JH |
280 | pg_result = PQexec(pg_conn, CS query); |
281 | switch(PQresultStatus(pg_result)) | |
282 | { | |
283 | case PGRES_EMPTY_QUERY: | |
284 | case PGRES_COMMAND_OK: | |
285 | /* The command was successful but did not return any data since it was | |
286 | not SELECT but either an INSERT, UPDATE or DELETE statement. Tell the | |
287 | high level code to not cache this query, and clean the current cache for | |
288 | this handle by setting *do_cache zero. */ | |
289 | ||
290 | result = string_cat(result, US PQcmdTuples(pg_result)); | |
291 | *do_cache = 0; | |
292 | DEBUG(D_lookup) debug_printf("PGSQL: command does not return any data " | |
293 | "but was successful. Rows affected: %s\n", string_from_gstring(result)); | |
294 | break; | |
295 | ||
296 | case PGRES_TUPLES_OK: | |
297 | break; | |
298 | ||
299 | default: | |
300 | /* This was the original code: | |
301 | *errmsg = string_sprintf("PGSQL: query failed: %s\n", | |
302 | PQresultErrorMessage(pg_result)); | |
303 | This was suggested by a user: | |
304 | */ | |
305 | ||
306 | *errmsg = string_sprintf("PGSQL: query failed: %s (%s) (%s)\n", | |
307 | PQresultErrorMessage(pg_result), | |
308 | PQresStatus(PQresultStatus(pg_result)), query); | |
309 | goto PGSQL_EXIT; | |
310 | } | |
0756eb3c PH |
311 | |
312 | /* Result is in pg_result. Find the number of fields returned. If this is one, | |
313 | we don't add field names to the data. Otherwise we do. If the query did not | |
314 | return anything we skip the for loop; this also applies to the case | |
315 | PGRES_COMMAND_OK. */ | |
316 | ||
317 | num_fields = PQnfields(pg_result); | |
318 | num_tuples = PQntuples(pg_result); | |
319 | ||
320 | /* Get the fields and construct the result string. If there is more than one | |
321 | row, we insert '\n' between them. */ | |
322 | ||
323 | for (i = 0; i < num_tuples; i++) | |
324 | { | |
acec9514 JH |
325 | if (result) |
326 | result = string_catn(result, US"\n", 1); | |
0756eb3c | 327 | |
acec9514 | 328 | if (num_fields == 1) |
8143ff45 | 329 | result = string_catn(result, |
acec9514 JH |
330 | US PQgetvalue(pg_result, i, 0), PQgetlength(pg_result, i, 0)); |
331 | else | |
0756eb3c PH |
332 | { |
333 | int j; | |
334 | for (j = 0; j < num_fields; j++) | |
335 | { | |
336 | uschar *tmp = US PQgetvalue(pg_result, i, j); | |
acec9514 | 337 | result = lf_quote(US PQfname(pg_result, j), tmp, Ustrlen(tmp), result); |
0756eb3c PH |
338 | } |
339 | } | |
340 | } | |
341 | ||
8143ff45 | 342 | /* If result is NULL then no data has been found and so we return FAIL. */ |
0756eb3c | 343 | |
acec9514 | 344 | if (!result) |
0756eb3c PH |
345 | { |
346 | yield = FAIL; | |
347 | *errmsg = US"PGSQL: no data found"; | |
348 | } | |
0756eb3c PH |
349 | |
350 | /* Get here by goto from various error checks. */ | |
351 | ||
352 | PGSQL_EXIT: | |
353 | ||
354 | /* Free store for any result that was got; don't close the connection, as | |
355 | it is cached. */ | |
356 | ||
acec9514 | 357 | if (pg_result) PQclear(pg_result); |
0756eb3c | 358 | |
4c04137d | 359 | /* Non-NULL result indicates a successful result */ |
0756eb3c | 360 | |
acec9514 | 361 | if (result) |
0756eb3c | 362 | { |
8143ff45 | 363 | store_reset(result->s + result->ptr + 1); |
acec9514 | 364 | *resultptr = string_from_gstring(result); |
0756eb3c PH |
365 | return OK; |
366 | } | |
367 | else | |
368 | { | |
369 | DEBUG(D_lookup) debug_printf("%s\n", *errmsg); | |
370 | return yield; /* FAIL or DEFER */ | |
371 | } | |
372 | } | |
373 | ||
374 | ||
375 | ||
376 | ||
377 | /************************************************* | |
378 | * Find entry point * | |
379 | *************************************************/ | |
380 | ||
381 | /* See local README for interface description. The handle and filename | |
b7670459 PH |
382 | arguments are not used. The code to loop through a list of servers while the |
383 | query is deferred with a retryable error is now in a separate function that is | |
384 | shared with other SQL lookups. */ | |
0756eb3c | 385 | |
e6d225ae | 386 | static int |
55414b25 | 387 | pgsql_find(void *handle, uschar *filename, const uschar *query, int length, |
14b3c5bc | 388 | uschar **result, uschar **errmsg, uint *do_cache) |
0756eb3c | 389 | { |
b7670459 PH |
390 | return lf_sqlperform(US"PostgreSQL", US"pgsql_servers", pgsql_servers, query, |
391 | result, errmsg, do_cache, perform_pgsql_search); | |
0756eb3c PH |
392 | } |
393 | ||
394 | ||
395 | ||
396 | /************************************************* | |
397 | * Quote entry point * | |
398 | *************************************************/ | |
399 | ||
400 | /* The characters that always need to be quoted (with backslash) are newline, | |
401 | tab, carriage return, backspace, backslash itself, and the quote characters. | |
0756eb3c | 402 | |
5547e2c5 PH |
403 | The original code quoted single quotes as \' which is documented as valid in |
404 | the O'Reilly book "Practical PostgreSQL" (first edition) as an alternative to | |
405 | the SQL standard '' way of representing a single quote as data. However, in | |
406 | June 2006 there was some security issue with using \' and so this has been | |
407 | changed. | |
408 | ||
409 | [Note: There is a function called PQescapeStringConn() that quotes strings. | |
410 | This cannot be used because it needs a PGconn argument (the connection handle). | |
411 | Why, I don't know. Seems odd for just string escaping...] | |
412 | ||
0756eb3c PH |
413 | Arguments: |
414 | s the string to be quoted | |
415 | opt additional option text or NULL if none | |
416 | ||
417 | Returns: the processed string or NULL for a bad option | |
418 | */ | |
419 | ||
e6d225ae | 420 | static uschar * |
0756eb3c PH |
421 | pgsql_quote(uschar *s, uschar *opt) |
422 | { | |
423 | register int c; | |
424 | int count = 0; | |
425 | uschar *t = s; | |
426 | uschar *quoted; | |
427 | ||
428 | if (opt != NULL) return NULL; /* No options recognized */ | |
429 | ||
430 | while ((c = *t++) != 0) | |
376d2ec0 | 431 | if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL) count++; |
0756eb3c PH |
432 | |
433 | if (count == 0) return s; | |
434 | t = quoted = store_get(Ustrlen(s) + count + 1); | |
435 | ||
436 | while ((c = *s++) != 0) | |
437 | { | |
5547e2c5 PH |
438 | if (c == '\'') |
439 | { | |
440 | *t++ = '\''; | |
441 | *t++ = '\''; | |
442 | } | |
376d2ec0 | 443 | else if (Ustrchr("\n\t\r\b\"\\", c) != NULL) |
0756eb3c PH |
444 | { |
445 | *t++ = '\\'; | |
446 | switch(c) | |
447 | { | |
448 | case '\n': *t++ = 'n'; | |
449 | break; | |
450 | case '\t': *t++ = 't'; | |
451 | break; | |
452 | case '\r': *t++ = 'r'; | |
453 | break; | |
454 | case '\b': *t++ = 'b'; | |
455 | break; | |
456 | default: *t++ = c; | |
457 | break; | |
458 | } | |
459 | } | |
460 | else *t++ = c; | |
461 | } | |
462 | ||
463 | *t = 0; | |
464 | return quoted; | |
465 | } | |
466 | ||
6545de78 PP |
467 | |
468 | /************************************************* | |
469 | * Version reporting entry point * | |
470 | *************************************************/ | |
471 | ||
472 | /* See local README for interface description. */ | |
473 | ||
474 | #include "../version.h" | |
475 | ||
476 | void | |
477 | pgsql_version_report(FILE *f) | |
478 | { | |
479 | #ifdef DYNLOOKUP | |
480 | fprintf(f, "Library version: PostgreSQL: Exim version %s\n", EXIM_VERSION_STR); | |
481 | #endif | |
482 | ||
483 | /* Version reporting: there appears to be no available information about | |
484 | the client library in libpq-fe.h; once you have a connection object, you | |
485 | can access the server version and the chosen protocol version, but those | |
486 | aren't really what we want. It might make sense to debug_printf those | |
487 | when the connection is established though? */ | |
488 | } | |
489 | ||
490 | ||
e6d225ae DW |
491 | static lookup_info _lookup_info = { |
492 | US"pgsql", /* lookup name */ | |
493 | lookup_querystyle, /* query-style lookup */ | |
494 | pgsql_open, /* open function */ | |
495 | NULL, /* no check function */ | |
496 | pgsql_find, /* find function */ | |
497 | NULL, /* no close function */ | |
498 | pgsql_tidy, /* tidy function */ | |
6545de78 PP |
499 | pgsql_quote, /* quoting function */ |
500 | pgsql_version_report /* version reporting */ | |
e6d225ae DW |
501 | }; |
502 | ||
503 | #ifdef DYNLOOKUP | |
504 | #define pgsql_lookup_module_info _lookup_module_info | |
505 | #endif | |
506 | ||
507 | static lookup_info *_lookup_list[] = { &_lookup_info }; | |
508 | lookup_module_info pgsql_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 }; | |
0756eb3c PH |
509 | |
510 | /* End of lookups/pgsql.c */ |