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