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, }
static struct ast_module_info *	ast_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]

Definition at line 116 of file func_shell.c.

References AST_CFE_READ, and ast_custom_function_register_escalating.

{
   return ast_custom_function_register_escalating(&shell_function, AST_CFE_READ);
}

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.

{
   int res = 0;

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "Missing Argument!  Example:  Set(foo=${SHELL(echo \"bar\")})\n");
      return -1;
   }

   if (chan) {
      ast_autoservice_start(chan);
   }

   if (len >= 1) {
      FILE *ptr;
      char plbuff[4096];

      ptr = popen(data, "r");
      if (ptr) {
         while (fgets(plbuff, sizeof(plbuff), ptr)) {
            strncat(buf, plbuff, len - strlen(buf) - 1);
         }
         pclose(ptr);
      } else {
         ast_log(LOG_WARNING, "Failed to execute shell command '%s'\n", data);
         res = -1;
      }
   }

   if (chan) {
      ast_autoservice_stop(chan);
   }

   return res;
}

static int unload_module

(

void

)

[static]

Definition at line 111 of file func_shell.c.

References ast_custom_function_unregister().

{
   return ast_custom_function_unregister(&shell_function);
}

---

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, } [static]

Definition at line 121 of file func_shell.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 121 of file func_shell.c.

struct ast_custom_function shell_function [static]

Initial value:

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

Definition at line 106 of file func_shell.c.