7b3d2bff8072b0421545546009435b950b00d5b9
[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         if (!(strings = ast_strdupa(data)))
87                 return ERROR_NOMEM;
88
89         for (ptrkey = strings; *ptrkey; ptrkey++) {
90                 if (*ptrkey == '|') {
91                         count++;
92                 }
93         }
94
95         sortable_keys = alloca(count * sizeof(struct sortable_keys));
96         if (!sortable_keys) {
97                 return ERROR_NOMEM;
98         }
99
100         memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
101
102         /* Parse each into a struct */
103         count2 = 0;
104         while ((ptrkey = strsep(&strings, "|"))) {
105                 ptrvalue = index(ptrkey, ':');
106                 if (!ptrvalue) {
107                         count--;
108                         continue;
109                 }
110                 *ptrvalue = '\0';
111                 ptrvalue++;
112                 sortable_keys[count2].key = ptrkey;
113                 sscanf(ptrvalue, "%f", &sortable_keys[count2].value);
114                 count2++;
115         }
116
117         /* Sort the structs */
118         qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
119
120         for (count2 = 0; count2 < count; count2++) {
121                 int blen = strlen(buffer);
122                 if (element_count++) {
123                         strncat(buffer + blen, ",", buflen - blen - 1);
124                         blen++;
125                 }
126                 strncat(buffer + blen, sortable_keys[count2].key, buflen - blen - 1);
127         }
128
129         return 0;
130 }
131
132 static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
133 {
134         char *parse;
135         AST_DECLARE_APP_ARGS(args,
136                 AST_APP_ARG(varname);
137                 AST_APP_ARG(delimiter);
138                 AST_APP_ARG(field);
139         );
140
141         memset(buffer, 0, buflen); 
142         
143         if (!(parse = ast_strdupa(data)))
144                 return ERROR_NOMEM;
145
146         AST_STANDARD_APP_ARGS(args, parse);
147
148         /* Check and parse arguments */
149         if(args.argc < 3){
150                 return ERROR_NOARG;
151         } else {
152                 char d, ds[2];
153                 char *tmp = alloca(strlen(args.varname) + 4);
154                 char varvalue[MAXRESULT], *tmp2=varvalue;
155
156                 if (tmp) {
157                         snprintf(tmp, strlen(args.varname) + 4, "${%s}", args.varname);
158                         memset(varvalue, 0, sizeof(varvalue));
159                 } else {
160                         return ERROR_NOMEM;
161                 }
162
163                 if (args.delimiter[0])
164                         d = args.delimiter[0];
165                 else
166                         d = '-';
167
168                 /* String form of the delimiter, for use with strsep(3) */
169                 snprintf(ds, sizeof(ds), "%c", d);
170
171                 pbx_substitute_variables_helper(chan, tmp, tmp2, MAXRESULT - 1);
172
173                 if (tmp2) {
174                         int curfieldnum = 1;
175                         while ((tmp2 != NULL) && (args.field != NULL)) {
176                                 char *nextgroup = strsep(&(args.field), "&");
177                                 int num1 = 0, num2 = MAXRESULT;
178                                 char trashchar;
179
180                                 if (sscanf(nextgroup, "%d-%d", &num1, &num2) == 2) {
181                                         /* range with both start and end */
182                                 } else if (sscanf(nextgroup, "-%d", &num2) == 1) {
183                                         /* range with end */
184                                         num1 = 0;
185                                 } else if ((sscanf(nextgroup, "%d%c", &num1, &trashchar) == 2) && (trashchar == '-')) {
186                                         /* range with start */
187                                         num2 = MAXRESULT;
188                                 } else if (sscanf(nextgroup, "%d", &num1) == 1) {
189                                         /* single number */
190                                         num2 = num1;
191                                 } else {
192                                         return ERROR_USAGE;
193                                 }
194
195                                 /* Get to start, if any */
196                                 if (num1 > 0) {
197                                         while ((tmp2 != (char *)NULL + 1) && (curfieldnum < num1)) {
198                                                 tmp2 = index(tmp2, d) + 1;
199                                                 curfieldnum++;
200                                         }
201                                 }
202
203                                 /* Most frequent problem is the expectation of reordering fields */
204                                 if ((num1 > 0) && (curfieldnum > num1)) {
205                                         ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
206                                 }
207
208                                 /* Re-null tmp2 if we added 1 to NULL */
209                                 if (tmp2 == (char *)NULL + 1)
210                                         tmp2 = NULL;
211
212                                 /* Output fields until we either run out of fields or num2 is reached */
213                                 while ((tmp2 != NULL) && (curfieldnum <= num2)) {
214                                         char *tmp3 = strsep(&tmp2, ds);
215                                         int curlen = strlen(buffer);
216
217                                         if (curlen) {
218                                                 snprintf(buffer + curlen, buflen - curlen, "%c%s", d, tmp3);
219                                         } else {
220                                                 snprintf(buffer, buflen, "%s", tmp3);
221                                         }
222
223                                         curfieldnum++;
224                                 }
225                         }
226                 }
227         }
228         return 0;
229 }
230
231 static char *acf_sort_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
232 {
233         struct localuser *u;
234
235         LOCAL_USER_ACF_ADD(u);
236
237         switch (sort_internal(chan, data, buf, len)) {
238         case ERROR_NOARG:
239                 ast_log(LOG_ERROR, "SORT() requires an argument\n");
240                 break;
241         case ERROR_NOMEM:
242                 ast_log(LOG_ERROR, "Out of memory\n");
243                 break;
244         case 0:
245                 break;
246         default:
247                 ast_log(LOG_ERROR, "Unknown internal error\n");
248         }
249         LOCAL_USER_REMOVE(u);
250         return buf;
251 }
252
253 static char *acf_cut_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
254 {
255         struct localuser *u;
256
257         LOCAL_USER_ACF_ADD(u);
258
259         switch (cut_internal(chan, data, buf, len)) {
260         case ERROR_NOARG:
261                 ast_log(LOG_ERROR, "Syntax: CUT(<varname>,<char-delim>,<range-spec>) - missing argument!\n");
262                 break;
263         case ERROR_NOMEM:
264                 ast_log(LOG_ERROR, "Out of memory\n");
265                 break;
266         case ERROR_USAGE:
267                 ast_log(LOG_ERROR, "Usage: CUT(<varname>,<char-delim>,<range-spec>)\n");
268                 break;
269         case 0:
270                 break;
271         default:
272                 ast_log(LOG_ERROR, "Unknown internal error\n");
273         }
274         LOCAL_USER_REMOVE(u);
275         return buf;
276 }
277
278 struct ast_custom_function acf_sort = {
279         .name = "SORT",
280         .synopsis = "Sorts a list of key/vals into a list of keys, based upon the vals",
281         .syntax = "SORT(key1:val1[...][,keyN:valN])",
282         .desc =
283 "Takes a comma-separated list of keys and values, each separated by a colon, and returns a\n"
284 "comma-separated list of the keys, sorted by their values.  Values will be evaluated as\n"
285 "floating-point numbers.\n",
286         .read = acf_sort_exec,
287 };
288
289 struct ast_custom_function acf_cut = {
290         .name = "CUT",
291         .synopsis = "Slices and dices strings, based upon a named delimiter.",
292         .syntax = "CUT(<varname>,<char-delim>,<range-spec>)",
293         .desc =
294 "  varname    - variable you want cut\n"
295 "  char-delim - defaults to '-'\n"
296 "  range-spec - number of the field you want (1-based offset)\n"
297 "             may also be specified as a range (with -)\n"
298 "             or group of ranges and fields (with &)\n",
299         .read = acf_cut_exec,
300 };
301
302 int unload_module(void)
303 {
304         int res = 0;
305
306         res |= ast_custom_function_unregister(&acf_cut);
307         res |= ast_custom_function_unregister(&acf_sort);
308
309         STANDARD_HANGUP_LOCALUSERS;
310
311         return res;
312 }
313
314 int load_module(void)
315 {
316         int res = 0;
317
318         res |= ast_custom_function_register(&acf_cut);
319         res |= ast_custom_function_register(&acf_sort);
320
321         return res;
322 }
323
324 char *description(void)
325 {
326         return tdesc;
327 }
328
329 int usecount(void)
330 {
331         int res;
332         STANDARD_USECOUNT(res);
333         return res;
334 }
335
336 char *key()
337 {
338         return ASTERISK_GPL_KEY;
339 }