Merge changes from team/group/appdocsxml
[asterisk/asterisk.git] / funcs / func_blacklist.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 Function to lookup the callerid number, and see if it is blacklisted
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \ingroup functions
26  * 
27  */
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/pbx.h"
34 #include "asterisk/module.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/astdb.h"
37
38 /*** DOCUMENTATION
39         <function name="BLACKLIST" language="en_US">
40                 <synopsis>
41                         Check if the callerid is on the blacklist.
42                 </synopsis>
43                 <syntax />
44                 <description>
45                         <para>Uses astdb to check if the Caller*ID is in family <literal>blacklist</literal>.
46                         Returns <literal>1</literal> or <literal>0</literal>.</para>
47                 </description>
48         </function>
49
50 ***/
51
52 static int blacklist_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
53 {
54         char blacklist[1];
55         int bl = 0;
56
57         if (chan->cid.cid_num) {
58                 if (!ast_db_get("blacklist", chan->cid.cid_num, blacklist, sizeof (blacklist)))
59                         bl = 1;
60         }
61         if (chan->cid.cid_name) {
62                 if (!ast_db_get("blacklist", chan->cid.cid_name, blacklist, sizeof (blacklist)))
63                         bl = 1;
64         }
65
66         snprintf(buf, len, "%d", bl);
67         return 0;
68 }
69
70 static struct ast_custom_function blacklist_function = {
71         .name = "BLACKLIST",
72         .read = blacklist_read,
73 };
74
75 static int unload_module(void)
76 {
77         return ast_custom_function_unregister(&blacklist_function);
78 }
79
80 static int load_module(void)
81 {
82         return ast_custom_function_register(&blacklist_function);
83 }
84
85 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Look up Caller*ID name/number from blacklist database");