OK. THis a DEBUG_THREADS situation.
[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 <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 #ifndef DEBUG_THREADS
91 enum ast_lock_type {
92                 AST_MUTEX,
93                 AST_RDLOCK,
94                 AST_WRLOCK,
95 };
96 #endif
97 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
98                         int line_num, const char *func, const char *lock_name, void *lock_addr);
99 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
100                         int line_num, const char *func, const char *lock_name, void *lock_addr)
101 {
102     /* not a lot to do in a standalone w/o threading! */
103 }
104
105 void ast_mark_lock_acquired(void);
106 void ast_mark_lock_acquired(void)
107 {
108     /* not a lot to do in a standalone w/o threading! */
109 }
110
111 void ast_remove_lock_info(void *lock_addr);
112 void ast_remove_lock_info(void *lock_addr)
113 {
114     /* not a lot to do in a standalone w/o threading! */
115 }
116
117 static int global_lineno = 1;
118 static int global_expr_count=0;
119 static int global_expr_max_size=0;
120 static int global_expr_tot_size=0;
121 static int global_warn_count=0;
122 static int global_OK_count=0;
123
124 struct varz
125 {
126         char varname[100]; /* a really ultra-simple, space-wasting linked list of var=val data */
127         char varval[1000]; /* if any varname is bigger than 100 chars, or val greater than 1000, then **CRASH** */
128         struct varz *next;
129 };
130
131 struct varz *global_varlist;
132
133 /* Our own version of ast_log, since the expr parser uses it. */
134
135 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...) __attribute__ ((format (printf,5,6)));
136
137 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
138 {
139         va_list vars;
140         va_start(vars,fmt);
141         
142         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
143                    level, file, line, function);
144         vprintf(fmt, vars);
145         fflush(stdout);
146         va_end(vars);
147 }
148 void ast_register_file_version(const char *file, const char *version);
149 void ast_unregister_file_version(const char *file);
150
151 char *find_var(const char *varname);
152 void set_var(const char *varname, const char *varval);
153 unsigned int check_expr(char* buffer, char* error_report);
154 int check_eval(char *buffer, char *error_report);
155 void parse_file(const char *fname);
156
157 void ast_register_file_version(const char *file, const char *version)
158 {
159 }
160
161 void ast_unregister_file_version(const char *file)
162 {
163 }
164
165 char *find_var(const char *varname) /* the list should be pretty short, if there's any list at all */
166 {
167         struct varz *t;
168         for (t= global_varlist; t; t = t->next) {
169                 if (!strcmp(t->varname, varname)) {
170                         return t->varval;
171                 }
172         }
173         return 0;
174 }
175
176 void set_var(const char *varname, const char *varval);
177
178 void set_var(const char *varname, const char *varval)
179 {
180         struct varz *t = (struct varz*)calloc(1,sizeof(struct varz));
181         if (!t)
182                 return;
183         strcpy(t->varname, varname);
184         strcpy(t->varval, varval);
185         t->next = global_varlist;
186         global_varlist = t;
187 }
188
189 unsigned int check_expr(char* buffer, char* error_report)
190 {
191         char* cp;
192         unsigned int warn_found = 0;
193
194         error_report[0] = 0;
195         
196         for (cp = buffer; *cp; ++cp)
197         {
198                 switch (*cp)
199                 {
200                         case '"':
201                                 /* skip to the other end */
202                                 while (*(++cp) && *cp != '"') ;
203
204                                 if (*cp == 0)
205                                 {
206                                         fprintf(stderr,
207                                                 "Trouble? Unterminated double quote found at line %d\n",
208                                                 global_lineno);
209                                 }
210                                 break;
211                                 
212                         case '>':
213                         case '<':
214                         case '!':
215                                 if (   (*(cp + 1) == '=')
216                                         && ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 2) != ' ') ) )
217                                 {
218                                         char msg[200];
219                                         snprintf(msg,
220                                                 sizeof(msg),
221                                                 "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",
222                                                 global_lineno, *cp, *(cp + 1));
223                                         strcat(error_report, msg);
224                                         ++global_warn_count;
225                                         ++warn_found;
226                                 }
227                                 break;
228                                 
229                         case '|':
230                         case '&':
231                         case '=':
232                         case '+':
233                         case '-':
234                         case '*':
235                         case '/':
236                         case '%':
237                         case '?':
238                         case ':':
239                                 if ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 1) != ' ') )
240                                 {
241                                         char msg[200];
242                                         snprintf(msg,
243                                                 sizeof(msg),
244                                                 "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",
245                                                 global_lineno, *cp );
246                                         strcat(error_report, msg);
247                                         ++global_warn_count;
248                                         ++warn_found;
249                                 }
250                                 break;
251                 }
252         }
253
254         return warn_found;
255 }
256
257 int check_eval(char *buffer, char *error_report);
258
259 struct ast_custom_function *ast_custom_function_find(const char *name);
260
261 struct ast_custom_function *ast_custom_function_find(const char *name)
262 {
263         return 0;
264 }
265
266 int check_eval(char *buffer, char *error_report)
267 {
268         char *cp, *ep;
269         char s[4096];
270         char evalbuf[80000];
271         int result;
272
273         error_report[0] = 0;
274         ep = evalbuf;
275
276         for (cp=buffer;*cp;cp++) {
277                 if (*cp == '$' && *(cp+1) == '{') {
278                         int brack_lev = 1;
279                         char *xp= cp+2;
280                         
281                         while (*xp) {
282                                 if (*xp == '{')
283                                         brack_lev++;
284                                 else if (*xp == '}')
285                                         brack_lev--;
286                                 
287                                 if (brack_lev == 0)
288                                         break;
289                                 xp++;
290                         }
291                         if (*xp == '}') {
292                                 char varname[200];
293                                 char *val;
294                                 
295                                 strncpy(varname,cp+2, xp-cp-2);
296                                 varname[xp-cp-2] = 0;
297                                 cp = xp;
298                                 val = find_var(varname);
299                                 if (val) {
300                                         char *z = val;
301                                         while (*z)
302                                                 *ep++ = *z++;
303                                 }
304                                 else {
305                                         *ep++ = '5';  /* why not */
306                                         *ep++ = '5';
307                                         *ep++ = '5';
308                                 }
309                         }
310                         else {
311                                 printf("Unterminated variable reference at line %d\n", global_lineno);
312                                 *ep++ = *cp;
313                         }
314                 }
315                 else if (*cp == '\\') {
316                         /* braindead simple elim of backslash */
317                         cp++;
318                         *ep++ = *cp;
319                 }
320                 else
321                         *ep++ = *cp;
322         }
323         *ep++ = 0;
324
325         /* now, run the test */
326         result = ast_expr(evalbuf, s, sizeof(s),NULL);
327         if (result) {
328                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: %s\n", global_lineno, evalbuf, s);
329                 return 1;
330         } else {
331                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: ****SYNTAX ERROR****\n", global_lineno, evalbuf);
332                 return 1;
333         }
334 }
335
336
337 void parse_file(const char *fname);
338
339 void parse_file(const char *fname)
340 {
341         FILE *f = fopen(fname,"r");
342         FILE *l = fopen("expr2_log","w");
343         int c1;
344         char last_char= 0;
345         char buffer[30000]; /* I sure hope no expr gets this big! */
346         
347         if (!f) {
348                 fprintf(stderr,"Couldn't open %s for reading... need an extensions.conf file to parse!\n",fname);
349                 exit(20);
350         }
351         if (!l) {
352                 fprintf(stderr,"Couldn't open 'expr2_log' file for writing... please fix and re-run!\n");
353                 exit(21);
354         }
355         
356         global_lineno = 1;
357         
358         while ((c1 = fgetc(f)) != EOF) {
359                 if (c1 == '\n')
360                         global_lineno++;
361                 else if (c1 == '[') {
362                         if (last_char == '$') {
363                                 /* bingo, an expr */
364                                 int bracklev = 1;
365                                 int bufcount = 0;
366                                 int retval;
367                                 char error_report[30000];
368                                 
369                                 while ((c1 = fgetc(f)) != EOF) {
370                                         if (c1 == '[')
371                                                 bracklev++;
372                                         else if (c1 == ']')
373                                                 bracklev--;
374                                         if (c1 == '\n') {
375                                                 fprintf(l, "ERROR-- A newline in an expression? Weird! ...at line %d\n", global_lineno);
376                                                 fclose(f);
377                                                 fclose(l);
378                                                 printf("--- ERROR --- A newline in the middle of an expression at line %d!\n", global_lineno);
379                                         }
380                                         
381                                         if (bracklev == 0)
382                                                 break;
383                                         buffer[bufcount++] = c1;
384                                 }
385                                 if (c1 == EOF) {
386                                         fprintf(l, "ERROR-- End of File Reached in the middle of an Expr at line %d\n", global_lineno);
387                                         fclose(f);
388                                         fclose(l);
389                                         printf("--- ERROR --- EOF reached in middle of an expression at line %d!\n", global_lineno);
390                                         exit(22);
391                                 }
392                                 
393                                 buffer[bufcount] = 0;
394                                 /* update stats */
395                                 global_expr_tot_size += bufcount;
396                                 global_expr_count++;
397                                 if (bufcount > global_expr_max_size)
398                                         global_expr_max_size = bufcount;
399                                 
400                                 retval = check_expr(buffer, error_report); /* check_expr should bump the warning counter */
401                                 if (retval != 0) {
402                                         /* print error report */
403                                         printf("Warning(s) at line %d, expression: $[%s]; see expr2_log file for details\n", 
404                                                    global_lineno, buffer);
405                                         fprintf(l, "%s", error_report);
406                                 }
407                                 else {
408                                         printf("OK -- $[%s] at line %d\n", buffer, global_lineno);
409                                         global_OK_count++;
410                                 }
411                                 error_report[0] = 0;
412                                 retval = check_eval(buffer, error_report);
413                                 fprintf(l, "%s", error_report);
414                         }
415                 }
416                 last_char = c1;
417         }
418         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",
419                    global_expr_count,
420                    global_OK_count,
421                    global_warn_count,
422                    global_expr_max_size,
423                    (global_expr_count) ? global_expr_tot_size/global_expr_count : 0);
424         
425         fclose(f);
426         fclose(l);
427 }
428
429
430 int main(int argc,char **argv)
431 {
432         int argc1;
433         char *eq;
434         
435         if (argc < 2) {
436                 printf("check_expr -- a program to look thru extensions.conf files for $[...] expressions,\n");
437                 printf("              and run them thru the parser, looking for problems\n");
438                 printf("Hey-- give me a path to an extensions.conf file!\n");
439                 printf(" You can also follow the file path with a series of variable decls,\n");
440                 printf("     of the form, varname=value, each separated from the next by spaces.\n");
441                 printf("     (this might allow you to avoid division by zero messages, check that math\n");
442                 printf("      is being done correctly, etc.)\n");
443                 printf(" Note that messages about operators not being surrounded by spaces is merely to alert\n");
444                 printf("  you to possible problems where you might be expecting those operators as part of a string.\n");
445         printf("  (to include operators in a string, wrap with double quotes!)\n");
446                 
447                 exit(19);
448         }
449         global_varlist = 0;
450         for (argc1=2;argc1 < argc; argc1++) {
451                 if ((eq = strchr(argv[argc1],'='))) {
452                         *eq = 0;
453                         set_var(argv[argc1],eq+1);
454                 }
455         }
456
457         /* parse command args for x=y and set varz */
458         
459         parse_file(argv[1]);
460         return 0;
461 }