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