[Asterisk-code-review] pbx: Add helper function to execute applications. (asterisk[18])
Friendly Automation
asteriskteam at digium.com
Mon Jun 27 10:42:35 CDT 2022
Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/18671 )
Change subject: pbx: Add helper function to execute applications.
......................................................................
pbx: Add helper function to execute applications.
Finding an application and executing it if found is
a common task throughout Asterisk. This adds a helper
function around pbx_exec to do this, to eliminate
redundant code and make it easier for modules to
substitute variables and execute applications by name.
ASTERISK-30061 #close
Change-Id: Ifee4d2825df7545fb515d763d393065675140c84
---
M apps/app_disa.c
M include/asterisk/pbx.h
M main/bridge_channel.c
M main/dial.c
M main/features.c
M main/pbx_app.c
M main/pbx_builtins.c
M res/res_stasis_snoop.c
8 files changed, 51 insertions(+), 49 deletions(-)
Approvals:
Joshua Colp: Looks good to me, but someone else must approve
Kevin Harwell: Looks good to me, but someone else must approve
Benjamin Keith Ford: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/apps/app_disa.c b/apps/app_disa.c
index cceb554..44cccc7 100644
--- a/apps/app_disa.c
+++ b/apps/app_disa.c
@@ -361,7 +361,6 @@
if (k == 3) {
int recheck = 0;
- struct ast_app *app_reset_cdr;
if (!ast_exists_extension(chan, args.context, exten, 1,
S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
@@ -386,10 +385,7 @@
ast_channel_unlock(chan);
}
- app_reset_cdr = pbx_findapp("ResetCDR");
- if (app_reset_cdr) {
- pbx_exec(chan, app_reset_cdr, special_noanswer ? "" : "e");
- } else {
+ if (ast_pbx_exec_application(chan, "ResetCDR", special_noanswer ? "" : "e")) {
ast_log(AST_LOG_NOTICE, "ResetCDR application not found; CDR will not be reset\n");
}
ast_explicit_goto(chan, args.context, exten, 1);
diff --git a/include/asterisk/pbx.h b/include/asterisk/pbx.h
index d531b44..95332ea 100644
--- a/include/asterisk/pbx.h
+++ b/include/asterisk/pbx.h
@@ -269,6 +269,23 @@
int pbx_exec(struct ast_channel *c, struct ast_app *app, const char *data);
/*!
+ * \brief Execute an application
+ *
+ * \param c channel to execute on
+ * \param app name of app to execute
+ * \param data the data passed into the app
+ *
+ * This application executes an application by name on a given channel.
+ * It is a wrapper around pbx_exec that will perform variable substitution
+ * and then execute the application if it exists.
+ * If the application is not found, a warning is logged.
+ *
+ * \retval 0 success
+ * \retval -1 failure (including application not found)
+ */
+int ast_pbx_exec_application(struct ast_channel *chan, const char *app_name, const char *app_args);
+
+/*!
* \brief Register a new context or find an existing one
*
* \param extcontexts pointer to the ast_context structure pointer
diff --git a/main/bridge_channel.c b/main/bridge_channel.c
index 1b0f1dd..a0334b8 100644
--- a/main/bridge_channel.c
+++ b/main/bridge_channel.c
@@ -1178,23 +1178,7 @@
} else if (!strcasecmp("Macro", app_name)) {
ast_app_exec_macro(NULL, chan, app_args);
} else {
- struct ast_app *app;
-
- app = pbx_findapp(app_name);
- if (!app) {
- ast_log(LOG_WARNING, "Could not find application (%s)\n", app_name);
- } else {
- struct ast_str *substituted_args = ast_str_create(16);
-
- if (substituted_args) {
- ast_str_substitute_variables(&substituted_args, 0, chan, app_args);
- res = pbx_exec(chan, app, ast_str_buffer(substituted_args));
- ast_free(substituted_args);
- } else {
- ast_log(LOG_WARNING, "Could not substitute application argument variables for %s\n", app_name);
- res = pbx_exec(chan, app, app_args);
- }
- }
+ res = ast_pbx_exec_application(chan, app_name, app_args);
}
return res;
}
diff --git a/main/dial.c b/main/dial.c
index c40b7fb..944207c 100644
--- a/main/dial.c
+++ b/main/dial.c
@@ -166,14 +166,12 @@
static void answer_exec_run(struct ast_dial *dial, struct ast_dial_channel *dial_channel, char *app, char *args)
{
struct ast_channel *chan = dial_channel->owner;
- struct ast_app *ast_app = pbx_findapp(app);
- /* If the application was not found, return immediately */
- if (!ast_app)
+ /* Execute the application, if available */
+ if (ast_pbx_exec_application(chan, app, args)) {
+ /* If the application was not found, return immediately */
return;
-
- /* All is well... execute the application */
- pbx_exec(chan, ast_app, args);
+ }
/* If another thread is not taking over hang up the channel */
ast_mutex_lock(&dial->lock);
diff --git a/main/features.c b/main/features.c
index b67bf38..db584b5 100644
--- a/main/features.c
+++ b/main/features.c
@@ -504,12 +504,7 @@
ast_channel_unlock(peer);
}
if (monitor_chan) {
- struct ast_app *monitor_app;
-
- monitor_app = pbx_findapp("Monitor");
- if (monitor_app) {
- pbx_exec(monitor_chan, monitor_app, monitor_args);
- }
+ ast_pbx_exec_application(monitor_chan, "Monitor", monitor_args);
}
}
diff --git a/main/pbx_app.c b/main/pbx_app.c
index 0cbb04a..5879d73 100644
--- a/main/pbx_app.c
+++ b/main/pbx_app.c
@@ -498,6 +498,31 @@
return res;
}
+int ast_pbx_exec_application(struct ast_channel *chan, const char *app_name, const char *app_args)
+{
+ int res = -1;
+ struct ast_app *app;
+
+ app = pbx_findapp(app_name);
+ if (!app) {
+ ast_log(LOG_WARNING, "Could not find application (%s)\n", app_name);
+ } else {
+ struct ast_str *substituted_args = NULL;
+
+ if (!ast_strlen_zero(app_args) && (substituted_args = ast_str_create(16))) {
+ ast_str_substitute_variables(&substituted_args, 0, chan, app_args);
+ res = pbx_exec(chan, app, ast_str_buffer(substituted_args));
+ ast_free(substituted_args);
+ } else {
+ if (!ast_strlen_zero(app_args)) {
+ ast_log(LOG_WARNING, "Could not substitute application argument variables for %s\n", app_name);
+ }
+ res = pbx_exec(chan, app, app_args);
+ }
+ }
+ return res;
+}
+
static struct ast_cli_entry app_cli[] = {
AST_CLI_DEFINE(handle_show_applications, "Shows registered dialplan applications"),
AST_CLI_DEFINE(handle_show_application, "Describe a specific dialplan application"),
diff --git a/main/pbx_builtins.c b/main/pbx_builtins.c
index 078a307..7ef4d03 100644
--- a/main/pbx_builtins.c
+++ b/main/pbx_builtins.c
@@ -1000,7 +1000,6 @@
{
char *s, *appname;
struct ast_timing timing;
- struct ast_app *app;
static const char * const usage = "ExecIfTime requires an argument:\n <time range>,<days of week>,<days of month>,<months>[,<timezone>]?<appname>[(<appargs>)]";
if (ast_strlen_zero(data)) {
@@ -1038,13 +1037,7 @@
ast_log(LOG_WARNING, "Failed to find closing parenthesis\n");
}
-
- if ((app = pbx_findapp(appname))) {
- return pbx_exec(chan, app, S_OR(s, ""));
- } else {
- ast_log(LOG_WARNING, "Cannot locate application %s\n", appname);
- return -1;
- }
+ return ast_pbx_exec_application(chan, appname, S_OR(s, ""));
}
/*!
diff --git a/res/res_stasis_snoop.c b/res/res_stasis_snoop.c
index 190ee06..8d0c6eb 100644
--- a/res/res_stasis_snoop.c
+++ b/res/res_stasis_snoop.c
@@ -263,14 +263,8 @@
static void *snoop_stasis_thread(void *obj)
{
RAII_VAR(struct stasis_app_snoop *, snoop, obj, ao2_cleanup);
- struct ast_app *stasis = pbx_findapp("Stasis");
- if (!stasis) {
- ast_hangup(snoop->chan);
- return NULL;
- }
-
- pbx_exec(snoop->chan, stasis, ast_str_buffer(snoop->app));
+ ast_pbx_exec_application(snoop->chan, "Stasis", ast_str_buffer(snoop->app));
ast_hangup(snoop->chan);
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18671
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: Ifee4d2825df7545fb515d763d393065675140c84
Gerrit-Change-Number: 18671
Gerrit-PatchSet: 2
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-Reviewer: Benjamin Keith Ford <bford at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220627/e2b41c88/attachment-0001.html>
More information about the asterisk-code-review
mailing list