Mon Mar 12 2012 21:25:20

Asterisk developer's documentation


app_system.c File Reference

Execute arbitrary system commands. More...

#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/channel.h"
#include "asterisk/strings.h"
#include "asterisk/threadstorage.h"
Include dependency graph for app_system.c:

Go to the source code of this file.

Functions

static void __init_buf_buf (void)
static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
static int system_exec (struct ast_channel *chan, const char *data)
static int system_exec_helper (struct ast_channel *chan, const char *data, int failmode)
static int trysystem_exec (struct ast_channel *chan, const char *data)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Generic System() application" , .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 char * app = "System"
static char * app2 = "TrySystem"
static struct ast_module_infoast_module_info = &__mod_info
static struct ast_threadstorage buf_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_buf_buf , .custom_init = NULL , }
static char * chanvar = "SYSTEMSTATUS"

Detailed Description

Execute arbitrary system commands.

Author:
Mark Spencer <markster@digium.com>

Definition in file app_system.c.


Function Documentation

static void __init_buf_buf ( void  ) [static]

Definition at line 99 of file app_system.c.

{
static void __reg_module ( void  ) [static]

Definition at line 186 of file app_system.c.

static void __unreg_module ( void  ) [static]

Definition at line 186 of file app_system.c.

static int load_module ( void  ) [static]
static int system_exec ( struct ast_channel chan,
const char *  data 
) [static]

Definition at line 156 of file app_system.c.

References system_exec_helper().

Referenced by load_module().

{
   return system_exec_helper(chan, data, -1);
}
static int system_exec_helper ( struct ast_channel chan,
const char *  data,
int  failmode 
) [static]

Definition at line 107 of file app_system.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_safe_system(), ast_str_buffer(), ast_str_get_encoded_str(), ast_str_strlen(), ast_str_thread_get(), ast_strlen_zero(), buf_buf, errno, LOG_NOTICE, LOG_WARNING, and pbx_builtin_setvar_helper().

Referenced by system_exec(), and trysystem_exec().

{
   int res = 0;
   struct ast_str *buf = ast_str_thread_get(&buf_buf, 16);
   char *cbuf;

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "System requires an argument(command)\n");
      pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
      return failmode;
   }

   ast_autoservice_start(chan);

   /* Do our thing here */
   ast_str_get_encoded_str(&buf, 0, (char *) data);
   cbuf = ast_str_buffer(buf);

   if (strchr("\"'", cbuf[0]) && cbuf[ast_str_strlen(buf) - 1] == cbuf[0]) {
      cbuf[ast_str_strlen(buf) - 1] = '\0';
      cbuf++;
      ast_log(LOG_NOTICE, "It is not necessary to quote the argument to the System application.\n");
   }

   res = ast_safe_system(cbuf);

   if ((res < 0) && (errno != ECHILD)) {
      ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
      pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
      res = failmode;
   } else if (res == 127) {
      ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
      pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
      res = failmode;
   } else {
      if (res < 0) 
         res = 0;
      if (res != 0)
         pbx_builtin_setvar_helper(chan, chanvar, "APPERROR");
      else
         pbx_builtin_setvar_helper(chan, chanvar, "SUCCESS");
      res = 0;
   } 

   ast_autoservice_stop(chan);

   return res;
}
static int trysystem_exec ( struct ast_channel chan,
const char *  data 
) [static]

Definition at line 161 of file app_system.c.

References system_exec_helper().

Referenced by load_module().

{
   return system_exec_helper(chan, data, 0);
}
static int unload_module ( void  ) [static]

Definition at line 166 of file app_system.c.

References ast_unregister_application().

{
   int res;

   res = ast_unregister_application(app);
   res |= ast_unregister_application(app2);

   return res;
}

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Generic System() application" , .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 186 of file app_system.c.

char* app = "System" [static]

Definition at line 101 of file app_system.c.

char* app2 = "TrySystem" [static]

Definition at line 103 of file app_system.c.

Definition at line 186 of file app_system.c.

struct ast_threadstorage buf_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_buf_buf , .custom_init = NULL , } [static]

Definition at line 99 of file app_system.c.

Referenced by system_exec_helper().

char* chanvar = "SYSTEMSTATUS" [static]

Definition at line 105 of file app_system.c.

Referenced by function_sippeer(), and load_config().