Mon Jun 27 16:51:00 2011

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"

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 = "8586c2a7d357cb591cc3a6607a8f62d1" , .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 95 of file app_system.c.

00104 {

static void __reg_module ( void   )  [static]

Definition at line 182 of file app_system.c.

static void __unreg_module ( void   )  [static]

Definition at line 182 of file app_system.c.

static int load_module ( void   )  [static]

Definition at line 172 of file app_system.c.

References ast_register_application_xml, system_exec(), and trysystem_exec().

00173 {
00174    int res;
00175 
00176    res = ast_register_application_xml(app2, trysystem_exec);
00177    res |= ast_register_application_xml(app, system_exec);
00178 
00179    return res;
00180 }

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

Definition at line 152 of file app_system.c.

References system_exec_helper().

Referenced by load_module().

00153 {
00154    return system_exec_helper(chan, data, -1);
00155 }

static int system_exec_helper ( struct ast_channel chan,
const char *  data,
int  failmode 
) [static]

Definition at line 103 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().

00104 {
00105    int res = 0;
00106    struct ast_str *buf = ast_str_thread_get(&buf_buf, 16);
00107    char *cbuf;
00108 
00109    if (ast_strlen_zero(data)) {
00110       ast_log(LOG_WARNING, "System requires an argument(command)\n");
00111       pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
00112       return failmode;
00113    }
00114 
00115    ast_autoservice_start(chan);
00116 
00117    /* Do our thing here */
00118    ast_str_get_encoded_str(&buf, 0, (char *) data);
00119    cbuf = ast_str_buffer(buf);
00120 
00121    if (strchr("\"'", cbuf[0]) && cbuf[ast_str_strlen(buf) - 1] == cbuf[0]) {
00122       cbuf[ast_str_strlen(buf) - 1] = '\0';
00123       cbuf++;
00124       ast_log(LOG_NOTICE, "It is not necessary to quote the argument to the System application.\n");
00125    }
00126 
00127    res = ast_safe_system(cbuf);
00128 
00129    if ((res < 0) && (errno != ECHILD)) {
00130       ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
00131       pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
00132       res = failmode;
00133    } else if (res == 127) {
00134       ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
00135       pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
00136       res = failmode;
00137    } else {
00138       if (res < 0) 
00139          res = 0;
00140       if (res != 0)
00141          pbx_builtin_setvar_helper(chan, chanvar, "APPERROR");
00142       else
00143          pbx_builtin_setvar_helper(chan, chanvar, "SUCCESS");
00144       res = 0;
00145    } 
00146 
00147    ast_autoservice_stop(chan);
00148 
00149    return res;
00150 }

static int trysystem_exec ( struct ast_channel chan,
const char *  data 
) [static]

Definition at line 157 of file app_system.c.

References system_exec_helper().

Referenced by load_module().

00158 {
00159    return system_exec_helper(chan, data, 0);
00160 }

static int unload_module ( void   )  [static]

Definition at line 162 of file app_system.c.

References ast_unregister_application().

00163 {
00164    int res;
00165 
00166    res = ast_unregister_application(app);
00167    res |= ast_unregister_application(app2);
00168 
00169    return res;
00170 }


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

Definition at line 182 of file app_system.c.

char* app = "System" [static]

Definition at line 97 of file app_system.c.

char* app2 = "TrySystem" [static]

Definition at line 99 of file app_system.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 182 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 95 of file app_system.c.

Referenced by system_exec_helper().

char* chanvar = "SYSTEMSTATUS" [static]

Definition at line 101 of file app_system.c.

Referenced by function_sippeer(), and load_config().


Generated on Mon Jun 27 16:51:00 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7