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