87654fd245825b9c754f6f957c154973aea93343
[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         }
256         return 0;
257 }
258
259 static int sort_exec(struct ast_channel *chan, void *data)
260 {
261         int res=0;
262         struct localuser *u;
263         char *varname, *strings, result[512] = "";
264         static int dep_warning=0;
265
266         if (!dep_warning) {
267                 ast_log(LOG_WARNING, "The application Sort is deprecated.  Please use the SORT() function instead.\n");
268                 dep_warning=1;
269         }
270
271         if (!data) {
272                 ast_log(LOG_ERROR, "Sort() requires an argument\n");
273                 return 0;
274         }
275
276         LOCAL_USER_ADD(u);
277
278         strings = ast_strdupa((char *)data);
279         if (!strings) {
280                 ast_log(LOG_ERROR, "Out of memory\n");
281                 LOCAL_USER_REMOVE(u);
282                 return 0;
283         }
284
285         varname = strsep(&strings, "=");
286         switch (sort_internal(chan, strings, result, sizeof(result))) {
287         case ERROR_NOARG:
288                 ast_log(LOG_ERROR, "Sort() requires an argument\n");
289                 res = 0;
290                 break;
291         case ERROR_NOMEM:
292                 ast_log(LOG_ERROR, "Out of memory\n");
293                 res = -1;
294                 break;
295         case 0:
296                 pbx_builtin_setvar_helper(chan, varname, result);
297                 res = 0;
298                 break;
299         default:
300                 ast_log(LOG_ERROR, "Unknown internal error\n");
301                 res = -1;
302         }
303         LOCAL_USER_REMOVE(u);
304         return res;
305 }
306
307 static int cut_exec(struct ast_channel *chan, void *data)
308 {
309         int res=0;
310         struct localuser *u;
311         char *s, *newvar=NULL, result[512];
312         static int dep_warning = 0;
313
314         LOCAL_USER_ADD(u);
315
316         if (!dep_warning) {
317                 ast_log(LOG_WARNING, "The application Cut is deprecated.  Please use the CUT() function instead.\n");
318                 dep_warning=1;
319         }
320
321         /* Check and parse arguments */
322         if (data) {
323                 s = ast_strdupa((char *)data);
324                 if (s) {
325                         newvar = strsep(&s, "=");
326                 } else {
327                         ast_log(LOG_ERROR, "Out of memory\n");
328                         LOCAL_USER_REMOVE(u);
329                         return -1;
330                 }
331         }
332
333         switch (cut_internal(chan, s, result, sizeof(result))) {
334         case ERROR_NOARG:
335                 ast_log(LOG_ERROR, "Cut() requires an argument\n");
336                 res = 0;
337                 break;
338         case ERROR_NOMEM:
339                 ast_log(LOG_ERROR, "Out of memory\n");
340                 res = -1;
341                 break;
342         case ERROR_USAGE:
343                 ast_log(LOG_ERROR, "Usage: %s\n", cut_synopsis);
344                 res = 0;
345                 break;
346         case 0:
347                 pbx_builtin_setvar_helper(chan, newvar, result);
348                 res = 0;
349                 break;
350         default:
351                 ast_log(LOG_ERROR, "Unknown internal error\n");
352                 res = -1;
353         }
354         LOCAL_USER_REMOVE(u);
355         return res;
356 }
357
358 static char *acf_sort_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
359 {
360         struct localuser *u;
361
362         LOCAL_USER_ACF_ADD(u);
363
364         switch (sort_internal(chan, data, buf, len)) {
365         case ERROR_NOARG:
366                 ast_log(LOG_ERROR, "SORT() requires an argument\n");
367                 break;
368         case ERROR_NOMEM:
369                 ast_log(LOG_ERROR, "Out of memory\n");
370                 break;
371         case 0:
372                 break;
373         default:
374                 ast_log(LOG_ERROR, "Unknown internal error\n");
375         }
376         LOCAL_USER_REMOVE(u);
377         return buf;
378 }
379
380 static char *acf_cut_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
381 {
382         struct localuser *u;
383
384         LOCAL_USER_ACF_ADD(u);
385
386         switch (cut_internal(chan, data, buf, len)) {
387         case ERROR_NOARG:
388                 ast_log(LOG_ERROR, "Cut() requires an argument\n");
389                 break;
390         case ERROR_NOMEM:
391                 ast_log(LOG_ERROR, "Out of memory\n");
392                 break;
393         case ERROR_USAGE:
394                 ast_log(LOG_ERROR, "Usage: %s\n", cut_synopsis);
395                 break;
396         case 0:
397                 break;
398         default:
399                 ast_log(LOG_ERROR, "Unknown internal error\n");
400         }
401         LOCAL_USER_REMOVE(u);
402         return buf;
403 }
404
405 struct ast_custom_function acf_sort = {
406         .name = "SORT",
407         .synopsis = "Sorts a list of key/vals into a list of keys, based upon the vals",
408         .syntax = "SORT(key1:val1[...][,keyN:valN])",
409         .desc =
410 "Takes a comma-separated list of keys and values, each separated by a colon, and returns a\n"
411 "comma-separated list of the keys, sorted by their values.  Values will be evaluated as\n"
412 "floating-point numbers.\n",
413         .read = acf_sort_exec,
414 };
415
416 struct ast_custom_function acf_cut = {
417         .name = "CUT",
418         .synopsis = "Slices and dices strings, based upon a named delimiter.",
419         .syntax = "CUT(<varname>,<char-delim>,<range-spec>)",
420         .desc =
421 "  varname    - variable you want cut\n"
422 "  char-delim - defaults to '-'\n"
423 "  range-spec - number of the field you want (1-based offset)\n"
424 "             may also be specified as a range (with -)\n"
425 "             or group of ranges and fields (with &)\n",
426         .read = acf_cut_exec,
427 };
428
429 int unload_module(void)
430 {
431         int res;
432
433         res = ast_custom_function_unregister(&acf_cut);
434         res |= ast_custom_function_unregister(&acf_sort);
435         res |= ast_unregister_application(app_sort);
436         res |= ast_unregister_application(app_cut);
437
438         STANDARD_HANGUP_LOCALUSERS;
439
440         return res;
441 }
442
443 int load_module(void)
444 {
445         int res;
446
447         res = ast_custom_function_register(&acf_cut);
448         res |= ast_custom_function_register(&acf_sort);
449         res |= ast_register_application(app_sort, sort_exec, app_sort_synopsis, app_sort_descrip);
450         res |= ast_register_application(app_cut, cut_exec, cut_synopsis, cut_descrip);
451
452         return res;
453 }
454
455 char *description(void)
456 {
457         return tdesc;
458 }
459
460 int usecount(void)
461 {
462         int res;
463         STANDARD_USECOUNT(res);
464         return res;
465 }
466
467 char *key()
468 {
469         return ASTERISK_GPL_KEY;
470 }