93d3c8c4938e540489338dd7d0fa1bce51c08a2e
[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   "The option string may contain the following character:\n"
57   "     'j' -- jump to n+101 priority if the number/name is found in the blacklist\n"
58   "This application sets the following channel variable upon completion:\n"
59   "     LOOKUPBLSTATUS          The status of the Blacklist lookup as a text string, one of\n"
60   "             FOUND | NOTFOUND\n"
61   "Example: exten => 1234,1,LookupBlacklist()\n";
62
63 STANDARD_LOCAL_USER;
64
65 LOCAL_USER_DECL;
66
67 static int
68 lookupblacklist_exec (struct ast_channel *chan, void *data)
69 {
70         char blacklist[1];
71         struct localuser *u;
72         int bl = 0;
73         int priority_jump = 0;
74
75         LOCAL_USER_ADD(u);
76
77         if (!ast_strlen_zero(data)) {
78                 if (strchr(data, 'j'))
79                         priority_jump = 1;
80         }
81
82         if (chan->cid.cid_num) {
83                 if (!ast_db_get("blacklist", chan->cid.cid_num, blacklist, sizeof (blacklist))) {
84                         if (option_verbose > 2)
85                                 ast_log(LOG_NOTICE, "Blacklisted number %s found\n",chan->cid.cid_num);
86                         bl = 1;
87                 }
88         }
89         if (chan->cid.cid_name) {
90                 if (!ast_db_get("blacklist", chan->cid.cid_name, blacklist, sizeof (blacklist))) {
91                         if (option_verbose > 2)
92                                 ast_log (LOG_NOTICE,"Blacklisted name \"%s\" found\n",chan->cid.cid_name);
93                         bl = 1;
94                 }
95         }
96
97         if (bl) {
98                 if (priority_jump || option_priority_jumping) 
99                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
100                 pbx_builtin_setvar_helper(chan, "LOOKUPBLSTATUS", "FOUND");
101         } else
102                 pbx_builtin_setvar_helper(chan, "LOOKUPBLSTATUS", "NOTFOUND");  
103
104         LOCAL_USER_REMOVE(u);
105
106         return 0;
107 }
108
109 int unload_module (void)
110 {
111         int res;
112
113         res = ast_unregister_application(app);
114
115         STANDARD_HANGUP_LOCALUSERS;
116
117         return res;     
118 }
119
120 int load_module (void)
121 {
122         return ast_register_application (app, lookupblacklist_exec, synopsis,descrip);
123 }
124
125 char *description (void)
126 {
127         return tdesc;
128 }
129
130 int usecount (void)
131 {
132         int res;
133         STANDARD_USECOUNT (res);
134         return res;
135 }
136
137 char *key ()
138 {
139         return ASTERISK_GPL_KEY;
140 }