fa5d48116a9a794d7d6f1870945047e51f59fdef
[asterisk/asterisk.git] / apps / app_lookupblacklist.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 App to lookup the callerid number, and see if it is blacklisted
22  *
23  * \ingroup applications
24  * 
25  */
26
27 #include <string.h>
28 #include <stdlib.h>
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/lock.h"
35 #include "asterisk/file.h"
36 #include "asterisk/logger.h"
37 #include "asterisk/options.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/module.h"
41 #include "asterisk/translate.h"
42 #include "asterisk/image.h"
43 #include "asterisk/callerid.h"
44 #include "asterisk/astdb.h"
45 #include "asterisk/options.h"
46
47 static char *tdesc = "Look up Caller*ID name/number from blacklist database";
48
49 static char *app = "LookupBlacklist";
50
51 static char *synopsis = "Look up Caller*ID name/number from blacklist database";
52
53 static char *descrip =
54   "  LookupBlacklist(options): Looks up the Caller*ID number on the active\n"
55   "channel in the Asterisk database (family 'blacklist').  \n"
56   "Returns 0.  Does nothing if no Caller*ID was received on the\n"
57   "channel.\n"
58   "The option string may contain zero or the following character:\n"
59   "     'j' -- jump to n+101 priority if the number/name is found in the blacklist\n"
60   "This application sets the following channel variable upon completion:\n"
61   "     LOOKUPBLSTATUS          The status of the Blacklist lookup as a text string, one of\n"
62   "             FOUND | NOTFOUND\n"
63   "Example: database put blacklist <name/number> 1\n";
64
65 STANDARD_LOCAL_USER;
66
67 LOCAL_USER_DECL;
68
69 static int
70 lookupblacklist_exec (struct ast_channel *chan, void *data)
71 {
72         char blacklist[1];
73         struct localuser *u;
74         int bl = 0;
75         int priority_jump = 0;
76
77         LOCAL_USER_ADD(u);
78
79         if (!ast_strlen_zero(data)) {
80                 if (strchr(data, 'j'))
81                         priority_jump = 1;
82         }
83
84         if (chan->cid.cid_num) {
85                 if (!ast_db_get("blacklist", chan->cid.cid_num, blacklist, sizeof (blacklist))) {
86                         if (option_verbose > 2)
87                                 ast_log(LOG_NOTICE, "Blacklisted number %s found\n",chan->cid.cid_num);
88                         bl = 1;
89                 }
90         }
91         if (chan->cid.cid_name) {
92                 if (!ast_db_get("blacklist", chan->cid.cid_name, blacklist, sizeof (blacklist))) {
93                         if (option_verbose > 2)
94                                 ast_log (LOG_NOTICE,"Blacklisted name \"%s\" found\n",chan->cid.cid_name);
95                         bl = 1;
96                 }
97         }
98
99         if (bl) {
100                 if (priority_jump || option_priority_jumping) 
101                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
102                 pbx_builtin_setvar_helper(chan, "LOOKUPBLSTATUS", "FOUND");
103         } else
104                 pbx_builtin_setvar_helper(chan, "LOOKUPBLSTATUS", "NOTFOUND");  
105
106         LOCAL_USER_REMOVE(u);
107
108         return 0;
109 }
110
111 int unload_module (void)
112 {
113         int res;
114
115         res = ast_unregister_application(app);
116
117         STANDARD_HANGUP_LOCALUSERS;
118
119         return res;     
120 }
121
122 int load_module (void)
123 {
124         return ast_register_application (app, lookupblacklist_exec, synopsis,descrip);
125 }
126
127 char *description (void)
128 {
129         return tdesc;
130 }
131
132 int usecount (void)
133 {
134         int res;
135         STANDARD_USECOUNT (res);
136         return res;
137 }
138
139 char *key ()
140 {
141         return ASTERISK_GPL_KEY;
142 }