res_cliexec.c File Reference

Execute dialplan applications from the CLI. More...

#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/frame.h"
#include "asterisk/format_cache.h"

Include dependency graph for res_cliexec.c:

Go to the source code of this file.

Functions
	AST_MODULE_INFO_STANDARD_EXTENDED (ASTERISK_GPL_KEY, "Simple dialplan execution from the CLI")
static char *	handle_exec (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	CLI support for executing application. More...
static int	load_module (void)
static int	unload_module (void)

Variables
static int	cli_chan = 0
static struct ast_cli_entry	cli_cliorig []
static const struct ast_channel_tech	mock_channel_tech

Detailed Description

Execute dialplan applications from the CLI.

Author

Naveen Albert aster.nosp@m.isk@.nosp@m.phrea.nosp@m.knet.nosp@m..org

Definition in file res_cliexec.c.

Function Documentation

AST_MODULE_INFO_STANDARD_EXTENDED()

AST_MODULE_INFO_STANDARD_EXTENDED	(	ASTERISK_GPL_KEY	,
		"Simple dialplan execution from the CLI"
	)

handle_exec()

static char * handle_exec ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

CLI support for executing application.

Definition at line 48 of file res_cliexec.c.

{
    struct ast_channel *c = NULL;
    RAII_VAR(struct ast_format_cap *, caps, NULL, ao2_cleanup);
    char *app_name, *app_args;
    int ret = 0;
    struct ast_app *app;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "dialplan exec application";
        e->usage =
            "Usage: dialplan exec application <appname> [<args>]\n"
            "       Execute a single dialplan application call for\n"
            "       testing. A mock channel is used to execute\n"
            "       the application, so it may not make\n"
            "       sense to use all applications, and only\n"
            "       global variables should be used.\n"
            "       The ulaw, alaw, and h264 codecs are available.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != e->args + 1 && a->argc != e->args + 2) {
        return CLI_SHOWUSAGE;
    }
 
    app_name = (char *) a->argv[3];
    app_args = a->argc == e->args + 2 ? (char *) a->argv[4] : NULL;
 
    if (!app_name) {
        return CLI_FAILURE;
    }
 
    caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    if (!caps) {
        ast_log(LOG_WARNING, "Could not allocate an empty format capabilities structure\n");
        return CLI_FAILURE;
    }
 
    if (ast_format_cap_append(caps, ast_format_ulaw, 0)) {
        ast_log(LOG_WARNING, "Failed to append a ulaw format to capabilities for channel nativeformats\n");
        return CLI_FAILURE;
    }
 
    if (ast_format_cap_append(caps, ast_format_alaw, 0)) {
        ast_log(LOG_WARNING, "Failed to append an alaw format to capabilities for channel nativeformats\n");
        return CLI_FAILURE;
    }
 
    if (ast_format_cap_append(caps, ast_format_h264, 0)) {
        ast_log(LOG_WARNING, "Failed to append an h264 format to capabilities for channel nativeformats\n");
        return CLI_FAILURE;
    }
 
    c = ast_channel_alloc(0, AST_STATE_DOWN, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, "CLIExec/%d", ++cli_chan);
    if (!c) {
        ast_cli(a->fd, "Unable to allocate mock channel for application execution.\n");
        return CLI_FAILURE;
    }
    ast_channel_tech_set(c, &mock_channel_tech);
    ast_channel_nativeformats_set(c, caps);
    ast_channel_set_writeformat(c, ast_format_slin);
    ast_channel_set_rawwriteformat(c, ast_format_slin);
    ast_channel_set_readformat(c, ast_format_slin);
    ast_channel_set_rawreadformat(c, ast_format_slin);
    ast_channel_unlock(c);
 
    app = pbx_findapp(app_name);
    if (!app) {
        ast_log(LOG_WARNING, "Could not find application (%s)\n", app_name);
        ast_hangup(c);
        return CLI_FAILURE;
    } else {
        struct ast_str *substituted_args = ast_str_create(16);
 
        if (substituted_args) {
            ast_str_substitute_variables(&substituted_args, 0, c, app_args);
            ast_cli(a->fd, "Executing: %s(%s)\n", app_name, ast_str_buffer(substituted_args));
            ret = pbx_exec(c, 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);
            ast_cli(a->fd, "Executing: %s(%s)\n", app_name, app_args);
            ret = pbx_exec(c, app, app_args);
        }
    }
 
    ast_hangup(c); /* no need to unref separately */
 
    ast_cli(a->fd, "Return Value: %s (%d)\n", ret ? "Failure" : "Success", ret);
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, app, app_name(), ast_cli_entry::args, ast_channel_alloc, ast_channel_nativeformats_set(), ast_channel_set_rawreadformat(), ast_channel_set_rawwriteformat(), ast_channel_set_readformat(), ast_channel_set_writeformat(), ast_channel_tech_set(), ast_channel_unlock, ast_cli(), ast_format_alaw, ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_h264, ast_format_slin, ast_format_ulaw, ast_free, ast_hangup(), ast_log, AST_STATE_DOWN, ast_str_buffer(), ast_str_create, ast_str_substitute_variables(), c, cli_chan, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, LOG_WARNING, mock_channel_tech, NULL, pbx_exec(), pbx_findapp(), RAII_VAR, and ast_cli_entry::usage.

load_module()

static int load_module ( void  )

static

Definition at line 153 of file res_cliexec.c.

{
    int res;
    res = ast_cli_register_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
    return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and cli_cliorig.

unload_module()

static int unload_module ( void  )

static

Definition at line 148 of file res_cliexec.c.

{
    return ast_cli_unregister_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
}

References ARRAY_LEN, ast_cli_unregister_multiple(), and cli_cliorig.

Variable Documentation

cli_chan

int cli_chan = 0

static

Definition at line 45 of file res_cliexec.c.

Referenced by handle_exec().

cli_cliorig

struct ast_cli_entry cli_cliorig[]

static

Initial value:

= {
    { .handler =  handle_exec , .summary =  "Execute a dialplan application" ,},
}

Definition at line 144 of file res_cliexec.c.

Referenced by load_module(), and unload_module().

mock_channel_tech

const struct ast_channel_tech mock_channel_tech

static

Initial value:

= {
}

Definition at line 42 of file res_cliexec.c.

Referenced by handle_exec().