Skip to content
Snippets Groups Projects
func_env.c 6.37 KiB
Newer Older
  • Learn to ignore specific revisions
  •  * Asterisk -- An open source telephony toolkit.
    
     * Copyright (C) 1999 - 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.
     */
    
    
     * \brief Environment related dialplan functions
    
    Olle Johansson's avatar
    Olle Johansson committed
     * \ingroup functions
    
    #include "asterisk.h"
    
    ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
    
    
    #include <sys/stat.h>
    
    #include "asterisk/channel.h"
    #include "asterisk/pbx.h"
    #include "asterisk/utils.h"
    #include "asterisk/app.h"
    
    
    /*** DOCUMENTATION
    	<function name="ENV" language="en_US">
    		<synopsis>
    			Gets or sets the environment variable specified.
    		</synopsis>
    		<syntax>
    			<parameter name="varname" required="true">
    
    				<para>Environment variable name</para>
    
    			</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">
    
    				<para>Maybe specified as any number. If negative, <replaceable>offset</replaceable> specifies the number
    
    				of bytes back from the end of the file.</para>
    			</parameter>
    			<parameter name="length" required="true">
    
    				<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>
    
    			</parameter>
    		</syntax>
    		<description>
    		</description>
    	</function>
     ***/
    
    
    static int env_read(struct ast_channel *chan, const char *cmd, char *data,
    
    		    char *buf, size_t len)
    
    	char *ret = NULL;
    
    	*buf = '\0';
    
    	if (data)
    
    	if (ret)
    		ast_copy_string(buf, ret, len);
    
    	return 0;
    
    static int env_write(struct ast_channel *chan, const char *cmd, char *data,
    
    		     const char *value)
    
    Kevin P. Fleming's avatar
    Kevin P. Fleming committed
    	if (!ast_strlen_zero(data)) {
    		if (!ast_strlen_zero(value)) {
    
    			setenv(data, value, 1);
    		} else {
    			unsetenv(data);
    		}
    	}
    
    static int stat_read(struct ast_channel *chan, const char *cmd, char *data,
    
    		     char *buf, size_t len)
    
    {
    	char *action;
    	struct stat s;
    
    
    	ast_copy_string(buf, "0", len);
    
    	if (stat(data, &s)) {
    
    	} else {
    		switch (*action) {
    		case 'e':
    
    			strcpy(buf, "1");
    
    			snprintf(buf, len, "%d", (unsigned int) s.st_size);
    
    			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':
    
    			snprintf(buf, len, "%d", (int) s.st_mtime);
    
    			snprintf(buf, len, "%d", (int) s.st_mtime);
    
    			snprintf(buf, len, "%d", (int) s.st_ctime);
    
    			snprintf(buf, len, "%o", (int) s.st_mode);
    
    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);
    	);
    
    
    	AST_STANDARD_APP_ARGS(args, data);
    
    		offset = atoi(args.offset);
    
    		/* 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);
    
    	if (!(contents = ast_read_textfile(args.filename))) {
    
    	}
    
    	do {
    		contents_len = strlen(contents);
    		if (offset > contents_len) {
    			res = -1;
    			break;
    		}
    
    		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);
    
    static struct ast_custom_function env_function = {
    
    	.write = env_write
    
    static struct ast_custom_function stat_function = {
    
    	.name = "STAT",
    
    	.read = stat_read,
    	.read_max = 12,
    
    static struct ast_custom_function file_function = {
    	.name = "FILE",
    
    	.read = file_read
    
    	/*
    	 * 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).
    	 */
    };
    
    
    static int unload_module(void)
    
    {
    	int res = 0;
    
    	res |= ast_custom_function_unregister(&env_function);
    	res |= ast_custom_function_unregister(&stat_function);
    
    	res |= ast_custom_function_unregister(&file_function);
    
    static int load_module(void)
    
    {
    	int res = 0;
    
    	res |= ast_custom_function_register(&env_function);
    	res |= ast_custom_function_register(&stat_function);
    
    	res |= ast_custom_function_register(&file_function);
    
    AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Environment/filesystem dialplan functions");