Enhance to accept a maximum of N digits. Bug #1261
[asterisk/asterisk.git] / apps / app_read.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Trivial application to read a variable
5  * 
6  * Copyright (C) 2003, Digium
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13  
14 #include <asterisk/lock.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/channel.h>
18 #include <asterisk/pbx.h>
19 #include <asterisk/app.h>
20 #include <asterisk/module.h>
21 #include <asterisk/translate.h>
22 #include <asterisk/options.h>
23 #include <string.h>
24 #include <stdlib.h>
25 #include <pthread.h>
26
27 static char *tdesc = "Read Variable Application";
28
29 static char *app = "Read";
30
31 static char *synopsis = "Read a variable";
32
33 static char *descrip = 
34 "  Read(variable[|filename][|maxdigits]):  Reads a #-terminated string of digits from\n"
35 "the user, optionally playing a given filename first.  Returns -1 on hangup or\n"
36 "error and 0 otherwise.\n"
37 "  maxdigits   -- maximum acceptable number of digits. Stops reading after maxdigits\n"
38 "                 have been entered (without requiring the user press the '#' key).\n"
39 "                 Defaults to 0 - no limit - wait for the user press the '#' key.\n"
40 "                 Any value below 0 means the same. Max accepted value is 255.\n";      
41
42 STANDARD_LOCAL_USER;
43
44 LOCAL_USER_DECL;
45
46 static int read_exec(struct ast_channel *chan, void *data)
47 {
48         int res = 0;
49         struct localuser *u;
50         char tmp[256];
51         char tmp2[256]="";
52         char *filename;
53         char *stringp;
54         char *maxdigitstr;
55         int maxdigits=255;
56         if (!data || !strlen((char *)data)) {
57                 ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
58                 return -1;
59         }
60         strncpy(tmp, (char *)data, sizeof(tmp)-1);
61         stringp=tmp;
62         strsep(&stringp, "|");
63         filename = strsep(&stringp, "|");
64         maxdigitstr = strsep(&stringp,"|");
65         if (maxdigitstr)
66         {
67             maxdigits = atoi(maxdigitstr);
68             if ((maxdigits<1) || (maxdigits>255)) {
69                 maxdigits = 255;
70             }
71             else
72                 ast_verbose(VERBOSE_PREFIX_3 "Accepting a maximum of %i digits.\n", maxdigits);
73         }       
74         if (!strlen(tmp)) {
75                 ast_log(LOG_WARNING, "Read requires an variable name\n");
76                 return -1;
77         }
78         LOCAL_USER_ADD(u);
79         if (chan->_state != AST_STATE_UP) {
80                 /* Answer if the line isn't up. */
81                 res = ast_answer(chan);
82         }
83         if (!res) {
84                 ast_stopstream(chan);
85                 res = ast_app_getdata(chan, filename, tmp2, maxdigits, 0);
86                 if (!res)
87                         pbx_builtin_setvar_helper(chan, tmp, tmp2);
88                 ast_verbose(VERBOSE_PREFIX_3 "User entered '%s'\n", tmp2);
89         }
90         LOCAL_USER_REMOVE(u);
91         return res;
92 }
93
94 int unload_module(void)
95 {
96         STANDARD_HANGUP_LOCALUSERS;
97         return ast_unregister_application(app);
98 }
99
100 int load_module(void)
101 {
102         return ast_register_application(app, read_exec, synopsis, descrip);
103 }
104
105 char *description(void)
106 {
107         return tdesc;
108 }
109
110 int usecount(void)
111 {
112         int res;
113         STANDARD_USECOUNT(res);
114         return res;
115 }
116
117 char *key()
118 {
119         return ASTERISK_GPL_KEY;
120 }