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