Merged revisions 302921 via svnmerge from
[asterisk/asterisk.git] / apps / app_privacy.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 Block all calls without Caller*ID, require phone # to be entered
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/lock.h"
33 #include "asterisk/file.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/translate.h"
39 #include "asterisk/image.h"
40 #include "asterisk/callerid.h"
41 #include "asterisk/app.h"
42 #include "asterisk/config.h"
43
44 /*** DOCUMENTATION
45         <application name="PrivacyManager" language="en_US">
46                 <synopsis>
47                         Require phone number to be entered, if no CallerID sent
48                 </synopsis>
49                 <syntax>
50                         <parameter name="maxretries">
51                                 <para>Total tries caller is allowed to input a callerid. Defaults to <literal>3</literal>.</para>
52                         </parameter>
53                         <parameter name="minlength">
54                                 <para>Minimum allowable digits in the input callerid number. Defaults to <literal>10</literal>.</para>
55                         </parameter>
56                         <parameter name="context">
57                                 <para>Context to check the given callerid against patterns.</para>
58                         </parameter>
59                 </syntax>
60                 <description>
61                         <para>If no Caller*ID is sent, PrivacyManager answers the channel and asks
62                         the caller to enter their phone number. The caller is given
63                         <replaceable>maxretries</replaceable> attempts to do so. The application does
64                         <emphasis>nothing</emphasis> if Caller*ID was received on the channel.</para>
65                         <para>The application sets the following channel variable upon completion:</para>
66                         <variablelist>
67                                 <variable name="PRIVACYMGRSTATUS">
68                                         <para>The status of the privacy manager's attempt to collect a phone number from the user.</para>
69                                         <value name="SUCCESS"/>
70                                         <value name="FAILED"/>
71                                 </variable>
72                         </variablelist>
73                 </description>
74                 <see-also>
75                         <ref type="application">Zapateller</ref>
76                 </see-also>
77         </application>
78  ***/
79
80
81 static char *app = "PrivacyManager";
82
83 static int privacy_exec(struct ast_channel *chan, const char *data)
84 {
85         int res=0;
86         int retries;
87         int maxretries = 3;
88         int minlength = 10;
89         int x = 0;
90         char phone[30];
91         char *parse = NULL;
92         AST_DECLARE_APP_ARGS(args,
93                 AST_APP_ARG(maxretries);
94                 AST_APP_ARG(minlength);
95                 AST_APP_ARG(options);
96                 AST_APP_ARG(checkcontext);
97         );
98
99         if (chan->caller.id.number.valid
100                 && !ast_strlen_zero(chan->caller.id.number.str)) {
101                 ast_verb(3, "CallerID number present: Skipping\n");
102         } else {
103                 /*Answer the channel if it is not already*/
104                 if (chan->_state != AST_STATE_UP) {
105                         if ((res = ast_answer(chan))) {
106                                 return -1;
107                         }
108                 }
109
110                 parse = ast_strdupa(data);
111
112                 AST_STANDARD_APP_ARGS(args, parse);
113
114                 if (!ast_strlen_zero(args.maxretries)) {
115                         if (sscanf(args.maxretries, "%30d", &x) == 1 && x > 0) {
116                                 maxretries = x;
117                         } else {
118                                 ast_log(LOG_WARNING, "Invalid max retries argument: '%s'\n", args.maxretries);
119                         }
120                 }
121                 if (!ast_strlen_zero(args.minlength)) {
122                         if (sscanf(args.minlength, "%30d", &x) == 1 && x > 0) {
123                                 minlength = x;
124                         } else {
125                                 ast_log(LOG_WARNING, "Invalid min length argument: '%s'\n", args.minlength);
126                         }
127                 }
128
129                 /* Play unidentified call */
130                 res = ast_safe_sleep(chan, 1000);
131                 if (!res) {
132                         res = ast_streamfile(chan, "privacy-unident", chan->language);
133                 }
134                 if (!res) {
135                         res = ast_waitstream(chan, "");
136                 }
137
138                 /* Ask for 10 digit number, give 3 attempts */
139                 for (retries = 0; retries < maxretries; retries++) {
140                         if (!res) {
141                                 res = ast_streamfile(chan, "privacy-prompt", chan->language);
142                         }
143                         if (!res) {
144                                 res = ast_waitstream(chan, "");
145                         }
146
147                         if (!res) {
148                                 res = ast_readstring(chan, phone, sizeof(phone) - 1, /* digit timeout ms */ 3200, /* first digit timeout */ 5000, "#");
149                         }
150
151                         if (res < 0) {
152                                 break;
153                         }
154
155                         /* Make sure we get at least digits */
156                         if (strlen(phone) >= minlength ) {
157                                 /* if we have a checkcontext argument, do pattern matching */
158                                 if (!ast_strlen_zero(args.checkcontext)) {
159                                         if (!ast_exists_extension(NULL, args.checkcontext, phone, 1, NULL)) {
160                                                 res = ast_streamfile(chan, "privacy-incorrect", chan->language);
161                                                 if (!res) {
162                                                         res = ast_waitstream(chan, "");
163                                                 }
164                                         } else {
165                                                 break;
166                                         }
167                                 } else {
168                                         break;
169                                 }
170                         } else {
171                                 res = ast_streamfile(chan, "privacy-incorrect", chan->language);
172                                 if (!res) {
173                                         res = ast_waitstream(chan, "");
174                                 }
175                         }
176                 }
177
178                 /* Got a number, play sounds and send them on their way */
179                 if ((retries < maxretries) && res >= 0) {
180                         res = ast_streamfile(chan, "privacy-thankyou", chan->language);
181                         if (!res) {
182                                 res = ast_waitstream(chan, "");
183                         }
184
185                         /*
186                          * This is a caller entered number that is going to be used locally.
187                          * Therefore, the given number presentation is allowed and should
188                          * be passed out to other channels.  This is the point of the
189                          * privacy application.
190                          */
191                         chan->caller.id.name.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
192                         chan->caller.id.number.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
193                         chan->caller.id.number.plan = 0;/* Unknown */
194
195                         ast_set_callerid(chan, phone, "Privacy Manager", NULL);
196
197                         ast_verb(3, "Changed Caller*ID number to '%s'\n", phone);
198
199                         pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "SUCCESS");
200                 } else {
201                         pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "FAILED");
202                 }
203         }
204
205         return 0;
206 }
207
208 static int unload_module(void)
209 {
210         return ast_unregister_application(app);
211 }
212
213 static int load_module(void)
214 {
215         return ast_register_application_xml(app, privacy_exec);
216 }
217
218 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Require phone number to be entered, if no CallerID sent");