include "logger.h" and errno.h from asterisk.h - usage shows that they
[asterisk/asterisk.git] / 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/options.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/app.h"
37 #include "asterisk/module.h"
38
39 static char *app_readfile = "ReadFile";
40
41 static char *readfile_synopsis = "Read the contents of a text file into a channel variable";
42
43 static char *readfile_descrip =
44 "ReadFile(varname=file,length)\n"
45 "  varname  - Result stored here.\n"
46 "  file     - The name of the file to read.\n"
47 "  length   - Maximum number of characters to capture.\n";
48
49
50 static int readfile_exec(struct ast_channel *chan, void *data)
51 {
52         int res=0;
53         char *s, *varname=NULL, *file=NULL, *length=NULL, *returnvar=NULL;
54         int len=0;
55         static int deprecation_warning = 0;
56
57         if (ast_strlen_zero(data)) {
58                 ast_log(LOG_WARNING, "ReadFile require an argument!\n");
59                 return -1;
60         }
61
62         s = ast_strdupa(data);
63
64         varname = strsep(&s, "=");
65         file = strsep(&s, ",");
66         length = s;
67
68         if (deprecation_warning++ % 10 == 0)
69                 ast_log(LOG_WARNING, "ReadFile has been deprecated in favor of Set(%s=${FILE(%s,0,%s)})\n", varname, file, length);
70
71         if (!varname || !file) {
72                 ast_log(LOG_ERROR, "No file or variable specified!\n");
73                 return -1;
74         }
75
76         if (length) {
77                 if ((sscanf(length, "%d", &len) != 1) || (len < 0)) {
78                         ast_log(LOG_WARNING, "%s is not a positive number, defaulting length to max\n", length);
79                         len = 0;
80                 }
81         }
82
83         if ((returnvar = ast_read_textfile(file))) {
84                 if (len > 0) {
85                         if (len < strlen(returnvar))
86                                 returnvar[len]='\0';
87                         else
88                                 ast_log(LOG_WARNING, "%s is longer than %d, and %d \n", file, len, (int)strlen(returnvar));
89                 }
90                 pbx_builtin_setvar_helper(chan, varname, returnvar);
91                 ast_free(returnvar);
92         }
93
94         return res;
95 }
96
97
98 static int unload_module(void)
99 {
100         return ast_unregister_application(app_readfile);
101 }
102
103 static int load_module(void)
104 {
105         return ast_register_application(app_readfile, readfile_exec, readfile_synopsis, readfile_descrip);
106 }
107
108 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Stores output of file into a variable");