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