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 #include <../include/asterisk/ast_expr.h>
  25
  26 static int global_lineno = 1;
  27 static int global_expr_count=0;
  28 static int global_expr_max_size=0;
  29 static int global_expr_tot_size=0;
  30 static int global_warn_count=0;
  31 static int global_OK_count=0;
  32
  33 struct varz
  34 {
  35         char varname[100]; /* a really ultra-simple, space-wasting linked list of var=val data */
  36         char varval[1000]; /* if any varname is bigger than 100 chars, or val greater than 1000, then **CRASH** */
  37         struct varz *next;
  38 };
  39
  40 struct varz *global_varlist;
  41
  42 /* Our own version of ast_log, since the expr parser uses it. */
  43
  44 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...) __attribute__ ((format (printf,5,6)));
  45
  46 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
  47 {
  48         va_list vars;
  49         va_start(vars,fmt);
  50
  51         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
  52                    level, file, line, function);
  53         vprintf(fmt, vars);
  54         fflush(stdout);
  55         va_end(vars);
  56 }
  57 void ast_register_file_version(const char *file, const char *version);
  58 void ast_unregister_file_version(const char *file);
  59
  60 char *find_var(const char *varname);
  61 void set_var(const char *varname, const char *varval);
  62 unsigned int check_expr(char* buffer, char* error_report);
  63 int check_eval(char *buffer, char *error_report);
  64 void parse_file(const char *fname);
  65
  66 void ast_register_file_version(const char *file, const char *version)
  67 {
  68 }
  69
  70 void ast_unregister_file_version(const char *file)
  71 {
  72 }
  73
  74 char *find_var(const char *varname) /* the list should be pretty short, if there's any list at all */
  75 {
  76         struct varz *t;
  77         for (t= global_varlist; t; t = t->next) {
  78                 if (!strcmp(t->varname, varname)) {
  79                         return t->varval;
  80                 }
  81         }
  82         return 0;
  83 }
  84
  85 void set_var(const char *varname, const char *varval)
  86 {
  87         struct varz *t = (struct varz*)calloc(1,sizeof(struct varz));
  88         strcpy(t->varname, varname);
  89         strcpy(t->varval, varval);
  90         t->next = global_varlist;
  91         global_varlist = t;
  92 }
  93
  94 unsigned int check_expr(char* buffer, char* error_report)
  95 {
  96         char* cp;
  97         unsigned int warn_found = 0;
  98
  99         error_report[0] = 0;
 100
 101         for (cp = buffer; *cp; ++cp)
 102         {
 103                 switch (*cp)
 104                 {
 105                         case '"':
 106                                 /* skip to the other end */
 107                                 while (*(++cp) && *cp != '"') ;
 108
 109                                 if (*cp == 0)
 110                                 {
 111                                         fprintf(stderr,
 112                                                 "Trouble? Unterminated double quote found at line %d\n",
 113                                                 global_lineno);
 114                                 }
 115                                 break;
 116
 117                         case '>':
 118                         case '<':
 119                         case '!':
 120                                 if (   (*(cp + 1) == '=')
 121                                         && ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 2) != ' ') ) )
 122                                 {
 123                                         char msg[200];
 124                                         snprintf(msg,
 125                                                 sizeof(msg),
 126                                                 "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",
 127                                                 global_lineno, *cp, *(cp + 1));
 128                                         strcat(error_report, msg);
 129                                         ++global_warn_count;
 130                                         ++warn_found;
 131                                 }
 132                                 break;
 133
 134                         case '|':
 135                         case '&':
 136                         case '=':
 137                         case '+':
 138                         case '-':
 139                         case '*':
 140                         case '/':
 141                         case '%':
 142                         case '?':
 143                         case ':':
 144                                 if ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 1) != ' ') )
 145                                 {
 146                                         char msg[200];
 147                                         snprintf(msg,
 148                                                 sizeof(msg),
 149                                                 "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",
 150                                                 global_lineno, *cp );
 151                                         strcat(error_report, msg);
 152                                         ++global_warn_count;
 153                                         ++warn_found;
 154                                 }
 155                                 break;
 156                 }
 157         }
 158
 159         return warn_found;
 160 }
 161
 162 int check_eval(char *buffer, char *error_report)
 163 {
 164         char *cp, *ep;
 165         char s[4096];
 166         char evalbuf[80000];
 167         int result;
 168
 169         error_report[0] = 0;
 170         ep = evalbuf;
 171
 172         for (cp=buffer;*cp;cp++) {
 173                 if (*cp == '$' && *(cp+1) == '{') {
 174                         int brack_lev = 1;
 175                         char *xp= cp+2;
 176
 177                         while (*xp) {
 178                                 if (*xp == '{')
 179                                         brack_lev++;
 180                                 else if (*xp == '}')
 181                                         brack_lev--;
 182
 183                                 if (brack_lev == 0)
 184                                         break;
 185                                 xp++;
 186                         }
 187                         if (*xp == '}') {
 188                                 char varname[200];
 189                                 char *val;
 190
 191                                 strncpy(varname,cp+2, xp-cp-2);
 192                                 varname[xp-cp-2] = 0;
 193                                 cp = xp;
 194                                 val = find_var(varname);
 195                                 if (val) {
 196                                         char *z = val;
 197                                         while (*z)
 198                                                 *ep++ = *z++;
 199                                 }
 200                                 else {
 201                                         *ep++ = '5';  /* why not */
 202                                         *ep++ = '5';
 203                                         *ep++ = '5';
 204                                 }
 205                         }
 206                         else {
 207                                 printf("Unterminated variable reference at line %d\n", global_lineno);
 208                                 *ep++ = *cp;
 209                         }
 210                 }
 211                 else if (*cp == '\\') {
 212                         /* braindead simple elim of backslash */
 213                         cp++;
 214                         *ep++ = *cp;
 215                 }
 216                 else
 217                         *ep++ = *cp;
 218         }
 219         *ep++ = 0;
 220
 221         /* now, run the test */
 222         result = ast_expr(evalbuf, s, sizeof(s));
 223         if (result) {
 224                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: %s\n", global_lineno, evalbuf, s);
 225                 return 1;
 226         } else {
 227                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: ****SYNTAX ERROR****\n", global_lineno, evalbuf);
 228                 return 1;
 229         }
 230 }
 231
 232
 233 void parse_file(const char *fname)
 234 {
 235         FILE *f = fopen(fname,"r");
 236         FILE *l = fopen("expr2_log","w");
 237         int c1;
 238         char last_char= 0;
 239         char buffer[30000]; /* I sure hope no expr gets this big! */
 240
 241         if (!f) {
 242                 fprintf(stderr,"Couldn't open %s for reading... need an extensions.conf file to parse!\n",fname);
 243                 exit(20);
 244         }
 245         if (!l) {
 246                 fprintf(stderr,"Couldn't open 'expr2_log' file for writing... please fix and re-run!\n");
 247                 exit(21);
 248         }
 249
 250         global_lineno = 1;
 251
 252         while ((c1 = fgetc(f)) != EOF) {
 253                 if (c1 == '\n')
 254                         global_lineno++;
 255                 else if (c1 == '[') {
 256                         if (last_char == '$') {
 257                                 /* bingo, an expr */
 258                                 int bracklev = 1;
 259                                 int bufcount = 0;
 260                                 int retval;
 261                                 char error_report[30000];
 262
 263                                 while ((c1 = fgetc(f)) != EOF) {
 264                                         if (c1 == '[')
 265                                                 bracklev++;
 266                                         else if (c1 == ']')
 267                                                 bracklev--;
 268                                         if (c1 == '\n') {
 269                                                 fprintf(l, "ERROR-- A newline in an expression? Weird! ...at line %d\n", global_lineno);
 270                                                 fclose(f);
 271                                                 fclose(l);
 272                                                 printf("--- ERROR --- A newline in the middle of an expression at line %d!\n", global_lineno);
 273                                         }
 274
 275                                         if (bracklev == 0)
 276                                                 break;
 277                                         buffer[bufcount++] = c1;
 278                                 }
 279                                 if (c1 == EOF) {
 280                                         fprintf(l, "ERROR-- End of File Reached in the middle of an Expr at line %d\n", global_lineno);
 281                                         fclose(f);
 282                                         fclose(l);
 283                                         printf("--- ERROR --- EOF reached in middle of an expression at line %d!\n", global_lineno);
 284                                         exit(22);
 285                                 }
 286
 287                                 buffer[bufcount] = 0;
 288                                 /* update stats */
 289                                 global_expr_tot_size += bufcount;
 290                                 global_expr_count++;
 291                                 if (bufcount > global_expr_max_size)
 292                                         global_expr_max_size = bufcount;
 293
 294                                 retval = check_expr(buffer, error_report); /* check_expr should bump the warning counter */
 295                                 if (retval != 0) {
 296                                         /* print error report */
 297                                         printf("Warning(s) at line %d, expression: $[%s]; see expr2_log file for details\n",
 298                                                    global_lineno, buffer);
 299                                         fprintf(l, "%s", error_report);
 300                                 }
 301                                 else {
 302                                         printf("OK -- $[%s] at line %d\n", buffer, global_lineno);
 303                                         global_OK_count++;
 304                                 }
 305                                 error_report[0] = 0;
 306                                 retval = check_eval(buffer, error_report);
 307                                 fprintf(l, "%s", error_report);
 308                         }
 309                 }
 310                 last_char = c1;
 311         }
 312         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",
 313                    global_expr_count,
 314                    global_OK_count,
 315                    global_warn_count,
 316                    global_expr_max_size,
 317                    (global_expr_count) ? global_expr_tot_size/global_expr_count : 0);
 318
 319         fclose(f);
 320         fclose(l);
 321 }
 322
 323
 324 int main(int argc,char **argv)
 325 {
 326         int argc1;
 327         char *eq;
 328
 329         if (argc < 2) {
 330                 printf("check_expr -- a program to look thru extensions.conf files for $[...] expressions,\n");
 331                 printf("              and run them thru the parser, looking for problems\n");
 332                 printf("Hey-- give me a path to an extensions.conf file!\n");
 333                 printf(" You can also follow the file path with a series of variable decls,\n");
 334                 printf("     of the form, varname=value, each separated from the next by spaces.\n");
 335                 printf("     (this might allow you to avoid division by zero messages, check that math\n");
 336                 printf("      is being done correctly, etc.)\n");
 337                 printf(" Note that messages about operators not being surrounded by spaces is merely to alert\n");
 338                 printf("  you to possible problems where you might be expecting those operators as part of a string.\n");
 339         printf("  (to include operators in a string, wrap with double quotes!)\n");
 340
 341                 exit(19);
 342         }
 343         global_varlist = 0;
 344         for (argc1=2;argc1 < argc; argc1++) {
 345                 if ((eq = strchr(argv[argc1],'='))) {
 346                         *eq = 0;
 347                         set_var(argv[argc1],eq+1);
 348                 }
 349         }
 350
 351         /* parse command args for x=y and set varz */
 352
 353         parse_file(argv[1]);
 354         return 0;
 355 }