remove unnecessary checks before calls to ast_strlen_zero
[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  */
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         
113         if (ast_strlen_zero(data)) {
114                 ast_log(LOG_WARNING, "OSPLookup requires an argument (extension)\n");
115                 return -1;
116         }
117
118         LOCAL_USER_ADD(u);
119
120         temp = ast_strdupa(data);
121         if (!temp) {
122                 ast_log(LOG_ERROR, "Out of memory!\n");
123                 LOCAL_USER_REMOVE(u);
124                 return -1;
125         }
126
127         provider = strchr(temp, '|');
128         if (provider) {
129                 *provider = '\0';
130                 provider++;
131                 opts = strchr(provider, '|');
132                 if (opts) {
133                         *opts = '\0';
134                         opts++;
135                 }
136         }
137         
138         ast_log(LOG_DEBUG, "Whoo hoo, looking up OSP on '%s' via '%s'\n", temp, provider ? provider : "<default>");
139         if ((res = ast_osp_lookup(chan, provider, temp, chan->cid.cid_num, &result)) > 0) {
140                 char tmp[80];
141                 snprintf(tmp, sizeof(tmp), "%d", result.handle);
142                 pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
143                 pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
144                 pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
145                 pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
146                 snprintf(tmp, sizeof(tmp), "%d", result.numresults);
147                 pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
148
149         } else {
150                 if (!res)
151                         ast_log(LOG_NOTICE, "OSP Lookup failed for '%s' (provider '%s')\n", temp, provider ? provider : "<default>");
152                 else
153                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Lookup for '%s' (provider '%s')!\n", chan->name, temp, provider ? provider : "<default>" );
154         }
155         if (!res) {
156                 /* Look for a "busy" place */
157                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
158         } else if (res > 0)
159                 res = 0;
160         LOCAL_USER_REMOVE(u);
161         return res;
162 }
163
164 static int ospnext_exec(struct ast_channel *chan, void *data)
165 {
166         int res=0;
167         struct localuser *u;
168         char *temp;
169         int cause;
170         struct ast_osp_result result;
171
172         if (ast_strlen_zero(data)) {
173                 ast_log(LOG_WARNING, "OSPNext should have an argument (cause)\n");
174                 return -1;
175         }
176         
177         LOCAL_USER_ADD(u);
178
179         cause = str2cause((char *)data);
180         temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
181         result.handle = -1;
182         if (!ast_strlen_zero(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
183                 if ((res = ast_osp_next(&result, cause)) > 0) {
184                         char tmp[80];
185                         snprintf(tmp, sizeof(tmp), "%d", result.handle);
186                         pbx_builtin_setvar_helper(chan, "_OSPHANDLE", tmp);
187                         pbx_builtin_setvar_helper(chan, "_OSPTECH", result.tech);
188                         pbx_builtin_setvar_helper(chan, "_OSPDEST", result.dest);
189                         pbx_builtin_setvar_helper(chan, "_OSPTOKEN", result.token);
190                         snprintf(tmp, sizeof(tmp), "%d", result.numresults);
191                         pbx_builtin_setvar_helper(chan, "_OSPRESULTS", tmp);
192                 }
193         } else {
194                 if (!res) {
195                         if (result.handle < 0)
196                                 ast_log(LOG_NOTICE, "OSP Lookup Next failed for handle '%d'\n", result.handle);
197                         else
198                                 ast_log(LOG_DEBUG, "No OSP handle specified\n");
199                 } else
200                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Next!\n", chan->name);
201         }
202         if (!res) {
203                 /* Look for a "busy" place */
204                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
205         } else if (res > 0)
206                 res = 0;
207         LOCAL_USER_REMOVE(u);
208         return res;
209 }
210
211 static int ospfinished_exec(struct ast_channel *chan, void *data)
212 {
213         int res=0;
214         struct localuser *u;
215         char *temp;
216         int cause;
217         time_t start=0, duration=0;
218         struct ast_osp_result result;
219
220         if (ast_strlen_zero(data)) {
221                 ast_log(LOG_WARNING, "OSPFinish should have an argument (cause)\n");
222                 return -1;
223         }
224
225         LOCAL_USER_ADD(u);      
226
227         if (chan->cdr) {
228                 start = chan->cdr->answer.tv_sec;
229                 if (start)
230                         duration = time(NULL) - start;
231                 else
232                         duration = 0;
233         } else
234                 ast_log(LOG_WARNING, "OSPFinish called on channel '%s' with no CDR!\n", chan->name);
235         
236         cause = str2cause((char *)data);
237         temp = pbx_builtin_getvar_helper(chan, "OSPHANDLE");
238         result.handle = -1;
239         if (!ast_strlen_zero(temp) && (sscanf(temp, "%d", &result.handle) == 1) && (result.handle > -1)) {
240                 if (!ast_osp_terminate(result.handle, cause, start, duration)) {
241                         pbx_builtin_setvar_helper(chan, "_OSPHANDLE", "");
242                         res = 1;
243                 }
244         } else {
245                 if (!res) {
246                         if (result.handle > -1)
247                                 ast_log(LOG_NOTICE, "OSP Finish failed for handle '%d'\n", result.handle);
248                         else
249                                 ast_log(LOG_DEBUG, "No OSP handle specified\n");
250                 } else
251                         ast_log(LOG_DEBUG, "Got hangup on '%s' while doing OSP Terminate!\n", chan->name);
252         }
253         if (!res) {
254                 /* Look for a "busy" place */
255                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
256         } else if (res > 0)
257                 res = 0;
258         LOCAL_USER_REMOVE(u);
259         return res;
260 }
261
262
263 int unload_module(void)
264 {
265         int res;
266         
267         res = ast_unregister_application(app3);
268         res |= ast_unregister_application(app2);
269         res |= ast_unregister_application(app);
270
271         STANDARD_HANGUP_LOCALUSERS;
272
273         return res;
274 }
275
276 int load_module(void)
277 {
278         int res;
279         
280         res = ast_register_application(app, osplookup_exec, synopsis, descrip);
281         res |= ast_register_application(app2, ospnext_exec, synopsis2, descrip2);
282         res |= ast_register_application(app3, ospfinished_exec, synopsis3, descrip3);
283         
284         return res;
285 }
286
287 int reload(void)
288 {
289         return 0;
290 }
291
292
293 char *description(void)
294 {
295         return tdesc;
296 }
297
298 int usecount(void)
299 {
300         int res;
301         STANDARD_USECOUNT(res);
302         return res;
303 }
304
305 char *key()
306 {
307         return ASTERISK_GPL_KEY;
308 }
309