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