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 /* 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("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
;
117 ISC_STATUS status
[20], *statusp
= status
;
123 uschar
*result
= NULL
;
124 ibase_connection
*cn
;
125 uschar
*server_copy
= NULL
;
128 /* Disaggregate the parameters from the server argument. The order is host,
129 database, user, password. We can write to the string, since it is in a
130 nextinlist temporary buffer. The copy of the string that is used for caching
131 has the password removed. This copy is also used for debugging output. */
133 for (i
= 2; i
> 0; i
--) {
134 uschar
*pp
= Ustrrchr(server
, '|');
137 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) {
157 /* Use a previously cached connection ? */
160 static char db_info_options
[] = { isc_info_base_level
};
162 /* test if the connection is alive */
163 if (isc_database_info
164 (status
, &cn
->dbh
, sizeof(db_info_options
), db_info_options
,
165 sizeof(buffer
), buffer
)) {
166 /* error occurred: assume connection is down */
169 ("Interbase cleaning up cached connection: %s\n",
171 isc_detach_database(status
, &cn
->dbh
);
174 debug_printf("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 (p
= sdata
[1]; *p
;)
204 *dpb
++ = isc_dpb_password
;
205 *dpb
++ = strlen(sdata
[2]);
206 for (p
= sdata
[2]; *p
;)
208 dpb_length
= dpb
- buffer
;
211 debug_printf("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
)) {
217 isc_interprete(buffer
, &statusp
);
219 string_sprintf("Interbase attach() failed: %s", buffer
);
220 *defer_break
= FALSE
;
224 /* Now start a read-only read-committed transaction */
225 if (isc_start_transaction
226 (status
, &cn
->transh
, 1, &cn
->dbh
, sizeof(trans_options
),
228 isc_interprete(buffer
, &statusp
);
229 isc_detach_database(status
, &cn
->dbh
);
231 string_sprintf("Interbase start_transaction() failed: %s",
233 *defer_break
= FALSE
;
239 if (isc_dsql_allocate_statement(status
, &cn
->dbh
, &stmth
)) {
240 isc_interprete(buffer
, &statusp
);
242 string_sprintf("Interbase alloc_statement() failed: %s",
244 *defer_break
= FALSE
;
248 out_sqlda
= store_get(XSQLDA_LENGTH(1));
249 out_sqlda
->version
= SQLDA_VERSION1
;
253 (status
, &cn
->transh
, &stmth
, 0, query
, 1, out_sqlda
)) {
254 isc_interprete(buffer
, &statusp
);
255 store_reset(out_sqlda
);
258 string_sprintf("Interbase prepare_statement() failed: %s",
260 *defer_break
= FALSE
;
264 /* re-allocate the output structure if there's more than one field */
265 if (out_sqlda
->sqln
< out_sqlda
->sqld
) {
266 XSQLDA
*new_sqlda
= store_get(XSQLDA_LENGTH(out_sqlda
->sqld
));
267 if (isc_dsql_describe
268 (status
, &stmth
, out_sqlda
->version
, new_sqlda
)) {
269 isc_interprete(buffer
, &statusp
);
270 isc_dsql_free_statement(status
, &stmth
, DSQL_drop
);
271 store_reset(out_sqlda
);
274 string_sprintf("Interbase describe_statement() failed: %s",
276 *defer_break
= FALSE
;
279 out_sqlda
= new_sqlda
;
282 /* allocate storage for every returned field */
283 for (i
= 0, var
= out_sqlda
->sqlvar
; i
< out_sqlda
->sqld
; i
++, var
++) {
284 switch (var
->sqltype
& ~1) {
287 (char *) store_get(sizeof(char) * var
->sqllen
+ 2);
291 (char *) store_get(sizeof(char) * var
->sqllen
);
294 var
->sqldata
= (char *) store_get(sizeof(short));
297 var
->sqldata
= (char *) store_get(sizeof(ISC_LONG
));
301 var
->sqldata
= (char *) store_get(sizeof(ISC_INT64
));
305 var
->sqldata
= (char *) store_get(sizeof(float));
308 var
->sqldata
= (char *) store_get(sizeof(double));
312 var
->sqldata
= (char *) store_get(sizeof(ISC_QUAD
));
316 var
->sqldata
= (char *) store_get(sizeof(ISC_TIMESTAMP
));
319 var
->sqldata
= (char *) store_get(sizeof(ISC_DATE
));
322 var
->sqldata
= (char *) store_get(sizeof(ISC_TIME
));
326 if (var
->sqltype
& 1) {
327 var
->sqlind
= (short *) store_get(sizeof(short));
331 /* finally, we're ready to execute the statement */
333 (status
, &cn
->transh
, &stmth
, out_sqlda
->version
, NULL
)) {
334 isc_interprete(buffer
, &statusp
);
336 string_sprintf("Interbase describe_statement() failed: %s",
338 isc_dsql_free_statement(status
, &stmth
, DSQL_drop
);
339 *defer_break
= FALSE
;
343 while (isc_dsql_fetch(status
, &stmth
, out_sqlda
->version
, out_sqlda
) !=
345 /* check if an error occurred */
346 if (status
[0] & status
[1]) {
347 isc_interprete(buffer
, &statusp
);
349 string_sprintf("Interbase fetch() failed: %s", buffer
);
350 isc_dsql_free_statement(status
, &stmth
, DSQL_drop
);
351 *defer_break
= FALSE
;
356 result
= string_catn(result
, &ssize
, &offset
, US
"\n", 1);
358 /* Find the number of fields returned. If this is one, we don't add field
359 names to the data. Otherwise we do. */
360 if (out_sqlda
->sqld
== 1) {
361 if (out_sqlda
->sqlvar
[0].sqlind
== NULL
|| *out_sqlda
->sqlvar
[0].sqlind
!= -1) /* NULL value yields nothing */
363 string_catn(result
, &ssize
, &offset
, US buffer
,
364 fetch_field(buffer
, sizeof(buffer
),
365 &out_sqlda
->sqlvar
[0]));
369 for (i
= 0; i
< out_sqlda
->sqld
; i
++) {
370 int len
= fetch_field(buffer
, sizeof(buffer
),
371 &out_sqlda
->sqlvar
[i
]);
374 string_cat(result
, &ssize
, &offset
,
375 US out_sqlda
->sqlvar
[i
].aliasname
,
376 out_sqlda
->sqlvar
[i
].aliasname_length
);
377 result
= string_catn(result
, &ssize
, &offset
, US
"=", 1);
379 /* Quote the value if it contains spaces or is empty */
381 if (*out_sqlda
->sqlvar
[i
].sqlind
== -1) { /* NULL value */
383 string_catn(result
, &ssize
, &offset
, US
"\"\"", 2);
386 else if (buffer
[0] == 0 || Ustrchr(buffer
, ' ') != NULL
) {
389 string_catn(result
, &ssize
, &offset
, US
"\"", 1);
390 for (j
= 0; j
< len
; j
++) {
391 if (buffer
[j
] == '\"' || buffer
[j
] == '\\')
393 string_cat(result
, &ssize
, &offset
,
396 string_cat(result
, &ssize
, &offset
,
400 string_catn(result
, &ssize
, &offset
, US
"\"", 1);
403 string_catn(result
, &ssize
, &offset
, US buffer
, len
);
405 result
= string_catn(result
, &ssize
, &offset
, US
" ", 1);
409 /* If result is NULL then no data has been found and so we return FAIL.
410 Otherwise, we must terminate the string which has been built; string_cat()
411 always leaves enough room for a terminating zero. */
413 if (result
== NULL
) {
415 *errmsg
= US
"Interbase: no data found";
418 store_reset(result
+ offset
+ 1);
422 /* Get here by goto from various error checks. */
427 isc_dsql_free_statement(status
, &stmth
, DSQL_drop
);
429 /* Non-NULL result indicates a successful result */
431 if (result
!= NULL
) {
435 DEBUG(D_lookup
) debug_printf("%s\n", *errmsg
);
436 return yield
; /* FAIL or DEFER */
443 /*************************************************
445 *************************************************/
447 /* See local README for interface description. The handle and filename
448 arguments are not used. Loop through a list of servers while the query is
449 deferred with a retryable error. */
452 ibase_find(void *handle
, uschar
* filename
, uschar
* query
, int length
,
453 uschar
** result
, uschar
** errmsg
, uint
*do_cache
)
457 uschar
*list
= ibase_servers
;
460 /* Keep picky compilers happy */
463 DEBUG(D_lookup
) debug_printf("Interbase query: %s\n", query
);
466 string_nextinlist(&list
, &sep
, buffer
,
467 sizeof(buffer
))) != NULL
) {
468 BOOL defer_break
= FALSE
;
469 int rc
= perform_ibase_search(query
, server
, result
, errmsg
,
471 if (rc
!= DEFER
|| defer_break
)
475 if (ibase_servers
== NULL
)
476 *errmsg
= US
"no Interbase servers defined (ibase_servers option)";
483 /*************************************************
484 * Quote entry point *
485 *************************************************/
487 /* The only characters that need to be quoted (with backslash) are newline,
488 tab, carriage return, backspace, backslash itself, and the quote characters.
489 Percent, and underscore and not escaped. They are only special in contexts
490 where they can be wild cards, and this isn't usually the case for data inserted
491 from messages, since that isn't likely to be treated as a pattern of any kind.
492 Sadly, MySQL doesn't seem to behave like other programs. If you use something
493 like "where id="ab\%cd" it does not treat the string as "ab%cd". So you really
494 can't quote "on spec".
497 s the string to be quoted
498 opt additional option text or NULL if none
500 Returns: the processed string or NULL for a bad option
503 static uschar
*ibase_quote(uschar
* s
, uschar
* opt
)
511 return NULL
; /* No options recognized */
513 while ((c
= *t
++) != 0)
514 if (Ustrchr("\n\t\r\b\'\"\\", c
) != NULL
)
519 t
= quoted
= store_get(Ustrlen(s
) + count
+ 1);
521 while ((c
= *s
++) != 0) {
522 if (Ustrchr("'", c
) != NULL
) {
527 case '\n': *t++ = 'n';
529 case '\t': *t++ = 't';
531 case '\r': *t++ = 'r';
533 case '\b': *t++ = 'b';
547 /*************************************************
548 * Version reporting entry point *
549 *************************************************/
551 /* See local README for interface description. */
553 #include "../version.h"
556 ibase_version_report(FILE *f
)
559 fprintf(f
, "Library version: ibase: Exim version %s\n", EXIM_VERSION_STR
);
564 static lookup_info _lookup_info
= {
565 US
"ibase", /* lookup name */
566 lookup_querystyle
, /* query-style lookup */
567 ibase_open
, /* open function */
568 NULL
, /* no check function */
569 ibase_find
, /* find function */
570 NULL
, /* no close function */
571 ibase_tidy
, /* tidy function */
572 ibase_quote
, /* quoting function */
573 ibase_version_report
/* version reporting */
577 #define ibase_lookup_module_info _lookup_module_info
580 static lookup_info
*_lookup_list
[] = { &_lookup_info
};
581 lookup_module_info ibase_lookup_module_info
= { LOOKUP_MODULE_INFO_MAGIC
, _lookup_list
, 1 };
583 /* End of lookups/ibase.c */