print an error message if invalid arguments are specified (issue #5872)
[asterisk/asterisk.git] / apps / app_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  * \brief Cut application
20  *
21  * \ingroup applications
22  */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <string.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/options.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/app.h"
40
41 /* Maximum length of any variable */
42 #define MAXRESULT       1024
43
44 static char *tdesc = "Cut out information from a string";
45
46 static char *app_cut = "Cut";
47
48 static char *cut_synopsis = "Splits a variable's contents using the specified delimiter";
49
50 static char *cut_descrip =
51 "  Cut(newvar=varname,delimiter,fieldspec): This applicaiton will split the\n"
52 "contents of a variable based on the given delimeter and store the result in\n"
53 "a new variable.\n"
54 "Parameters:\n"
55 "  newvar    - new variable created from result string\n"
56 "  varname   - variable you want cut\n"
57 "  delimiter - defaults to '-'\n"
58 "  fieldspec - number of the field you want (1-based offset)\n"
59 "              may also be specified as a range (with -)\n"
60 "              or group of ranges and fields (with &)\n"
61 "This application has been deprecated in favor of the CUT function.\n";
62
63 static char *app_sort = "Sort";
64 static char *app_sort_synopsis = "Sorts a list of keywords and values";
65 static char *app_sort_descrip =
66 "  Sort(newvar=key1:val1[,key2:val2[[...],keyN:valN]]): This application will\n"
67 "sort the list provided in ascending order. The result will be stored in the\n"
68 "specified variable name.\n"
69 "  This applicaiton has been deprecated in favor of the SORT function.\n";
70
71 STANDARD_LOCAL_USER;
72
73 LOCAL_USER_DECL;
74
75 struct sortable_keys {
76         char *key;
77         float value;
78 };
79
80 static int sort_subroutine(const void *arg1, const void *arg2)
81 {
82         const struct sortable_keys *one=arg1, *two=arg2;
83         if (one->value < two->value) {
84                 return -1;
85         } else if (one->value == two->value) {
86                 return 0;
87         } else {
88                 return 1;
89         }
90 }
91
92 #define ERROR_NOARG     (-1)
93 #define ERROR_NOMEM     (-2)
94 #define ERROR_USAGE     (-3)
95
96 static int sort_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
97 {
98         char *strings, *ptrkey, *ptrvalue;
99         int count=1, count2, element_count=0;
100         struct sortable_keys *sortable_keys;
101
102         memset(buffer, 0, buflen);
103
104         if (!data) {
105                 return ERROR_NOARG;
106         }
107
108         strings = ast_strdupa((char *)data);
109         if (!strings) {
110                 return ERROR_NOMEM;
111         }
112
113         for (ptrkey = strings; *ptrkey; ptrkey++) {
114                 if (*ptrkey == '|') {
115                         count++;
116                 }
117         }
118
119         sortable_keys = alloca(count * sizeof(struct sortable_keys));
120         if (!sortable_keys) {
121                 return ERROR_NOMEM;
122         }
123
124         memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
125
126         /* Parse each into a struct */
127         count2 = 0;
128         while ((ptrkey = strsep(&strings, "|"))) {
129                 ptrvalue = index(ptrkey, ':');
130                 if (!ptrvalue) {
131                         count--;
132                         continue;
133                 }
134                 *ptrvalue = '\0';
135                 ptrvalue++;
136                 sortable_keys[count2].key = ptrkey;
137                 sscanf(ptrvalue, "%f", &sortable_keys[count2].value);
138                 count2++;
139         }
140
141         /* Sort the structs */
142         qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
143
144         for (count2 = 0; count2 < count; count2++) {
145                 int blen = strlen(buffer);
146                 if (element_count++) {
147                         strncat(buffer + blen, ",", buflen - blen - 1);
148                 }
149                 strncat(buffer + blen + 1, sortable_keys[count2].key, buflen - blen - 2);
150         }
151
152         return 0;
153 }
154
155 static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
156 {
157         char *s, *args[3], *varname=NULL, *delimiter=NULL, *field=NULL;
158         int args_okay = 0;
159
160         memset(buffer, 0, buflen);
161
162         /* Check and parse arguments */
163         if (data) {
164                 s = ast_strdupa((char *)data);
165                 if (s) {
166                         ast_app_separate_args(s, '|', args, 3);
167                         varname = args[0];
168                         delimiter = args[1];
169                         field = args[2];
170
171                         if (field) {
172                                 args_okay = 1;
173                         }
174                 } else {
175                         return ERROR_NOMEM;
176                 }
177         }
178
179         if (args_okay) {
180                 char d, ds[2];
181                 char *tmp = alloca(strlen(varname) + 4);
182                 char varvalue[MAXRESULT], *tmp2=varvalue;
183
184                 if (tmp) {
185                         snprintf(tmp, strlen(varname) + 4, "${%s}", varname);
186                         memset(varvalue, 0, sizeof(varvalue));
187                 } else {
188                         return ERROR_NOMEM;
189                 }
190
191                 if (delimiter[0])
192                         d = delimiter[0];
193                 else
194                         d = '-';
195
196                 /* String form of the delimiter, for use with strsep(3) */
197                 snprintf(ds, sizeof(ds), "%c", d);
198
199                 pbx_substitute_variables_helper(chan, tmp, tmp2, MAXRESULT - 1);
200
201                 if (tmp2) {
202                         int curfieldnum = 1;
203                         while ((tmp2 != NULL) && (field != NULL)) {
204                                 char *nextgroup = strsep(&field, "&");
205                                 int num1 = 0, num2 = MAXRESULT;
206                                 char trashchar;
207
208                                 if (sscanf(nextgroup, "%d-%d", &num1, &num2) == 2) {
209                                         /* range with both start and end */
210                                 } else if (sscanf(nextgroup, "-%d", &num2) == 1) {
211                                         /* range with end */
212                                         num1 = 0;
213                                 } else if ((sscanf(nextgroup, "%d%c", &num1, &trashchar) == 2) && (trashchar == '-')) {
214                                         /* range with start */
215                                         num2 = MAXRESULT;
216                                 } else if (sscanf(nextgroup, "%d", &num1) == 1) {
217                                         /* single number */
218                                         num2 = num1;
219                                 } else {
220                                         return ERROR_USAGE;
221                                 }
222
223                                 /* Get to start, if any */
224                                 if (num1 > 0) {
225                                         while ((tmp2 != (char *)NULL + 1) && (curfieldnum < num1)) {
226                                                 tmp2 = index(tmp2, d) + 1;
227                                                 curfieldnum++;
228                                         }
229                                 }
230
231                                 /* Most frequent problem is the expectation of reordering fields */
232                                 if ((num1 > 0) && (curfieldnum > num1)) {
233                                         ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
234                                 }
235
236                                 /* Re-null tmp2 if we added 1 to NULL */
237                                 if (tmp2 == (char *)NULL + 1)
238                                         tmp2 = NULL;
239
240                                 /* Output fields until we either run out of fields or num2 is reached */
241                                 while ((tmp2 != NULL) && (curfieldnum <= num2)) {
242                                         char *tmp3 = strsep(&tmp2, ds);
243                                         int curlen = strlen(buffer);
244
245                                         if (curlen) {
246                                                 snprintf(buffer + curlen, buflen - curlen, "%c%s", d, tmp3);
247                                         } else {
248                                                 snprintf(buffer, buflen, "%s", tmp3);
249                                         }
250
251                                         curfieldnum++;
252                                 }
253                         }
254                 }
255         } else {
256                 return ERROR_NOARG;
257         }
258         return 0;
259 }
260
261 static int sort_exec(struct ast_channel *chan, void *data)
262 {
263         int res=0;
264         struct localuser *u;
265         char *varname, *strings, result[512] = "";
266         static int dep_warning=0;
267
268         if (!dep_warning) {
269                 ast_log(LOG_WARNING, "The application Sort is deprecated.  Please use the SORT() function instead.\n");
270                 dep_warning=1;
271         }
272
273         if (!data) {
274                 ast_log(LOG_ERROR, "Sort() requires an argument\n");
275                 return 0;
276         }
277
278         LOCAL_USER_ADD(u);
279
280         strings = ast_strdupa((char *)data);
281         if (!strings) {
282                 ast_log(LOG_ERROR, "Out of memory\n");
283                 LOCAL_USER_REMOVE(u);
284                 return 0;
285         }
286
287         varname = strsep(&strings, "=");
288         switch (sort_internal(chan, strings, result, sizeof(result))) {
289         case ERROR_NOARG:
290                 ast_log(LOG_ERROR, "Sort() requires an argument\n");
291                 res = 0;
292                 break;
293         case ERROR_NOMEM:
294                 ast_log(LOG_ERROR, "Out of memory\n");
295                 res = -1;
296                 break;
297         case 0:
298                 pbx_builtin_setvar_helper(chan, varname, result);
299                 res = 0;
300                 break;
301         default:
302                 ast_log(LOG_ERROR, "Unknown internal error\n");
303                 res = -1;
304         }
305         LOCAL_USER_REMOVE(u);
306         return res;
307 }
308
309 static int cut_exec(struct ast_channel *chan, void *data)
310 {
311         int res=0;
312         struct localuser *u;
313         char *s, *newvar=NULL, result[512];
314         static int dep_warning = 0;
315
316         LOCAL_USER_ADD(u);
317
318         if (!dep_warning) {
319                 ast_log(LOG_WARNING, "The application Cut is deprecated.  Please use the CUT() function instead.\n");
320                 dep_warning=1;
321         }
322
323         /* Check and parse arguments */
324         if (data) {
325                 s = ast_strdupa((char *)data);
326                 if (s) {
327                         newvar = strsep(&s, "=");
328                 } else {
329                         ast_log(LOG_ERROR, "Out of memory\n");
330                         LOCAL_USER_REMOVE(u);
331                         return -1;
332                 }
333         }
334
335         switch (cut_internal(chan, s, result, sizeof(result))) {
336         case ERROR_NOARG:
337                 ast_log(LOG_ERROR, "Cut() requires an argument\n");
338                 res = 0;
339                 break;
340         case ERROR_NOMEM:
341                 ast_log(LOG_ERROR, "Out of memory\n");
342                 res = -1;
343                 break;
344         case ERROR_USAGE:
345                 ast_log(LOG_ERROR, "Usage: %s\n", cut_synopsis);
346                 res = 0;
347                 break;
348         case 0:
349                 pbx_builtin_setvar_helper(chan, newvar, result);
350                 res = 0;
351                 break;
352         default:
353                 ast_log(LOG_ERROR, "Unknown internal error\n");
354                 res = -1;
355         }
356         LOCAL_USER_REMOVE(u);
357         return res;
358 }
359
360 static char *acf_sort_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
361 {
362         struct localuser *u;
363
364         LOCAL_USER_ACF_ADD(u);
365
366         switch (sort_internal(chan, data, buf, len)) {
367         case ERROR_NOARG:
368                 ast_log(LOG_ERROR, "SORT() requires an argument\n");
369                 break;
370         case ERROR_NOMEM:
371                 ast_log(LOG_ERROR, "Out of memory\n");
372                 break;
373         case 0:
374                 break;
375         default:
376                 ast_log(LOG_ERROR, "Unknown internal error\n");
377         }
378         LOCAL_USER_REMOVE(u);
379         return buf;
380 }
381
382 static char *acf_cut_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
383 {
384         struct localuser *u;
385
386         LOCAL_USER_ACF_ADD(u);
387
388         switch (cut_internal(chan, data, buf, len)) {
389         case ERROR_NOARG:
390                 ast_log(LOG_ERROR, "CUT() requires an argument\n");
391                 break;
392         case ERROR_NOMEM:
393                 ast_log(LOG_ERROR, "Out of memory\n");
394                 break;
395         case ERROR_USAGE:
396                 ast_log(LOG_ERROR, "Usage: %s\n", cut_synopsis);
397                 break;
398         case 0:
399                 break;
400         default:
401                 ast_log(LOG_ERROR, "Unknown internal error\n");
402         }
403         LOCAL_USER_REMOVE(u);
404         return buf;
405 }
406
407 struct ast_custom_function acf_sort = {
408         .name = "SORT",
409         .synopsis = "Sorts a list of key/vals into a list of keys, based upon the vals",
410         .syntax = "SORT(key1:val1[...][,keyN:valN])",
411         .desc =
412 "Takes a comma-separated list of keys and values, each separated by a colon, and returns a\n"
413 "comma-separated list of the keys, sorted by their values.  Values will be evaluated as\n"
414 "floating-point numbers.\n",
415         .read = acf_sort_exec,
416 };
417
418 struct ast_custom_function acf_cut = {
419         .name = "CUT",
420         .synopsis = "Slices and dices strings, based upon a named delimiter.",
421         .syntax = "CUT(<varname>,<char-delim>,<range-spec>)",
422         .desc =
423 "  varname    - variable you want cut\n"
424 "  char-delim - defaults to '-'\n"
425 "  range-spec - number of the field you want (1-based offset)\n"
426 "             may also be specified as a range (with -)\n"
427 "             or group of ranges and fields (with &)\n",
428         .read = acf_cut_exec,
429 };
430
431 int unload_module(void)
432 {
433         int res;
434
435         res = ast_custom_function_unregister(&acf_cut);
436         res |= ast_custom_function_unregister(&acf_sort);
437         res |= ast_unregister_application(app_sort);
438         res |= ast_unregister_application(app_cut);
439
440         STANDARD_HANGUP_LOCALUSERS;
441
442         return res;
443 }
444
445 int load_module(void)
446 {
447         int res;
448
449         res = ast_custom_function_register(&acf_cut);
450         res |= ast_custom_function_register(&acf_sort);
451         res |= ast_register_application(app_sort, sort_exec, app_sort_synopsis, app_sort_descrip);
452         res |= ast_register_application(app_cut, cut_exec, cut_synopsis, cut_descrip);
453
454         return res;
455 }
456
457 char *description(void)
458 {
459         return tdesc;
460 }
461
462 int usecount(void)
463 {
464         int res;
465         STANDARD_USECOUNT(res);
466         return res;
467 }
468
469 char *key()
470 {
471         return ASTERISK_GPL_KEY;
472 }