2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2005, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Open Settlement Protocol Lookup
23 * \ingroup applications
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/options.h"
42 #include "asterisk/config.h"
43 #include "asterisk/module.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/causes.h"
46 #include "asterisk/astosp.h"
47 #include "asterisk/app.h"
48 #include "asterisk/options.h"
50 static char *tdesc = "OSP Lookup";
52 static char *app = "OSPLookup";
53 static char *app2 = "OSPNext";
54 static char *app3 = "OSPFinish";
56 static char *synopsis = "Lookup number in OSP";
57 static char *synopsis2 = "Lookup next OSP entry";
58 static char *synopsis3 = "Record OSP entry";
60 static char *descrip =
61 " OSPLookup(exten[|provider[|options]]): Looks up an extension via OSP and sets\n"
62 "the variables, where 'n' is the number of the result beginning with 1:\n"
63 " ${OSPTECH}: The technology to use for the call\n"
64 " ${OSPDEST}: The destination to use for the call\n"
65 " ${OSPTOKEN}: The actual OSP token as a string\n"
66 " ${OSPHANDLE}: The OSP Handle for anything remaining\n"
67 " ${OSPRESULTS}: The number of OSP results total remaining\n"
69 "The option string may contain the following character:\n"
70 " 'j' -- jump to n+101 priority if the lookup was NOT successful\n"
71 "This application sets the following channel variable upon completion:\n"
72 " OSPLOOKUPSTATUS The status of the OSP Lookup attempt as a text string, one of\n"
73 " SUCCESS | FAILED \n";
76 static char *descrip2 =
77 " OSPNext(cause[|options]): Looks up the next OSP Destination for ${OSPHANDLE}\n"
78 "See OSPLookup for more information\n"
80 "The option string may contain the following character:\n"
81 " 'j' -- jump to n+101 priority if the lookup was NOT successful\n"
82 "This application sets the following channel variable upon completion:\n"
83 " OSPNEXTSTATUS The status of the OSP Next attempt as a text string, one of\n"
84 " SUCCESS | FAILED \n";
86 static char *descrip3 =
87 " OSPFinish(status[|options]): Records call state for ${OSPHANDLE}, according to\n"
88 "status, which should be one of BUSY, CONGESTION, ANSWER, NOANSWER, or CHANUNAVAIL\n"
89 "or coincidentally, just what the Dial application stores in its ${DIALSTATUS}.\n"
91 "The option string may contain the following character:\n"
92 " 'j' -- jump to n+101 priority if the finish attempt was NOT successful\n"
93 "This application sets the following channel variable upon completion:\n"
94 " OSPFINISHSTATUS The status of the OSP Finish attempt as a text string, one of\n"
95 " SUCCESS | FAILED \n";
101 static int str2cause(char *cause)
103 if (!strcasecmp(cause, "BUSY"))
104 return AST_CAUSE_BUSY;
105 if (!strcasecmp(cause, "CONGESTION"))
106 return AST_CAUSE_CONGESTION;
107 if (!strcasecmp(cause, "ANSWER"))
108 return AST_CAUSE_NORMAL;
109 if (!strcasecmp(cause, "CANCEL"))
110 return AST_CAUSE_NORMAL;
111 if (!strcasecmp(cause, "NOANSWER"))
112 return AST_CAUSE_NOANSWER;
113 if (!strcasecmp(cause, "NOCHANAVAIL"))
114 return AST_CAUSE_CONGESTION;
115 ast_log(LOG_WARNING, "Unknown cause '%s', using NORMAL\n", cause);
116 return AST_CAUSE_NORMAL;
119 static int osplookup_exec(struct ast_channel *chan, void *data)
124 struct ast_osp_result result;
125 int priority_jump = 0;
126 AST_DECLARE_APP_ARGS(args,
127 AST_APP_ARG(extension);
128 AST_APP_ARG(provider);
129 AST_APP_ARG(options);
132 if (ast_strlen_zero(data)) {
133 ast_log(LOG_WARNING, "OSPLookup requires an argument OSPLookup(exten[|provider[|options]])\n");
139 temp = ast_strdupa(data);
141 ast_log(LOG_ERROR, "Out of memory!\n");
142 LOCAL_USER_REMOVE(u);
146 AST_STANDARD_APP_ARGS(args, temp);
149 if (strchr(args.options, 'j'))
153 ast_log(LOG_DEBUG, "Whoo hoo, looking up OSP on '%s' via '%s'\n", args.extension, args.provider ? args.provider : "<default>");
154 if ((res = ast_osp_lookup(chan, args.provider, args.extension, chan->cid.cid_num, &result)) > 0) {
156 snprintf(tmp, sizeof(tmp), "%d", result.handle);
157 pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
158 pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
159 pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
160 pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
161 snprintf(tmp, sizeof(tmp), "%d", result.numresults);
162 pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
163 pbx_builtin_setvar_helper(chan, "OSPLOOKUPSTATUS", "SUCCESS");
167 ast_log(LOG_NOTICE, "OSP Lookup failed for '%s' (provider '%s')\n", args.extension, args.provider ? args.provider : "<default>");
168 pbx_builtin_setvar_helper(chan, "OSPLOOKUPSTATUS", "FAILED");
170 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 /* Look for a "busy" place */
174 if (priority_jump || option_priority_jumping)
175 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
178 LOCAL_USER_REMOVE(u);
182 static int ospnext_exec(struct ast_channel *chan, void *data)
188 struct ast_osp_result result;
189 int priority_jump = 0;
190 AST_DECLARE_APP_ARGS(args,
192 AST_APP_ARG(options);
195 if (ast_strlen_zero(data)) {
196 ast_log(LOG_WARNING, "OSPNext should have an argument (cause[|options])\n");
202 temp = ast_strdupa(data);
204 ast_log(LOG_ERROR, "Out of memory!\n");
205 LOCAL_USER_REMOVE(u);
209 AST_STANDARD_APP_ARGS(args, temp);
212 if (strchr(args.options, 'j'))
216 cause = str2cause(args.cause);
217 temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
219 if (!ast_strlen_zero(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
220 if ((res = ast_osp_next(&result, cause)) > 0) {
222 snprintf(tmp, sizeof(tmp), "%d", result.handle);
223 pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
224 pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
225 pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
226 pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
227 snprintf(tmp, sizeof(tmp), "%d", result.numresults);
228 pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
229 pbx_builtin_setvar_helper(chan, "OSPNEXTSTATUS", "SUCCESS");
233 if (result.handle < 0)
234 ast_log(LOG_NOTICE, "OSP Lookup Next failed for handle '%d'\n", result.handle);
236 ast_log(LOG_DEBUG, "No OSP handle specified\n");
237 pbx_builtin_setvar_helper(chan, "OSPNEXTSTATUS", "FAILED");
239 ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Next!\n", chan->name);
242 /* Look for a "busy" place */
243 if (priority_jump || option_priority_jumping)
244 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
247 LOCAL_USER_REMOVE(u);
251 static int ospfinished_exec(struct ast_channel *chan, void *data)
257 time_t start=0, duration=0;
258 struct ast_osp_result result;
259 int priority_jump = 0;
260 AST_DECLARE_APP_ARGS(args,
262 AST_APP_ARG(options);
265 if (ast_strlen_zero(data)) {
266 ast_log(LOG_WARNING, "OSPFinish should have an argument (status[|options])\n");
272 temp = ast_strdupa(data);
274 ast_log(LOG_ERROR, "Out of memory!\n");
275 LOCAL_USER_REMOVE(u);
279 AST_STANDARD_APP_ARGS(args, temp);
282 if (strchr(args.options, 'j'))
287 start = chan->cdr->answer.tv_sec;
289 duration = time(NULL) - start;
293 ast_log(LOG_WARNING, "OSPFinish called on channel '%s' with no CDR!\n", chan->name);
295 cause = str2cause(args.status);
296 temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
298 if (!ast_strlen_zero(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
299 if (!ast_osp_terminate(result.handle, cause, start, duration)) {
300 pbx_builtin_setvar_helper(chan, "_OSPHANDLE", "");
301 pbx_builtin_setvar_helper(chan, "OSPFINISHSTATUS", "SUCCESS");
306 if (result.handle > -1)
307 ast_log(LOG_NOTICE, "OSP Finish failed for handle '%d'\n", result.handle);
309 ast_log(LOG_DEBUG, "No OSP handle specified\n");
310 pbx_builtin_setvar_helper(chan, "OSPFINISHSTATUS", "FAILED");
312 ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Terminate!\n", chan->name);
315 /* Look for a "busy" place */
316 if (priority_jump || option_priority_jumping)
317 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
320 LOCAL_USER_REMOVE(u);
325 int unload_module(void)
329 res = ast_unregister_application(app3);
330 res |= ast_unregister_application(app2);
331 res |= ast_unregister_application(app);
333 STANDARD_HANGUP_LOCALUSERS;
338 int load_module(void)
342 res = ast_register_application(app, osplookup_exec, synopsis, descrip);
343 res |= ast_register_application(app2, ospnext_exec, synopsis2, descrip2);
344 res |= ast_register_application(app3, ospfinished_exec, synopsis3, descrip3);
355 char *description(void)
363 STANDARD_USECOUNT(res);
369 return ASTERISK_GPL_KEY;