From 405a08aaed7b50aea70ac55c6288ad6e6acf09f1 Mon Sep 17 00:00:00 2001 From: "Joshua C. Colp" Date: Thu, 31 Aug 2023 07:31:20 -0300 Subject: [PATCH] variables: Add additional variable dialplan functions. Using the Set dialplan application does not actually delete channel or global variables. Instead the variables are set to an empty value. This change adds two dialplan functions, GLOBAL_DELETE and DELETE which can be used to delete global and channel variables instead of just setting them to empty. There is also no ability within the dialplan to determine if a global or channel variable has actually been set or not. This change also adds two dialplan functions, GLOBAL_EXISTS and VARIABLE_EXISTS which can be used to determine if a global or channel variable has been set or not. Resolves: #289 UserNote: Four new dialplan functions have been added. GLOBAL_DELETE and DELETE have been added which allows the deletion of global and channel variables. GLOBAL_EXISTS and VARIABLE_EXISTS have been added which checks whether a global or channel variable has been set. --- funcs/func_global.c | 65 +++++++++++++++++++++++++++++++++++++++++++++ funcs/func_logic.c | 64 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 129 insertions(+) diff --git a/funcs/func_global.c b/funcs/func_global.c index 4b5e0d659c..74f58663b4 100644 --- a/funcs/func_global.c +++ b/funcs/func_global.c @@ -53,6 +53,40 @@ Set or get the value of a global variable specified in varname + + + Deletes a specified global variable. + + + + Global variable name + + + + Delete the global variable specified in varname. + Will succeed if the global variable exists or not. + + + GLOBAL + DELETE + + + + + Check if a global variable exists or not. + + + + Global variable name + + + + Returns 1 if global variable exists or 0 otherwise. + + + VARIABLE_EXISTS + + Gets or sets the shared variable specified. @@ -145,6 +179,33 @@ static struct ast_custom_function global_function = { .write = global_write, }; +static int global_delete_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) +{ + pbx_builtin_setvar_helper(NULL, data, NULL); + + return 0; +} + +static struct ast_custom_function global_delete_function = { + .name = "GLOBAL_DELETE", + .write = global_delete_write, +}; + +static int global_exists_read(struct ast_channel *chan, const char *cmd, char *data, + char *buf, size_t len) +{ + const char *var = pbx_builtin_getvar_helper(NULL, data); + + strcpy(buf, var ? "1" : "0"); + + return 0; +} + +static struct ast_custom_function global_exists_function = { + .name = "GLOBAL_EXISTS", + .read = global_exists_read, +}; + static int shared_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { struct ast_datastore *varstore; @@ -313,6 +374,8 @@ static int unload_module(void) int res = 0; res |= ast_custom_function_unregister(&global_function); + res |= ast_custom_function_unregister(&global_delete_function); + res |= ast_custom_function_unregister(&global_exists_function); res |= ast_custom_function_unregister(&shared_function); return res; @@ -323,6 +386,8 @@ static int load_module(void) int res = 0; res |= ast_custom_function_register(&global_function); + res |= ast_custom_function_register(&global_delete_function); + res |= ast_custom_function_register(&global_exists_function); res |= ast_custom_function_register(&shared_function); return res; diff --git a/funcs/func_logic.c b/funcs/func_logic.c index d267749333..9aa908be92 100644 --- a/funcs/func_logic.c +++ b/funcs/func_logic.c @@ -111,6 +111,39 @@ + + + Deletes a specified channel variable. + + + + Channel variable name + + + + Delete the channel variable specified in varname. + Will succeed if the channel variable exists or not. + + + GLOBAL_DELETE + + + + + Check if a dialplan variable exists or not. + + + + Channel variable name + + + + Returns 1 if channel variable exists or 0 otherwise. + + + GLOBAL_EXISTS + + ***/ static int isnull(struct ast_channel *chan, const char *cmd, char *data, @@ -274,6 +307,23 @@ static int import_read2(struct ast_channel *chan, const char *cmd, char *data, s return import_helper(chan, cmd, data, NULL, str, len); } +static int delete_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) +{ + pbx_builtin_setvar_helper(chan, data, NULL); + + return 0; +} + +static int variable_exists_read(struct ast_channel *chan, const char *cmd, char *data, + char *buf, size_t len) +{ + const char *var = pbx_builtin_getvar_helper(chan, data); + + strcpy(buf, var ? "1" : "0"); + + return 0; +} + static struct ast_custom_function isnull_function = { .name = "ISNULL", .read = isnull, @@ -308,6 +358,16 @@ static struct ast_custom_function import_function = { .read2 = import_read2, }; +static struct ast_custom_function delete_function = { + .name = "DELETE", + .write = delete_write, +}; + +static struct ast_custom_function variable_exists_function = { + .name = "VARIABLE_EXISTS", + .read = variable_exists_read, +}; + static int unload_module(void) { int res = 0; @@ -318,6 +378,8 @@ static int unload_module(void) res |= ast_custom_function_unregister(&if_function); res |= ast_custom_function_unregister(&if_time_function); res |= ast_custom_function_unregister(&import_function); + res |= ast_custom_function_unregister(&delete_function); + res |= ast_custom_function_unregister(&variable_exists_function); return res; } @@ -332,6 +394,8 @@ static int load_module(void) res |= ast_custom_function_register(&if_function); res |= ast_custom_function_register(&if_time_function); res |= ast_custom_function_register(&import_function); + res |= ast_custom_function_register(&delete_function); + res |= ast_custom_function_register(&variable_exists_function); return res; }