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