utils/check_expr.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 #include <stdio.h>
  20 #include <stddef.h>
  21 #include <stdarg.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24
  25 struct ast_channel
  26 {
  27         char x; /* basically empty! */
  28 };
  29
  30 #include <../include/asterisk/compat.h>
  31 #include <../include/asterisk/ast_expr.h>
  32
  33 #define AST_API_MODULE 1
  34 #include "asterisk/inline_api.h"
  35
  36 #define AST_API_MODULE 1
  37 #include "asterisk/lock.h"
  38
  39 #include "asterisk/strings.h"
  40
  41 /* I included this from utils.c, so as not to have everything in that .c
  42    file included */
  43 /*!
  44  * core handler for dynamic strings.
  45  * This is not meant to be called directly, but rather through the
  46  * various wrapper macros
  47  *      ast_str_set(...)
  48  *      ast_str_append(...)
  49  *      ast_str_set_va(...)
  50  *      ast_str_append_va(...)
  51  */
  52 int __ast_str_helper(struct ast_str **buf, size_t max_len,
  53         int append, const char *fmt, va_list ap)
  54 {
  55         int res, need;
  56         int offset = (append && (*buf)->len) ? (*buf)->used : 0;
  57
  58         if (max_len < 0)
  59                 max_len = (*buf)->len;  /* don't exceed the allocated space */
  60         /*
  61          * Ask vsnprintf how much space we need. Remember that vsnprintf
  62          * does not count the final '\0' so we must add 1.
  63          */
  64         res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);
  65
  66         need = res + offset + 1;
  67         /*
  68          * If there is not enough space and we are below the max length,
  69          * reallocate the buffer and return a message telling to retry.
  70          */
  71         if (need > (*buf)->len && (max_len == 0 || (*buf)->len < max_len) ) {
  72                 if (max_len && max_len < need)  /* truncate as needed */
  73                         need = max_len;
  74                 else if (max_len == 0)  /* if unbounded, give more room for next time */
  75                         need += 16 + need/4;
  76                 if (ast_str_make_space(buf, need)) {
  77                         return AST_DYNSTR_BUILD_FAILED;
  78                 }
  79                 (*buf)->str[offset] = '\0';     /* Truncate the partial write. */
  80
  81                 /* va_end() and va_start() must be done before calling
  82                  * vsnprintf() again. */
  83                 return AST_DYNSTR_BUILD_RETRY;
  84         }
  85         /* update space used, keep in mind the truncation */
  86         (*buf)->used = (res + offset > (*buf)->len) ? (*buf)->len : res + offset;
  87
  88         return res;
  89 }
  90
  91 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
  92                         int line_num, const char *func, const char *lock_name, void *lock_addr)
  93 {
  94     /* not a lot to do in a standalone w/o threading! */
  95 }
  96
  97 void ast_mark_lock_acquired(void)
  98 {
  99     /* not a lot to do in a standalone w/o threading! */
 100 }
 101
 102 void ast_remove_lock_info(void *lock_addr)
 103 {
 104     /* not a lot to do in a standalone w/o threading! */
 105 }
 106
 107 static int global_lineno = 1;
 108 static int global_expr_count=0;
 109 static int global_expr_max_size=0;
 110 static int global_expr_tot_size=0;
 111 static int global_warn_count=0;
 112 static int global_OK_count=0;
 113
 114 struct varz
 115 {
 116         char varname[100]; /* a really ultra-simple, space-wasting linked list of var=val data */
 117         char varval[1000]; /* if any varname is bigger than 100 chars, or val greater than 1000, then **CRASH** */
 118         struct varz *next;
 119 };
 120
 121 struct varz *global_varlist;
 122
 123 /* Our own version of ast_log, since the expr parser uses it. */
 124
 125 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...) __attribute__ ((format (printf,5,6)));
 126
 127 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
 128 {
 129         va_list vars;
 130         va_start(vars,fmt);
 131
 132         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
 133                    level, file, line, function);
 134         vprintf(fmt, vars);
 135         fflush(stdout);
 136         va_end(vars);
 137 }
 138 void ast_register_file_version(const char *file, const char *version);
 139 void ast_unregister_file_version(const char *file);
 140
 141 char *find_var(const char *varname);
 142 void set_var(const char *varname, const char *varval);
 143 unsigned int check_expr(char* buffer, char* error_report);
 144 int check_eval(char *buffer, char *error_report);
 145 void parse_file(const char *fname);
 146
 147 void ast_register_file_version(const char *file, const char *version)
 148 {
 149 }
 150
 151 void ast_unregister_file_version(const char *file)
 152 {
 153 }
 154
 155 char *find_var(const char *varname) /* the list should be pretty short, if there's any list at all */
 156 {
 157         struct varz *t;
 158         for (t= global_varlist; t; t = t->next) {
 159                 if (!strcmp(t->varname, varname)) {
 160                         return t->varval;
 161                 }
 162         }
 163         return 0;
 164 }
 165
 166 void set_var(const char *varname, const char *varval);
 167
 168 void set_var(const char *varname, const char *varval)
 169 {
 170         struct varz *t = (struct varz*)calloc(1,sizeof(struct varz));
 171         if (!t)
 172                 return;
 173         strcpy(t->varname, varname);
 174         strcpy(t->varval, varval);
 175         t->next = global_varlist;
 176         global_varlist = t;
 177 }
 178
 179 unsigned int check_expr(char* buffer, char* error_report)
 180 {
 181         char* cp;
 182         unsigned int warn_found = 0;
 183
 184         error_report[0] = 0;
 185
 186         for (cp = buffer; *cp; ++cp)
 187         {
 188                 switch (*cp)
 189                 {
 190                         case '"':
 191                                 /* skip to the other end */
 192                                 while (*(++cp) && *cp != '"') ;
 193
 194                                 if (*cp == 0)
 195                                 {
 196                                         fprintf(stderr,
 197                                                 "Trouble? Unterminated double quote found at line %d\n",
 198                                                 global_lineno);
 199                                 }
 200                                 break;
 201
 202                         case '>':
 203                         case '<':
 204                         case '!':
 205                                 if (   (*(cp + 1) == '=')
 206                                         && ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 2) != ' ') ) )
 207                                 {
 208                                         char msg[200];
 209                                         snprintf(msg,
 210                                                 sizeof(msg),
 211                                                 "WARNING: line %d: '%c%c' operator not separated by spaces. This may lead to confusion. You may wish to use double quotes to quote the grouping it is in. Please check!\n",
 212                                                 global_lineno, *cp, *(cp + 1));
 213                                         strcat(error_report, msg);
 214                                         ++global_warn_count;
 215                                         ++warn_found;
 216                                 }
 217                                 break;
 218
 219                         case '|':
 220                         case '&':
 221                         case '=':
 222                         case '+':
 223                         case '-':
 224                         case '*':
 225                         case '/':
 226                         case '%':
 227                         case '?':
 228                         case ':':
 229                                 if ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 1) != ' ') )
 230                                 {
 231                                         char msg[200];
 232                                         snprintf(msg,
 233                                                 sizeof(msg),
 234                                                 "WARNING: line %d: '%c' operator not separated by spaces. This may lead to confusion. You may wish to use double quotes to quote the grouping it is in. Please check!\n",
 235                                                 global_lineno, *cp );
 236                                         strcat(error_report, msg);
 237                                         ++global_warn_count;
 238                                         ++warn_found;
 239                                 }
 240                                 break;
 241                 }
 242         }
 243
 244         return warn_found;
 245 }
 246
 247 int check_eval(char *buffer, char *error_report);
 248
 249 struct ast_custom_function *ast_custom_function_find(const char *name);
 250
 251 struct ast_custom_function *ast_custom_function_find(const char *name)
 252 {
 253         return 0;
 254 }
 255
 256 int check_eval(char *buffer, char *error_report)
 257 {
 258         char *cp, *ep;
 259         char s[4096];
 260         char evalbuf[80000];
 261         int result;
 262
 263         error_report[0] = 0;
 264         ep = evalbuf;
 265
 266         for (cp=buffer;*cp;cp++) {
 267                 if (*cp == '$' && *(cp+1) == '{') {
 268                         int brack_lev = 1;
 269                         char *xp= cp+2;
 270
 271                         while (*xp) {
 272                                 if (*xp == '{')
 273                                         brack_lev++;
 274                                 else if (*xp == '}')
 275                                         brack_lev--;
 276
 277                                 if (brack_lev == 0)
 278                                         break;
 279                                 xp++;
 280                         }
 281                         if (*xp == '}') {
 282                                 char varname[200];
 283                                 char *val;
 284
 285                                 strncpy(varname,cp+2, xp-cp-2);
 286                                 varname[xp-cp-2] = 0;
 287                                 cp = xp;
 288                                 val = find_var(varname);
 289                                 if (val) {
 290                                         char *z = val;
 291                                         while (*z)
 292                                                 *ep++ = *z++;
 293                                 }
 294                                 else {
 295                                         *ep++ = '5';  /* why not */
 296                                         *ep++ = '5';
 297                                         *ep++ = '5';
 298                                 }
 299                         }
 300                         else {
 301                                 printf("Unterminated variable reference at line %d\n", global_lineno);
 302                                 *ep++ = *cp;
 303                         }
 304                 }
 305                 else if (*cp == '\\') {
 306                         /* braindead simple elim of backslash */
 307                         cp++;
 308                         *ep++ = *cp;
 309                 }
 310                 else
 311                         *ep++ = *cp;
 312         }
 313         *ep++ = 0;
 314
 315         /* now, run the test */
 316         result = ast_expr(evalbuf, s, sizeof(s),NULL);
 317         if (result) {
 318                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: %s\n", global_lineno, evalbuf, s);
 319                 return 1;
 320         } else {
 321                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: ****SYNTAX ERROR****\n", global_lineno, evalbuf);
 322                 return 1;
 323         }
 324 }
 325
 326
 327 void parse_file(const char *fname);
 328
 329 void parse_file(const char *fname)
 330 {
 331         FILE *f = fopen(fname,"r");
 332         FILE *l = fopen("expr2_log","w");
 333         int c1;
 334         char last_char= 0;
 335         char buffer[30000]; /* I sure hope no expr gets this big! */
 336
 337         if (!f) {
 338                 fprintf(stderr,"Couldn't open %s for reading... need an extensions.conf file to parse!\n",fname);
 339                 exit(20);
 340         }
 341         if (!l) {
 342                 fprintf(stderr,"Couldn't open 'expr2_log' file for writing... please fix and re-run!\n");
 343                 exit(21);
 344         }
 345
 346         global_lineno = 1;
 347
 348         while ((c1 = fgetc(f)) != EOF) {
 349                 if (c1 == '\n')
 350                         global_lineno++;
 351                 else if (c1 == '[') {
 352                         if (last_char == '$') {
 353                                 /* bingo, an expr */
 354                                 int bracklev = 1;
 355                                 int bufcount = 0;
 356                                 int retval;
 357                                 char error_report[30000];
 358
 359                                 while ((c1 = fgetc(f)) != EOF) {
 360                                         if (c1 == '[')
 361                                                 bracklev++;
 362                                         else if (c1 == ']')
 363                                                 bracklev--;
 364                                         if (c1 == '\n') {
 365                                                 fprintf(l, "ERROR-- A newline in an expression? Weird! ...at line %d\n", global_lineno);
 366                                                 fclose(f);
 367                                                 fclose(l);
 368                                                 printf("--- ERROR --- A newline in the middle of an expression at line %d!\n", global_lineno);
 369                                         }
 370
 371                                         if (bracklev == 0)
 372                                                 break;
 373                                         buffer[bufcount++] = c1;
 374                                 }
 375                                 if (c1 == EOF) {
 376                                         fprintf(l, "ERROR-- End of File Reached in the middle of an Expr at line %d\n", global_lineno);
 377                                         fclose(f);
 378                                         fclose(l);
 379                                         printf("--- ERROR --- EOF reached in middle of an expression at line %d!\n", global_lineno);
 380                                         exit(22);
 381                                 }
 382
 383                                 buffer[bufcount] = 0;
 384                                 /* update stats */
 385                                 global_expr_tot_size += bufcount;
 386                                 global_expr_count++;
 387                                 if (bufcount > global_expr_max_size)
 388                                         global_expr_max_size = bufcount;
 389
 390                                 retval = check_expr(buffer, error_report); /* check_expr should bump the warning counter */
 391                                 if (retval != 0) {
 392                                         /* print error report */
 393                                         printf("Warning(s) at line %d, expression: $[%s]; see expr2_log file for details\n",
 394                                                    global_lineno, buffer);
 395                                         fprintf(l, "%s", error_report);
 396                                 }
 397                                 else {
 398                                         printf("OK -- $[%s] at line %d\n", buffer, global_lineno);
 399                                         global_OK_count++;
 400                                 }
 401                                 error_report[0] = 0;
 402                                 retval = check_eval(buffer, error_report);
 403                                 fprintf(l, "%s", error_report);
 404                         }
 405                 }
 406                 last_char = c1;
 407         }
 408         printf("Summary:\n  Expressions detected: %d\n  Expressions OK:  %d\n  Total # Warnings:   %d\n  Longest Expr:   %d chars\n  Ave expr len:  %d chars\n",
 409                    global_expr_count,
 410                    global_OK_count,
 411                    global_warn_count,
 412                    global_expr_max_size,
 413                    (global_expr_count) ? global_expr_tot_size/global_expr_count : 0);
 414
 415         fclose(f);
 416         fclose(l);
 417 }
 418
 419
 420 int main(int argc,char **argv)
 421 {
 422         int argc1;
 423         char *eq;
 424
 425         if (argc < 2) {
 426                 printf("check_expr -- a program to look thru extensions.conf files for $[...] expressions,\n");
 427                 printf("              and run them thru the parser, looking for problems\n");
 428                 printf("Hey-- give me a path to an extensions.conf file!\n");
 429                 printf(" You can also follow the file path with a series of variable decls,\n");
 430                 printf("     of the form, varname=value, each separated from the next by spaces.\n");
 431                 printf("     (this might allow you to avoid division by zero messages, check that math\n");
 432                 printf("      is being done correctly, etc.)\n");
 433                 printf(" Note that messages about operators not being surrounded by spaces is merely to alert\n");
 434                 printf("  you to possible problems where you might be expecting those operators as part of a string.\n");
 435         printf("  (to include operators in a string, wrap with double quotes!)\n");
 436
 437                 exit(19);
 438         }
 439         global_varlist = 0;
 440         for (argc1=2;argc1 < argc; argc1++) {
 441                 if ((eq = strchr(argv[argc1],'='))) {
 442                         *eq = 0;
 443                         set_var(argv[argc1],eq+1);
 444                 }
 445         }
 446
 447         /* parse command args for x=y and set varz */
 448
 449         parse_file(argv[1]);
 450         return 0;
 451 }