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