Merged revisions 328247 via svnmerge from
[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 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/file.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/app.h"
40
41 /*** DOCUMENTATION
42         <function name="SORT" language="en_US">
43                 <synopsis>
44                         Sorts a list of key/vals into a list of keys, based upon the vals.      
45                 </synopsis>
46                 <syntax>
47                         <parameter name="keyval" required="true" argsep=":">
48                                 <argument name="key1" required="true" />
49                                 <argument name="val1" required="true" />
50                         </parameter>
51                         <parameter name="keyvaln" multiple="true" argsep=":">
52                                 <argument name="key2" required="true" />
53                                 <argument name="val2" required="true" />
54                         </parameter>
55                 </syntax>
56                 <description>
57                         <para>Takes a comma-separated list of keys and values, each separated by a colon, and returns a
58                         comma-separated list of the keys, sorted by their values.  Values will be evaluated as
59                         floating-point numbers.</para>
60                 </description>
61         </function>
62         <function name="CUT" language="en_US">
63                 <synopsis>
64                         Slices and dices strings, based upon a named delimiter.         
65                 </synopsis>
66                 <syntax>
67                         <parameter name="varname" required="true">
68                                 <para>Variable you want cut</para>
69                         </parameter>
70                         <parameter name="char-delim" required="true">
71                                 <para>Delimiter, defaults to <literal>-</literal></para>
72                         </parameter>
73                         <parameter name="range-spec" required="true">
74                                 <para>Number of the field you want (1-based offset), may also be specified as a range (with <literal>-</literal>)
75                                 or group of ranges and fields (with <literal>&amp;</literal>)</para>
76                         </parameter>
77                 </syntax>
78                 <description>
79                         <para>Cut out information from a string (<replaceable>varname</replaceable>), based upon a named delimiter.</para>
80                 </description>  
81         </function>
82  ***/
83
84 struct sortable_keys {
85         char *key;
86         float value;
87 };
88
89 static int sort_subroutine(const void *arg1, const void *arg2)
90 {
91         const struct sortable_keys *one=arg1, *two=arg2;
92         if (one->value < two->value)
93                 return -1;
94         else if (one->value == two->value)
95                 return 0;
96         else
97                 return 1;
98 }
99
100 #define ERROR_NOARG     (-1)
101 #define ERROR_NOMEM     (-2)
102 #define ERROR_USAGE     (-3)
103
104 static int sort_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
105 {
106         char *strings, *ptrkey, *ptrvalue;
107         int count=1, count2, element_count=0;
108         struct sortable_keys *sortable_keys;
109
110         *buffer = '\0';
111
112         if (!data)
113                 return ERROR_NOARG;
114
115         strings = ast_strdupa(data);
116
117         for (ptrkey = strings; *ptrkey; ptrkey++) {
118                 if (*ptrkey == ',')
119                         count++;
120         }
121
122         sortable_keys = alloca(count * sizeof(struct sortable_keys));
123
124         memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
125
126         /* Parse each into a struct */
127         count2 = 0;
128         while ((ptrkey = strsep(&strings, ","))) {
129                 ptrvalue = strchr(ptrkey, ':');
130                 if (!ptrvalue) {
131                         count--;
132                         continue;
133                 }
134                 *ptrvalue++ = '\0';
135                 sortable_keys[count2].key = ptrkey;
136                 sscanf(ptrvalue, "%30f", &sortable_keys[count2].value);
137                 count2++;
138         }
139
140         /* Sort the structs */
141         qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
142
143         for (count2 = 0; count2 < count; count2++) {
144                 int blen = strlen(buffer);
145                 if (element_count++) {
146                         strncat(buffer + blen, ",", buflen - blen - 1);
147                         blen++;
148                 }
149                 strncat(buffer + blen, sortable_keys[count2].key, buflen - blen - 1);
150         }
151
152         return 0;
153 }
154
155 static int cut_internal(struct ast_channel *chan, char *data, struct ast_str **buf, ssize_t buflen)
156 {
157         char *parse, ds[2], *var_expr;
158         size_t delim_consumed;
159         struct ast_str *var_value;
160         AST_DECLARE_APP_ARGS(args,
161                 AST_APP_ARG(varname);
162                 AST_APP_ARG(delimiter);
163                 AST_APP_ARG(field);
164         );
165
166         parse = ast_strdupa(data);
167
168         AST_STANDARD_APP_ARGS(args, parse);
169
170         /* Check arguments */
171         if (args.argc < 3) {
172                 return ERROR_NOARG;
173         } else if (!(var_expr = alloca(strlen(args.varname) + 4))) {
174                 return ERROR_NOMEM;
175         }
176
177         /* Get the value of the variable named in the 1st argument */
178         snprintf(var_expr, strlen(args.varname) + 4, "${%s}", args.varname);
179         var_value = ast_str_create(16);
180         ast_str_substitute_variables(&var_value, 0, chan, var_expr);
181
182         /* Copy delimiter from 2nd argument to ds[] possibly decoding backslash escapes */
183         if (ast_get_encoded_char(args.delimiter, ds, &delim_consumed)) {
184                 ast_copy_string(ds, "-", sizeof(ds));
185         }
186         ds[1] = '\0';
187
188         if (ast_str_strlen(var_value)) {
189                 int curfieldnum = 1;
190                 char *curfieldptr = ast_str_buffer(var_value);
191                 int out_field_count = 0;
192
193                 while (curfieldptr != NULL && args.field != NULL) {
194                         char *next_range = strsep(&(args.field), "&");
195                         int start_field, stop_field;
196                         char trashchar;
197
198                         if (sscanf(next_range, "%30d-%30d", &start_field, &stop_field) == 2) {
199                                 /* range with both start and end */
200                         } else if (sscanf(next_range, "-%30d", &stop_field) == 1) {
201                                 /* range with end only */
202                                 start_field = 1;
203                         } else if ((sscanf(next_range, "%30d%1c", &start_field, &trashchar) == 2) && (trashchar == '-')) {
204                                 /* range with start only */
205                                 stop_field = INT_MAX;
206                         } else if (sscanf(next_range, "%30d", &start_field) == 1) {
207                                 /* single number */
208                                 stop_field = start_field;
209                         } else {
210                                 /* invalid field spec */
211                                 ast_free(var_value);
212                                 return ERROR_USAGE;
213                         }
214
215                         /* Get to start, if not there already */
216                         while (curfieldptr != NULL && curfieldnum < start_field) {
217                                 strsep(&curfieldptr, ds);
218                                 curfieldnum++;
219                         }
220
221                         /* Most frequent problem is the expectation of reordering fields */
222                         if (curfieldnum > start_field) {
223                                 ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
224                         }
225
226                         /* Output fields until we either run out of fields or stop_field is reached */
227                         while (curfieldptr != NULL && curfieldnum <= stop_field) {
228                                 char *field_value = strsep(&curfieldptr, ds);
229                                 ast_str_append(buf, buflen, "%s%s", out_field_count++ ? ds : "", field_value);
230                                 curfieldnum++;
231                         }
232                 }
233         }
234         ast_free(var_value);
235         return 0;
236 }
237
238 static int acf_sort_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
239 {
240         int ret = -1;
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                 ret = 0;
251                 break;
252         default:
253                 ast_log(LOG_ERROR, "Unknown internal error\n");
254         }
255
256         return ret;
257 }
258
259 static int acf_cut_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
260 {
261         int ret = -1;
262         struct ast_str *str = ast_str_create(16);
263
264         switch (cut_internal(chan, data, &str, 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                 ret = 0;
276                 ast_copy_string(buf, ast_str_buffer(str), len);
277                 break;
278         default:
279                 ast_log(LOG_ERROR, "Unknown internal error\n");
280         }
281         ast_free(str);
282         return ret;
283 }
284
285 static int acf_cut_exec2(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
286 {
287         int ret = -1;
288
289         switch (cut_internal(chan, data, buf, len)) {
290         case ERROR_NOARG:
291                 ast_log(LOG_ERROR, "Syntax: CUT(<varname>,<char-delim>,<range-spec>) - missing argument!\n");
292                 break;
293         case ERROR_NOMEM:
294                 ast_log(LOG_ERROR, "Out of memory\n");
295                 break;
296         case ERROR_USAGE:
297                 ast_log(LOG_ERROR, "Usage: CUT(<varname>,<char-delim>,<range-spec>)\n");
298                 break;
299         case 0:
300                 ret = 0;
301                 break;
302         default:
303                 ast_log(LOG_ERROR, "Unknown internal error\n");
304         }
305
306         return ret;
307 }
308
309 static struct ast_custom_function acf_sort = {
310         .name = "SORT",
311         .read = acf_sort_exec,
312 };
313
314 static struct ast_custom_function acf_cut = {
315         .name = "CUT",
316         .read = acf_cut_exec,
317         .read2 = acf_cut_exec2,
318 };
319
320 static int unload_module(void)
321 {
322         int res = 0;
323
324         res |= ast_custom_function_unregister(&acf_cut);
325         res |= ast_custom_function_unregister(&acf_sort);
326
327         return res;
328 }
329
330 static int load_module(void)
331 {
332         int res = 0;
333
334         res |= ast_custom_function_register(&acf_cut);
335         res |= ast_custom_function_register(&acf_sort);
336
337         return res;
338 }
339
340 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Cut out information from a string");