And hindsight is always 20/20. The initial question was about this:
!!defenv HOME
. . .
event_route[evrexec:timer] {
xlog("L_N", "HOME: " + HOME + "\n");
}
$def(HOME) would work.
|
Ben Kaufman |
|
Sr. VoIP Engineer |
|
P: |
|
24 hour client support:
855.639.6300 |
From: Daniel-Constantin Mierla <miconda@gmail.com>
Sent: Thursday, December 9, 2021 12:37 PM
To: Ben Kaufman <bkaufman@bcmone.com>; Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>
Subject: Re: [SR-Users] Unquoted values from #!defenv
#!defines are preprocessor directives, think about them like copy+paste and then config interpreter tries to understand the config content.
As one example in the wiki, the value of a define can be even a script snippet -- see the define of IDLOOP:
*
https://www.kamailio.org/wiki/cookbooks/5.5.x/core#define
Your example fails because it results in copying and surrounding the value with quotes, so the interpreter sees:
""bar""
practically, it is empty string followed by token 'bar' and followed by another empty string.
It is the expected behaviour, similar to what happens in C with #define macros. One must know what sets in the value and use the appropriate pre-processor directive.
Cheers,
Daniel
On 09.12.21 18:13, Ben Kaufman wrote:
Sorry, I noticed the file discrepancy after sending the email. I did make sure to retest with #!defenvs and it does work.
With regards to quoted/unquoted envvars, I’m not expecting that a quoted environmental variable would do anything with the quotes, but right now, Kamailio will fail to start when using #!defenvs with a quoted variable. If I set:
export FOO= "\"bar\"\"
and use:
#!defenvs FOO
Kamailio will fail to start. I would expect it to have literal quotes in the string.
Ben Kaufman
Sr. VoIP Engineer
P:
24 hour client support: 855.639.6300
From: Daniel-Constantin Mierla <miconda@gmail.com>
Sent: Thursday, December 9, 2021 11:02 AM
To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>; Ben Kaufman <bkaufman@bcmone.com>
Subject: Re: [SR-Users] Unquoted values from #!defenv
The example snippet you gave is with #!devenv, not with #!devenvs. Is it what you tested in this case?
Cheers,
DanielOn 09.12.21 15:57, Ben Kaufman wrote:
Thank you. It’s tested and working with this simple config:
#!KAMAILIO
loadmodule "xlog"
loadmodule "pv"
loadmodule "evrexec"
modparam("evrexec", "exec", "name=evrexec:timer;wait=1000;workers=1;")
c HOME
request_route{
forward();
}
event_route[evrexec:timer] {
xlog("L_N", "HOME: " + HOME + "\n");
}
Regards,
Kaufman
From: Daniel-Constantin Mierla <miconda@gmail.com>
Sent: Thursday, December 9, 2021 3:55 AM
To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>; Ben Kaufman <bkaufman@bcmone.com>
Subject: Re: [SR-Users] Unquoted values from #!defenv
I pushed the code to enclose the value in between quotes. Can you test and see if works now?
Cheers,
DanielOn 08.12.21 19:07, Daniel-Constantin Mierla wrote:
I expected the quoted mode parameter does the work -- I will check and push the update.
Regarding support for undefined env values, maybe add something like #!trydefenv, because I find #!defenv useful at is it, to be used when the env variable must be set for proper working of kamailio (e.g., DB url) and fail to start if not set.
Cheers,
DanielOn 08.12.21 17:17, Ben Kaufman wrote:
Daniel,
Is the #!defenvs feature still a work in progress? I wrote a change to add #!defenvn and #!defenvns to allow for undefined environmental variables, and noticed that the string quoting on #!defenvs doesn’t do anything except log the quoting mode in /src/core/ pp_define_set().
Ben Kaufman
Sr. VoIP Engineer
P:
24 hour client support: 855.639.6300
From: sr-users <sr-users-bounces@lists.kamailio.org> On Behalf Of Ben Kaufman
Sent: Tuesday, December 7, 2021 9:12 AM
To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>
Subject: Re: [SR-Users] Unquoted values from #!defenv
Thank you. I’ve been using -A to set values thus far as CMD arguments to the container’s ENTRYPOINT. If submitting a pull request, would it be preferrable to allow #!defenv/#!defenvs to accept undefined values, or to add new keywords like #!ifdefenv/#!ifdefenvs ?
Ben Kaufman
From: Daniel-Constantin Mierla <miconda@gmail.com>
Sent: Tuesday, December 7, 2021 2:22 AM
To: Ben Kaufman <bkaufman@bcmone.com>; Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>
Subject: Re: [SR-Users] Unquoted values from #!defenv
The current behaviour targets the use of existing values from the environment variables. If you need other kind of features, you can propose pull requests. Or you can eventually have a start script that sets defines with -A cli parameter based on env variables.
Cheers,
DanielOn 06.12.21 21:56, Ben Kaufman wrote:
Thank you :)
A follow up question would be on the usability of the #!defenv (and probably #!defenvs) usability with #!ifdef. In the scenario below, if the environmental variable WITH_DEBUGGER is not defined, then Kamailio will fail to start, thus the #!ifdef is somewhat limited. It makes sense for scenarios where someone might toggle the setting editing the config file, but it would be very convenient to toggle the environmental variable instead, particularly in containerized environments. Any thoughts on how best to control this?
#!defenv WITH_DEBUGGER
#!ifdef WITH_DEBUGGER
loadmodule "debugger"
. . .
#!endif
Ben Kaufman
From: Daniel-Constantin Mierla <miconda@gmail.com>
Sent: Monday, December 6, 2021 3:55 AM
To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.org>; Ben Kaufman <bkaufman@nexvortex.com>
Subject: Re: [SR-Users] Unquoted values from #!defenv
Hello,
#!substdef does not set the value inside quoted string, it replaces inside a string value, so it does not put quotes around replacement part. So it does it it is written in the docs. There is #!substdefs witch can create a define with quoted value.
Note that defines are standalone-token replacement, you can define an ID to a number, to a keyword (e.g., src_ip), to a quoted string or even a multi-line script snippet, like:
#!define IDLOOP $var(i) = 0; \
while($var(i)<5) { \
xlog("++++ $var(i)\n"); \
$var(i) = $var(i) + 1; \
}See the core cookbook for more details.
Anyhow, as using env variable values as quoted string is useful and setting them with quotes might look odd, I added #!defenvs:
* https://www.kamailio.org/wiki/cookbooks/devel/core#defenvs
Cheers,
DanielOn 30.11.21 22:40, Ben Kaufman wrote:
Hello all,
Looking for some clarification regarding quoting and !#defenv . I understand that the example below fails because the environmental variable HOME is not quoted, thus when used in the xlog() call it fails. How is it possible to evaluate and/or use the value of the environmental variable if defined as a preprocessor variable? Looking at the documentation the reason for this directive is “It is a simplified alternative of using #!substdef with $env(NAME) in the replacement part.” But #!substdef would allow setting the value inside of a quoted string, so does it really meet that requirement?
I’m aware that I could use $env(HOME) rather than a preprocessor directive of HOME. I’m just trying to understand the usage of the #!defenv feature.
#!KAMAILIO
## Tested in 5.5.2
loadmodule "xlog"
loadmodule "pv"
loadmodule "evrexec"
modparam("evrexec", "exec", "name=evrexec:timer;wait=1000;workers=1;")
#!defenv HOME
request_route{
forward();
}
event_route[evrexec:timer] {
xlog("L_N", "HOME: " + HOME + "\n");
}
Ben Kaufman
__________________________________________________________Kamailio - Users Mailing List - Non Commercial Discussions* sr-users@lists.kamailio.orgImportant: keep the mailing list in the recipients, do not reply only to the sender!Edit mailing list options or unsubscribe:* https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users--Daniel-Constantin Mierla -- www.asipto.comwww.twitter.com/miconda -- www.linkedin.com/in/micondaKamailio Advanced Training - OnlineFeb 21-24, 2022 (America Timezone)* https://www.asipto.com/sw/kamailio-advanced-training-online/--Daniel-Constantin Mierla -- www.asipto.comwww.twitter.com/miconda -- www.linkedin.com/in/micondaKamailio Advanced Training - OnlineFeb 21-24, 2022 (America Timezone)* https://www.asipto.com/sw/kamailio-advanced-training-online/
__________________________________________________________Kamailio - Users Mailing List - Non Commercial Discussions* sr-users@lists.kamailio.orgImportant: keep the mailing list in the recipients, do not reply only to the sender!Edit mailing list options or unsubscribe:* https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users--Daniel-Constantin Mierla -- www.asipto.comwww.twitter.com/miconda -- www.linkedin.com/in/micondaKamailio Advanced Training - OnlineFeb 21-24, 2022 (America Timezone)* https://www.asipto.com/sw/kamailio-advanced-training-online/--Daniel-Constantin Mierla -- www.asipto.comwww.twitter.com/miconda -- www.linkedin.com/in/micondaKamailio Advanced Training - OnlineFeb 21-24, 2022 (America Timezone)* https://www.asipto.com/sw/kamailio-advanced-training-online/
__________________________________________________________Kamailio - Users Mailing List - Non Commercial Discussions* sr-users@lists.kamailio.orgImportant: keep the mailing list in the recipients, do not reply only to the sender!Edit mailing list options or unsubscribe:* https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users--Daniel-Constantin Mierla -- www.asipto.comwww.twitter.com/miconda -- www.linkedin.com/in/micondaKamailio Advanced Training - OnlineFeb 21-24, 2022 (America Timezone)* https://www.asipto.com/sw/kamailio-advanced-training-online/
--
Daniel-Constantin Mierla -- www.asipto.com
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - Online
Feb 21-24, 2022 (America Timezone)
* https://www.asipto.com/sw/kamailio-advanced-training-online/