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