func_shell.c File Reference

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"

Include dependency graph for func_shell.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
static int shell_helper (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Collects the output generated by a command executed by the system shell" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static struct ast_module_infoast_module_info = &__mod_info
static struct ast_custom_function shell_function


Detailed Description

SHELL function to return the output generated by a command issued to the system shell.

Note:
Inspiration and Guidance from Russell! Thank You!
Author:
Brandon Kruse <bkruse@digium.com>

Definition in file func_shell.c.


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 121 of file func_shell.c.

static void __unreg_module ( void   )  [static]

Definition at line 121 of file func_shell.c.

static int load_module ( void   )  [static]

static int shell_helper ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
) [static]

Definition at line 42 of file func_shell.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_log, ast_strlen_zero, and LOG_WARNING.

00044 {
00045    int res = 0;
00046 
00047    if (ast_strlen_zero(data)) {
00048       ast_log(LOG_WARNING, "Missing Argument!  Example:  Set(foo=${SHELL(echo \"bar\")})\n");
00049       return -1;
00050    }
00051 
00052    if (chan) {
00053       ast_autoservice_start(chan);
00054    }
00055 
00056    if (len >= 1) {
00057       FILE *ptr;
00058       char plbuff[4096];
00059 
00060       ptr = popen(data, "r");
00061       if (ptr) {
00062          while (fgets(plbuff, sizeof(plbuff), ptr)) {
00063             strncat(buf, plbuff, len - strlen(buf) - 1);
00064          }
00065          pclose(ptr);
00066       } else {
00067          ast_log(LOG_WARNING, "Failed to execute shell command '%s'\n", data);
00068          res = -1;
00069       }
00070    }
00071 
00072    if (chan) {
00073       ast_autoservice_stop(chan);
00074    }
00075 
00076    return res;
00077 }

static int unload_module ( void   )  [static]

Definition at line 111 of file func_shell.c.

References ast_custom_function_unregister().

00112 {
00113    return ast_custom_function_unregister(&shell_function);
00114 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Collects the output generated by a command executed by the system shell" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, } [static]

Definition at line 121 of file func_shell.c.

Definition at line 121 of file func_shell.c.

Initial value:

 {
   .name = "SHELL",
   .read = shell_helper,
}

Definition at line 106 of file func_shell.c.


Generated on Thu Apr 16 06:31:24 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6