since the module API is changing, it's a good time to const-ify the description(...
[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 static char *tdesc = "Cut out information from a string";
48
49 LOCAL_USER_DECL;
50
51 struct sortable_keys {
52         char *key;
53         float value;
54 };
55
56 static int sort_subroutine(const void *arg1, const void *arg2)
57 {
58         const struct sortable_keys *one=arg1, *two=arg2;
59         if (one->value < two->value) {
60                 return -1;
61         } else if (one->value == two->value) {
62                 return 0;
63         } else {
64                 return 1;
65         }
66 }
67
68 #define ERROR_NOARG     (-1)
69 #define ERROR_NOMEM     (-2)
70 #define ERROR_USAGE     (-3)
71
72 static int sort_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
73 {
74         char *strings, *ptrkey, *ptrvalue;
75         int count=1, count2, element_count=0;
76         struct sortable_keys *sortable_keys;
77
78         memset(buffer, 0, buflen);
79
80         if (!data) {
81                 return ERROR_NOARG;
82         }
83
84         if (!(strings = ast_strdupa(data)))
85                 return ERROR_NOMEM;
86
87         for (ptrkey = strings; *ptrkey; ptrkey++) {
88                 if (*ptrkey == '|') {
89                         count++;
90                 }
91         }
92
93         sortable_keys = alloca(count * sizeof(struct sortable_keys));
94         if (!sortable_keys) {
95                 return ERROR_NOMEM;
96         }
97
98         memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
99
100         /* Parse each into a struct */
101         count2 = 0;
102         while ((ptrkey = strsep(&strings, "|"))) {
103                 ptrvalue = index(ptrkey, ':');
104                 if (!ptrvalue) {
105                         count--;
106                         continue;
107                 }
108                 *ptrvalue = '\0';
109                 ptrvalue++;
110                 sortable_keys[count2].key = ptrkey;
111                 sscanf(ptrvalue, "%f", &sortable_keys[count2].value);
112                 count2++;
113         }
114
115         /* Sort the structs */
116         qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
117
118         for (count2 = 0; count2 < count; count2++) {
119                 int blen = strlen(buffer);
120                 if (element_count++) {
121                         strncat(buffer + blen, ",", buflen - blen - 1);
122                         blen++;
123                 }
124                 strncat(buffer + blen, sortable_keys[count2].key, buflen - blen - 1);
125         }
126
127         return 0;
128 }
129
130 static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
131 {
132         char *parse;
133         AST_DECLARE_APP_ARGS(args,
134                 AST_APP_ARG(varname);
135                 AST_APP_ARG(delimiter);
136                 AST_APP_ARG(field);
137         );
138
139         memset(buffer, 0, buflen); 
140         
141         if (!(parse = ast_strdupa(data)))
142                 return ERROR_NOMEM;
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 int acf_sort_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
230 {
231         struct localuser *u;
232         int ret = -1;
233
234         LOCAL_USER_ADD(u);
235
236         switch (sort_internal(chan, data, buf, len)) {
237         case ERROR_NOARG:
238                 ast_log(LOG_ERROR, "SORT() requires an argument\n");
239                 break;
240         case ERROR_NOMEM:
241                 ast_log(LOG_ERROR, "Out of memory\n");
242                 break;
243         case 0:
244                 ret = 0;
245                 break;
246         default:
247                 ast_log(LOG_ERROR, "Unknown internal error\n");
248         }
249         LOCAL_USER_REMOVE(u);
250
251         return ret;
252 }
253
254 static int acf_cut_exec(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
255 {
256         int ret = -1;
257         struct localuser *u;
258
259         LOCAL_USER_ADD(u);
260
261         switch (cut_internal(chan, data, buf, len)) {
262         case ERROR_NOARG:
263                 ast_log(LOG_ERROR, "Syntax: CUT(<varname>,<char-delim>,<range-spec>) - missing argument!\n");
264                 break;
265         case ERROR_NOMEM:
266                 ast_log(LOG_ERROR, "Out of memory\n");
267                 break;
268         case ERROR_USAGE:
269                 ast_log(LOG_ERROR, "Usage: CUT(<varname>,<char-delim>,<range-spec>)\n");
270                 break;
271         case 0:
272                 ret = 0;
273                 break;
274         default:
275                 ast_log(LOG_ERROR, "Unknown internal error\n");
276         }
277         LOCAL_USER_REMOVE(u);
278
279         return ret;
280 }
281
282 struct ast_custom_function acf_sort = {
283         .name = "SORT",
284         .synopsis = "Sorts a list of key/vals into a list of keys, based upon the vals",
285         .syntax = "SORT(key1:val1[...][,keyN:valN])",
286         .desc =
287 "Takes a comma-separated list of keys and values, each separated by a colon, and returns a\n"
288 "comma-separated list of the keys, sorted by their values.  Values will be evaluated as\n"
289 "floating-point numbers.\n",
290         .read = acf_sort_exec,
291 };
292
293 struct ast_custom_function acf_cut = {
294         .name = "CUT",
295         .synopsis = "Slices and dices strings, based upon a named delimiter.",
296         .syntax = "CUT(<varname>,<char-delim>,<range-spec>)",
297         .desc =
298 "  varname    - variable you want cut\n"
299 "  char-delim - defaults to '-'\n"
300 "  range-spec - number of the field you want (1-based offset)\n"
301 "             may also be specified as a range (with -)\n"
302 "             or group of ranges and fields (with &)\n",
303         .read = acf_cut_exec,
304 };
305
306 int unload_module(void)
307 {
308         int res = 0;
309
310         res |= ast_custom_function_unregister(&acf_cut);
311         res |= ast_custom_function_unregister(&acf_sort);
312
313         STANDARD_HANGUP_LOCALUSERS;
314
315         return res;
316 }
317
318 int load_module(void)
319 {
320         int res = 0;
321
322         res |= ast_custom_function_register(&acf_cut);
323         res |= ast_custom_function_register(&acf_sort);
324
325         return res;
326 }
327
328 const char *description(void)
329 {
330         return tdesc;
331 }
332
333 int usecount(void)
334 {
335         int res;
336         STANDARD_USECOUNT(res);
337         return res;
338 }
339
340 const char *key()
341 {
342         return ASTERISK_GPL_KEY;
343 }