Thu Apr 28 2011 17:15:14

Asterisk developer's documentation


app_privacy.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Block all calls without Caller*ID, require phone # to be entered
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  *
00025  * \ingroup applications
00026  */
00027 
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 302920 $")
00031 
00032 #include "asterisk/lock.h"
00033 #include "asterisk/file.h"
00034 #include "asterisk/utils.h"
00035 #include "asterisk/channel.h"
00036 #include "asterisk/pbx.h"
00037 #include "asterisk/module.h"
00038 #include "asterisk/translate.h"
00039 #include "asterisk/image.h"
00040 #include "asterisk/callerid.h"
00041 #include "asterisk/app.h"
00042 #include "asterisk/config.h"
00043 
00044 /*** DOCUMENTATION
00045    <application name="PrivacyManager" language="en_US">
00046       <synopsis>
00047          Require phone number to be entered, if no CallerID sent
00048       </synopsis>
00049       <syntax>
00050          <parameter name="maxretries">
00051             <para>Total tries caller is allowed to input a callerid. Defaults to <literal>3</literal>.</para>
00052          </parameter>
00053          <parameter name="minlength">
00054             <para>Minimum allowable digits in the input callerid number. Defaults to <literal>10</literal>.</para>
00055          </parameter>
00056          <parameter name="context">
00057             <para>Context to check the given callerid against patterns.</para>
00058          </parameter>
00059       </syntax>
00060       <description>
00061          <para>If no Caller*ID is sent, PrivacyManager answers the channel and asks
00062          the caller to enter their phone number. The caller is given
00063          <replaceable>maxretries</replaceable> attempts to do so. The application does
00064          <emphasis>nothing</emphasis> if Caller*ID was received on the channel.</para>
00065          <para>The application sets the following channel variable upon completion:</para>
00066          <variablelist>
00067             <variable name="PRIVACYMGRSTATUS">
00068                <para>The status of the privacy manager's attempt to collect a phone number from the user.</para>
00069                <value name="SUCCESS"/>
00070                <value name="FAILED"/>
00071             </variable>
00072          </variablelist>
00073       </description>
00074       <see-also>
00075          <ref type="application">Zapateller</ref>
00076       </see-also>
00077    </application>
00078  ***/
00079 
00080 
00081 static char *app = "PrivacyManager";
00082 
00083 static int privacy_exec (struct ast_channel *chan, void *data)
00084 {
00085    int res=0;
00086    int retries;
00087    int maxretries = 3;
00088    int minlength = 10;
00089    int x = 0;
00090    char phone[30];
00091    char *parse = NULL;
00092    AST_DECLARE_APP_ARGS(args,
00093       AST_APP_ARG(maxretries);
00094       AST_APP_ARG(minlength);
00095       AST_APP_ARG(options);
00096       AST_APP_ARG(checkcontext);
00097    );
00098 
00099    if (!ast_strlen_zero(chan->cid.cid_num)) {
00100       ast_verb(3, "CallerID Present: Skipping\n");
00101    } else {
00102       /*Answer the channel if it is not already*/
00103       if (chan->_state != AST_STATE_UP) {
00104          if ((res = ast_answer(chan))) {
00105             return -1;
00106          }
00107       }
00108 
00109       parse = ast_strdupa(data);
00110 
00111       AST_STANDARD_APP_ARGS(args, parse);
00112 
00113       if (!ast_strlen_zero(args.maxretries)) {
00114          if (sscanf(args.maxretries, "%30d", &x) == 1 && x > 0) {
00115             maxretries = x;
00116          } else {
00117             ast_log(LOG_WARNING, "Invalid max retries argument: '%s'\n", args.maxretries);
00118          }
00119       }
00120       if (!ast_strlen_zero(args.minlength)) {
00121          if (sscanf(args.minlength, "%30d", &x) == 1 && x > 0) {
00122             minlength = x;
00123          } else {
00124             ast_log(LOG_WARNING, "Invalid min length argument: '%s'\n", args.minlength);
00125          }
00126       }
00127 
00128       /* Play unidentified call */
00129       res = ast_safe_sleep(chan, 1000);
00130       if (!res) {
00131          res = ast_streamfile(chan, "privacy-unident", chan->language);
00132       }
00133       if (!res) {
00134          res = ast_waitstream(chan, "");
00135       }
00136 
00137       /* Ask for 10 digit number, give 3 attempts */
00138       for (retries = 0; retries < maxretries; retries++) {
00139          if (!res) {
00140             res = ast_streamfile(chan, "privacy-prompt", chan->language);
00141          }
00142          if (!res) {
00143             res = ast_waitstream(chan, "");
00144          }
00145 
00146          if (!res) {
00147             res = ast_readstring(chan, phone, sizeof(phone) - 1, /* digit timeout ms */ 3200, /* first digit timeout */ 5000, "#");
00148          }
00149 
00150          if (res < 0) {
00151             break;
00152          }
00153 
00154          /* Make sure we get at least digits */
00155          if (strlen(phone) >= minlength ) {
00156             /* if we have a checkcontext argument, do pattern matching */
00157             if (!ast_strlen_zero(args.checkcontext)) {
00158                if (!ast_exists_extension(NULL, args.checkcontext, phone, 1, NULL)) {
00159                   res = ast_streamfile(chan, "privacy-incorrect", chan->language);
00160                   if (!res) {
00161                      res = ast_waitstream(chan, "");
00162                   }
00163                } else {
00164                   break;
00165                }
00166             } else {
00167                break;
00168             }
00169          } else {
00170             res = ast_streamfile(chan, "privacy-incorrect", chan->language);
00171             if (!res) {
00172                res = ast_waitstream(chan, "");
00173             }
00174          }
00175       }
00176 
00177       /* Got a number, play sounds and send them on their way */
00178       if ((retries < maxretries) && res >= 0) {
00179          res = ast_streamfile(chan, "privacy-thankyou", chan->language);
00180          if (!res) {
00181             res = ast_waitstream(chan, "");
00182          }
00183 
00184          ast_set_callerid(chan, phone, "Privacy Manager", NULL);
00185 
00186          /* Clear the unavailable presence bit so if it came in on PRI
00187           * the caller id will now be passed out to other channels
00188           */
00189          chan->cid.cid_pres &= (AST_PRES_UNAVAILABLE ^ 0xFF);
00190 
00191          ast_verb(3, "Changed Caller*ID to '%s', callerpres to %d\n", phone, chan->cid.cid_pres);
00192 
00193          pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "SUCCESS");
00194       } else {
00195          pbx_builtin_setvar_helper(chan, "PRIVACYMGRSTATUS", "FAILED");
00196       }
00197    }
00198 
00199    return 0;
00200 }
00201 
00202 static int unload_module(void)
00203 {
00204    return ast_unregister_application(app);
00205 }
00206 
00207 static int load_module(void)
00208 {
00209    return ast_register_application_xml(app, privacy_exec);
00210 }
00211 
00212 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Require phone number to be entered, if no CallerID sent");