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