mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-29 23:39:35 +00:00
5b168ee34b
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
105 lines
2.7 KiB
C
105 lines
2.7 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2006, Digium, Inc.
|
|
*
|
|
* 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.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* SHELL function to return the value of a system call.
|
|
*
|
|
* \note Inspiration and Guidance from Russell! Thank You!
|
|
*
|
|
* \author Brandon Kruse <bkruse@digium.com>
|
|
*
|
|
* \ingroup functions
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/utils.h"
|
|
#include "asterisk/app.h"
|
|
|
|
static int shell_helper(struct ast_channel *chan, const char *cmd, char *data,
|
|
char *buf, size_t len)
|
|
{
|
|
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");
|
|
while (fgets(plbuff, sizeof(plbuff), ptr)) {
|
|
strncat(buf, plbuff, len - strlen(buf) - 1);
|
|
}
|
|
pclose(ptr);
|
|
}
|
|
|
|
if (chan)
|
|
ast_autoservice_stop(chan);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/*** DOCUMENTATION
|
|
<function name="SHELL" language="en_US">
|
|
<synopsis>
|
|
Executes a command as if you were at a shell.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="command" required="true">
|
|
<para>This is the argument to the function, the command you want to pass to the shell.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Returns the value from a system command</para>
|
|
<para>Example: <literal>Set(foo=${SHELL(echo \bar\)})</literal></para>
|
|
<note><para>When using the SHELL() dialplan function, your \SHELL\ is /bin/sh,
|
|
which may differ as to the underlying shell, depending upon your production
|
|
platform. Also keep in mind that if you are using a common path, you should
|
|
be mindful of race conditions that could result from two calls running
|
|
SHELL() simultaneously.</para></note>
|
|
</description>
|
|
|
|
</function>
|
|
***/
|
|
static struct ast_custom_function shell_function = {
|
|
.name = "SHELL",
|
|
.read = shell_helper,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
return ast_custom_function_unregister(&shell_function);
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_custom_function_register(&shell_function);
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Returns the output of a shell command");
|
|
|