MINOR: cfgparse: try to suggest correct variable names on errors

When an empty argument comes from the use of a non-existing variable,
we'll now detect the difference with an empty variable (error pointer
points to the variable's name instead), and submit it to env_suggest()
to see if another variable looks likely to be the right one or not.

This can be quite useful to quickly figure how to fix misspelled variable
names. Currently only series of letters, digits and underscores are
attempted to be resolved as a name.

diff --git a/src/cfgparse.c b/src/cfgparse.c
index 2374b2cb38268ca4b64b6ea43a5a5bc63d2b3fd0..a9b86ada98c1eb0c27d17a9181d86ca3055d2890 100644 (file)
--- a/src/cfgparse.c
+++ b/src/cfgparse.c
@@ -2071,6 +2071,7 @@ next_line:
                                for (check_arg = 0; check_arg < arg; check_arg++) {
                                        if (!*args[check_arg]) {
                                                size_t newpos;
+                                               int suggest = 0;
 
                                                /* if an empty arg was found, its pointer should be in <errptr>, except
                                                 * for rare cases such as '\x00' etc. We need to check errptr in any case
@@ -2082,6 +2083,9 @@ next_line:
                                                        if (newpos >= strlen(line))
                                                                newpos = 0; // impossible to report anything, start at the beginning.
                                                        errptr = line + newpos;
+                                               } else if (isalnum(*errptr) || *errptr == '_') {
+                                                       /* looks like an environment variable */
+                                                       suggest = 1;
                                                }
 
                                                /* sanitize input line in-place */
@@ -2092,6 +2096,21 @@ next_line:
                                                         "If this is caused by an environment variable expansion, please have a look at section "
                                                         "2.3 of the configuration manual to find solutions to address this.\n",
                                                         file, linenum, check_arg, (int)(errptr - thisline + 1), line, (int)(newpos + 1), "^");
+
+                                               if (suggest) {
+                                                       const char *end = errptr;
+                                                       struct ist alt;
+
+                                                       while (isalnum(*end) || *end == '_')
+                                                               end++;
+
+                                                       if (end > errptr) {
+                                                               alt = env_suggest(ist2(errptr, end - errptr));
+                                                               if (isttest(alt))
+                                                                       ha_notice("Hint: maybe you meant %.*s instead ?\n", (int)istlen(alt), istptr(alt));
+                                                       }
+                                               }
+
                                                err_code |= ERR_ALERT | ERR_FATAL;
                                                fatal++;
                                                break;