This is the perhaps the biggest, boldest, most daring change I've ever committed...
[asterisk/asterisk.git] / pbx / pbx_ael.c
1 /* 
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * Steve Murphy <murf@parsetree.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 /*! \file
20  *
21  * \brief Compile symbolic Asterisk Extension Logic into Asterisk extensions, version 2.
22  * 
23  */
24
25 /*** MODULEINFO
26         <depend>res_ael_share</depend>
27  ***/
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include <sys/types.h>
34 #include <stdlib.h>
35 #include <unistd.h>
36 #include <stdio.h>
37 #include <string.h>
38 #include <ctype.h>
39 #include <errno.h>
40 #include <regex.h>
41 #include <sys/stat.h>
42
43 #include "asterisk/pbx.h"
44 #include "asterisk/config.h"
45 #include "asterisk/module.h"
46 #include "asterisk/logger.h"
47 #include "asterisk/cli.h"
48 #include "asterisk/app.h"
49 #include "asterisk/callerid.h"
50 #include "asterisk/ael_structs.h"
51 #include "asterisk/pval.h"
52 #ifdef AAL_ARGCHECK
53 #include "asterisk/argdesc.h"
54 #endif
55
56 /* these functions are in ../ast_expr2.fl */
57
58 #define DEBUG_READ   (1 << 0)
59 #define DEBUG_TOKENS (1 << 1)
60 #define DEBUG_MACROS (1 << 2)
61 #define DEBUG_CONTEXTS (1 << 3)
62
63 static char *config = "extensions.ael";
64 static char *registrar = "pbx_ael";
65 static int pbx_load_module(void);
66
67 #ifndef AAL_ARGCHECK
68 /* for the time being, short circuit all the AAL related structures
69    without permanently removing the code; after/during the AAL 
70    development, this code can be properly re-instated 
71 */
72
73 #endif
74
75 #ifdef AAL_ARGCHECK
76 int option_matches_j( struct argdesc *should, pval *is, struct argapp *app);
77 int option_matches( struct argdesc *should, pval *is, struct argapp *app);
78 int ael_is_funcname(char *name);
79 #endif
80
81 int check_app_args(pval *appcall, pval *arglist, struct argapp *app);
82 void check_pval(pval *item, struct argapp *apps, int in_globals);
83 void check_pval_item(pval *item, struct argapp *apps, int in_globals);
84 void check_switch_expr(pval *item, struct argapp *apps);
85 void ast_expr_register_extra_error_info(char *errmsg);
86 void ast_expr_clear_extra_error_info(void);
87 struct pval *find_macro(char *name);
88 struct pval *find_context(char *name);
89 struct pval *find_context(char *name);
90 struct pval *find_macro(char *name);
91 struct ael_priority *new_prio(void);
92 struct ael_extension *new_exten(void);
93 void linkprio(struct ael_extension *exten, struct ael_priority *prio);
94 void destroy_extensions(struct ael_extension *exten);
95 void set_priorities(struct ael_extension *exten);
96 void add_extensions(struct ael_extension *exten);
97 void ast_compile_ael2(struct ast_context **local_contexts, struct pval *root);
98 void destroy_pval(pval *item);
99 void destroy_pval_item(pval *item);
100 int is_float(char *arg );
101 int is_int(char *arg );
102 int is_empty(char *arg);
103
104 /* static void substitute_commas(char *str); */
105
106 static int aeldebug = 0;
107
108 /* interface stuff */
109
110 /* if all the below are static, who cares if they are present? */
111
112 static int pbx_load_module(void)
113 {
114         int errs=0, sem_err=0, sem_warn=0, sem_note=0;
115         char *rfilename;
116         struct ast_context *local_contexts=NULL, *con;
117         struct pval *parse_tree;
118
119         ast_log(LOG_NOTICE, "Starting AEL load process.\n");
120         if (config[0] == '/')
121                 rfilename = (char *)config;
122         else {
123                 rfilename = alloca(strlen(config) + strlen(ast_config_AST_CONFIG_DIR) + 2);
124                 sprintf(rfilename, "%s/%s", ast_config_AST_CONFIG_DIR, config);
125         }
126         if (access(rfilename,R_OK) != 0) {
127                 ast_log(LOG_NOTICE, "File %s not found; AEL declining load\n", rfilename);
128                 return AST_MODULE_LOAD_DECLINE;
129         }
130         
131         parse_tree = ael2_parse(rfilename, &errs);
132         ast_log(LOG_NOTICE, "AEL load process: parsed config file name '%s'.\n", rfilename);
133         ael2_semantic_check(parse_tree, &sem_err, &sem_warn, &sem_note);
134         if (errs == 0 && sem_err == 0) {
135                 ast_log(LOG_NOTICE, "AEL load process: checked config file name '%s'.\n", rfilename);
136                 ast_compile_ael2(&local_contexts, parse_tree);
137                 ast_log(LOG_NOTICE, "AEL load process: compiled config file name '%s'.\n", rfilename);
138                 
139                 ast_merge_contexts_and_delete(&local_contexts, registrar);
140                 ast_log(LOG_NOTICE, "AEL load process: merged config file name '%s'.\n", rfilename);
141                 for (con = ast_walk_contexts(NULL); con; con = ast_walk_contexts(con))
142                         ast_context_verify_includes(con);
143                 ast_log(LOG_NOTICE, "AEL load process: verified config file name '%s'.\n", rfilename);
144         } else {
145                 ast_log(LOG_ERROR, "Sorry, but %d syntax errors and %d semantic errors were detected. It doesn't make sense to compile.\n", errs, sem_err);
146                 destroy_pval(parse_tree); /* free up the memory */
147                 return AST_MODULE_LOAD_DECLINE;
148         }
149         destroy_pval(parse_tree); /* free up the memory */
150         
151         return AST_MODULE_LOAD_SUCCESS;
152 }
153
154 /* CLI interface */
155 static char *handle_cli_ael_debug_multiple(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
156 {
157         switch (cmd) {
158         case CLI_INIT:
159                 e->command = "ael debug [read|tokens|macros|contexts|off]";
160                 e->usage =
161                         "Usage: ael debug [read|tokens|macros|contexts|off]\n"
162                         "       Enable AEL read, token, macro, or context debugging,\n"
163                         "       or disable all AEL debugging messages.  Note: this\n"
164                         "       currently does nothing.\n";
165                 return NULL;
166         case CLI_GENERATE:
167                 return NULL;
168         }
169
170         if (a->argc != 3)
171                 return CLI_SHOWUSAGE;
172
173         if (!strcasecmp(a->argv[2], "read"))
174                 aeldebug |= DEBUG_READ;
175         else if (!strcasecmp(a->argv[2], "tokens"))
176                 aeldebug |= DEBUG_TOKENS;
177         else if (!strcasecmp(a->argv[2], "macros"))
178                 aeldebug |= DEBUG_MACROS;
179         else if (!strcasecmp(a->argv[2], "contexts"))
180                 aeldebug |= DEBUG_CONTEXTS;
181         else if (!strcasecmp(a->argv[2], "off"))
182                 aeldebug = 0;
183         else
184                 return CLI_SHOWUSAGE;
185
186         return CLI_SUCCESS;
187 }
188
189 static char *handle_cli_ael_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
190 {
191         switch (cmd) {
192         case CLI_INIT:
193                 e->command = "ael reload";
194                 e->usage =
195                         "Usage: ael reload\n"
196                         "       Reloads AEL configuration.\n";
197                 return NULL;
198         case CLI_GENERATE:
199                 return NULL;
200         }
201
202         if (a->argc != 2)
203                 return CLI_SHOWUSAGE;
204
205         return (pbx_load_module() ? CLI_FAILURE : CLI_SUCCESS);
206 }
207
208 static struct ast_cli_entry cli_ael[] = {
209         AST_CLI_DEFINE(handle_cli_ael_reload,         "Reload AEL configuration"),
210         AST_CLI_DEFINE(handle_cli_ael_debug_multiple, "Enable AEL debugging flags")
211 };
212
213 static int unload_module(void)
214 {
215         ast_context_destroy(NULL, registrar);
216         ast_cli_unregister_multiple(cli_ael, sizeof(cli_ael) / sizeof(struct ast_cli_entry));
217         return 0;
218 }
219
220 static int load_module(void)
221 {
222         ast_cli_register_multiple(cli_ael, sizeof(cli_ael) / sizeof(struct ast_cli_entry));
223         return (pbx_load_module());
224 }
225
226 static int reload(void)
227 {
228         return pbx_load_module();
229 }
230
231 #ifdef STANDALONE_AEL
232 #define AST_MODULE "ael"
233 int ael_external_load_module(void);
234 int ael_external_load_module(void)
235 {
236         pbx_load_module();
237         return 1;
238 }
239 #endif
240
241 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Asterisk Extension Language Compiler",
242                 .load = load_module,
243                 .unload = unload_module,
244                 .reload = reload,
245                );
246
247 #ifdef AAL_ARGCHECK
248 static char *ael_funclist[] =
249 {
250         "AGENT",
251         "ARRAY",
252         "BASE64_DECODE",
253         "BASE64_ENCODE",
254         "CALLERID",
255         "CDR",
256         "CHANNEL",
257         "CHECKSIPDOMAIN",
258         "CHECK_MD5",
259         "CURL",
260         "CUT",
261         "DB",
262         "DB_EXISTS",
263         "DUNDILOOKUP",
264         "ENUMLOOKUP",
265         "ENV",
266         "EVAL",
267         "EXISTS",
268         "FIELDQTY",
269         "FILTER",
270         "GROUP",
271         "GROUP_COUNT",
272         "GROUP_LIST",
273         "GROUP_MATCH_COUNT",
274         "IAXPEER",
275         "IF",
276         "IFTIME",
277         "ISNULL",
278         "KEYPADHASH",
279         "LANGUAGE",
280         "LEN",
281         "MATH",
282         "MD5",
283         "MUSICCLASS",
284         "QUEUEAGENTCOUNT",
285         "QUEUE_MEMBER_COUNT",
286         "QUEUE_MEMBER_LIST",
287         "QUOTE",
288         "RAND",
289         "REGEX",
290         "SET",
291         "SHA1",
292         "SIPCHANINFO",
293         "SIPPEER",
294         "SIP_HEADER",
295         "SORT",
296         "STAT",
297         "STRFTIME",
298         "STRPTIME",
299         "TIMEOUT",
300         "TXTCIDNAME",
301         "URIDECODE",
302         "URIENCODE",
303         "VMCOUNT"
304 };
305
306
307 int ael_is_funcname(char *name)
308 {
309         int s,t;
310         t = sizeof(ael_funclist)/sizeof(char*);
311         s = 0;
312         while ((s < t) && strcasecmp(name, ael_funclist[s])) 
313                 s++;
314         if ( s < t )
315                 return 1;
316         else
317                 return 0;
318 }
319 #endif