2005-05-05 05:39:33 +00:00
|
|
|
/*
|
2005-09-14 20:46:50 +00:00
|
|
|
* Asterisk -- An open source telephony toolkit.
|
2005-05-05 05:39:33 +00:00
|
|
|
*
|
2006-02-12 04:28:58 +00:00
|
|
|
* Copyright (C) 1999 - 2006, Digium, Inc.
|
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.
|
2005-05-05 05:39:33 +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 Environment related dialplan functions
|
2005-09-14 20:46:50 +00:00
|
|
|
*
|
2007-01-24 09:05:29 +00:00
|
|
|
* \ingroup functions
|
2005-05-05 05:39:33 +00:00
|
|
|
*/
|
|
|
|
|
2006-06-07 18:54:56 +00:00
|
|
|
#include "asterisk.h"
|
|
|
|
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
|
2005-12-21 17:09:54 +00:00
|
|
|
#include <sys/stat.h>
|
2005-05-05 05:39:33 +00:00
|
|
|
|
2006-02-11 03:14:05 +00:00
|
|
|
#include "asterisk/module.h"
|
2005-05-05 05:39:33 +00:00
|
|
|
#include "asterisk/channel.h"
|
|
|
|
#include "asterisk/pbx.h"
|
|
|
|
#include "asterisk/utils.h"
|
|
|
|
#include "asterisk/app.h"
|
|
|
|
|
2008-11-01 21:10:07 +00:00
|
|
|
/*** DOCUMENTATION
|
|
|
|
<function name="ENV" language="en_US">
|
|
|
|
<synopsis>
|
|
|
|
Gets or sets the environment variable specified.
|
|
|
|
</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="varname" required="true">
|
2008-11-02 02:50:33 +00:00
|
|
|
<para>Environment variable name</para>
|
2008-11-01 21:10:07 +00:00
|
|
|
</parameter>
|
|
|
|
</syntax>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</function>
|
|
|
|
<function name="STAT" language="en_US">
|
|
|
|
<synopsis>
|
|
|
|
Does a check on the specified file.
|
|
|
|
</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="flag" required="true">
|
|
|
|
<para>Flag may be one of the following:</para>
|
|
|
|
<para>d - Checks if the file is a directory.</para>
|
|
|
|
<para>e - Checks if the file exists.</para>
|
|
|
|
<para>f - Checks if the file is a regular file.</para>
|
|
|
|
<para>m - Returns the file mode (in octal)</para>
|
|
|
|
<para>s - Returns the size (in bytes) of the file</para>
|
|
|
|
<para>A - Returns the epoch at which the file was last accessed.</para>
|
|
|
|
<para>C - Returns the epoch at which the inode was last changed.</para>
|
|
|
|
<para>M - Returns the epoch at which the file was last modified.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="filename" required="true" />
|
|
|
|
</syntax>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</function>
|
|
|
|
<function name="FILE" language="en_US">
|
|
|
|
<synopsis>
|
|
|
|
Obtains the contents of a file.
|
|
|
|
</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="filename" required="true" />
|
|
|
|
<parameter name="offset" required="true">
|
2009-03-16 17:33:38 +00:00
|
|
|
<para>Maybe specified as any number. If negative, <replaceable>offset</replaceable> specifies the number
|
2008-11-01 21:10:07 +00:00
|
|
|
of bytes back from the end of the file.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="length" required="true">
|
2009-03-16 17:33:38 +00:00
|
|
|
<para>If specified, will limit the length of the data read to that size. If negative,
|
|
|
|
trims <replaceable>length</replaceable> bytes from the end of the file.</para>
|
2008-11-01 21:10:07 +00:00
|
|
|
</parameter>
|
|
|
|
</syntax>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</function>
|
|
|
|
***/
|
|
|
|
|
2007-01-06 00:13:33 +00:00
|
|
|
static int env_read(struct ast_channel *chan, const char *cmd, char *data,
|
2006-02-12 04:28:58 +00:00
|
|
|
char *buf, size_t len)
|
2005-05-05 05:39:33 +00:00
|
|
|
{
|
2006-02-12 04:28:58 +00:00
|
|
|
char *ret = NULL;
|
2005-05-05 05:39:33 +00:00
|
|
|
|
2006-02-12 04:28:58 +00:00
|
|
|
*buf = '\0';
|
|
|
|
|
|
|
|
if (data)
|
2005-05-05 05:39:33 +00:00
|
|
|
ret = getenv(data);
|
|
|
|
|
2006-02-12 04:28:58 +00:00
|
|
|
if (ret)
|
|
|
|
ast_copy_string(buf, ret, len);
|
|
|
|
|
|
|
|
return 0;
|
2005-05-05 05:39:33 +00:00
|
|
|
}
|
|
|
|
|
2007-01-06 00:13:33 +00:00
|
|
|
static int env_write(struct ast_channel *chan, const char *cmd, char *data,
|
2006-02-12 04:28:58 +00:00
|
|
|
const char *value)
|
2005-05-05 05:39:33 +00:00
|
|
|
{
|
2005-11-08 01:55:31 +00:00
|
|
|
if (!ast_strlen_zero(data)) {
|
|
|
|
if (!ast_strlen_zero(value)) {
|
2005-05-05 05:39:33 +00:00
|
|
|
setenv(data, value, 1);
|
|
|
|
} else {
|
|
|
|
unsetenv(data);
|
|
|
|
}
|
|
|
|
}
|
2006-02-12 04:28:58 +00:00
|
|
|
|
|
|
|
return 0;
|
2005-05-05 05:39:33 +00:00
|
|
|
}
|
|
|
|
|
2007-01-06 00:13:33 +00:00
|
|
|
static int stat_read(struct ast_channel *chan, const char *cmd, char *data,
|
2006-02-12 04:28:58 +00:00
|
|
|
char *buf, size_t len)
|
2005-12-21 17:09:54 +00:00
|
|
|
{
|
|
|
|
char *action;
|
|
|
|
struct stat s;
|
|
|
|
|
2007-11-27 15:41:46 +00:00
|
|
|
ast_copy_string(buf, "0", len);
|
2005-12-21 17:09:54 +00:00
|
|
|
|
2007-07-23 19:51:41 +00:00
|
|
|
action = strsep(&data, ",");
|
2005-12-21 17:09:54 +00:00
|
|
|
if (stat(data, &s)) {
|
2007-12-31 20:33:21 +00:00
|
|
|
return 0;
|
2005-12-21 17:09:54 +00:00
|
|
|
} else {
|
|
|
|
switch (*action) {
|
|
|
|
case 'e':
|
2006-02-12 04:28:58 +00:00
|
|
|
strcpy(buf, "1");
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
case 's':
|
2006-02-12 04:28:58 +00:00
|
|
|
snprintf(buf, len, "%d", (unsigned int) s.st_size);
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
case 'f':
|
|
|
|
snprintf(buf, len, "%d", S_ISREG(s.st_mode) ? 1 : 0);
|
|
|
|
break;
|
|
|
|
case 'd':
|
|
|
|
snprintf(buf, len, "%d", S_ISDIR(s.st_mode) ? 1 : 0);
|
|
|
|
break;
|
|
|
|
case 'M':
|
2006-02-12 04:28:58 +00:00
|
|
|
snprintf(buf, len, "%d", (int) s.st_mtime);
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
case 'A':
|
2006-02-12 04:28:58 +00:00
|
|
|
snprintf(buf, len, "%d", (int) s.st_mtime);
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
case 'C':
|
2006-02-12 04:28:58 +00:00
|
|
|
snprintf(buf, len, "%d", (int) s.st_ctime);
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
case 'm':
|
2006-02-12 04:28:58 +00:00
|
|
|
snprintf(buf, len, "%o", (int) s.st_mode);
|
2005-12-21 17:09:54 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2006-02-12 04:28:58 +00:00
|
|
|
|
|
|
|
return 0;
|
2005-12-21 17:09:54 +00:00
|
|
|
}
|
|
|
|
|
2007-11-08 17:32:15 +00:00
|
|
|
static int file_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
|
|
|
|
{
|
|
|
|
AST_DECLARE_APP_ARGS(args,
|
|
|
|
AST_APP_ARG(filename);
|
|
|
|
AST_APP_ARG(offset);
|
|
|
|
AST_APP_ARG(length);
|
|
|
|
);
|
2009-03-16 17:33:38 +00:00
|
|
|
int offset = 0, length, res = 0;
|
2007-11-08 17:32:15 +00:00
|
|
|
char *contents;
|
2009-03-16 17:33:38 +00:00
|
|
|
size_t contents_len;
|
2007-11-08 17:32:15 +00:00
|
|
|
|
|
|
|
AST_STANDARD_APP_ARGS(args, data);
|
2009-03-16 17:33:38 +00:00
|
|
|
if (args.argc > 1) {
|
2007-11-08 17:32:15 +00:00
|
|
|
offset = atoi(args.offset);
|
2009-03-16 17:33:38 +00:00
|
|
|
}
|
2007-11-08 17:32:15 +00:00
|
|
|
|
|
|
|
if (args.argc > 2) {
|
2009-03-16 17:33:38 +00:00
|
|
|
/* The +1/-1 in this code section is to accomodate for the terminating NULL. */
|
|
|
|
if ((length = atoi(args.length) + 1) > len) {
|
|
|
|
ast_log(LOG_WARNING, "Length %d is greater than the max (%d). Truncating output.\n", length - 1, (int)len - 1);
|
2007-11-08 17:32:15 +00:00
|
|
|
length = len;
|
|
|
|
}
|
2009-03-16 17:33:38 +00:00
|
|
|
} else {
|
2007-11-08 17:32:15 +00:00
|
|
|
length = len;
|
2009-03-16 17:33:38 +00:00
|
|
|
}
|
2007-11-08 17:32:15 +00:00
|
|
|
|
2009-03-16 17:33:38 +00:00
|
|
|
if (!(contents = ast_read_textfile(args.filename))) {
|
2007-11-08 17:32:15 +00:00
|
|
|
return -1;
|
2009-03-16 17:33:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
do {
|
|
|
|
contents_len = strlen(contents);
|
|
|
|
if (offset > contents_len) {
|
|
|
|
res = -1;
|
|
|
|
break;
|
|
|
|
}
|
2007-11-08 17:32:15 +00:00
|
|
|
|
2009-03-16 17:33:38 +00:00
|
|
|
if (offset >= 0) {
|
|
|
|
if (length < 0) {
|
|
|
|
if (contents_len - offset + length < 0) {
|
|
|
|
/* Nothing left after trimming */
|
|
|
|
res = -1;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
ast_copy_string(buf, &contents[offset], contents_len + length);
|
|
|
|
} else {
|
|
|
|
ast_copy_string(buf, &contents[offset], length);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if (offset * -1 > contents_len) {
|
|
|
|
ast_log(LOG_WARNING, "Offset is larger than the file size.\n");
|
|
|
|
offset = contents_len * -1;
|
|
|
|
}
|
|
|
|
ast_copy_string(buf, &contents[contents_len + offset], length);
|
2007-11-08 17:32:15 +00:00
|
|
|
}
|
2009-03-16 17:33:38 +00:00
|
|
|
} while (0);
|
|
|
|
|
2007-11-08 17:32:15 +00:00
|
|
|
ast_free(contents);
|
|
|
|
|
2009-03-16 17:33:38 +00:00
|
|
|
return res;
|
2007-11-08 17:32:15 +00:00
|
|
|
}
|
|
|
|
|
2006-02-11 03:14:05 +00:00
|
|
|
static struct ast_custom_function env_function = {
|
2005-05-05 05:39:33 +00:00
|
|
|
.name = "ENV",
|
2006-02-11 03:14:05 +00:00
|
|
|
.read = env_read,
|
2008-11-01 21:10:07 +00:00
|
|
|
.write = env_write
|
2005-05-05 05:39:33 +00:00
|
|
|
};
|
2005-12-21 17:09:54 +00:00
|
|
|
|
2006-02-11 03:14:05 +00:00
|
|
|
static struct ast_custom_function stat_function = {
|
2005-12-21 17:09:54 +00:00
|
|
|
.name = "STAT",
|
2008-11-01 21:10:07 +00:00
|
|
|
.read = stat_read
|
2005-12-21 17:09:54 +00:00
|
|
|
};
|
|
|
|
|
2007-11-08 17:32:15 +00:00
|
|
|
static struct ast_custom_function file_function = {
|
|
|
|
.name = "FILE",
|
2008-11-01 21:10:07 +00:00
|
|
|
.read = file_read
|
2007-11-08 17:32:15 +00:00
|
|
|
/*
|
|
|
|
* Some enterprising programmer could probably add write functionality
|
|
|
|
* to FILE(), although I'm not sure how useful it would be. Hence why
|
|
|
|
* it's called FILE and not READFILE (like the app was).
|
|
|
|
*/
|
|
|
|
};
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int unload_module(void)
|
2006-02-11 03:14:05 +00:00
|
|
|
{
|
|
|
|
int res = 0;
|
|
|
|
|
|
|
|
res |= ast_custom_function_unregister(&env_function);
|
|
|
|
res |= ast_custom_function_unregister(&stat_function);
|
2007-11-08 17:32:15 +00:00
|
|
|
res |= ast_custom_function_unregister(&file_function);
|
2006-02-11 03:14:05 +00:00
|
|
|
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int load_module(void)
|
2006-02-11 03:14:05 +00:00
|
|
|
{
|
|
|
|
int res = 0;
|
|
|
|
|
|
|
|
res |= ast_custom_function_register(&env_function);
|
|
|
|
res |= ast_custom_function_register(&stat_function);
|
2007-11-08 17:32:15 +00:00
|
|
|
res |= ast_custom_function_register(&file_function);
|
2006-02-11 03:14:05 +00:00
|
|
|
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Environment/filesystem dialplan functions");
|