]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
projects / thirdparty / haproxy.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: e352b9d)
MINOR: vars: make the vars() sample fetch function support a default value
authorWilly Tarreau <w@1wt.eu>
Fri, 3 Sep 2021 10:00:13 +0000 (12:00 +0200)
committerWilly Tarreau <w@1wt.eu>
Fri, 3 Sep 2021 10:08:54 +0000 (12:08 +0200)
It is quite common to see in configurations constructions like the
following one:

    http-request set-var(txn.bodylen) 0
    http-request set-var(txn.bodylen) req.hdr(content-length)
    ...
    http-request set-header orig-len %[var(txn.bodylen)]

The set-var() rules are almost always duplicated when manipulating
integers or any other value that is mandatory along operations. This is
a problem because it makes the configurations complicated to maintain
and slower than needed. And it becomes even more complicated when several
conditions may set the same variable because the risk of forgetting to
initialize it or to accidentally reset it is high.

This patch extends the var() sample fetch function to take an optional
argument which contains a default value to be returned if the variable
was not set. This way it becomes much simpler to use the variable, just
set it where needed, and read it with a fall back to the default value:

    http-request set-var(txn.bodylen) req.hdr(content-length)
    ...
    http-request set-header orig-len %[var(txn.bodylen,0)]

The default value is always passed as a string, thus it will experience
a cast to the output type. It doesn't seem userful to complicate the
configuration to pass an explicit type at this point.

The vars.vtc regtest was updated accordingly.

doc/configuration.txt patch | blob | blame | history
reg-tests/sample_fetches/vars.vtc patch | blob | blame | history
src/vars.c patch | blob | blame | history

diff --git a/doc/configuration.txt b/doc/configuration.txt
index f6641750d0ff0385a4fd3942b64410cf0525e7a6..1a8eb5be722356ae52ca0ad04a9100a233bc2e7b 100644 (file)
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -17764,10 +17764,11 @@ uuid([<version>]) : string
   specified, a UUID version 4 (fully random) is returned.
   Currently, only version 4 is supported.
 
-var(<var-name>) : undefined
+var(<var-name>[,<default>]) : undefined
   Returns a variable with the stored type. If the variable is not set, the
-  sample fetch fails. The name of the variable starts with an indication
-  about its scope. The scopes allowed are:
+  sample fetch fails, unless a default value is provided, in which case it will
+  return it as a string. Empty strings are permitted. The name of the variable
+  starts with an indication about its scope. The scopes allowed are:
     "proc" : the variable is shared with the whole process
     "sess" : the variable is shared with the whole session
     "txn"  : the variable is shared with the transaction (request and
diff --git a/reg-tests/sample_fetches/vars.vtc b/reg-tests/sample_fetches/vars.vtc
index 5dc7b44000acbdd51d63ea65afaa00062fdf77bd..8a04718b477d812d9df0cf7447327a52b5a7ff8b 100644 (file)
--- a/reg-tests/sample_fetches/vars.vtc
+++ b/reg-tests/sample_fetches/vars.vtc
@@ -5,8 +5,9 @@ feature ignore_unknown_macro
 
 haproxy h1 -conf {
     global
+        # note below, str60 is purposely not defined so that the default is used
         set-var proc.int12 int(12)
-        set-var proc.int5  str(60),div(proc.int12)
+        set-var proc.int5  var(proc.str60,60),div(proc.int12)
         set-var proc.str1  str("this is")
         set-var proc.str2  str("a string")
         set-var proc.str   var(proc.str1)
diff --git a/src/vars.c b/src/vars.c
index df421f71ed1d212a78473e036cca8c11d13c58af..1e8e1bd30c387485d8a09e63c72f59766e2f3f86 100644 (file)
--- a/src/vars.c
+++ b/src/vars.c
@@ -339,8 +339,12 @@ static inline struct var *var_get(struct vars *vars, const char *name)
 static int smp_fetch_var(const struct arg *args, struct sample *smp, const char *kw, void *private)
 {
        const struct var_desc *var_desc = &args[0].data.var;
+       const struct buffer *def = NULL;
 
-       return vars_get_by_desc(var_desc, smp, NULL);
+       if (args[1].type == ARGT_STR)
+               def = &args[1].data.str;
+
+       return vars_get_by_desc(var_desc, smp, def);
 }
 
 /* This function search in the <head> a variable with the same
@@ -1193,7 +1197,7 @@ REGISTER_POST_DEINIT(vars_deinit);
 
 static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
 
-       { "var", smp_fetch_var, ARG1(1,STR), smp_check_var, SMP_T_STR, SMP_USE_CONST },
+       { "var", smp_fetch_var, ARG2(1,STR,STR), smp_check_var, SMP_T_STR, SMP_USE_CONST },
        { /* END */ },
 }};
 
Mirror of https://github.com/haproxy/haproxy.git