apps/app_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 application
  20  *
  21  * \ingroup applications
  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                 }
 124                 strncat(buffer + blen + 1, sortable_keys[count2].key, buflen - blen - 2);
 125         }
 126
 127         return 0;
 128 }
 129
 130 static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
 131 {
 132         char *s, *args[3], *varname=NULL, *delimiter=NULL, *field=NULL;
 133         int args_okay = 0;
 134
 135         memset(buffer, 0, buflen);
 136
 137         /* Check and parse arguments */
 138         if (data) {
 139                 s = ast_strdupa((char *)data);
 140                 if (s) {
 141                         ast_app_separate_args(s, '|', args, 3);
 142                         varname = args[0];
 143                         delimiter = args[1];
 144                         field = args[2];
 145
 146                         if (field) {
 147                                 args_okay = 1;
 148                         }
 149                 } else {
 150                         return ERROR_NOMEM;
 151                 }
 152         }
 153
 154         if (args_okay) {
 155                 char d, ds[2];
 156                 char *tmp = alloca(strlen(varname) + 4);
 157                 char varvalue[MAXRESULT], *tmp2=varvalue;
 158
 159                 if (tmp) {
 160                         snprintf(tmp, strlen(varname) + 4, "${%s}", varname);
 161                         memset(varvalue, 0, sizeof(varvalue));
 162                 } else {
 163                         return ERROR_NOMEM;
 164                 }
 165
 166                 if (delimiter[0])
 167                         d = delimiter[0];
 168                 else
 169                         d = '-';
 170
 171                 /* String form of the delimiter, for use with strsep(3) */
 172                 snprintf(ds, sizeof(ds), "%c", d);
 173
 174                 pbx_substitute_variables_helper(chan, tmp, tmp2, MAXRESULT - 1);
 175
 176                 if (tmp2) {
 177                         int curfieldnum = 1;
 178                         while ((tmp2 != NULL) && (field != NULL)) {
 179                                 char *nextgroup = strsep(&field, "&");
 180                                 int num1 = 0, num2 = MAXRESULT;
 181                                 char trashchar;
 182
 183                                 if (sscanf(nextgroup, "%d-%d", &num1, &num2) == 2) {
 184                                         /* range with both start and end */
 185                                 } else if (sscanf(nextgroup, "-%d", &num2) == 1) {
 186                                         /* range with end */
 187                                         num1 = 0;
 188                                 } else if ((sscanf(nextgroup, "%d%c", &num1, &trashchar) == 2) && (trashchar == '-')) {
 189                                         /* range with start */
 190                                         num2 = MAXRESULT;
 191                                 } else if (sscanf(nextgroup, "%d", &num1) == 1) {
 192                                         /* single number */
 193                                         num2 = num1;
 194                                 } else {
 195                                         return ERROR_USAGE;
 196                                 }
 197
 198                                 /* Get to start, if any */
 199                                 if (num1 > 0) {
 200                                         while ((tmp2 != (char *)NULL + 1) && (curfieldnum < num1)) {
 201                                                 tmp2 = index(tmp2, d) + 1;
 202                                                 curfieldnum++;
 203                                         }
 204                                 }
 205
 206                                 /* Most frequent problem is the expectation of reordering fields */
 207                                 if ((num1 > 0) && (curfieldnum > num1)) {
 208                                         ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
 209                                 }
 210
 211                                 /* Re-null tmp2 if we added 1 to NULL */
 212                                 if (tmp2 == (char *)NULL + 1)
 213                                         tmp2 = NULL;
 214
 215                                 /* Output fields until we either run out of fields or num2 is reached */
 216                                 while ((tmp2 != NULL) && (curfieldnum <= num2)) {
 217                                         char *tmp3 = strsep(&tmp2, ds);
 218                                         int curlen = strlen(buffer);
 219
 220                                         if (curlen) {
 221                                                 snprintf(buffer + curlen, buflen - curlen, "%c%s", d, tmp3);
 222                                         } else {
 223                                                 snprintf(buffer, buflen, "%s", tmp3);
 224                                         }
 225
 226                                         curfieldnum++;
 227                                 }
 228                         }
 229                 }
 230         } else {
 231                 return ERROR_NOARG;
 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, "CUT() requires an 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: %s\n", cut_synopsis);
 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 }