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