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