1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The code in this module was contributed by Ard Biesheuvel. */
11 #include "lf_functions.h"
13 #include <ibase.h> /* The system header */
15 /* Structure and anchor for caching connections. */
17 typedef struct ibase_connection {
18 struct ibase_connection *next;
24 static ibase_connection *ibase_connections = NULL;
28 /*************************************************
30 *************************************************/
32 /* See local README for interface description. */
34 static void *ibase_open(uschar * filename, uschar ** errmsg)
36 return (void *) (1); /* Just return something non-null */
41 /*************************************************
43 *************************************************/
45 /* See local README for interface description. */
47 static void ibase_tidy(void)
50 ISC_STATUS status[20];
52 while ((cn = ibase_connections) != NULL) {
53 ibase_connections = cn->next;
54 DEBUG(D_lookup) debug_printf_indent("close Interbase connection: %s\n",
56 isc_commit_transaction(status, &cn->transh);
57 isc_detach_database(status, &cn->dbh);
61 static int fetch_field(char *buffer, int buffer_size, XSQLVAR * var)
63 if (buffer_size < var->sqllen)
66 switch (var->sqltype & ~1) {
68 strncpy(buffer, &var->sqldata[2], *(short *) var->sqldata);
69 return *(short *) var->sqldata;
71 strncpy(buffer, var->sqldata, var->sqllen);
74 return sprintf(buffer, "%d", *(short *) var->sqldata);
76 return sprintf(buffer, "%ld", *(ISC_LONG *) var->sqldata);
79 return sprintf(buffer, "%lld", *(ISC_INT64 *) var->sqldata);
87 /*************************************************
88 * Internal search function *
89 *************************************************/
91 /* This function is called from the find entry point to do the search for a
95 query the query string
96 server the server string
97 resultptr where to store the result
98 errmsg where to point an error message
99 defer_break TRUE if no more servers are to be tried after DEFER
101 The server string is of the form "host:dbname|user|password". The host can be
102 host:port. This string is in a nextinlist temporary buffer, so can be
105 Returns: OK, FAIL, or DEFER
109 perform_ibase_search(uschar * query, uschar * server, uschar ** resultptr,
110 uschar ** errmsg, BOOL * defer_break)
112 isc_stmt_handle stmth = NULL;
118 ISC_STATUS status[20], *statusp = status;
122 ibase_connection *cn;
123 uschar *server_copy = NULL;
126 /* Disaggregate the parameters from the server argument. The order is host,
127 database, user, password. We can write to the string, since it is in a
128 nextinlist temporary buffer. The copy of the string that is used for caching
129 has the password removed. This copy is also used for debugging output. */
131 for (int i = 2; i > 0; i--)
133 uschar *pp = Ustrrchr(server, '|');
137 *errmsg = string_sprintf("incomplete Interbase server data: %s",
138 (i == 3) ? server : server_copy);
145 server_copy = string_copy(server); /* sans password */
147 sdata[0] = server; /* What's left at the start */
149 /* See if we have a cached connection to the server */
151 for (cn = ibase_connections; cn != NULL; cn = cn->next)
152 if (Ustrcmp(cn->server, server_copy) == 0)
155 /* Use a previously cached connection ? */
159 static char db_info_options[] = { isc_info_base_level };
161 /* test if the connection is alive */
162 if (isc_database_info(status, &cn->dbh, sizeof(db_info_options),
163 db_info_options, sizeof(buffer), buffer))
165 /* error occurred: assume connection is down */
168 ("Interbase cleaning up cached connection: %s\n",
170 isc_detach_database(status, &cn->dbh);
173 DEBUG(D_lookup) debug_printf_indent("Interbase using cached connection for %s\n",
178 cn = store_get(sizeof(ibase_connection));
179 cn->server = server_copy;
182 cn->next = ibase_connections;
183 ibase_connections = cn;
186 /* If no cached connection, we must set one up. */
188 if (cn->dbh == NULL || cn->transh == NULL)
192 static char trans_options[] =
193 { isc_tpb_version3, isc_tpb_read, isc_tpb_read_committed,
197 /* Construct the database parameter buffer. */
199 *dpb++ = isc_dpb_version1;
200 *dpb++ = isc_dpb_user_name;
201 *dpb++ = strlen(sdata[1]);
202 for (char * p = sdata[1]; *p;)
204 *dpb++ = isc_dpb_password;
205 *dpb++ = strlen(sdata[2]);
206 for (char * p = sdata[2]; *p;)
208 dpb_length = dpb - buffer;
211 debug_printf_indent("new Interbase connection: database=%s user=%s\n",
214 /* Connect to the database */
215 if (isc_attach_database
216 (status, 0, sdata[0], &cn->dbh, dpb_length, buffer))
218 isc_interprete(buffer, &statusp);
220 string_sprintf("Interbase attach() failed: %s", buffer);
221 *defer_break = FALSE;
225 /* Now start a read-only read-committed transaction */
226 if (isc_start_transaction
227 (status, &cn->transh, 1, &cn->dbh, sizeof(trans_options),
230 isc_interprete(buffer, &statusp);
231 isc_detach_database(status, &cn->dbh);
233 string_sprintf("Interbase start_transaction() failed: %s",
235 *defer_break = FALSE;
241 if (isc_dsql_allocate_statement(status, &cn->dbh, &stmth))
243 isc_interprete(buffer, &statusp);
245 string_sprintf("Interbase alloc_statement() failed: %s",
247 *defer_break = FALSE;
251 out_sqlda = store_get(XSQLDA_LENGTH(1));
252 out_sqlda->version = SQLDA_VERSION1;
256 (status, &cn->transh, &stmth, 0, query, 1, out_sqlda))
258 isc_interprete(buffer, &statusp);
259 store_reset(out_sqlda);
262 string_sprintf("Interbase prepare_statement() failed: %s",
264 *defer_break = FALSE;
268 /* re-allocate the output structure if there's more than one field */
269 if (out_sqlda->sqln < out_sqlda->sqld)
271 XSQLDA *new_sqlda = store_get(XSQLDA_LENGTH(out_sqlda->sqld));
272 if (isc_dsql_describe
273 (status, &stmth, out_sqlda->version, new_sqlda))
275 isc_interprete(buffer, &statusp);
276 isc_dsql_free_statement(status, &stmth, DSQL_drop);
277 store_reset(out_sqlda);
279 *errmsg = string_sprintf("Interbase describe_statement() failed: %s",
281 *defer_break = FALSE;
284 out_sqlda = new_sqlda;
287 /* allocate storage for every returned field */
288 for (i = 0, var = out_sqlda->sqlvar; i < out_sqlda->sqld; i++, var++)
290 switch (var->sqltype & ~1)
293 var->sqldata = CS store_get(sizeof(char) * var->sqllen + 2);
296 var->sqldata = CS store_get(sizeof(char) * var->sqllen);
299 var->sqldata = CS store_get(sizeof(short));
302 var->sqldata = CS store_get(sizeof(ISC_LONG));
306 var->sqldata = CS store_get(sizeof(ISC_INT64));
310 var->sqldata = CS store_get(sizeof(float));
313 var->sqldata = CS store_get(sizeof(double));
317 var->sqldata = CS store_get(sizeof(ISC_QUAD));
321 var->sqldata = CS store_get(sizeof(ISC_TIMESTAMP));
324 var->sqldata = CS store_get(sizeof(ISC_DATE));
327 var->sqldata = CS store_get(sizeof(ISC_TIME));
331 if (var->sqltype & 1)
332 var->sqlind = (short *) store_get(sizeof(short));
335 /* finally, we're ready to execute the statement */
337 (status, &cn->transh, &stmth, out_sqlda->version, NULL))
339 isc_interprete(buffer, &statusp);
340 *errmsg = string_sprintf("Interbase describe_statement() failed: %s",
342 isc_dsql_free_statement(status, &stmth, DSQL_drop);
343 *defer_break = FALSE;
347 while (isc_dsql_fetch(status, &stmth, out_sqlda->version, out_sqlda) != 100L)
349 /* check if an error occurred */
350 if (status[0] & status[1])
352 isc_interprete(buffer, &statusp);
354 string_sprintf("Interbase fetch() failed: %s", buffer);
355 isc_dsql_free_statement(status, &stmth, DSQL_drop);
356 *defer_break = FALSE;
361 result = string_catn(result, US "\n", 1);
363 /* Find the number of fields returned. If this is one, we don't add field
364 names to the data. Otherwise we do. */
365 if (out_sqlda->sqld == 1)
367 if (out_sqlda->sqlvar[0].sqlind == NULL || *out_sqlda->sqlvar[0].sqlind != -1) /* NULL value yields nothing */
368 result = string_catn(result, US buffer,
369 fetch_field(buffer, sizeof(buffer),
370 &out_sqlda->sqlvar[0]));
374 for (int i = 0; i < out_sqlda->sqld; i++)
376 int len = fetch_field(buffer, sizeof(buffer), &out_sqlda->sqlvar[i]);
378 result = string_catn(result, US out_sqlda->sqlvar[i].aliasname,
379 out_sqlda->sqlvar[i].aliasname_length);
380 result = string_catn(result, US "=", 1);
382 /* Quote the value if it contains spaces or is empty */
384 if (*out_sqlda->sqlvar[i].sqlind == -1) /* NULL value */
385 result = string_catn(result, US "\"\"", 2);
387 else if (buffer[0] == 0 || Ustrchr(buffer, ' ') != NULL)
389 result = string_catn(result, US "\"", 1);
390 for (int j = 0; j < len; j++)
392 if (buffer[j] == '\"' || buffer[j] == '\\')
393 result = string_cat(result, US "\\", 1);
394 result = string_cat(result, US buffer + j, 1);
396 result = string_catn(result, US "\"", 1);
399 result = string_catn(result, US buffer, len);
400 result = string_catn(result, US " ", 1);
404 /* If result is NULL then no data has been found and so we return FAIL.
405 Otherwise, we must terminate the string which has been built; string_cat()
406 always leaves enough room for a terminating zero. */
411 *errmsg = US "Interbase: no data found";
414 store_reset(result->s + result->ptr + 1);
417 /* Get here by goto from various error checks. */
422 isc_dsql_free_statement(status, &stmth, DSQL_drop);
424 /* Non-NULL result indicates a successful result */
428 *resultptr = string_from_gstring(result);
433 DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);
434 return yield; /* FAIL or DEFER */
441 /*************************************************
443 *************************************************/
445 /* See local README for interface description. The handle and filename
446 arguments are not used. Loop through a list of servers while the query is
447 deferred with a retryable error. */
450 ibase_find(void *handle, uschar * filename, uschar * query, int length,
451 uschar ** result, uschar ** errmsg, uint *do_cache)
455 uschar *list = ibase_servers;
458 /* Keep picky compilers happy */
461 DEBUG(D_lookup) debug_printf_indent("Interbase query: %s\n", query);
464 string_nextinlist(&list, &sep, buffer,
465 sizeof(buffer))) != NULL) {
466 BOOL defer_break = FALSE;
467 int rc = perform_ibase_search(query, server, result, errmsg,
469 if (rc != DEFER || defer_break)
473 if (ibase_servers == NULL)
474 *errmsg = US "no Interbase servers defined (ibase_servers option)";
481 /*************************************************
482 * Quote entry point *
483 *************************************************/
485 /* The only characters that need to be quoted (with backslash) are newline,
486 tab, carriage return, backspace, backslash itself, and the quote characters.
487 Percent, and underscore and not escaped. They are only special in contexts
488 where they can be wild cards, and this isn't usually the case for data inserted
489 from messages, since that isn't likely to be treated as a pattern of any kind.
490 Sadly, MySQL doesn't seem to behave like other programs. If you use something
491 like "where id="ab\%cd" it does not treat the string as "ab%cd". So you really
492 can't quote "on spec".
495 s the string to be quoted
496 opt additional option text or NULL if none
498 Returns: the processed string or NULL for a bad option
501 static uschar *ibase_quote(uschar * s, uschar * opt)
509 return NULL; /* No options recognized */
511 while ((c = *t++) != 0)
512 if (Ustrchr("\n\t\r\b\'\"\\", c) != NULL)
517 t = quoted = store_get(Ustrlen(s) + count + 1);
519 while ((c = *s++) != 0) {
520 if (Ustrchr("'", c) != NULL) {
525 case '\n': *t++ = 'n';
527 case '\t': *t++ = 't';
529 case '\r': *t++ = 'r';
531 case '\b': *t++ = 'b';
545 /*************************************************
546 * Version reporting entry point *
547 *************************************************/
549 /* See local README for interface description. */
551 #include "../version.h"
554 ibase_version_report(FILE *f)
557 fprintf(f, "Library version: ibase: Exim version %s\n", EXIM_VERSION_STR);
562 static lookup_info _lookup_info = {
563 US"ibase", /* lookup name */
564 lookup_querystyle, /* query-style lookup */
565 ibase_open, /* open function */
566 NULL, /* no check function */
567 ibase_find, /* find function */
568 NULL, /* no close function */
569 ibase_tidy, /* tidy function */
570 ibase_quote, /* quoting function */
571 ibase_version_report /* version reporting */
575 #define ibase_lookup_module_info _lookup_module_info
578 static lookup_info *_lookup_list[] = { &_lookup_info };
579 lookup_module_info ibase_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 };
581 /* End of lookups/ibase.c */