Doxygen documentation update from oej (issue #5505)
[asterisk/asterisk.git] / apps / app_zapateller.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 Playback the special information tone to get rid of telemarketers
22  * 
23  */
24  
25 #include <string.h>
26 #include <stdlib.h>
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/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/translate.h"
39
40 static char *tdesc = "Block Telemarketers with Special Information Tone";
41
42 static char *app = "Zapateller";
43
44 static char *synopsis = "Block telemarketers with SIT";
45
46 static char *descrip = 
47 "  Zapateller(options):  Generates special information tone to block\n"
48 "telemarketers from calling you.  Returns 0 normally or -1 on hangup.\n"
49 "Options is a pipe-delimited list of options.  The following options\n"
50 "are available: 'answer' causes the line to be answered before playing\n"
51 "the tone, 'nocallerid' causes Zapateller to only play the tone if there\n"
52 "is no callerid information available.  Options should be separated by |\n"
53 "characters\n";
54
55 STANDARD_LOCAL_USER;
56
57 LOCAL_USER_DECL;
58
59 static int zapateller_exec(struct ast_channel *chan, void *data)
60 {
61         int res = 0;
62         struct localuser *u;
63         int answer = 0, nocallerid = 0;
64         char *c;
65         char *stringp=NULL;
66         
67         LOCAL_USER_ADD(u);
68
69         stringp=data;
70         c = strsep(&stringp, "|");
71         while(c && !ast_strlen_zero(c)) {
72                 if (!strcasecmp(c, "answer"))
73                         answer = 1;
74                 else if (!strcasecmp(c, "nocallerid"))
75                         nocallerid = 1;
76
77                 c = strsep(&stringp, "|");
78         }
79
80         ast_stopstream(chan);
81         if (chan->_state != AST_STATE_UP) {
82
83                 if (answer) 
84                         res = ast_answer(chan);
85                 if (!res) {
86                         res = ast_safe_sleep(chan, 500);
87                 }
88         }
89         if (chan->cid.cid_num && nocallerid) {
90                 LOCAL_USER_REMOVE(u);
91                 return res;
92         } 
93         if (!res) 
94                 res = ast_tonepair(chan, 950, 0, 330, 0);
95         if (!res) 
96                 res = ast_tonepair(chan, 1400, 0, 330, 0);
97         if (!res) 
98                 res = ast_tonepair(chan, 1800, 0, 330, 0);
99         if (!res) 
100                 res = ast_tonepair(chan, 0, 0, 1000, 0);
101         LOCAL_USER_REMOVE(u);
102         return res;
103 }
104
105 int unload_module(void)
106 {
107         int res;
108
109         res = ast_unregister_application(app);
110         
111         STANDARD_HANGUP_LOCALUSERS;
112
113         return res;     
114 }
115
116 int load_module(void)
117 {
118         return ast_register_application(app, zapateller_exec, synopsis, descrip);
119 }
120
121 char *description(void)
122 {
123         return tdesc;
124 }
125
126 int usecount(void)
127 {
128         int res;
129         STANDARD_USECOUNT(res);
130         return res;
131 }
132
133 char *key()
134 {
135         return ASTERISK_GPL_KEY;
136 }