2000-01-02 20:59:00 +00:00
|
|
|
/*
|
2005-09-14 20:46:50 +00:00
|
|
|
* Asterisk -- An open source telephony toolkit.
|
2000-01-02 20:59:00 +00:00
|
|
|
*
|
2005-01-21 07:06:25 +00:00
|
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
2000-01-02 20:59:00 +00:00
|
|
|
*
|
2004-09-18 14:14:15 +00:00
|
|
|
* Mark Spencer <markster@digium.com>
|
2000-01-02 20:59:00 +00:00
|
|
|
*
|
2005-09-14 20:46:50 +00:00
|
|
|
* See http://www.asterisk.org for more information about
|
|
|
|
* the Asterisk project. Please do not directly contact
|
|
|
|
* any of the maintainers of this project for assistance;
|
|
|
|
* the project provides a web site, mailing lists and IRC
|
|
|
|
* channels for your use.
|
|
|
|
*
|
2000-01-02 20:59:00 +00:00
|
|
|
* This program is free software, distributed under the terms of
|
2005-09-14 20:46:50 +00:00
|
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
|
|
* at the top of the source tree.
|
|
|
|
*/
|
|
|
|
|
2005-10-24 20:12:06 +00:00
|
|
|
/*! \file
|
2005-09-14 20:46:50 +00:00
|
|
|
*
|
2005-10-24 20:12:06 +00:00
|
|
|
* \brief Execute arbitrary system commands
|
2005-12-30 21:18:06 +00:00
|
|
|
*
|
|
|
|
* \author Mark Spencer <markster@digium.com>
|
2005-09-14 20:46:50 +00:00
|
|
|
*
|
2005-11-06 15:09:47 +00:00
|
|
|
* \ingroup applications
|
2000-01-02 20:59:00 +00:00
|
|
|
*/
|
|
|
|
|
2012-06-15 16:20:16 +00:00
|
|
|
/*** MODULEINFO
|
|
|
|
<support_level>core</support_level>
|
|
|
|
***/
|
|
|
|
|
2006-06-07 18:54:56 +00:00
|
|
|
#include "asterisk.h"
|
|
|
|
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
|
2005-04-21 06:02:45 +00:00
|
|
|
#include "asterisk/pbx.h"
|
|
|
|
#include "asterisk/module.h"
|
|
|
|
#include "asterisk/app.h"
|
2007-11-22 03:50:04 +00:00
|
|
|
#include "asterisk/channel.h" /* autoservice */
|
2009-02-20 17:29:51 +00:00
|
|
|
#include "asterisk/strings.h"
|
|
|
|
#include "asterisk/threadstorage.h"
|
2000-01-02 20:59:00 +00:00
|
|
|
|
2008-11-01 21:10:07 +00:00
|
|
|
/*** DOCUMENTATION
|
|
|
|
<application name="System" language="en_US">
|
|
|
|
<synopsis>
|
|
|
|
Execute a system command.
|
|
|
|
</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="command" required="true">
|
|
|
|
<para>Command to execute</para>
|
|
|
|
</parameter>
|
|
|
|
</syntax>
|
|
|
|
<description>
|
|
|
|
<para>Executes a command by using system(). If the command
|
|
|
|
fails, the console should report a fallthrough.</para>
|
|
|
|
<para>Result of execution is returned in the <variable>SYSTEMSTATUS</variable> channel variable:</para>
|
|
|
|
<variablelist>
|
|
|
|
<variable name="SYSTEMSTATUS">
|
|
|
|
<value name="FAILURE">
|
|
|
|
Could not execute the specified command.
|
|
|
|
</value>
|
|
|
|
<value name="SUCCESS">
|
|
|
|
Specified command successfully executed.
|
|
|
|
</value>
|
|
|
|
</variable>
|
|
|
|
</variablelist>
|
|
|
|
</description>
|
|
|
|
</application>
|
|
|
|
<application name="TrySystem" language="en_US">
|
|
|
|
<synopsis>
|
|
|
|
Try executing a system command.
|
|
|
|
</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="command" required="true">
|
|
|
|
<para>Command to execute</para>
|
|
|
|
</parameter>
|
|
|
|
</syntax>
|
|
|
|
<description>
|
|
|
|
<para>Executes a command by using system().</para>
|
|
|
|
<para>Result of execution is returned in the <variable>SYSTEMSTATUS</variable> channel variable:</para>
|
|
|
|
<variablelist>
|
|
|
|
<variable name="SYSTEMSTATUS">
|
|
|
|
<value name="FAILURE">
|
|
|
|
Could not execute the specified command.
|
|
|
|
</value>
|
|
|
|
<value name="SUCCESS">
|
|
|
|
Specified command successfully executed.
|
|
|
|
</value>
|
|
|
|
<value name="APPERROR">
|
|
|
|
Specified command successfully executed, but returned error code.
|
|
|
|
</value>
|
|
|
|
</variable>
|
|
|
|
</variablelist>
|
|
|
|
</description>
|
|
|
|
</application>
|
|
|
|
|
|
|
|
***/
|
|
|
|
|
2009-02-20 17:29:51 +00:00
|
|
|
AST_THREADSTORAGE(buf_buf);
|
|
|
|
|
2000-01-02 20:59:00 +00:00
|
|
|
static char *app = "System";
|
|
|
|
|
2004-09-18 14:14:15 +00:00
|
|
|
static char *app2 = "TrySystem";
|
|
|
|
|
2005-09-07 18:52:54 +00:00
|
|
|
static char *chanvar = "SYSTEMSTATUS";
|
|
|
|
|
2009-05-21 21:13:09 +00:00
|
|
|
static int system_exec_helper(struct ast_channel *chan, const char *data, int failmode)
|
2000-01-02 20:59:00 +00:00
|
|
|
{
|
2007-07-16 14:39:29 +00:00
|
|
|
int res = 0;
|
2009-02-20 17:29:51 +00:00
|
|
|
struct ast_str *buf = ast_str_thread_get(&buf_buf, 16);
|
2010-03-11 20:25:02 +00:00
|
|
|
char *cbuf;
|
|
|
|
|
2005-10-26 19:48:14 +00:00
|
|
|
if (ast_strlen_zero(data)) {
|
2000-01-02 20:59:00 +00:00
|
|
|
ast_log(LOG_WARNING, "System requires an argument(command)\n");
|
2005-09-07 18:52:54 +00:00
|
|
|
pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
|
2004-09-18 14:14:15 +00:00
|
|
|
return failmode;
|
2000-01-02 20:59:00 +00:00
|
|
|
}
|
2005-10-19 18:19:02 +00:00
|
|
|
|
2007-09-19 19:51:47 +00:00
|
|
|
ast_autoservice_start(chan);
|
|
|
|
|
2000-01-02 20:59:00 +00:00
|
|
|
/* Do our thing here */
|
2009-02-20 17:29:51 +00:00
|
|
|
ast_str_get_encoded_str(&buf, 0, (char *) data);
|
2010-03-11 20:25:02 +00:00
|
|
|
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);
|
2009-02-20 17:29:51 +00:00
|
|
|
|
2004-02-27 06:56:08 +00:00
|
|
|
if ((res < 0) && (errno != ECHILD)) {
|
2002-06-21 01:40:13 +00:00
|
|
|
ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
|
2005-09-07 18:52:54 +00:00
|
|
|
pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
|
2004-09-18 14:14:15 +00:00
|
|
|
res = failmode;
|
2000-01-02 20:59:00 +00:00
|
|
|
} else if (res == 127) {
|
2002-06-21 01:40:13 +00:00
|
|
|
ast_log(LOG_WARNING, "Unable to execute '%s'\n", (char *)data);
|
2005-09-07 18:52:54 +00:00
|
|
|
pbx_builtin_setvar_helper(chan, chanvar, "FAILURE");
|
2004-09-18 14:14:15 +00:00
|
|
|
res = failmode;
|
2000-01-02 20:59:00 +00:00
|
|
|
} else {
|
2005-09-07 18:52:54 +00:00
|
|
|
if (res < 0)
|
2004-02-27 06:56:08 +00:00
|
|
|
res = 0;
|
2005-09-07 18:52:54 +00:00
|
|
|
if (res != 0)
|
|
|
|
pbx_builtin_setvar_helper(chan, chanvar, "APPERROR");
|
|
|
|
else
|
|
|
|
pbx_builtin_setvar_helper(chan, chanvar, "SUCCESS");
|
2000-01-02 20:59:00 +00:00
|
|
|
res = 0;
|
2005-09-07 18:52:54 +00:00
|
|
|
}
|
|
|
|
|
2007-09-19 19:51:47 +00:00
|
|
|
ast_autoservice_stop(chan);
|
|
|
|
|
2000-01-02 20:59:00 +00:00
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2009-05-21 21:13:09 +00:00
|
|
|
static int system_exec(struct ast_channel *chan, const char *data)
|
2004-09-18 14:14:15 +00:00
|
|
|
{
|
|
|
|
return system_exec_helper(chan, data, -1);
|
|
|
|
}
|
|
|
|
|
2009-05-21 21:13:09 +00:00
|
|
|
static int trysystem_exec(struct ast_channel *chan, const char *data)
|
2004-09-18 14:14:15 +00:00
|
|
|
{
|
|
|
|
return system_exec_helper(chan, data, 0);
|
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int unload_module(void)
|
2000-01-02 20:59:00 +00:00
|
|
|
{
|
2005-10-18 22:52:21 +00:00
|
|
|
int res;
|
|
|
|
|
|
|
|
res = ast_unregister_application(app);
|
|
|
|
res |= ast_unregister_application(app2);
|
|
|
|
|
|
|
|
return res;
|
2000-01-02 20:59:00 +00:00
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int load_module(void)
|
2000-01-02 20:59:00 +00:00
|
|
|
{
|
2005-10-18 22:52:21 +00:00
|
|
|
int res;
|
|
|
|
|
2008-11-01 21:10:07 +00:00
|
|
|
res = ast_register_application_xml(app2, trysystem_exec);
|
|
|
|
res |= ast_register_application_xml(app, system_exec);
|
2005-10-18 22:52:21 +00:00
|
|
|
|
|
|
|
return res;
|
2000-01-02 20:59:00 +00:00
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Generic System() application");
|