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