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