dsearch: full-path return option
[exim.git] / src / src / search.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
3386088d 5/* Copyright (c) University of Cambridge 1995 - 2015 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* A set of functions to search databases in various formats. An open
9database is represented by a void * value which is returned from a lookup-
10specific "open" function. These are now all held in individual modules in the
11lookups subdirectory and the functions here form a generic interface.
12
13Caching is used to improve performance. Open files are cached until a tidyup
14function is called, and for each file the result of the last lookup is cached.
15However, if too many files are opened, some of those that are not in use have
16to be closed. Those open items that use real files are kept on a LRU chain to
17help with this.
18
19All the data is held in permanent store so as to be independent of the stacking
20pool that is reset from time to time. In fact, we use malloc'd store so that it
21can be freed when the caches are tidied up. It isn't actually clear whether
22this is a benefit or not, to be honest. */
23
24#include "exim.h"
25
26
27/* Tree in which to cache open files until tidyup called. */
28
29static tree_node *search_tree = NULL;
30
31/* Two-way chain of open databases that use real files. This is maintained in
32recently-used order for the purposes of closing the least recently used when
33too many files are open. */
34
35static tree_node *open_top = NULL;
36static tree_node *open_bot = NULL;
37
38/* Count of open databases that use real files */
39
40static int open_filecount = 0;
41
42/* Allow us to reset store used for lookups and lookup caching */
43
f3ebb786 44static rmark search_reset_point = NULL;
059ec3d9
PH
45
46
47
48/*************************************************
49* Validate a plain lookup type name *
50*************************************************/
51
52/* Only those names that are recognized and whose code is included in the
53binary give an OK response. Use a binary chop search now that the list has got
54so long.
55
56Arguments:
57 name lookup type name - not necessarily zero terminated (e.g. dbm*)
58 len length of the name
59
60Returns: +ve => valid lookup name; value is offset in lookup_list
61 -ve => invalid name; message in search_error_message.
62*/
63
64int
55414b25 65search_findtype(const uschar *name, int len)
059ec3d9
PH
66{
67int bot = 0;
68int top = lookup_list_count;
69while (top > bot)
70 {
71 int mid = (top + bot)/2;
e6d225ae 72 int c = Ustrncmp(name, lookup_list[mid]->name, len);
059ec3d9
PH
73
74 /* If c == 0 we have matched the incoming name with the start of the search
75 type name. However, some search types are substrings of others (e.g. nis and
76 nisplus) so we need to check that the lengths are the same. The length of the
77 type name cannot be shorter (else c would not be 0); if it is not equal it
78 must be longer, and in that case, the incoming name comes before the name we
79 are testing. By leaving c == 0 when the lengths are different, and doing a
80 > 0 test below, this all falls out correctly. */
81
e6d225ae 82 if (c == 0 && Ustrlen(lookup_list[mid]->name) == len)
059ec3d9 83 {
e6d225ae 84 if (lookup_list[mid]->find != NULL) return mid;
059ec3d9
PH
85 search_error_message = string_sprintf("lookup type \"%.*s\" is not "
86 "available (not in the binary - check buildtime LOOKUP configuration)",
87 len, name);
88 return -1;
89 }
90
91 if (c > 0) bot = mid + 1; else top = mid;
92 }
93
94search_error_message = string_sprintf("unknown lookup type \"%.*s\"",len,name);
95return -1;
96}
97
98
99
100/*************************************************
101* Validate a full lookup type name *
102*************************************************/
103
104/* This function recognizes the "partial-" prefix and also terminating * and *@
105suffixes.
106
107Arguments:
108 name the full lookup type name
109 ptypeptr where to put the partial type
110 after subtraction of 1024 or 2048:
111 negative => no partial matching
112 non-negative => minimum number of non-wild components
113 ptypeaff where to put a pointer to the affix
114 the affix is within name if supplied therein
115 otherwise it's a literal string
116 afflen the length of the affix
117 starflags where to put the SEARCH_STAR and SEARCH_STARAT flags
67a57a5a 118 opts where to put the options
059ec3d9
PH
119
120Returns: +ve => valid lookup name; value is offset in lookup_list
121 -ve => invalid name; message in search_error_message.
122*/
123
124int
55414b25 125search_findtype_partial(const uschar *name, int *ptypeptr, const uschar **ptypeaff,
67a57a5a 126 int *afflen, int *starflags, const uschar ** opts)
059ec3d9
PH
127{
128int len, stype;
129int pv = -1;
55414b25 130const uschar *ss = name;
67a57a5a 131const uschar * t;
059ec3d9
PH
132
133*starflags = 0;
134*ptypeaff = NULL;
135
136/* Check for a partial matching type. It must start with "partial", optionally
137followed by a sequence of digits. If this is followed by "-", the affix is the
138default "*." string. Otherwise we expect an affix in parentheses. Affixes are a
139limited number of characters, not including parens. */
140
141if (Ustrncmp(name, "partial", 7) == 0)
142 {
143 ss += 7;
144 if (isdigit (*ss))
145 {
146 pv = 0;
147 while (isdigit(*ss)) pv = pv*10 + *ss++ - '0';
148 }
149 else pv = 2; /* Default number of wild components */
150
151 if (*ss == '(')
152 {
153 *ptypeaff = ++ss;
154 while (ispunct(*ss) && *ss != ')') ss++;
155 if (*ss != ')') goto BAD_TYPE;
156 *afflen = ss++ - *ptypeaff;
157 }
158 else if (*ss++ == '-')
159 {
160 *ptypeaff = US "*.";
161 *afflen = 2;
162 }
163 else
164 {
165 BAD_TYPE:
166 search_error_message = string_sprintf("format error in lookup type \"%s\"",
167 name);
168 return -1;
169 }
170 }
171
67a57a5a
JH
172/* Now we are left with a lookup name, possibly followed by * or *@,
173and then by options starting with a "," */
059ec3d9 174
67a57a5a
JH
175len = Ustrlen(ss);
176if ((t = Ustrchr(ss, '*')))
177 {
178 len = t - ss;
179 *starflags |= (t[1] == '@' ? SEARCH_STARAT : SEARCH_STAR);
180 }
181else
182 t = ss;
183
a5dc727a
JH
184if ((t = Ustrchr(t, ',')))
185 {
186 int l = t - ss;
187 if (l < len) len = l;
188 *opts = string_copy(t+1);
189 }
190else
191 * opts = NULL;
059ec3d9
PH
192
193/* Check for the individual search type. Only those that are actually in the
d7837193
PH
194binary are valid. For query-style types, "partial" and default types are
195erroneous. */
059ec3d9
PH
196
197stype = search_findtype(ss, len);
d7837193 198if (stype >= 0 && mac_islookup(stype, lookup_querystyle))
059ec3d9 199 {
d7837193
PH
200 if (pv >= 0)
201 {
202 search_error_message = string_sprintf("\"partial\" is not permitted "
203 "for lookup type \"%s\"", ss);
204 return -1;
205 }
206 if ((*starflags & (SEARCH_STAR|SEARCH_STARAT)) != 0)
207 {
208 search_error_message = string_sprintf("defaults using \"*\" or \"*@\" are "
209 "not permitted for lookup type \"%s\"", ss);
210 return -1;
211 }
059ec3d9
PH
212 }
213
059ec3d9
PH
214*ptypeptr = pv;
215return stype;
216}
217
218
219
220/*************************************************
221* Release cached resources *
222*************************************************/
223
224/* When search_open is called it caches the "file" that it opens in
225search_tree. The name of the tree node is a concatenation of the search type
226with the file name. For query-style lookups, the file name is empty. Real files
227are normally closed only when this tidyup routine is called, typically at the
228end of sections of code where a number of lookups might occur. However, if too
229many files are open simultaneously, some get closed beforehand. They can't be
230removed from the tree. There is also a general tidyup function which is called
231for the lookup driver, if it exists.
232
233First, there is an internal, recursive subroutine.
234
235Argument: a pointer to a search_openfile tree node
236Returns: nothing
237*/
238
239static void
240tidyup_subtree(tree_node *t)
241{
242search_cache *c = (search_cache *)(t->data.ptr);
243if (t->left != NULL) tidyup_subtree(t->left);
244if (t->right != NULL) tidyup_subtree(t->right);
245if (c != NULL &&
246 c->handle != NULL &&
e6d225ae
DW
247 lookup_list[c->search_type]->close != NULL)
248 lookup_list[c->search_type]->close(c->handle);
059ec3d9
PH
249}
250
251
252/* The external entry point
253
254Argument: none
255Returns: nothing
256*/
257
258void
259search_tidyup(void)
260{
059ec3d9
PH
261int old_pool = store_pool;
262
42c7f0b4 263DEBUG(D_lookup) debug_printf_indent("search_tidyup called\n");
059ec3d9
PH
264
265/* Close individually each cached open file. */
266
267store_pool = POOL_SEARCH;
d7978c0f 268if (search_tree)
059ec3d9
PH
269 {
270 tidyup_subtree(search_tree);
271 search_tree = NULL;
272 }
273open_top = open_bot = NULL;
274open_filecount = 0;
275
276/* Call the general tidyup entry for any drivers that have one. */
277
d7978c0f
JH
278for (int i = 0; i < lookup_list_count; i++) if (lookup_list[i]->tidy)
279 (lookup_list[i]->tidy)();
059ec3d9 280
f3ebb786 281if (search_reset_point) search_reset_point = store_reset(search_reset_point);
059ec3d9
PH
282store_pool = old_pool;
283}
284
285
286
287
288/*************************************************
289* Open search database *
290*************************************************/
291
292/* A mode, and lists of owners and groups, are passed over for checking in
293the cases where the database is one or more files. Return NULL, with a message
294pointed to by message, in cases of error.
295
296For search types that use a file or files, check up on the mode after
297opening. It is tempting to do a stat before opening the file, and use it as
298an existence check. However, doing that opens a small security loophole in
299that the status could be changed before the file is opened. Can't quite see
300what problems this might lead to, but you can't be too careful where security
301is concerned. Fstat() on an open file can normally be expected to succeed,
302but there are some NFS states where it does not.
303
304There are two styles of query: (1) in the "single-key+file" style, a single
305key string and a file name are given, for example, for linear searches, DBM
306files, or for NIS. (2) In the "query" style, no "filename" is given; instead
307just a single query string is passed. This applies to multiple-key lookup
308types such as NIS+.
309
310Before opening, scan the tree of cached files to see if this file is already
311open for the correct search type. If so, return the saved handle. If not, put
312the handle in the tree for possible subsequent use. See search_tidyup above for
313closing all the cached files.
314
315A count of open databases which use real files is maintained, and if this
316gets too large, we have to close a cached file. Its entry remains in the tree,
317but is marked closed.
318
319Arguments:
320 filename the name of the file for single-key+file style lookups,
321 NULL for query-style lookups
322 search_type the type of search required
323 modemask if a real single file is used, this specifies mode bits that
324 must not be set; otherwise it is ignored
325 owners if a real single file is used, this specifies the possible
326 owners of the file; otherwise it is ignored
327 owngroups if a real single file is used, this specifies the possible
328 group owners of the file; otherwise it is ignored
329
330Returns: an identifying handle for the open database;
331 this is the pointer to the tree block in the
332 cache of open files; return NULL on open failure, with
333 a message in search_error_message
334*/
335
336void *
d447dbd1
JH
337search_open(const uschar * filename, int search_type, int modemask,
338 uid_t * owners, gid_t * owngroups)
059ec3d9
PH
339{
340void *handle;
341tree_node *t;
342search_cache *c;
e6d225ae 343lookup_info *lk = lookup_list[search_type];
059ec3d9
PH
344uschar keybuffer[256];
345int old_pool = store_pool;
346
54a2a2a9
JH
347if (filename && is_tainted(filename))
348 {
349 log_write(0, LOG_MAIN|LOG_PANIC,
350 "Tainted filename for search: '%s'", filename);
351 return NULL;
352 }
353
059ec3d9
PH
354/* Change to the search store pool and remember our reset point */
355
356store_pool = POOL_SEARCH;
f3ebb786 357if (!search_reset_point) search_reset_point = store_mark();
059ec3d9 358
42c7f0b4
JH
359DEBUG(D_lookup) debug_printf_indent("search_open: %s \"%s\"\n", lk->name,
360 filename ? filename : US"NULL");
059ec3d9
PH
361
362/* See if we already have this open for this type of search, and if so,
363pass back the tree block as the handle. The key for the tree node is the search
364type plus '0' concatenated with the file name. There may be entries in the tree
365with closed files if a lot of files have been opened. */
366
367sprintf(CS keybuffer, "%c%.254s", search_type + '0',
df04890c 368 filename ? filename : US"");
059ec3d9 369
df04890c 370if ((t = tree_search(search_tree, keybuffer)))
059ec3d9 371 {
54a2a2a9 372 if ((c = (search_cache *)t->data.ptr)->handle)
059ec3d9 373 {
42c7f0b4 374 DEBUG(D_lookup) debug_printf_indent(" cached open\n");
059ec3d9
PH
375 store_pool = old_pool;
376 return t;
377 }
42c7f0b4 378 DEBUG(D_lookup) debug_printf_indent(" cached closed\n");
059ec3d9
PH
379 }
380
381/* Otherwise, we need to open the file or database - each search type has its
382own code, which is now split off into separately compiled modules. Before doing
383this, if the search type is one that uses real files, check on the number that
384we are holding open in the cache. If the limit is reached, close the least
385recently used one. */
386
387if (lk->type == lookup_absfile && open_filecount >= lookup_open_max)
df04890c 388 if (!open_bot)
059ec3d9
PH
389 log_write(0, LOG_MAIN|LOG_PANIC, "too many lookups open, but can't find "
390 "one to close");
391 else
392 {
393 search_cache *c = (search_cache *)(open_bot->data.ptr);
42c7f0b4 394 DEBUG(D_lookup) debug_printf_indent("Too many lookup files open\n closing %s\n",
059ec3d9 395 open_bot->name);
df04890c 396 if ((open_bot = c->up))
059ec3d9
PH
397 ((search_cache *)(open_bot->data.ptr))->down = NULL;
398 else
399 open_top = NULL;
e6d225ae 400 ((lookup_list[c->search_type])->close)(c->handle);
059ec3d9
PH
401 c->handle = NULL;
402 open_filecount--;
403 }
059ec3d9
PH
404
405/* If opening is successful, call the file-checking function if there is one,
406and if all is still well, enter the open database into the tree. */
407
df04890c 408if (!(handle = (lk->open)(filename, &search_error_message)))
059ec3d9
PH
409 {
410 store_pool = old_pool;
411 return NULL;
412 }
413
df04890c
JH
414if ( lk->check
415 && !lk->check(handle, filename, modemask, owners, owngroups,
416 &search_error_message))
059ec3d9
PH
417 {
418 lk->close(handle);
419 store_pool = old_pool;
420 return NULL;
421 }
422
423/* If this is a search type that uses real files, keep count. */
424
425if (lk->type == lookup_absfile) open_filecount++;
426
427/* If we found a previously opened entry in the tree, re-use it; otherwise
428insert a new entry. On re-use, leave any cached lookup data and the lookup
429count alone. */
430
df04890c 431if (!t)
059ec3d9 432 {
f3ebb786
JH
433 t = store_get(sizeof(tree_node) + Ustrlen(keybuffer), FALSE);
434 t->data.ptr = c = store_get(sizeof(search_cache), FALSE);
059ec3d9
PH
435 c->item_cache = NULL;
436 Ustrcpy(t->name, keybuffer);
437 tree_insertnode(&search_tree, t);
438 }
439else c = t->data.ptr;
440
441c->handle = handle;
442c->search_type = search_type;
443c->up = c->down = NULL;
444
445store_pool = old_pool;
446return t;
447}
448
449
450
451
452
453/*************************************************
454* Internal function: Find one item in database *
455*************************************************/
456
457/* The answer is always put into dynamic store. The last lookup for each handle
458is cached.
459
460Arguments:
461 handle the handle from search_open; points to tree node
462 filename the filename that was handed to search_open, or
463 NULL for query-style searches
464 keystring the keystring for single-key+file lookups, or
465 the querystring for query-style lookups
67a57a5a 466 opts type-specific options
059ec3d9
PH
467
468Returns: a pointer to a dynamic string containing the answer,
469 or NULL if the query failed or was deferred; in the
470 latter case, search_find_defer is set TRUE; after an unusual
471 failure, there may be a message in search_error_message.
472*/
473
474static uschar *
67a57a5a
JH
475internal_search_find(void * handle, const uschar * filename, uschar * keystring,
476 const uschar * opts)
059ec3d9 477{
0488984d
JH
478tree_node * t = (tree_node *)handle;
479search_cache * c = (search_cache *)(t->data.ptr);
480expiring_data * e = NULL; /* compiler quietening */
481uschar * data = NULL;
059ec3d9
PH
482int search_type = t->name[0] - '0';
483int old_pool = store_pool;
484
485/* Lookups that return DEFER may not always set an error message. So that
486the callers don't have to test for NULL, set an empty string. */
487
488search_error_message = US"";
8768d548 489f.search_find_defer = FALSE;
059ec3d9 490
42c7f0b4 491DEBUG(D_lookup) debug_printf_indent("internal_search_find: file=\"%s\"\n "
67a57a5a
JH
492 "type=%s key=\"%s\" opts=%s%s%s\n", filename,
493 lookup_list[search_type]->name, keystring,
494 opts ? "\"" : "", opts, opts ? "\"" : "");
059ec3d9
PH
495
496/* Insurance. If the keystring is empty, just fail. */
497
498if (keystring[0] == 0) return NULL;
499
500/* Use the special store pool for search data */
501
502store_pool = POOL_SEARCH;
503
504/* Look up the data for the key, unless it is already in the cache for this
505file. No need to check c->item_cache for NULL, tree_search will do so. */
506
14b3c5bc
JH
507if ( (t = tree_search(c->item_cache, keystring))
508 && (!(e = t->data.ptr)->expiry || e->expiry > time(NULL))
a5dc727a 509 && (!opts && !e->opts || opts && e->opts && Ustrcmp(opts, e->opts) == 0)
14b3c5bc
JH
510 )
511 { /* Data was in the cache already; set the pointer from the tree node */
7d8d08c4 512 data = e->data.ptr;
42c7f0b4 513 DEBUG(D_lookup) debug_printf_indent("cached data used for lookup of %s%s%s\n",
14b3c5bc
JH
514 keystring,
515 filename ? US"\n in " : US"", filename ? filename : US"");
516 }
517else
059ec3d9 518 {
14b3c5bc 519 uint do_cache = UINT_MAX;
059ec3d9
PH
520 int keylength = Ustrlen(keystring);
521
522 DEBUG(D_lookup)
523 {
a5dc727a
JH
524 if (t)
525 debug_printf_indent("cached data found but either wrong opts or dated; ");
42c7f0b4 526 debug_printf_indent("%s lookup required for %s%s%s\n",
14b3c5bc
JH
527 filename ? US"file" : US"database",
528 keystring,
529 filename ? US"\n in " : US"", filename ? filename : US"");
059ec3d9
PH
530 }
531
532 /* Call the code for the different kinds of search. DEFER is handled
533 like FAIL, except that search_find_defer is set so the caller can
534 distinguish if necessary. */
535
e6d225ae 536 if (lookup_list[search_type]->find(c->handle, filename, keystring, keylength,
67a57a5a 537 &data, &search_error_message, &do_cache, opts) == DEFER)
8768d548 538 f.search_find_defer = TRUE;
059ec3d9
PH
539
540 /* A record that has been found is now in data, which is either NULL
541 or points to a bit of dynamic store. Cache the result of the lookup if
542 caching is permitted. Lookups can disable caching, when they did something
543 that changes their data. The mysql and pgsql lookups do this when an
544 UPDATE/INSERT query was executed. */
545
546 else if (do_cache)
547 {
548 int len = keylength + 1;
14b3c5bc
JH
549
550 if (t) /* Previous, out-of-date cache entry. Update with the */
551 { /* new result and forget the old one */
552 e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache;
a5dc727a 553 e->opts = opts;
7d8d08c4 554 e->data.ptr = data;
14b3c5bc
JH
555 }
556 else
557 {
f3ebb786 558 e = store_get(sizeof(expiring_data) + sizeof(tree_node) + len, is_tainted(keystring));
14b3c5bc 559 e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache;
a5dc727a 560 e->opts = opts;
7d8d08c4 561 e->data.ptr = data;
98b98887 562 t = (tree_node *)(e+1);
14b3c5bc
JH
563 memcpy(t->name, keystring, len);
564 t->data.ptr = e;
565 tree_insertnode(&c->item_cache, t);
566 }
059ec3d9
PH
567 }
568
569 /* If caching was disabled, empty the cache tree. We just set the cache
570 pointer to NULL here, because we cannot release the store at this stage. */
571
572 else
573 {
42c7f0b4 574 DEBUG(D_lookup) debug_printf_indent("lookup forced cache cleanup\n");
059ec3d9
PH
575 c->item_cache = NULL;
576 }
577 }
578
059ec3d9
PH
579DEBUG(D_lookup)
580 {
14b3c5bc 581 if (data)
42c7f0b4 582 debug_printf_indent("lookup yielded: %s\n", data);
8768d548 583 else if (f.search_find_defer)
42c7f0b4
JH
584 debug_printf_indent("lookup deferred: %s\n", search_error_message);
585 else debug_printf_indent("lookup failed\n");
059ec3d9
PH
586 }
587
588/* Return it in new dynamic store in the regular pool */
589
590store_pool = old_pool;
14b3c5bc 591return data ? string_copy(data) : NULL;
059ec3d9
PH
592}
593
594
595
596
597/*************************************************
598* Find one item in database, possibly wildcarded *
599*************************************************/
600
601/* This function calls the internal function above; once only if there
602is no partial matching, but repeatedly when partial matching is requested.
603
604Arguments:
605 handle the handle from search_open
606 filename the filename that was handed to search_open, or
607 NULL for query-style searches
608 keystring the keystring for single-key+file lookups, or
609 the querystring for query-style lookups
610 partial -1 means no partial matching;
611 otherwise it's the minimum number of components;
612 affix the affix string for partial matching
613 affixlen the length of the affix string
614 starflags SEARCH_STAR and SEARCH_STARAT flags
615 expand_setup pointer to offset for setting up expansion strings;
616 don't do any if < 0
67a57a5a 617 opts type-specific options
059ec3d9
PH
618
619Returns: a pointer to a dynamic string containing the answer,
620 or NULL if the query failed or was deferred; in the
621 latter case, search_find_defer is set TRUE
622*/
623
624uschar *
d447dbd1
JH
625search_find(void * handle, const uschar * filename, uschar * keystring,
626 int partial, const uschar * affix, int affixlen, int starflags,
67a57a5a 627 int * expand_setup, const uschar * opts)
059ec3d9
PH
628{
629tree_node *t = (tree_node *)handle;
630BOOL set_null_wild = FALSE;
631uschar *yield;
632
633DEBUG(D_lookup)
634 {
635 if (partial < 0) affixlen = 99; /* So that "NULL" prints */
42c7f0b4 636 debug_printf_indent("search_find: file=\"%s\"\n key=\"%s\" "
67a57a5a
JH
637 "partial=%d affix=%.*s starflags=%x opts=%s%s%s\n",
638 filename ? filename : US"NULL",
639 keystring, partial, affixlen, affix, starflags,
640 opts ? "\"" : "", opts, opts ? "\"" : "");
641
059ec3d9
PH
642 }
643
644/* Arrange to put this database at the top of the LRU chain if it is a type
645that opens real files. */
646
df04890c
JH
647if ( open_top != (tree_node *)handle
648 && lookup_list[t->name[0]-'0']->type == lookup_absfile)
059ec3d9
PH
649 {
650 search_cache *c = (search_cache *)(t->data.ptr);
651 tree_node *up = c->up;
652 tree_node *down = c->down;
653
654 /* Cut it out of the list. A newly opened file will a NULL up pointer.
655 Otherwise there will be a non-NULL up pointer, since we checked above that
656 this block isn't already at the top of the list. */
657
df04890c 658 if (up)
059ec3d9
PH
659 {
660 ((search_cache *)(up->data.ptr))->down = down;
df04890c 661 if (down)
059ec3d9 662 ((search_cache *)(down->data.ptr))->up = up;
df04890c
JH
663 else
664 open_bot = up;
059ec3d9
PH
665 }
666
667 /* Now put it at the head of the list. */
668
669 c->up = NULL;
670 c->down = open_top;
df04890c
JH
671 if (!open_top) open_bot = t;
672 else ((search_cache *)(open_top->data.ptr))->up = t;
059ec3d9
PH
673 open_top = t;
674 }
675
676DEBUG(D_lookup)
677 {
42c7f0b4
JH
678 debug_printf_indent("LRU list:\n");
679 for (tree_node *t = open_top; t; )
059ec3d9
PH
680 {
681 search_cache *c = (search_cache *)(t->data.ptr);
42c7f0b4
JH
682 debug_printf_indent(" %s\n", t->name);
683 if (t == open_bot) debug_printf_indent(" End\n");
059ec3d9
PH
684 t = c->down;
685 }
686 }
687
688/* First of all, try to match the key string verbatim. If matched a complete
689entry but could have been partial, flag to set up variables. */
690
67a57a5a 691yield = internal_search_find(handle, filename, keystring, opts);
8768d548 692if (f.search_find_defer) return NULL;
df04890c
JH
693
694if (yield) { if (partial >= 0) set_null_wild = TRUE; }
059ec3d9
PH
695
696/* Not matched a complete entry; handle partial lookups, but only if the full
697search didn't defer. Don't use string_sprintf() to construct the initial key,
698just in case the original key is too long for the string_sprintf() buffer (it
699*has* happened!). The case of a zero-length affix has to be treated specially.
700*/
701
702else if (partial >= 0)
703 {
704 int len = Ustrlen(keystring);
705 uschar *keystring2;
706
707 /* Try with the affix on the front, except for a zero-length affix */
708
709 if (affixlen == 0) keystring2 = keystring; else
710 {
f3ebb786
JH
711 keystring2 = store_get(len + affixlen + 1,
712 is_tainted(keystring) || is_tainted(affix));
059ec3d9
PH
713 Ustrncpy(keystring2, affix, affixlen);
714 Ustrcpy(keystring2 + affixlen, keystring);
42c7f0b4 715 DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring2);
67a57a5a 716 yield = internal_search_find(handle, filename, keystring2, opts);
8768d548 717 if (f.search_find_defer) return NULL;
059ec3d9
PH
718 }
719
720 /* The key in its entirety did not match a wild entry; try chopping off
721 leading components. */
722
723 if (yield == NULL)
724 {
725 int dotcount = 0;
726 uschar *keystring3 = keystring2 + affixlen;
727 uschar *s = keystring3;
728 while (*s != 0) if (*s++ == '.') dotcount++;
729
730 while (dotcount-- >= partial)
731 {
732 while (*keystring3 != 0 && *keystring3 != '.') keystring3++;
733
734 /* If we get right to the end of the string (which will be the last time
735 through this loop), we've failed if the affix is null. Otherwise do one
736 last lookup for the affix itself, but if it is longer than 1 character,
737 remove the last character if it is ".". */
738
739 if (*keystring3 == 0)
740 {
741 if (affixlen < 1) break;
742 if (affixlen > 1 && affix[affixlen-1] == '.') affixlen--;
743 Ustrncpy(keystring2, affix, affixlen);
744 keystring2[affixlen] = 0;
745 keystring3 = keystring2;
746 }
747 else
748 {
749 keystring3 -= affixlen - 1;
750 if (affixlen > 0) Ustrncpy(keystring3, affix, affixlen);
751 }
752
42c7f0b4 753 DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring3);
67a57a5a 754 yield = internal_search_find(handle, filename, keystring3, opts);
8768d548 755 if (f.search_find_defer) return NULL;
df04890c 756 if (yield)
059ec3d9
PH
757 {
758 /* First variable is the wild part; second is the fixed part. Take care
759 to get it right when keystring3 is just "*". */
760
df04890c 761 if (expand_setup && *expand_setup >= 0)
059ec3d9
PH
762 {
763 int fixedlength = Ustrlen(keystring3) - affixlen;
764 int wildlength = Ustrlen(keystring) - fixedlength - 1;
765 *expand_setup += 1;
766 expand_nstring[*expand_setup] = keystring;
767 expand_nlength[*expand_setup] = wildlength;
768 *expand_setup += 1;
769 expand_nstring[*expand_setup] = keystring + wildlength + 1;
770 expand_nlength[*expand_setup] = (fixedlength < 0)? 0 : fixedlength;
771 }
772 break;
773 }
774 keystring3 += affixlen;
775 }
776 }
777
778 else set_null_wild = TRUE; /* Matched a wild entry without any wild part */
779 }
780
781/* If nothing has been matched, but the option to look for "*@" is set, try
4c04137d 782replacing everything to the left of @ by *. After a match, the wild part
059ec3d9
PH
783is set to the string to the left of the @. */
784
df04890c 785if (!yield && starflags & SEARCH_STARAT)
059ec3d9
PH
786 {
787 uschar *atat = Ustrrchr(keystring, '@');
788 if (atat != NULL && atat > keystring)
789 {
790 int savechar;
791 savechar = *(--atat);
792 *atat = '*';
793
42c7f0b4 794 DEBUG(D_lookup) debug_printf_indent("trying default match %s\n", atat);
67a57a5a 795 yield = internal_search_find(handle, filename, atat, opts);
059ec3d9 796 *atat = savechar;
8768d548 797 if (f.search_find_defer) return NULL;
059ec3d9 798
df04890c 799 if (yield && expand_setup && *expand_setup >= 0)
059ec3d9
PH
800 {
801 *expand_setup += 1;
802 expand_nstring[*expand_setup] = keystring;
803 expand_nlength[*expand_setup] = atat - keystring + 1;
804 *expand_setup += 1;
805 expand_nstring[*expand_setup] = keystring;
806 expand_nlength[*expand_setup] = 0;
807 }
808 }
809 }
810
811/* If we still haven't matched anything, and the option to look for "*" is set,
812try that. If we do match, the first variable (the wild part) is the whole key,
813and the second is empty. */
814
df04890c 815if (!yield && starflags & (SEARCH_STAR|SEARCH_STARAT))
059ec3d9 816 {
42c7f0b4 817 DEBUG(D_lookup) debug_printf_indent("trying to match *\n");
67a57a5a 818 yield = internal_search_find(handle, filename, US"*", opts);
df04890c 819 if (yield && expand_setup && *expand_setup >= 0)
059ec3d9
PH
820 {
821 *expand_setup += 1;
822 expand_nstring[*expand_setup] = keystring;
823 expand_nlength[*expand_setup] = Ustrlen(keystring);
824 *expand_setup += 1;
825 expand_nstring[*expand_setup] = keystring;
826 expand_nlength[*expand_setup] = 0;
827 }
828 }
829
830/* If this was a potentially partial lookup, and we matched either a
831complete non-wild domain entry, or we matched a wild-carded entry without
832chopping off any of the domain components, set up the expansion variables
833(if required) so that the first one is empty, and the second one is the
834fixed part of the domain. The set_null_wild flag is set only when yield is not
835NULL. */
836
df04890c 837if (set_null_wild && expand_setup && *expand_setup >= 0)
059ec3d9
PH
838 {
839 *expand_setup += 1;
840 expand_nstring[*expand_setup] = keystring;
841 expand_nlength[*expand_setup] = 0;
842 *expand_setup += 1;
843 expand_nstring[*expand_setup] = keystring;
844 expand_nlength[*expand_setup] = Ustrlen(keystring);
845 }
846
847return yield;
848}
849
850/* End of search.c */