it's a good idea to unregister everything before calling STANDARD_HANGUP_LOCALUSERS
[asterisk/asterisk.git] / apps / app_osplookup.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 /*
20  *
21  * Open Settlement Protocol Lookup
22  * 
23  */
24
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <string.h>
28 #include <ctype.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/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/options.h"
40 #include "asterisk/config.h"
41 #include "asterisk/module.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/causes.h"
44 #include "asterisk/astosp.h"
45
46 static char *tdesc = "OSP Lookup";
47
48 static char *app = "OSPLookup";
49 static char *app2 = "OSPNext";
50 static char *app3 = "OSPFinish";
51
52 static char *synopsis = "Lookup number in OSP";
53 static char *synopsis2 = "Lookup next OSP entry";
54 static char *synopsis3 = "Record OSP entry";
55
56 static char *descrip = 
57 "  OSPLookup(exten[|provider[|options]]):  Looks up an extension via OSP and sets\n"
58 "the variables, where 'n' is the number of the result beginning with 1:\n"
59 " ${OSPTECH}:   The technology to use for the call\n"
60 " ${OSPDEST}:   The destination to use for the call\n"
61 " ${OSPTOKEN}:  The actual OSP token as a string\n"
62 " ${OSPHANDLE}: The OSP Handle for anything remaining\n"
63 " ${OSPRESULTS}: The number of OSP results total remaining\n"
64 "\n"
65 "If the lookup was *not* successful and there exists a priority n + 101,\n"
66 "then that priority will be taken next.\n" ;
67
68 static char *descrip2 = 
69 "  OSPNext:  Looks up the next OSP Destination for ${OSPHANDLE}\n"
70 "See OSPLookup for more information\n"
71 "\n"
72 "If the lookup was *not* successful and there exists a priority n + 101,\n"
73 "then that priority will be taken next.\n" ;
74
75 static char *descrip3 = 
76 "  OSPFinish(status):  Records call state for ${OSPHANDLE}, according to\n"
77 "status, which should be one of BUSY, CONGESTION, ANSWER, NOANSWER, or NOCHANAVAIL\n"
78 "or coincidentally, just what the Dial application stores in its ${DIALSTATUS}\n"
79 "\n"
80 "If the finishing was *not* successful and there exists a priority n + 101,\n"
81 "then that priority will be taken next.\n" ;
82
83 STANDARD_LOCAL_USER;
84
85 LOCAL_USER_DECL;
86
87 static int str2cause(char *cause)
88 {
89         if (!strcasecmp(cause, "BUSY"))
90                 return AST_CAUSE_BUSY;
91         if (!strcasecmp(cause, "CONGESTION"))
92                 return AST_CAUSE_CONGESTION;
93         if (!strcasecmp(cause, "ANSWER"))
94                 return AST_CAUSE_NORMAL;
95         if (!strcasecmp(cause, "CANCEL"))
96                 return AST_CAUSE_NORMAL;
97         if (!strcasecmp(cause, "NOANSWER"))
98                 return AST_CAUSE_NOANSWER;
99         if (!strcasecmp(cause, "NOCHANAVAIL"))
100                 return AST_CAUSE_CONGESTION;
101         ast_log(LOG_WARNING, "Unknown cause '%s', using NORMAL\n", cause);
102         return AST_CAUSE_NORMAL;
103 }
104
105 static int osplookup_exec(struct ast_channel *chan, void *data)
106 {
107         int res=0;
108         struct localuser *u;
109         char *temp;
110         char *provider, *opts=NULL;
111         struct ast_osp_result result;
112         if (!data || ast_strlen_zero(data) || !(temp = ast_strdupa(data))) {
113                 ast_log(LOG_WARNING, "OSPLookup requires an argument (extension)\n");
114                 return -1;
115         }
116         provider = strchr(temp, '|');
117         if (provider) {
118                 *provider = '\0';
119                 provider++;
120                 opts = strchr(provider, '|');
121                 if (opts) {
122                         *opts = '\0';
123                         opts++;
124                 }
125         }
126         LOCAL_USER_ADD(u);
127         ast_log(LOG_DEBUG, "Whoo hoo, looking up OSP on '%s' via '%s'\n", temp, provider ? provider : "<default>");
128         if ((res = ast_osp_lookup(chan, provider, temp, chan->cid.cid_num, &result)) > 0) {
129                 char tmp[80];
130                 snprintf(tmp, sizeof(tmp), "%d", result.handle);
131                 pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
132                 pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
133                 pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
134                 pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
135                 snprintf(tmp, sizeof(tmp), "%d", result.numresults);
136                 pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
137
138         } else {
139                 if (!res)
140                         ast_log(LOG_NOTICE, "OSP Lookup failed for '%s' (provider '%s')\n", temp, provider ? provider : "<default>");
141                 else
142                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Lookup for '%s' (provider '%s')!\n", chan->name, temp, provider ? provider : "<default>" );
143         }
144         if (!res) {
145                 /* Look for a "busy" place */
146                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
147         } else if (res > 0)
148                 res = 0;
149         LOCAL_USER_REMOVE(u);
150         return res;
151 }
152
153 static int ospnext_exec(struct ast_channel *chan, void *data)
154 {
155         int res=0;
156         struct localuser *u;
157         char *temp;
158         int cause;
159         struct ast_osp_result result;
160         if (!data || ast_strlen_zero(data)) {
161                 ast_log(LOG_WARNING, "OSPNext should have an argument (cause)\n");
162         }
163         LOCAL_USER_ADD(u);
164         cause = str2cause((char *)data);
165         temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
166         result.handle = -1;
167         if (temp && strlen(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
168                 if ((res = ast_osp_next(&result, cause)) > 0) {
169                         char tmp[80];
170                         snprintf(tmp, sizeof(tmp), "%d", result.handle);
171                         pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
172                         pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
173                         pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
174                         pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
175                         snprintf(tmp, sizeof(tmp), "%d", result.numresults);
176                         pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
177                 }
178         } else {
179                 if (!res) {
180                         if (result.handle < 0)
181                                 ast_log(LOG_NOTICE, "OSP Lookup Next failed for handle '%d'\n", result.handle);
182                         else
183                                 ast_log(LOG_DEBUG, "No OSP handle specified\n");
184                 } else
185                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Next!\n", chan->name);
186         }
187         if (!res) {
188                 /* Look for a "busy" place */
189                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
190         } else if (res > 0)
191                 res = 0;
192         LOCAL_USER_REMOVE(u);
193         return res;
194 }
195
196 static int ospfinished_exec(struct ast_channel *chan, void *data)
197 {
198         int res=0;
199         struct localuser *u;
200         char *temp;
201         int cause;
202         time_t start=0, duration=0;
203         struct ast_osp_result result;
204         if (!data || ast_strlen_zero(data)) {
205                 ast_log(LOG_WARNING, "OSPFinish should have an argument (cause)\n");
206         }
207         if (chan->cdr) {
208                 start = chan->cdr->answer.tv_sec;
209                 if (start)
210                         duration = time(NULL) - start;
211                 else
212                         duration = 0;
213         } else
214                 ast_log(LOG_WARNING, "OSPFinish called on channel '%s' with no CDR!\n", chan->name);
215         LOCAL_USER_ADD(u);
216         cause = str2cause((char *)data);
217         temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
218         result.handle = -1;
219         if (temp && strlen(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
220                 if (!ast_osp_terminate(result.handle, cause, start, duration)) {
221                         pbx_builtin_setvar_helper(chan, "_OSPHANDLE", "");
222                         res = 1;
223                 }
224         } else {
225                 if (!res) {
226                         if (result.handle > -1)
227                                 ast_log(LOG_NOTICE, "OSP Finish failed for handle '%d'\n", result.handle);
228                         else
229                                 ast_log(LOG_DEBUG, "No OSP handle specified\n");
230                 } else
231                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Terminate!\n", chan->name);
232         }
233         if (!res) {
234                 /* Look for a "busy" place */
235                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
236         } else if (res > 0)
237                 res = 0;
238         LOCAL_USER_REMOVE(u);
239         return res;
240 }
241
242
243 int unload_module(void)
244 {
245         int res;
246         
247         res = ast_unregister_application(app3);
248         res |= ast_unregister_application(app2);
249         res |= ast_unregister_application(app);
250
251         STANDARD_HANGUP_LOCALUSERS;
252
253         return res;
254 }
255
256 int load_module(void)
257 {
258         int res;
259         
260         res = ast_register_application(app, osplookup_exec, synopsis, descrip);
261         res |= ast_register_application(app2, ospnext_exec, synopsis2, descrip2);
262         res |= ast_register_application(app3, ospfinished_exec, synopsis3, descrip3);
263         
264         return res;
265 }
266
267 int reload(void)
268 {
269         return 0;
270 }
271
272
273 char *description(void)
274 {
275         return tdesc;
276 }
277
278 int usecount(void)
279 {
280         int res;
281         STANDARD_USECOUNT(res);
282         return res;
283 }
284
285 char *key()
286 {
287         return ASTERISK_GPL_KEY;
288 }
289