Fix dbmjz lookup. Bug 2884

[exim.git] / src / src / lookups / lsearch.c

diff --git a/src/src/lookups/lsearch.c b/src/src/lookups/lsearch.c
index ec238d556d105d5afa7cdb747239e8c252e076cb..dcfdec91ed598468316337a6ef8abe50d887b10b 100644 (file)
--- a/src/src/lookups/lsearch.c
+++ b/src/src/lookups/lsearch.c
@@ -1,15 +1,13 @@
-/* $Cambridge: exim/src/src/lookups/lsearch.c,v 1.6 2005/12/06 10:25:59 ph10 Exp $ */
-

 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 

-/* Copyright (c) University of Cambridge 1995 - 2005 */
+/* Copyright (c) The Exim Maintainers 2020 - 2022 */
+/* Copyright (c) University of Cambridge 1995 - 2018 */

 /* See the file NOTICE for conditions of use and distribution. */
 
 #include "../exim.h"
 #include "lf_functions.h"
 /* See the file NOTICE for conditions of use and distribution. */
 
 #include "../exim.h"
 #include "lf_functions.h"

-#include "lsearch.h"

 
 /* Codes for the different kinds of lsearch that are supported */
 
 
 /* Codes for the different kinds of lsearch that are supported */
 


@@ -28,17 +26,12 @@ enum {
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-void *
-lsearch_open(uschar *filename, uschar **errmsg)
+static void *
+lsearch_open(const uschar * filename, uschar ** errmsg)

 {
 {

-FILE *f = Ufopen(filename, "rb");
-if (f == NULL)
-  {
-  int save_errno = errno;
-  *errmsg = string_open_failed(errno, "%s for linear search", filename);
-  errno = save_errno;
-  return NULL;
-  }
+FILE * f = Ufopen(filename, "rb");
+if (!f)
+  *errmsg = string_open_failed("%s for linear search", filename);

 return f;
 }
 
 return f;
 }
 


@@ -48,8 +41,8 @@ return f;
 *             Check entry point                  *
 *************************************************/
 
 *             Check entry point                  *
 *************************************************/
 

-BOOL
-lsearch_check(void *handle, uschar *filename, int modemask, uid_t *owners,
+static BOOL
+lsearch_check(void *handle, const uschar *filename, int modemask, uid_t *owners,

   gid_t *owngroups, uschar **errmsg)
 {
 return lf_check_file(fileno((FILE *)handle), filename, S_IFREG, modemask,
   gid_t *owngroups, uschar **errmsg)
 {
 return lf_check_file(fileno((FILE *)handle), filename, S_IFREG, modemask,


@@ -74,40 +67,47 @@ fit into the fixed sized buffer. Most of the time this will never be exercised,
 but people do occasionally do weird things. */
 
 static int
 but people do occasionally do weird things. */
 
 static int

-internal_lsearch_find(void *handle, uschar *filename, uschar *keystring,
-  int length, uschar **result, uschar **errmsg, int type)
+internal_lsearch_find(void * handle, const uschar * filename,
+  const uschar * keystring, int length, uschar ** result, uschar ** errmsg,
+  int type, const uschar * opts)

 {
 {

-FILE *f = (FILE *)handle;
-BOOL last_was_eol = TRUE;
-BOOL this_is_eol = TRUE;
+FILE *f = handle;
+BOOL ret_full = FALSE;

 int old_pool = store_pool;
 int old_pool = store_pool;

-void *reset_point = NULL;
+rmark reset_point = NULL;

 uschar buffer[4096];
 
 uschar buffer[4096];
 

+if (opts)
+  {
+  int sep = ',';
+  uschar * ele;
+
+  while ((ele = string_nextinlist(&opts, &sep, NULL, 0)))
+    if (Ustrcmp(ele, "ret=full") == 0)
+      { ret_full = TRUE; break; }
+  }
+

 /* Wildcard searches may use up some store, because of expansions. We don't
 want them to fill up our search store. What we do is set the pool to the main
 pool and get a point to reset to later. Wildcard searches could also issue
 lookups, but internal_search_find will take care of that, and the cache will be
 safely stored in the search pool again. */
 
 /* Wildcard searches may use up some store, because of expansions. We don't
 want them to fill up our search store. What we do is set the pool to the main
 pool and get a point to reset to later. Wildcard searches could also issue
 lookups, but internal_search_find will take care of that, and the cache will be
 safely stored in the search pool again. */
 

-if(type == LSEARCH_WILD || type == LSEARCH_NWILD)
+if (type == LSEARCH_WILD || type == LSEARCH_NWILD)

   {
   store_pool = POOL_MAIN;
   {
   store_pool = POOL_MAIN;

-  reset_point = store_get(0);
+  reset_point = store_mark();

   }
 
   }
 

-filename = filename;  /* Keep picky compilers happy */
-errmsg = errmsg;
-

 rewind(f);
 rewind(f);

-for (last_was_eol = TRUE;
+for (BOOL this_is_eol, last_was_eol = TRUE;

      Ufgets(buffer, sizeof(buffer), f) != NULL;
      last_was_eol = this_is_eol)
   {
      Ufgets(buffer, sizeof(buffer), f) != NULL;
      last_was_eol = this_is_eol)
   {

-  int ptr, size;

   int p = Ustrlen(buffer);
   int linekeylength;
   int p = Ustrlen(buffer);
   int linekeylength;

-  uschar *yield;
+  BOOL this_is_comment;
+  gstring * yield;

   uschar *s = buffer;
 
   /* Check whether this the final segment of a line. If it follows an
   uschar *s = buffer;
 
   /* Check whether this the final segment of a line. If it follows an


@@ -146,21 +146,22 @@ for (last_was_eol = TRUE;
   if (*s == '\"')
     {
     uschar *t = s++;
   if (*s == '\"')
     {
     uschar *t = s++;

-    while (*s != 0 && *s != '\"')
+    while (*s && *s != '\"')

       {
       {

-      if (*s == '\\') *t++ = string_interpret_escape(&s);
-        else *t++ = *s;
+      *t++ = *s == '\\' ? string_interpret_escape(CUSS &s) : *s;

       s++;
       }
       s++;
       }

-    if (*s != 0) s++;               /* Past terminating " */

     linekeylength = t - buffer;
     linekeylength = t - buffer;

+    if (*s) s++;                       /* Past terminating " */
+    if (ret_full)
+      memmove(t, s, Ustrlen(s)+1);     /* copy the rest of line also */

     }
 
   /* Otherwise it is terminated by a colon or white space */
 
   else
     {
     }
 
   /* Otherwise it is terminated by a colon or white space */
 
   else
     {

-    while (*s != 0 && *s != ':' && !isspace(*s)) s++;
+    while (*s && *s != ':' && !isspace(*s)) s++;

     linekeylength = s - buffer;
     }
 
     linekeylength = s - buffer;
     }
 


@@ -171,9 +172,9 @@ for (last_was_eol = TRUE;
     /* A plain lsearch treats each key as a literal */
 
     case LSEARCH_PLAIN:
     /* A plain lsearch treats each key as a literal */
 
     case LSEARCH_PLAIN:

-    if (linekeylength != length || strncmpic(buffer, keystring, length) != 0)
-      continue;
-    break;      /* Key matched */
+      if (linekeylength != length || strncmpic(buffer, keystring, length) != 0)
+       continue;
+      break;      /* Key matched */

 
     /* A wild lsearch treats each key as a possible wildcarded string; no
     expansion is done for nwildlsearch. */
 
     /* A wild lsearch treats each key as a possible wildcarded string; no
     expansion is done for nwildlsearch. */


@@ -183,14 +184,14 @@ for (last_was_eol = TRUE;
       {
       int rc;
       int save = buffer[linekeylength];
       {
       int rc;
       int save = buffer[linekeylength];

-      uschar *list = buffer;
+      const uschar *list = buffer;

       buffer[linekeylength] = 0;
       rc = match_isinlist(keystring,
         &list,
         UCHAR_MAX+1,              /* Single-item list */
         NULL,                     /* No anchor */
         NULL,                     /* No caching */
       buffer[linekeylength] = 0;
       rc = match_isinlist(keystring,
         &list,
         UCHAR_MAX+1,              /* Single-item list */
         NULL,                     /* No anchor */
         NULL,                     /* No caching */

-        MCL_STRING + ((type == LSEARCH_WILD)? 0:MCL_NOEXPAND),
+        MCL_STRING + (type == LSEARCH_WILD ? 0 : MCL_NOEXPAND),

         TRUE,                     /* Caseless */
         NULL);
       buffer[linekeylength] = save;
         TRUE,                     /* Caseless */
         NULL);
       buffer[linekeylength] = save;


@@ -198,53 +199,53 @@ for (last_was_eol = TRUE;
       if (rc == DEFER) return DEFER;
       }
 
       if (rc == DEFER) return DEFER;
       }
 

-    /* The key has matched. If the search involved a regular expression, it
-    might have caused numerical variables to be set. However, their values will
-    be in the wrong storage pool for external use. Copying them to the standard
-    pool is not feasible because of the caching of lookup results - a repeated
-    lookup will not match the regular expression again. Therefore, we flatten
-    all numeric variables at this point. */
+      /* The key has matched. If the search involved a regular expression, it
+      might have caused numerical variables to be set. However, their values will
+      be in the wrong storage pool for external use. Copying them to the standard
+      pool is not feasible because of the caching of lookup results - a repeated
+      lookup will not match the regular expression again. Therefore, we drop
+      all numeric variables at this point. */

 
 

-    expand_nmax = -1;
-    break;
+      expand_nmax = -1;
+      break;

 
     /* Compare an ip address against a list of network/ip addresses. We have to
     allow for the "*" case specially. */
 
     case LSEARCH_IP:
 
     /* Compare an ip address against a list of network/ip addresses. We have to
     allow for the "*" case specially. */
 
     case LSEARCH_IP:

-    if (linekeylength == 1 && buffer[0] == '*')
-      {
-      if (length != 1 || keystring[0] != '*') continue;
-      }
-    else if (length == 1 && keystring[0] == '*') continue;
-    else
-      {
-      int maskoffset;
-      int save = buffer[linekeylength];
-      buffer[linekeylength] = 0;
-      if (string_is_ip_address(buffer, &maskoffset) == 0 ||
-          !host_is_in_net(keystring, buffer, maskoffset)) continue;
-      buffer[linekeylength] = save;
-      }
-    break;      /* Key matched */
+      if (linekeylength == 1 && buffer[0] == '*')
+       {
+       if (length != 1 || keystring[0] != '*') continue;
+       }
+      else if (length == 1 && keystring[0] == '*') continue;
+      else
+       {
+       int maskoffset;
+       int save = buffer[linekeylength];
+       buffer[linekeylength] = 0;
+       if (string_is_ip_address(buffer, &maskoffset) == 0 ||
+           !host_is_in_net(keystring, buffer, maskoffset)) continue;
+       buffer[linekeylength] = save;
+       }
+      break;      /* Key matched */

     }
 
   /* The key has matched. Skip spaces after the key, and allow an optional
   colon after the spaces. This is an odd specification, but it's for
   compatibility. */
 
     }
 
   /* The key has matched. Skip spaces after the key, and allow an optional
   colon after the spaces. This is an odd specification, but it's for
   compatibility. */
 

-  while (isspace((uschar)*s)) s++;
-  if (*s == ':')
-    {
-    s++;
-    while (isspace((uschar)*s)) s++;
-    }
+  if (!ret_full)
+    if (Uskip_whitespace(&s) == ':')
+      {
+      s++;
+      Uskip_whitespace(&s);
+      }

 
   /* Reset dynamic store, if we need to, and revert to the search pool */
 
 
   /* Reset dynamic store, if we need to, and revert to the search pool */
 

-  if (reset_point != NULL)
+  if (reset_point)

     {
     {

-    store_reset(reset_point);
+    reset_point = store_reset(reset_point);

     store_pool = old_pool;
     }
 
     store_pool = old_pool;
     }
 


@@ -255,11 +256,12 @@ for (last_was_eol = TRUE;
 
   Initialize, and copy the first segment of data. */
 
 
   Initialize, and copy the first segment of data. */
 

-  size = 100;
-  ptr = 0;
-  yield = store_get(size);
-  if (*s != 0)
-    yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
+  this_is_comment = FALSE;
+  yield = string_get(100);
+  if (ret_full)
+    yield = string_cat(yield, buffer);
+  else if (*s)
+    yield = string_cat(yield, s);

 
   /* Now handle continuations */
 
 
   /* Now handle continuations */
 


@@ -285,26 +287,27 @@ for (last_was_eol = TRUE;
 
     if (last_was_eol)
       {
 
     if (last_was_eol)
       {

-      if (buffer[0] == 0 || buffer[0] == '#') continue;
+      this_is_comment = (this_is_comment || (buffer[0] == 0 || buffer[0] == '#'));
+      if (this_is_comment) continue;

       if (!isspace((uschar)buffer[0])) break;
       while (isspace((uschar)*s)) s++;
       *(--s) = ' ';
       }
       if (!isspace((uschar)buffer[0])) break;
       while (isspace((uschar)*s)) s++;
       *(--s) = ' ';
       }

+    if (this_is_comment) continue;

 
     /* Join a physical or logical line continuation onto the result string. */
 
 
     /* Join a physical or logical line continuation onto the result string. */
 

-    yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
+    yield = string_cat(yield, s);

     }
 
     }
 

-  yield[ptr] = 0;
-  store_reset(yield + ptr + 1);
-  *result = yield;
+  gstring_release_unused(yield);
+  *result = string_from_gstring(yield);

   return OK;
   }
 
 /* Reset dynamic store, if we need to */
 
   return OK;
   }
 
 /* Reset dynamic store, if we need to */
 

-if (reset_point != NULL)
+if (reset_point)

   {
   store_reset(reset_point);
   store_pool = old_pool;
   {
   store_reset(reset_point);
   store_pool = old_pool;


@@ -320,13 +323,13 @@ return FAIL;
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-int
-lsearch_find(void *handle, uschar *filename, uschar *keystring, int length,
-  uschar **result, uschar **errmsg, BOOL *do_cache)
+static int
+lsearch_find(void * handle, const uschar * filename, const uschar * keystring,
+  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
+  const uschar * opts)

 {
 {

-do_cache = do_cache;  /* Keep picky compilers happy */

 return internal_lsearch_find(handle, filename, keystring, length, result,
 return internal_lsearch_find(handle, filename, keystring, length, result,

-  errmsg, LSEARCH_PLAIN);
+  errmsg, LSEARCH_PLAIN, opts);

 }
 
 
 }
 
 


@@ -337,13 +340,13 @@ return internal_lsearch_find(handle, filename, keystring, length, result,
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-int
-wildlsearch_find(void *handle, uschar *filename, uschar *keystring, int length,
-  uschar **result, uschar **errmsg, BOOL *do_cache)
+static int
+wildlsearch_find(void * handle, const uschar * filename, const uschar * keystring,
+  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
+  const uschar * opts)

 {
 {

-do_cache = do_cache;  /* Keep picky compilers happy */

 return internal_lsearch_find(handle, filename, keystring, length, result,
 return internal_lsearch_find(handle, filename, keystring, length, result,

-  errmsg, LSEARCH_WILD);
+  errmsg, LSEARCH_WILD, opts);

 }
 
 
 }
 
 


@@ -354,13 +357,13 @@ return internal_lsearch_find(handle, filename, keystring, length, result,
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-int
-nwildlsearch_find(void *handle, uschar *filename, uschar *keystring, int length,
-  uschar **result, uschar **errmsg, BOOL *do_cache)
+static int
+nwildlsearch_find(void * handle, const uschar * filename, const uschar * keystring,
+  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
+  const uschar * opts)

 {
 {

-do_cache = do_cache;  /* Keep picky compilers happy */

 return internal_lsearch_find(handle, filename, keystring, length, result,
 return internal_lsearch_find(handle, filename, keystring, length, result,

-  errmsg, LSEARCH_NWILD);
+  errmsg, LSEARCH_NWILD, opts);

 }
 
 
 }
 
 


@@ -372,24 +375,20 @@ return internal_lsearch_find(handle, filename, keystring, length, result,
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-int
-iplsearch_find(void *handle, uschar *filename, uschar *keystring, int length,
-  uschar **result, uschar **errmsg, BOOL *do_cache)
+static int
+iplsearch_find(void * handle, uschar const * filename, const uschar * keystring,
+  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
+  const uschar * opts)

 {
 {

-do_cache = do_cache;  /* Keep picky compilers happy */

 if ((length == 1 && keystring[0] == '*') ||
     string_is_ip_address(keystring, NULL) != 0)
 if ((length == 1 && keystring[0] == '*') ||
     string_is_ip_address(keystring, NULL) != 0)

-  {

   return internal_lsearch_find(handle, filename, keystring, length, result,
   return internal_lsearch_find(handle, filename, keystring, length, result,

-    errmsg, LSEARCH_IP);
-  }
-else
-  {
-  *errmsg = string_sprintf("\"%s\" is not a valid iplsearch key (an IP "
-    "address, with optional CIDR mask, is wanted): "
-    "in a host list, use net-iplsearch as the search type", keystring);
-  return DEFER;
-  }
+    errmsg, LSEARCH_IP, opts);
+
+*errmsg = string_sprintf("\"%s\" is not a valid iplsearch key (an IP "
+"address, with optional CIDR mask, is wanted): "
+"in a host list, use net-iplsearch as the search type", keystring);
+return DEFER;

 }
 
 
 }
 
 


@@ -401,10 +400,88 @@ else
 
 /* See local README for interface description */
 
 
 /* See local README for interface description */
 

-void
+static void

 lsearch_close(void *handle)
 {
 (void)fclose((FILE *)handle);
 }
 
 lsearch_close(void *handle)
 {
 (void)fclose((FILE *)handle);
 }
 

+
+
+/*************************************************
+*         Version reporting entry point          *
+*************************************************/
+
+/* See local README for interface description. */
+
+#include "../version.h"
+
+gstring *
+lsearch_version_report(gstring * g)
+{
+#ifdef DYNLOOKUP
+g = string_fmt_append(g, "Library version: lsearch: Exim version %s\n", EXIM_VERSION_STR));
+#endif
+return g;
+}
+
+
+static lookup_info iplsearch_lookup_info = {
+  .name = US"iplsearch",               /* lookup name */
+  .type = lookup_absfile,              /* uses absolute file name */
+  .open = lsearch_open,                        /* open function */
+  .check = lsearch_check,              /* check function */
+  .find = iplsearch_find,              /* find function */
+  .close = lsearch_close,              /* close function */
+  .tidy = NULL,                                /* no tidy function */
+  .quote = NULL,                       /* no quoting function */
+  .version_report = NULL                           /* no version reporting (redundant) */
+};
+
+static lookup_info lsearch_lookup_info = {
+  .name = US"lsearch",                 /* lookup name */
+  .type = lookup_absfile,              /* uses absolute file name */
+  .open = lsearch_open,                        /* open function */
+  .check = lsearch_check,              /* check function */
+  .find = lsearch_find,                        /* find function */
+  .close = lsearch_close,              /* close function */
+  .tidy = NULL,                                /* no tidy function */
+  .quote = NULL,                       /* no quoting function */
+  .version_report = lsearch_version_report         /* version reporting */
+};
+
+static lookup_info nwildlsearch_lookup_info = {
+  .name = US"nwildlsearch",            /* lookup name */
+  .type = lookup_absfile,              /* uses absolute file name */
+  .open = lsearch_open,                        /* open function */
+  .check = lsearch_check,              /* check function */
+  .find = nwildlsearch_find,           /* find function */
+  .close = lsearch_close,              /* close function */
+  .tidy = NULL,                                /* no tidy function */
+  .quote = NULL,                       /* no quoting function */
+  .version_report = NULL                           /* no version reporting (redundant) */
+};
+
+static lookup_info wildlsearch_lookup_info = {
+  .name = US"wildlsearch",             /* lookup name */
+  .type = lookup_absfile,              /* uses absolute file name */
+  .open = lsearch_open,                        /* open function */
+  .check = lsearch_check,              /* check function */
+  .find = wildlsearch_find,            /* find function */
+  .close = lsearch_close,              /* close function */
+  .tidy = NULL,                                /* no tidy function */
+  .quote = NULL,                       /* no quoting function */
+  .version_report = NULL                           /* no version reporting (redundant) */
+};
+
+#ifdef DYNLOOKUP
+#define lsearch_lookup_module_info _lookup_module_info
+#endif
+
+static lookup_info *_lookup_list[] = { &iplsearch_lookup_info,
+                                       &lsearch_lookup_info,
+                                       &nwildlsearch_lookup_info,
+                                       &wildlsearch_lookup_info };
+lookup_module_info lsearch_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 4 };
+

 /* End of lookups/lsearch.c */
 /* End of lookups/lsearch.c */