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