We now can have a reference to a filename inside a <see-also> tag.
[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         </application>
75  ***/
76
77
78 static char *app = "PrivacyManager";
79
80 static int privacy_exec (struct ast_channel *chan, void *data)
81 {
82         int res=0;
83         int retries;
84         int maxretries = 3;
85         int minlength = 10;
86         int x = 0;
87         char phone[30];
88         char *parse = NULL;
89         AST_DECLARE_APP_ARGS(args,
90                 AST_APP_ARG(maxretries);
91                 AST_APP_ARG(minlength);
92                 AST_APP_ARG(options);
93                 AST_APP_ARG(checkcontext);
94         );
95
96         if (!ast_strlen_zero(chan->cid.cid_num)) {
97                 ast_verb(3, "CallerID Present: Skipping\n");
98         } else {
99                 /*Answer the channel if it is not already*/
100                 if (chan->_state != AST_STATE_UP) {
101                         if ((res = ast_answer(chan)))
102                                 return -1;
103                 }
104
105                 if (!ast_strlen_zero(data)) {
106                         parse = ast_strdupa(data);
107                         
108                         AST_STANDARD_APP_ARGS(args, parse);
109
110                         if (args.maxretries) {
111                                 if (sscanf(args.maxretries, "%d", &x) == 1)
112                                         maxretries = x;
113                                 else
114                                         ast_log(LOG_WARNING, "Invalid max retries argument\n");
115                         }
116                         if (args.minlength) {
117                                 if (sscanf(args.minlength, "%d", &x) == 1)
118                                         minlength = x;
119                                 else
120                                         ast_log(LOG_WARNING, "Invalid min length argument\n");
121                         }
122                 }               
123
124                 /* Play unidentified call */
125                 res = ast_safe_sleep(chan, 1000);
126                 if (!res)
127                         res = ast_streamfile(chan, "privacy-unident", chan->language);
128                 if (!res)
129                         res = ast_waitstream(chan, "");
130
131                 /* Ask for 10 digit number, give 3 attempts */
132                 for (retries = 0; retries < maxretries; retries++) {
133                         if (!res)
134                                 res = ast_streamfile(chan, "privacy-prompt", chan->language);
135                         if (!res)
136                                 res = ast_waitstream(chan, "");
137
138                         if (!res ) 
139                                 res = ast_readstring(chan, phone, sizeof(phone) - 1, /* digit timeout ms */ 3200, /* first digit timeout */ 5000, "#");
140
141                         if (res < 0)
142                                 break;
143
144                         /* Make sure we get at least digits */
145                         if (strlen(phone) >= minlength ) {
146                                 /* if we have a checkcontext argument, do pattern matching */
147                                 if (!ast_strlen_zero(args.checkcontext)) {
148                                         if (!ast_exists_extension(NULL, args.checkcontext, phone, 1, NULL)) {
149                                                 res = ast_streamfile(chan, "privacy-incorrect", chan->language);
150                                                 if (!res) {
151                                                         res = ast_waitstream(chan, "");
152                                                 }
153                                         } else {
154                                                 break;
155                                         }
156                                 } else {
157                                         break;
158                                 }
159                         } else {
160                                 res = ast_streamfile(chan, "privacy-incorrect", chan->language);
161                                 if (!res)
162                                         res = ast_waitstream(chan, "");
163                         }
164                 }
165                 
166                 /* Got a number, play sounds and send them on their way */
167                 if ((retries < maxretries) && res >= 0 ) {
168                         res = ast_streamfile(chan, "privacy-thankyou", chan->language);
169                         if (!res)
170                                 res = ast_waitstream(chan, "");
171
172                         ast_set_callerid (chan, phone, "Privacy Manager", NULL); 
173
174                         /* Clear the unavailable presence bit so if it came in on PRI
175                          * the caller id will now be passed out to other channels
176                          */
177                         chan->cid.cid_pres &= (AST_PRES_UNAVAILABLE ^ 0xFF);
178
179                         ast_verb(3, "Changed Caller*ID to %s, callerpres to %d\n",phone,chan->cid.cid_pres);
180
181                         pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "SUCCESS");
182                 } else {
183                         pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "FAILED");
184                 }
185         }
186
187         return 0;
188 }
189
190 static int unload_module(void)
191 {
192         return ast_unregister_application (app);
193 }
194
195 static int load_module(void)
196 {
197         return ast_register_application_xml(app, privacy_exec);
198 }
199
200 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Require phone number to be entered, if no CallerID sent");