<p>Friendly Automation <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17714">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Joshua Colp: Looks good to me, but someone else must approve
Kevin Harwell: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">cli: Add command to evaluate dialplan functions.<br><br>Adds the dialplan eval function commands to evaluate a dialplan<br>function from the CLI. The return value and function result are<br>printed out and can be used for testing or debugging.<br><br>ASTERISK-29820 #close<br><br>Change-Id: I833e97ea54c49336aca145330a2adeebfad05209<br>---<br>A doc/CHANGES-staging/cli_eval_function.txt<br>M main/pbx_variables.c<br>2 files changed, 52 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/CHANGES-staging/cli_eval_function.txt b/doc/CHANGES-staging/cli_eval_function.txt</span><br><span>new file mode 100644</span><br><span>index 0000000..9f7873c</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/cli_eval_function.txt</span><br><span>@@ -0,0 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: cli</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+A new CLI command 'dialplan eval function' has been</span><br><span style="color: hsl(120, 100%, 40%);">+added which allows users to test the behavior of</span><br><span style="color: hsl(120, 100%, 40%);">+dialplan function calls directly from the CLI.</span><br><span>diff --git a/main/pbx_variables.c b/main/pbx_variables.c</span><br><span>index 6f7439f..a060bf5 100644</span><br><span>--- a/main/pbx_variables.c</span><br><span>+++ b/main/pbx_variables.c</span><br><span>@@ -924,6 +924,52 @@</span><br><span> return CLI_SUCCESS;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief CLI support for executing function */</span><br><span style="color: hsl(120, 100%, 40%);">+static char *handle_eval_function(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_channel *c = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *fn, *substituted;</span><br><span style="color: hsl(120, 100%, 40%);">+ int ret;</span><br><span style="color: hsl(120, 100%, 40%);">+ char workspace[1024];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (cmd) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case CLI_INIT:</span><br><span style="color: hsl(120, 100%, 40%);">+ e->command = "dialplan eval function";</span><br><span style="color: hsl(120, 100%, 40%);">+ e->usage =</span><br><span style="color: hsl(120, 100%, 40%);">+ "Usage: dialplan eval function <name(args)>\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ " Evaluate a dialplan function call\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ " A dummy channel is used to evaluate\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ " the function call, so only global\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ " variables should be used.\n";</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ case CLI_GENERATE:</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (a->argc != e->args + 1) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return CLI_SHOWUSAGE;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ c = ast_dummy_channel_alloc();</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!c) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli(a->fd, "Unable to allocate bogus channel for function evaluation.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ return CLI_FAILURE;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ fn = (char *) a->argv[3];</span><br><span style="color: hsl(120, 100%, 40%);">+ pbx_substitute_variables_helper(c, fn, workspace, sizeof(workspace));</span><br><span style="color: hsl(120, 100%, 40%);">+ substituted = ast_strdupa(workspace);</span><br><span style="color: hsl(120, 100%, 40%);">+ workspace[0] = '\0';</span><br><span style="color: hsl(120, 100%, 40%);">+ ret = ast_func_read(c, substituted, workspace, sizeof(workspace));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ c = ast_channel_unref(c);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli(a->fd, "Return Value: %s (%d)\n", ret ? "Failure" : "Success", ret);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli(a->fd, "Result: %s\n", workspace);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return CLI_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static char *handle_set_global(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span> {</span><br><span> switch (cmd) {</span><br><span>@@ -1218,6 +1264,7 @@</span><br><span> static struct ast_cli_entry vars_cli[] = {</span><br><span> AST_CLI_DEFINE(handle_show_globals, "Show global dialplan variables"),</span><br><span> AST_CLI_DEFINE(handle_show_chanvar, "Show channel variables"),</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_CLI_DEFINE(handle_eval_function, "Evaluate dialplan function"),</span><br><span> AST_CLI_DEFINE(handle_set_global, "Set global dialplan variable"),</span><br><span> AST_CLI_DEFINE(handle_set_chanvar, "Set a channel variable"),</span><br><span> };</span><br><span></span><br></pre><div style="white-space:pre-wrap"></div><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17714">change 17714</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17714"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I833e97ea54c49336aca145330a2adeebfad05209 </div>
<div style="display:none"> Gerrit-Change-Number: 17714 </div>
<div style="display:none"> Gerrit-PatchSet: 7 </div>
<div style="display:none"> Gerrit-Owner: N A <mail@interlinked.x10host.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: Joshua Colp <jcolp@sangoma.com> </div>
<div style="display:none"> Gerrit-Reviewer: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>