Thu Apr 28 2011 17:15:15

Asterisk developer's documentation


app_readfile.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Matt O'Gorman <mogorman@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief ReadFile application -- Reads in a File for you.
00022  *
00023  * \author Matt O'Gorman <mogorman@digium.com>
00024  *
00025  * \ingroup applications
00026  */
00027 
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 211580 $")
00031 
00032 #include "asterisk/file.h"
00033 #include "asterisk/channel.h"
00034 #include "asterisk/pbx.h"
00035 #include "asterisk/app.h"
00036 #include "asterisk/module.h"
00037 
00038 /*** DOCUMENTATION
00039    <application name="ReadFile" language="en_US">
00040       <synopsis>
00041          Read the contents of a text file into a channel variable.
00042       </synopsis>
00043       <syntax argsep="=">
00044          <parameter name="varname" required="true">
00045             <para>Result stored here.</para>
00046          </parameter>
00047          <parameter name="fileparams" required="true">
00048             <argument name="file" required="true">
00049                <para>The name of the file to read.</para>
00050             </argument>
00051             <argument name="length" required="false">
00052                <para>Maximum number of characters to capture.</para>
00053                <para>If not specified defaults to max.</para>
00054             </argument>
00055          </parameter>
00056       </syntax>
00057       <description>
00058          <para>Read the contents of a text file into channel variable <replaceable>varname</replaceable></para>
00059          <warning><para>ReadFile has been deprecated in favor of Set(varname=${FILE(file,0,length)})</para></warning>
00060       </description>
00061       <see-also>
00062          <ref type="application">System</ref>
00063          <ref type="application">Read</ref>
00064       </see-also>
00065    </application>
00066  ***/
00067 
00068 static char *app_readfile = "ReadFile";
00069 
00070 static int readfile_exec(struct ast_channel *chan, void *data)
00071 {
00072    int res=0;
00073    char *s, *varname=NULL, *file=NULL, *length=NULL, *returnvar=NULL;
00074    int len=0;
00075    static int deprecation_warning = 0;
00076 
00077    if (ast_strlen_zero(data)) {
00078       ast_log(LOG_WARNING, "ReadFile require an argument!\n");
00079       return -1;
00080    }
00081 
00082    s = ast_strdupa(data);
00083 
00084    varname = strsep(&s, "=");
00085    file = strsep(&s, ",");
00086    length = s;
00087 
00088    if (deprecation_warning++ % 10 == 0)
00089       ast_log(LOG_WARNING, "ReadFile has been deprecated in favor of Set(%s=${FILE(%s,0,%s)})\n", varname, file, length);
00090 
00091    if (!varname || !file) {
00092       ast_log(LOG_ERROR, "No file or variable specified!\n");
00093       return -1;
00094    }
00095 
00096    if (length) {
00097       if ((sscanf(length, "%30d", &len) != 1) || (len < 0)) {
00098          ast_log(LOG_WARNING, "%s is not a positive number, defaulting length to max\n", length);
00099          len = 0;
00100       }
00101    }
00102 
00103    if ((returnvar = ast_read_textfile(file))) {
00104       if (len > 0) {
00105          if (len < strlen(returnvar))
00106             returnvar[len]='\0';
00107          else
00108             ast_log(LOG_WARNING, "%s is longer than %d, and %d \n", file, len, (int)strlen(returnvar));
00109       }
00110       pbx_builtin_setvar_helper(chan, varname, returnvar);
00111       ast_free(returnvar);
00112    }
00113 
00114    return res;
00115 }
00116 
00117 
00118 static int unload_module(void)
00119 {
00120    return ast_unregister_application(app_readfile);
00121 }
00122 
00123 static int load_module(void)
00124 {
00125    return ast_register_application_xml(app_readfile, readfile_exec);
00126 }
00127 
00128 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Stores output of file into a variable");