X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/d7d7b7b91dd75cec636fc144da7e27eed860f971..42c7f0b4ea09d8971a19beeef743ec8981d4aacc:/src/src/search.c?ds=sidebyside diff --git a/src/src/search.c b/src/src/search.c index 364cb3cb7..ebdf8a165 100644 --- a/src/src/search.c +++ b/src/src/search.c @@ -1,10 +1,8 @@ -/* $Cambridge: exim/src/src/search.c,v 1.3 2006/02/07 11:19:00 ph10 Exp $ */ - /************************************************* * Exim - an Internet mail transport agent * *************************************************/ -/* Copyright (c) University of Cambridge 1995 - 2006 */ +/* Copyright (c) University of Cambridge 1995 - 2015 */ /* See the file NOTICE for conditions of use and distribution. */ /* A set of functions to search databases in various formats. An open @@ -64,14 +62,14 @@ Returns: +ve => valid lookup name; value is offset in lookup_list */ int -search_findtype(uschar *name, int len) +search_findtype(const uschar *name, int len) { int bot = 0; int top = lookup_list_count; while (top > bot) { int mid = (top + bot)/2; - int c = Ustrncmp(name, lookup_list[mid].name, len); + int c = Ustrncmp(name, lookup_list[mid]->name, len); /* If c == 0 we have matched the incoming name with the start of the search type name. However, some search types are substrings of others (e.g. nis and @@ -81,9 +79,9 @@ while (top > bot) are testing. By leaving c == 0 when the lengths are different, and doing a > 0 test below, this all falls out correctly. */ - if (c == 0 && Ustrlen(lookup_list[mid].name) == len) + if (c == 0 && Ustrlen(lookup_list[mid]->name) == len) { - if (lookup_list[mid].find != NULL) return mid; + if (lookup_list[mid]->find != NULL) return mid; search_error_message = string_sprintf("lookup type \"%.*s\" is not " "available (not in the binary - check buildtime LOOKUP configuration)", len, name); @@ -123,12 +121,12 @@ Returns: +ve => valid lookup name; value is offset in lookup_list */ int -search_findtype_partial(uschar *name, int *ptypeptr, uschar **ptypeaff, +search_findtype_partial(const uschar *name, int *ptypeptr, const uschar **ptypeaff, int *afflen, int *starflags) { int len, stype; int pv = -1; -uschar *ss = name; +const uschar *ss = name; *starflags = 0; *ptypeaff = NULL; @@ -184,18 +182,26 @@ else if (len >= 1 && ss[len-1] == '*') } /* Check for the individual search type. Only those that are actually in the -binary are valid. For query-style types, "partial" is an error. */ +binary are valid. For query-style types, "partial" and default types are +erroneous. */ stype = search_findtype(ss, len); -if (pv >= 0 && mac_islookup(stype, lookup_querystyle)) +if (stype >= 0 && mac_islookup(stype, lookup_querystyle)) { - search_error_message = string_sprintf("\"partial\" is not permitted " - "for lookup type \"%s\"", ss); - return -1; + if (pv >= 0) + { + search_error_message = string_sprintf("\"partial\" is not permitted " + "for lookup type \"%s\"", ss); + return -1; + } + if ((*starflags & (SEARCH_STAR|SEARCH_STARAT)) != 0) + { + search_error_message = string_sprintf("defaults using \"*\" or \"*@\" are " + "not permitted for lookup type \"%s\"", ss); + return -1; + } } -/* All is well; pass back the partial type and return the lookup type. */ - *ptypeptr = pv; return stype; } @@ -229,8 +235,8 @@ if (t->left != NULL) tidyup_subtree(t->left); if (t->right != NULL) tidyup_subtree(t->right); if (c != NULL && c->handle != NULL && - lookup_list[c->search_type].close != NULL) - lookup_list[c->search_type].close(c->handle); + lookup_list[c->search_type]->close != NULL) + lookup_list[c->search_type]->close(c->handle); } @@ -243,15 +249,14 @@ Returns: nothing void search_tidyup(void) { -int i; int old_pool = store_pool; -DEBUG(D_lookup) debug_printf("search_tidyup called\n"); +DEBUG(D_lookup) debug_printf_indent("search_tidyup called\n"); /* Close individually each cached open file. */ store_pool = POOL_SEARCH; -if (search_tree != NULL) +if (search_tree) { tidyup_subtree(search_tree); search_tree = NULL; @@ -261,10 +266,10 @@ open_filecount = 0; /* Call the general tidyup entry for any drivers that have one. */ -for (i = 0; i < lookup_list_count; i++) - if (lookup_list[i].tidy != NULL) (lookup_list[i].tidy)(); +for (int i = 0; i < lookup_list_count; i++) if (lookup_list[i]->tidy) + (lookup_list[i]->tidy)(); -if (search_reset_point != NULL) store_reset(search_reset_point); +if (search_reset_point) store_reset(search_reset_point); search_reset_point = NULL; store_pool = old_pool; } @@ -327,7 +332,7 @@ search_open(uschar *filename, int search_type, int modemask, uid_t *owners, void *handle; tree_node *t; search_cache *c; -lookup_info *lk = lookup_list + search_type; +lookup_info *lk = lookup_list[search_type]; uschar keybuffer[256]; int old_pool = store_pool; @@ -336,8 +341,8 @@ int old_pool = store_pool; store_pool = POOL_SEARCH; if (search_reset_point == NULL) search_reset_point = store_get(0); -DEBUG(D_lookup) debug_printf("search_open: %s \"%s\"\n", lk->name, - (filename == NULL)? US"NULL" : filename); +DEBUG(D_lookup) debug_printf_indent("search_open: %s \"%s\"\n", lk->name, + filename ? filename : US"NULL"); /* See if we already have this open for this type of search, and if so, pass back the tree block as the handle. The key for the tree node is the search @@ -352,11 +357,11 @@ if ((t = tree_search(search_tree, keybuffer)) != NULL) c = (search_cache *)(t->data.ptr); if (c->handle != NULL) { - DEBUG(D_lookup) debug_printf(" cached open\n"); + DEBUG(D_lookup) debug_printf_indent(" cached open\n"); store_pool = old_pool; return t; } - DEBUG(D_lookup) debug_printf(" cached closed\n"); + DEBUG(D_lookup) debug_printf_indent(" cached closed\n"); } /* Otherwise, we need to open the file or database - each search type has its @@ -373,14 +378,14 @@ if (lk->type == lookup_absfile && open_filecount >= lookup_open_max) else { search_cache *c = (search_cache *)(open_bot->data.ptr); - DEBUG(D_lookup) debug_printf("Too many lookup files open\n closing %s\n", + DEBUG(D_lookup) debug_printf_indent("Too many lookup files open\n closing %s\n", open_bot->name); open_bot = c->up; if (open_bot != NULL) ((search_cache *)(open_bot->data.ptr))->down = NULL; else open_top = NULL; - ((lookup_list + c->search_type)->close)(c->handle); + ((lookup_list[c->search_type])->close)(c->handle); c->handle = NULL; open_filecount--; } @@ -389,7 +394,7 @@ if (lk->type == lookup_absfile && open_filecount >= lookup_open_max) /* If opening is successful, call the file-checking function if there is one, and if all is still well, enter the open database into the tree. */ -handle = lk->open(filename, &search_error_message); +handle = (lk->open)(filename, &search_error_message); if (handle == NULL) { store_pool = old_pool; @@ -458,9 +463,10 @@ Returns: a pointer to a dynamic string containing the answer, static uschar * internal_search_find(void *handle, uschar *filename, uschar *keystring) { -tree_node *t = (tree_node *)handle; -search_cache *c = (search_cache *)(t->data.ptr); -uschar *data = NULL; +tree_node * t = (tree_node *)handle; +search_cache * c = (search_cache *)(t->data.ptr); +expiring_data * e = NULL; /* compiler quietening */ +uschar * data = NULL; int search_type = t->name[0] - '0'; int old_pool = store_pool; @@ -468,11 +474,11 @@ int old_pool = store_pool; the callers don't have to test for NULL, set an empty string. */ search_error_message = US""; -search_find_defer = FALSE; +f.search_find_defer = FALSE; -DEBUG(D_lookup) debug_printf("internal_search_find: file=\"%s\"\n " +DEBUG(D_lookup) debug_printf_indent("internal_search_find: file=\"%s\"\n " "type=%s key=\"%s\"\n", filename, - lookup_list[search_type].name, keystring); + lookup_list[search_type]->name, keystring); /* Insurance. If the keystring is empty, just fail. */ @@ -485,29 +491,36 @@ store_pool = POOL_SEARCH; /* Look up the data for the key, unless it is already in the cache for this file. No need to check c->item_cache for NULL, tree_search will do so. */ -if ((t = tree_search(c->item_cache, keystring)) == NULL) +if ( (t = tree_search(c->item_cache, keystring)) + && (!(e = t->data.ptr)->expiry || e->expiry > time(NULL)) + ) + { /* Data was in the cache already; set the pointer from the tree node */ + data = e->ptr; + DEBUG(D_lookup) debug_printf_indent("cached data used for lookup of %s%s%s\n", + keystring, + filename ? US"\n in " : US"", filename ? filename : US""); + } +else { - BOOL do_cache = TRUE; + uint do_cache = UINT_MAX; int keylength = Ustrlen(keystring); DEBUG(D_lookup) { - if (filename != NULL) - debug_printf("file lookup required for %s\n in %s\n", - keystring, filename); - else - debug_printf("database lookup required for %s\n", keystring); + if (t) debug_printf_indent("cached data found but past valid time; "); + debug_printf_indent("%s lookup required for %s%s%s\n", + filename ? US"file" : US"database", + keystring, + filename ? US"\n in " : US"", filename ? filename : US""); } /* Call the code for the different kinds of search. DEFER is handled like FAIL, except that search_find_defer is set so the caller can distinguish if necessary. */ - if (lookup_list[search_type].find(c->handle, filename, keystring, keylength, + if (lookup_list[search_type]->find(c->handle, filename, keystring, keylength, &data, &search_error_message, &do_cache) == DEFER) - { - search_find_defer = TRUE; - } + f.search_find_defer = TRUE; /* A record that has been found is now in data, which is either NULL or points to a bit of dynamic store. Cache the result of the lookup if @@ -518,10 +531,22 @@ if ((t = tree_search(c->item_cache, keystring)) == NULL) else if (do_cache) { int len = keylength + 1; - t = store_get(sizeof(tree_node) + len); - memcpy(t->name, keystring, len); - t->data.ptr = data; - tree_insertnode(&c->item_cache, t); + + if (t) /* Previous, out-of-date cache entry. Update with the */ + { /* new result and forget the old one */ + e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache; + e->ptr = data; + } + else + { + e = store_get(sizeof(expiring_data) + sizeof(tree_node) + len); + e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache; + e->ptr = data; + t = (tree_node *)(e+1); + memcpy(t->name, keystring, len); + t->data.ptr = e; + tree_insertnode(&c->item_cache, t); + } } /* If caching was disabled, empty the cache tree. We just set the cache @@ -529,39 +554,24 @@ if ((t = tree_search(c->item_cache, keystring)) == NULL) else { - DEBUG(D_lookup) debug_printf("lookup forced cache cleanup\n"); + DEBUG(D_lookup) debug_printf_indent("lookup forced cache cleanup\n"); c->item_cache = NULL; } } -/* Data was in the cache already; set the pointer from the tree node */ - -else - { - data = US t->data.ptr; - DEBUG(D_lookup) debug_printf("cached data used for lookup of %s%s%s\n", - keystring, - (filename == NULL)? US"" : US"\n in ", - (filename == NULL)? US"" : filename); - } - -/* Debug: output the answer */ - DEBUG(D_lookup) { - if (data == NULL) - { - if (search_find_defer) debug_printf("lookup deferred: %s\n", - search_error_message); - else debug_printf("lookup failed\n"); - } - else debug_printf("lookup yielded: %s\n", data); + if (data) + debug_printf_indent("lookup yielded: %s\n", data); + else if (f.search_find_defer) + debug_printf_indent("lookup deferred: %s\n", search_error_message); + else debug_printf_indent("lookup failed\n"); } /* Return it in new dynamic store in the regular pool */ store_pool = old_pool; -return (data == NULL)? NULL : string_copy(data); +return data ? string_copy(data) : NULL; } @@ -595,7 +605,7 @@ Returns: a pointer to a dynamic string containing the answer, uschar * search_find(void *handle, uschar *filename, uschar *keystring, int partial, - uschar *affix, int affixlen, int starflags, int *expand_setup) + const uschar *affix, int affixlen, int starflags, int *expand_setup) { tree_node *t = (tree_node *)handle; BOOL set_null_wild = FALSE; @@ -604,7 +614,7 @@ uschar *yield; DEBUG(D_lookup) { if (partial < 0) affixlen = 99; /* So that "NULL" prints */ - debug_printf("search_find: file=\"%s\"\n key=\"%s\" " + debug_printf_indent("search_find: file=\"%s\"\n key=\"%s\" " "partial=%d affix=%.*s starflags=%x\n", (filename == NULL)? US"NULL" : filename, keystring, partial, affixlen, affix, starflags); @@ -614,7 +624,7 @@ DEBUG(D_lookup) that opens real files. */ if (open_top != (tree_node *)handle && - lookup_list[t->name[0]-'0'].type == lookup_absfile) + lookup_list[t->name[0]-'0']->type == lookup_absfile) { search_cache *c = (search_cache *)(t->data.ptr); tree_node *up = c->up; @@ -643,13 +653,12 @@ if (open_top != (tree_node *)handle && DEBUG(D_lookup) { - tree_node *t = open_top; - debug_printf("LRU list:\n"); - while (t != NULL) + debug_printf_indent("LRU list:\n"); + for (tree_node *t = open_top; t; ) { search_cache *c = (search_cache *)(t->data.ptr); - debug_printf(" %s\n", t->name); - if (t == open_bot) debug_printf(" End\n"); + debug_printf_indent(" %s\n", t->name); + if (t == open_bot) debug_printf_indent(" End\n"); t = c->down; } } @@ -658,7 +667,7 @@ DEBUG(D_lookup) entry but could have been partial, flag to set up variables. */ yield = internal_search_find(handle, filename, keystring); -if (search_find_defer) return NULL; +if (f.search_find_defer) return NULL; if (yield != NULL) { if (partial >= 0) set_null_wild = TRUE; } /* Not matched a complete entry; handle partial lookups, but only if the full @@ -679,9 +688,9 @@ else if (partial >= 0) keystring2 = store_get(len + affixlen + 1); Ustrncpy(keystring2, affix, affixlen); Ustrcpy(keystring2 + affixlen, keystring); - DEBUG(D_lookup) debug_printf("trying partial match %s\n", keystring2); + DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring2); yield = internal_search_find(handle, filename, keystring2); - if (search_find_defer) return NULL; + if (f.search_find_defer) return NULL; } /* The key in its entirety did not match a wild entry; try chopping off @@ -717,9 +726,9 @@ else if (partial >= 0) if (affixlen > 0) Ustrncpy(keystring3, affix, affixlen); } - DEBUG(D_lookup) debug_printf("trying partial match %s\n", keystring3); + DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring3); yield = internal_search_find(handle, filename, keystring3); - if (search_find_defer) return NULL; + if (f.search_find_defer) return NULL; if (yield != NULL) { /* First variable is the wild part; second is the fixed part. Take care @@ -746,7 +755,7 @@ else if (partial >= 0) } /* If nothing has been matched, but the option to look for "*@" is set, try -replacing everthing to the left of @ by *. After a match, the wild part +replacing everything to the left of @ by *. After a match, the wild part is set to the string to the left of the @. */ if (yield == NULL && (starflags & SEARCH_STARAT) != 0) @@ -758,10 +767,10 @@ if (yield == NULL && (starflags & SEARCH_STARAT) != 0) savechar = *(--atat); *atat = '*'; - DEBUG(D_lookup) debug_printf("trying default match %s\n", atat); + DEBUG(D_lookup) debug_printf_indent("trying default match %s\n", atat); yield = internal_search_find(handle, filename, atat); *atat = savechar; - if (search_find_defer) return NULL; + if (f.search_find_defer) return NULL; if (yield != NULL && expand_setup != NULL && *expand_setup >= 0) { @@ -781,7 +790,7 @@ and the second is empty. */ if (yield == NULL && (starflags & (SEARCH_STAR|SEARCH_STARAT)) != 0) { - DEBUG(D_lookup) debug_printf("trying to match *\n"); + DEBUG(D_lookup) debug_printf_indent("trying to match *\n"); yield = internal_search_find(handle, filename, US"*"); if (yield != NULL && expand_setup != NULL && *expand_setup >= 0) {