Wed Jan 8 2020 09:50:13

Asterisk developer's documentation


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"

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 = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
 
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 bkrus.nosp@m.e@di.nosp@m.gium..nosp@m.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.

117 {
119 }
static struct ast_custom_function shell_function
Definition: func_shell.c:106
#define ast_custom_function_register_escalating(acf, escalation)
Register a custom function which requires escalated privileges.
Definition: pbx.h:1173
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.

44 {
45  int res = 0;
46 
47  if (ast_strlen_zero(data)) {
48  ast_log(LOG_WARNING, "Missing Argument! Example: Set(foo=${SHELL(echo \"bar\")})\n");
49  return -1;
50  }
51 
52  if (chan) {
54  }
55 
56  if (len >= 1) {
57  FILE *ptr;
58  char plbuff[4096];
59 
60  ptr = popen(data, "r");
61  if (ptr) {
62  while (fgets(plbuff, sizeof(plbuff), ptr)) {
63  strncat(buf, plbuff, len - strlen(buf) - 1);
64  }
65  pclose(ptr);
66  } else {
67  ast_log(LOG_WARNING, "Failed to execute shell command '%s'\n", data);
68  res = -1;
69  }
70  }
71 
72  if (chan) {
74  }
75 
76  return res;
77 }
int ast_autoservice_start(struct ast_channel *chan)
Automatically service a channel for us...
Definition: autoservice.c:179
#define LOG_WARNING
Definition: logger.h:144
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
int ast_autoservice_stop(struct ast_channel *chan)
Stop servicing a channel for us...
Definition: autoservice.c:238
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
static int unload_module ( void  )
static

Definition at line 111 of file func_shell.c.

References ast_custom_function_unregister().

112 {
114 }
static struct ast_custom_function shell_function
Definition: func_shell.c:106
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx.c:3814

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 = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static

Definition at line 121 of file func_shell.c.

Definition at line 121 of file func_shell.c.

struct ast_custom_function shell_function
static
Initial value:
= {
.name = "SHELL",
.read = shell_helper,
}
static int shell_helper(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_shell.c:42

Definition at line 106 of file func_shell.c.