Automatically create new buddy upon reception of a presence stanza of
[asterisk/asterisk.git] / funcs / func_env.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Environment related dialplan functions
20  * 
21  * \ingroup functions
22  */
23
24 #include "asterisk.h"
25
26 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
27
28 #include <sys/stat.h>
29
30 #include "asterisk/module.h"
31 #include "asterisk/channel.h"
32 #include "asterisk/pbx.h"
33 #include "asterisk/utils.h"
34 #include "asterisk/app.h"
35
36 static int env_read(struct ast_channel *chan, const char *cmd, char *data,
37                     char *buf, size_t len)
38 {
39         char *ret = NULL;
40
41         *buf = '\0';
42
43         if (data)
44                 ret = getenv(data);
45
46         if (ret)
47                 ast_copy_string(buf, ret, len);
48
49         return 0;
50 }
51
52 static int env_write(struct ast_channel *chan, const char *cmd, char *data,
53                      const char *value)
54 {
55         if (!ast_strlen_zero(data)) {
56                 if (!ast_strlen_zero(value)) {
57                         setenv(data, value, 1);
58                 } else {
59                         unsetenv(data);
60                 }
61         }
62
63         return 0;
64 }
65
66 static int stat_read(struct ast_channel *chan, const char *cmd, char *data,
67                      char *buf, size_t len)
68 {
69         char *action;
70         struct stat s;
71
72         ast_copy_string(buf, "0", len);
73
74         action = strsep(&data, ",");
75         if (stat(data, &s)) {
76                 return 0;
77         } else {
78                 switch (*action) {
79                 case 'e':
80                         strcpy(buf, "1");
81                         break;
82                 case 's':
83                         snprintf(buf, len, "%d", (unsigned int) s.st_size);
84                         break;
85                 case 'f':
86                         snprintf(buf, len, "%d", S_ISREG(s.st_mode) ? 1 : 0);
87                         break;
88                 case 'd':
89                         snprintf(buf, len, "%d", S_ISDIR(s.st_mode) ? 1 : 0);
90                         break;
91                 case 'M':
92                         snprintf(buf, len, "%d", (int) s.st_mtime);
93                         break;
94                 case 'A':
95                         snprintf(buf, len, "%d", (int) s.st_mtime);
96                         break;
97                 case 'C':
98                         snprintf(buf, len, "%d", (int) s.st_ctime);
99                         break;
100                 case 'm':
101                         snprintf(buf, len, "%o", (int) s.st_mode);
102                         break;
103                 }
104         }
105
106         return 0;
107 }
108
109 static int file_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
110 {
111         AST_DECLARE_APP_ARGS(args,
112                 AST_APP_ARG(filename);
113                 AST_APP_ARG(offset);
114                 AST_APP_ARG(length);
115         );
116         int offset = 0, length;
117         char *contents;
118
119         AST_STANDARD_APP_ARGS(args, data);
120         if (args.argc > 1)
121                 offset = atoi(args.offset);
122
123         if (args.argc > 2) {
124                 if ((length = atoi(args.length)) < 1) {
125                         ast_log(LOG_WARNING, "Invalid length '%s'.  Returning the max (%d)\n", args.length, (int)len);
126                         length = len;
127                 } else if (length > len) {
128                         ast_log(LOG_WARNING, "Length %d is greater than the max (%d).  Truncating output.\n", length, (int)len);
129                         length = len;
130                 }
131         } else
132                 length = len;
133
134         if (!(contents = ast_read_textfile(args.filename)))
135                 return -1;
136
137         if (offset >= 0)
138                 ast_copy_string(buf, &contents[offset], length);
139         else {
140                 size_t tmp = strlen(contents);
141                 if (offset * -1 > tmp) {
142                         ast_log(LOG_WARNING, "Offset is larger than the file size.\n");
143                         offset = tmp * -1;
144                 }
145                 ast_copy_string(buf, &contents[tmp + offset], length);
146         }
147         ast_free(contents);
148
149         return 0;
150 }
151
152 static struct ast_custom_function env_function = {
153         .name = "ENV",
154         .synopsis = "Gets or sets the environment variable specified",
155         .syntax = "ENV(<envname>)",
156         .read = env_read,
157         .write = env_write,
158 };
159
160 static struct ast_custom_function stat_function = {
161         .name = "STAT",
162         .synopsis = "Does a check on the specified file",
163         .syntax = "STAT(<flag>,<filename>)",
164         .read = stat_read,
165         .desc =
166                 "flag may be one of the following:\n"
167                 "  d - Checks if the file is a directory\n"
168                 "  e - Checks if the file exists\n"
169                 "  f - Checks if the file is a regular file\n"
170                 "  m - Returns the file mode (in octal)\n"
171                 "  s - Returns the size (in bytes) of the file\n"
172                 "  A - Returns the epoch at which the file was last accessed\n"
173                 "  C - Returns the epoch at which the inode was last changed\n"
174                 "  M - Returns the epoch at which the file was last modified\n",
175 };
176
177 static struct ast_custom_function file_function = {
178         .name = "FILE",
179         .synopsis = "Obtains the contents of a file",
180         .syntax = "FILE(<filename>,<offset>,<length>)",
181         .read = file_read,
182         /*
183          * Some enterprising programmer could probably add write functionality
184          * to FILE(), although I'm not sure how useful it would be.  Hence why
185          * it's called FILE and not READFILE (like the app was).
186          */
187         .desc =
188 "<offset> may be specified as any number.  If negative, <offset> specifies\n"
189 "    the number of bytes back from the end of the file.\n"
190 "<length>, if specified, will limit the length of the data read to that size.\n",
191 };
192
193 static int unload_module(void)
194 {
195         int res = 0;
196
197         res |= ast_custom_function_unregister(&env_function);
198         res |= ast_custom_function_unregister(&stat_function);
199         res |= ast_custom_function_unregister(&file_function);
200
201         return res;
202 }
203
204 static int load_module(void)
205 {
206         int res = 0;
207
208         res |= ast_custom_function_register(&env_function);
209         res |= ast_custom_function_register(&stat_function);
210         res |= ast_custom_function_register(&file_function);
211
212         return res;
213 }
214
215 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Environment/filesystem dialplan functions");