apps/app_readfile.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Matt O'Gorman <mogorman@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief ReadFile application -- Reads in a File for you.
  22  *
  23  * \author Matt O'Gorman <mogorman@digium.com>
  24  *
  25  * \ingroup applications
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include "asterisk/file.h"
  33 #include "asterisk/channel.h"
  34 #include "asterisk/pbx.h"
  35 #include "asterisk/app.h"
  36 #include "asterisk/module.h"
  37
  38 static char *app_readfile = "ReadFile";
  39
  40 static char *readfile_synopsis = "Read the contents of a text file into a channel variable";
  41
  42 static char *readfile_descrip =
  43 "ReadFile(varname=file,length)\n"
  44 "  varname  - Result stored here.\n"
  45 "  file     - The name of the file to read.\n"
  46 "  length   - Maximum number of characters to capture.\n";
  47
  48
  49 static int readfile_exec(struct ast_channel *chan, void *data)
  50 {
  51         int res=0;
  52         char *s, *varname=NULL, *file=NULL, *length=NULL, *returnvar=NULL;
  53         int len=0;
  54         static int deprecation_warning = 0;
  55
  56         if (ast_strlen_zero(data)) {
  57                 ast_log(LOG_WARNING, "ReadFile require an argument!\n");
  58                 return -1;
  59         }
  60
  61         s = ast_strdupa(data);
  62
  63         varname = strsep(&s, "=");
  64         file = strsep(&s, ",");
  65         length = s;
  66
  67         if (deprecation_warning++ % 10 == 0)
  68                 ast_log(LOG_WARNING, "ReadFile has been deprecated in favor of Set(%s=${FILE(%s,0,%s)})\n", varname, file, length);
  69
  70         if (!varname || !file) {
  71                 ast_log(LOG_ERROR, "No file or variable specified!\n");
  72                 return -1;
  73         }
  74
  75         if (length) {
  76                 if ((sscanf(length, "%d", &len) != 1) || (len < 0)) {
  77                         ast_log(LOG_WARNING, "%s is not a positive number, defaulting length to max\n", length);
  78                         len = 0;
  79                 }
  80         }
  81
  82         if ((returnvar = ast_read_textfile(file))) {
  83                 if (len > 0) {
  84                         if (len < strlen(returnvar))
  85                                 returnvar[len]='\0';
  86                         else
  87                                 ast_log(LOG_WARNING, "%s is longer than %d, and %d \n", file, len, (int)strlen(returnvar));
  88                 }
  89                 pbx_builtin_setvar_helper(chan, varname, returnvar);
  90                 ast_free(returnvar);
  91         }
  92
  93         return res;
  94 }
  95
  96
  97 static int unload_module(void)
  98 {
  99         return ast_unregister_application(app_readfile);
 100 }
 101
 102 static int load_module(void)
 103 {
 104         return ast_register_application(app_readfile, readfile_exec, readfile_synopsis, readfile_descrip);
 105 }
 106
 107 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Stores output of file into a variable");