remove useless checks of the result of ast_strdupa
[asterisk/asterisk.git] / funcs / func_cut.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2003 Tilghman Lesher.  All rights reserved.
5  *
6  * Tilghman Lesher <app_cut__v003@the-tilghman.com>
7  *
8  * This code is released by the author with no restrictions on usage.
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  */
17
18 /*! \file
19  * 
20  * \brief CUT function
21  *
22  * \author Tilghman Lesher <app_cut__v003@the-tilghman.com>
23  *
24  * \ingroup functions
25  */
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <unistd.h>
30 #include <string.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/file.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/options.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/app.h"
43
44 /* Maximum length of any variable */
45 #define MAXRESULT       1024
46
47 static char *tdesc = "Cut out information from a string";
48
49 STANDARD_LOCAL_USER;
50
51 LOCAL_USER_DECL;
52
53 struct sortable_keys {
54         char *key;
55         float value;
56 };
57
58 static int sort_subroutine(const void *arg1, const void *arg2)
59 {
60         const struct sortable_keys *one=arg1, *two=arg2;
61         if (one->value < two->value) {
62                 return -1;
63         } else if (one->value == two->value) {
64                 return 0;
65         } else {
66                 return 1;
67         }
68 }
69
70 #define ERROR_NOARG     (-1)
71 #define ERROR_NOMEM     (-2)
72 #define ERROR_USAGE     (-3)
73
74 static int sort_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
75 {
76         char *strings, *ptrkey, *ptrvalue;
77         int count=1, count2, element_count=0;
78         struct sortable_keys *sortable_keys;
79
80         memset(buffer, 0, buflen);
81
82         if (!data) {
83                 return ERROR_NOARG;
84         }
85
86         strings = ast_strdupa(data);
87
88         for (ptrkey = strings; *ptrkey; ptrkey++) {
89                 if (*ptrkey == '|') {
90                         count++;
91                 }
92         }
93
94         sortable_keys = alloca(count * sizeof(struct sortable_keys));
95         if (!sortable_keys) {
96                 return ERROR_NOMEM;
97         }
98
99         memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
100
101         /* Parse each into a struct */
102         count2 = 0;
103         while ((ptrkey = strsep(&strings, "|"))) {
104                 ptrvalue = index(ptrkey, ':');
105                 if (!ptrvalue) {
106                         count--;
107                         continue;
108                 }
109                 *ptrvalue = '\0';
110                 ptrvalue++;
111                 sortable_keys[count2].key = ptrkey;
112                 sscanf(ptrvalue, "%f", &sortable_keys[count2].value);
113                 count2++;
114         }
115
116         /* Sort the structs */
117         qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
118
119         for (count2 = 0; count2 < count; count2++) {
120                 int blen = strlen(buffer);
121                 if (element_count++) {
122                         strncat(buffer + blen, ",", buflen - blen - 1);
123                         blen++;
124                 }
125                 strncat(buffer + blen, sortable_keys[count2].key, buflen - blen - 1);
126         }
127
128         return 0;
129 }
130
131 static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
132 {
133         char *parse;
134         AST_DECLARE_APP_ARGS(args,
135                 AST_APP_ARG(varname);
136                 AST_APP_ARG(delimiter);
137                 AST_APP_ARG(field);
138         );
139
140         memset(buffer, 0, buflen); 
141         
142         parse = ast_strdupa(data);
143
144         AST_STANDARD_APP_ARGS(args, parse);
145
146         /* Check and parse arguments */
147         if(args.argc < 3){
148                 return ERROR_NOARG;
149         } else {
150                 char d, ds[2];
151                 char *tmp = alloca(strlen(args.varname) + 4);
152                 char varvalue[MAXRESULT], *tmp2=varvalue;
153
154                 if (tmp) {
155                         snprintf(tmp, strlen(args.varname) + 4, "${%s}", args.varname);
156                         memset(varvalue, 0, sizeof(varvalue));
157                 } else {
158                         return ERROR_NOMEM;
159                 }
160
161                 if (args.delimiter[0])
162                         d = args.delimiter[0];
163                 else
164                         d = '-';
165
166                 /* String form of the delimiter, for use with strsep(3) */
167                 snprintf(ds, sizeof(ds), "%c", d);
168
169                 pbx_substitute_variables_helper(chan, tmp, tmp2, MAXRESULT - 1);
170
171                 if (tmp2) {
172                         int curfieldnum = 1;
173                         while ((tmp2 != NULL) && (args.field != NULL)) {
174                                 char *nextgroup = strsep(&(args.field), "&");
175                                 int num1 = 0, num2 = MAXRESULT;
176                                 char trashchar;
177
178                                 if (sscanf(nextgroup, "%d-%d", &num1, &num2) == 2) {
179                                         /* range with both start and end */
180                                 } else if (sscanf(nextgroup, "-%d", &num2) == 1) {
181                                         /* range with end */
182                                         num1 = 0;
183                                 } else if ((sscanf(nextgroup, "%d%c", &num1, &trashchar) == 2) && (trashchar == '-')) {
184                                         /* range with start */
185                                         num2 = MAXRESULT;
186                                 } else if (sscanf(nextgroup, "%d", &num1) == 1) {
187                                         /* single number */
188                                         num2 = num1;
189                                 } else {
190                                         return ERROR_USAGE;
191                                 }
192
193                                 /* Get to start, if any */
194                                 if (num1 > 0) {
195                                         while ((tmp2 != (char *)NULL + 1) && (curfieldnum < num1)) {
196                                                 tmp2 = index(tmp2, d) + 1;
197                                                 curfieldnum++;
198                                         }
199                                 }
200
201                                 /* Most frequent problem is the expectation of reordering fields */
202                                 if ((num1 > 0) && (curfieldnum > num1)) {
203                                         ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
204                                 }
205
206                                 /* Re-null tmp2 if we added 1 to NULL */
207                                 if (tmp2 == (char *)NULL + 1)
208                                         tmp2 = NULL;
209
210                                 /* Output fields until we either run out of fields or num2 is reached */
211                                 while ((tmp2 != NULL) && (curfieldnum <= num2)) {
212                                         char *tmp3 = strsep(&tmp2, ds);
213                                         int curlen = strlen(buffer);
214
215                                         if (curlen) {
216                                                 snprintf(buffer + curlen, buflen - curlen, "%c%s", d, tmp3);
217                                         } else {
218                                                 snprintf(buffer, buflen, "%s", tmp3);
219                                         }
220
221                                         curfieldnum++;
222                                 }
223                         }
224                 }
225         }
226         return 0;
227 }
228
229 static char *acf_sort_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
230 {
231         struct localuser *u;
232
233         LOCAL_USER_ACF_ADD(u);
234
235         switch (sort_internal(chan, data, buf, len)) {
236         case ERROR_NOARG:
237                 ast_log(LOG_ERROR, "SORT() requires an argument\n");
238                 break;
239         case ERROR_NOMEM:
240                 ast_log(LOG_ERROR, "Out of memory\n");
241                 break;
242         case 0:
243                 break;
244         default:
245                 ast_log(LOG_ERROR, "Unknown internal error\n");
246         }
247         LOCAL_USER_REMOVE(u);
248         return buf;
249 }
250
251 static char *acf_cut_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
252 {
253         struct localuser *u;
254
255         LOCAL_USER_ACF_ADD(u);
256
257         switch (cut_internal(chan, data, buf, len)) {
258         case ERROR_NOARG:
259                 ast_log(LOG_ERROR, "Syntax: CUT(<varname>,<char-delim>,<range-spec>) - missing argument!\n");
260                 break;
261         case ERROR_NOMEM:
262                 ast_log(LOG_ERROR, "Out of memory\n");
263                 break;
264         case ERROR_USAGE:
265                 ast_log(LOG_ERROR, "Usage: CUT(<varname>,<char-delim>,<range-spec>)\n");
266                 break;
267         case 0:
268                 break;
269         default:
270                 ast_log(LOG_ERROR, "Unknown internal error\n");
271         }
272         LOCAL_USER_REMOVE(u);
273         return buf;
274 }
275
276 struct ast_custom_function acf_sort = {
277         .name = "SORT",
278         .synopsis = "Sorts a list of key/vals into a list of keys, based upon the vals",
279         .syntax = "SORT(key1:val1[...][,keyN:valN])",
280         .desc =
281 "Takes a comma-separated list of keys and values, each separated by a colon, and returns a\n"
282 "comma-separated list of the keys, sorted by their values.  Values will be evaluated as\n"
283 "floating-point numbers.\n",
284         .read = acf_sort_exec,
285 };
286
287 struct ast_custom_function acf_cut = {
288         .name = "CUT",
289         .synopsis = "Slices and dices strings, based upon a named delimiter.",
290         .syntax = "CUT(<varname>,<char-delim>,<range-spec>)",
291         .desc =
292 "  varname    - variable you want cut\n"
293 "  char-delim - defaults to '-'\n"
294 "  range-spec - number of the field you want (1-based offset)\n"
295 "             may also be specified as a range (with -)\n"
296 "             or group of ranges and fields (with &)\n",
297         .read = acf_cut_exec,
298 };
299
300 int unload_module(void)
301 {
302         int res;
303
304         res = ast_custom_function_unregister(&acf_cut);
305         res |= ast_custom_function_unregister(&acf_sort);
306
307         STANDARD_HANGUP_LOCALUSERS;
308
309         return res;
310 }
311
312 int load_module(void)
313 {
314         int res;
315
316         res = ast_custom_function_register(&acf_cut);
317         res |= ast_custom_function_register(&acf_sort);
318
319         return res;
320 }
321
322 char *description(void)
323 {
324         return tdesc;
325 }
326
327 int usecount(void)
328 {
329         int res;
330         STANDARD_USECOUNT(res);
331         return res;
332 }
333
334 char *key()
335 {
336         return ASTERISK_GPL_KEY;
337 }