Detect Goto in pbx_lua.
[asterisk/asterisk.git] / pbx / pbx_lua.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2007, Digium, Inc.
5  *
6  * Matthew Nicholson <mnicholson@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 /*! 
20  * \file
21  *
22  * \author Matthew Nicholson <mnicholson@digium.com>
23  * \brief Lua PBX Switch
24  *
25  */
26
27 /*** MODULEINFO
28         <depend>lua</depend>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/logger.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/term.h"
42 #include "asterisk/paths.h"
43 #include "asterisk/hashtab.h"
44
45 #include <lua.h>
46 #include <lauxlib.h>
47 #include <lualib.h>
48
49 static char *config = "extensions.lua";
50 static char *registrar = "pbx_lua";
51
52 #define LUA_EXT_DATA_SIZE 256
53 #define LUA_BUF_SIZE 4096
54
55 /* This value is used by the lua engine to signal that a Goto or dialplan jump
56  * was detected. Ensure this value does not conflict with any values dialplan
57  * applications might return */
58 #define LUA_GOTO_DETECTED 5
59
60 static char *lua_read_extensions_file(lua_State *L, long *size);
61 static int lua_load_extensions(lua_State *L, struct ast_channel *chan);
62 static int lua_reload_extensions(lua_State *L);
63 static void lua_free_extensions(void);
64 static int lua_sort_extensions(lua_State *L);
65 static int lua_register_switches(lua_State *L);
66 static int lua_register_hints(lua_State *L);
67 static int lua_extension_cmp(lua_State *L);
68 static int lua_find_extension(lua_State *L, const char *context, const char *exten, int priority, ast_switch_f *func, int push_func);
69 static int lua_pbx_findapp(lua_State *L);
70 static int lua_pbx_exec(lua_State *L);
71
72 static int lua_get_variable_value(lua_State *L);
73 static int lua_set_variable_value(lua_State *L);
74 static int lua_get_variable(lua_State *L);
75 static int lua_set_variable(lua_State *L);
76 static int lua_func_read(lua_State *L);
77
78 static int lua_autoservice_start(lua_State *L);
79 static int lua_autoservice_stop(lua_State *L);
80 static int lua_autoservice_status(lua_State *L);
81 static int lua_check_hangup(lua_State *L);
82 static int lua_error_function(lua_State *L);
83
84 static void lua_update_registry(lua_State *L, const char *context, const char *exten, int priority);
85 static void lua_push_variable_table(lua_State *L, const char *name);
86 static void lua_create_app_table(lua_State *L);
87 static void lua_create_channel_table(lua_State *L);
88 static void lua_create_variable_metatable(lua_State *L);
89 static void lua_create_application_metatable(lua_State *L);
90 static void lua_create_autoservice_functions(lua_State *L);
91 static void lua_create_hangup_function(lua_State *L);
92 static void lua_detect_goto(lua_State *L);
93
94 static void lua_state_destroy(void *data);
95 static void lua_datastore_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
96 static lua_State *lua_get_state(struct ast_channel *chan);
97
98 static int exists(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
99 static int canmatch(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
100 static int matchmore(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
101 static int exec(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
102
103 AST_MUTEX_DEFINE_STATIC(config_file_lock);
104 static char *config_file_data = NULL;
105 static long config_file_size = 0;
106
107 static struct ast_context *local_contexts = NULL;
108 static struct ast_hashtab *local_table = NULL;
109
110 static const struct ast_datastore_info lua_datastore = {
111         .type = "lua",
112         .destroy = lua_state_destroy,
113         .chan_fixup = lua_datastore_fixup,
114 };
115
116
117 /*!
118  * \brief The destructor for lua_datastore
119  */
120 static void lua_state_destroy(void *data)
121 {
122         if (data)
123                 lua_close(data);
124 }
125
126 /*!
127  * \brief The fixup function for the lua_datastore.
128  * \param data the datastore data, in this case it will be a lua_State
129  * \param old_chan the channel we are moving from
130  * \param new_chan the channel we are moving to
131  *
132  * This function updates our internal channel pointer.
133  */
134 static void lua_datastore_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
135 {
136         lua_State *L = data;
137         lua_pushlightuserdata(L, new_chan);
138         lua_setfield(L, LUA_REGISTRYINDEX, "channel");
139 }
140
141 /*!
142  * \brief [lua_CFunction] Find an app and return it in a lua table (for access from lua, don't
143  * call directly)
144  *
145  * This function would be called in the following example as it would be found
146  * in extensions.lua.
147  *
148  * \code
149  * app.dial
150  * \endcode
151  */
152 static int lua_pbx_findapp(lua_State *L)
153 {
154         const char *app_name = luaL_checkstring(L, 2);
155         
156         lua_newtable(L);
157
158         lua_pushstring(L, "name");
159         lua_pushstring(L, app_name);
160         lua_settable(L, -3);
161
162         luaL_getmetatable(L, "application");
163         lua_setmetatable(L, -2);
164
165         return 1;
166 }
167
168 /*!
169  * \brief [lua_CFunction] This function is part of the 'application' metatable
170  * and is used to execute applications similar to pbx_exec() (for access from
171  * lua, don't call directly)
172  *
173  * \param L the lua_State to use
174  * \return nothing
175  *
176  * This funciton is executed as the '()' operator for apps accessed through the
177  * 'app' table.
178  *
179  * \code
180  * app.playback('demo-congrats')
181  * \endcode
182  */
183 static int lua_pbx_exec(lua_State *L)
184 {
185         int res, nargs = lua_gettop(L);
186         char data[LUA_EXT_DATA_SIZE] = "";
187         char *data_next = data, *app_name;
188         char *context, *exten;
189         char tmp[80], tmp2[80], tmp3[LUA_EXT_DATA_SIZE];
190         int priority, autoservice;
191         size_t data_left = sizeof(data);
192         struct ast_app *app;
193         struct ast_channel *chan;
194         
195         lua_getfield(L, 1, "name");
196         app_name = ast_strdupa(lua_tostring(L, -1));
197         lua_pop(L, 1);
198         
199         if (!(app = pbx_findapp(app_name))) {
200                 lua_pushstring(L, "application '");
201                 lua_pushstring(L, app_name);
202                 lua_pushstring(L, "' not found");
203                 lua_concat(L, 3);
204                 return lua_error(L);
205         }
206         
207
208         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
209         chan = lua_touserdata(L, -1);
210         lua_pop(L, 1);
211         
212         
213         lua_getfield(L, LUA_REGISTRYINDEX, "context");
214         context = ast_strdupa(lua_tostring(L, -1));
215         lua_pop(L, 1);
216         
217         lua_getfield(L, LUA_REGISTRYINDEX, "exten");
218         exten = ast_strdupa(lua_tostring(L, -1));
219         lua_pop(L, 1);
220         
221         lua_getfield(L, LUA_REGISTRYINDEX, "priority");
222         priority = lua_tointeger(L, -1);
223         lua_pop(L, 1);
224
225
226         if (nargs > 1) {
227                 int i;
228
229                 if (!lua_isnil(L, 2))
230                         ast_build_string(&data_next, &data_left, "%s", luaL_checkstring(L, 2));
231
232                 for (i = 3; i <= nargs; i++) {
233                         if (lua_isnil(L, i))
234                                 ast_build_string(&data_next, &data_left, ",");
235                         else
236                                 ast_build_string(&data_next, &data_left, ",%s", luaL_checkstring(L, i));
237                 }
238         }
239         
240         ast_verb(3, "Executing [%s@%s:%d] %s(\"%s\", \"%s\")\n",
241                         exten, context, priority,
242                         term_color(tmp, app_name, COLOR_BRCYAN, 0, sizeof(tmp)),
243                         term_color(tmp2, chan->name, COLOR_BRMAGENTA, 0, sizeof(tmp2)),
244                         term_color(tmp3, data, COLOR_BRMAGENTA, 0, sizeof(tmp3)));
245
246         lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
247         autoservice = lua_toboolean(L, -1);
248         lua_pop(L, 1);
249
250         if (autoservice)
251                 ast_autoservice_stop(chan);
252
253         res = pbx_exec(chan, app, data);
254         
255         if (autoservice)
256                 ast_autoservice_start(chan);
257
258         /* error executing an application, report it */
259         if (res) {
260                 lua_pushinteger(L, res);
261                 return lua_error(L);
262         }
263
264         lua_detect_goto(L);
265
266         return 0;
267 }
268
269 /*!
270  * \brief Detect if a Goto or other dialplan jump has been executed and return
271  * control to the pbx engine.
272  */
273 static void lua_detect_goto(lua_State *L)
274 {
275         struct ast_channel *chan;
276
277         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
278         chan = lua_touserdata(L, -1);
279         lua_pop(L, 1);
280
281         /* check context */
282         lua_getfield(L, LUA_REGISTRYINDEX, "context");
283         lua_pushstring(L, chan->context);
284         if (!lua_equal(L, -1, -2)) {
285                 lua_pushliteral(L, "context");
286                 goto e_goto_detected;
287         }
288         lua_pop(L, 2);
289
290         /* check exten */
291         lua_getfield(L, LUA_REGISTRYINDEX, "exten");
292         lua_pushstring(L, chan->exten);
293         if (!lua_equal(L, -1, -2)) {
294                 lua_pushliteral(L, "exten");
295                 goto e_goto_detected;
296         }
297         lua_pop(L, 2);
298
299         /* check priority */
300         lua_getfield(L, LUA_REGISTRYINDEX, "priority");
301         lua_pushinteger(L, chan->priority);
302         if (!lua_equal(L, -1, -2)) {
303                 lua_pushliteral(L, "priority");
304                 goto e_goto_detected;
305         }
306         lua_pop(L, 2);
307         return;
308
309 e_goto_detected:
310         /* format our debug message */
311         lua_insert(L, -3);
312
313         lua_pushliteral(L, " changed from ");
314         lua_insert(L, -3);
315
316         lua_pushliteral(L, " to ");
317         lua_insert(L, -2);
318
319         lua_concat(L, 5);
320
321         ast_debug(2, "Goto detected: %s\n", lua_tostring(L, -1));
322         lua_pop(L, 1);
323
324         /* let the lua engine know it needs to return control to the pbx */
325         lua_pushinteger(L, LUA_GOTO_DETECTED);
326         lua_error(L);
327 }
328
329 /*!
330  * \brief [lua_CFunction] Used to get the value of a variable or dialplan
331  * function (for access from lua, don't call directly)
332  * 
333  * The value of the variable or function is returned.  This function is the
334  * 'get()' function in the following example as would be seen in
335  * extensions.lua.
336  *
337  * \code
338  * channel.variable:get()
339  * \endcode
340  */
341 static int lua_get_variable_value(lua_State *L)
342 {
343         struct ast_channel *chan;
344         char *value = NULL, *name;
345         char *workspace = alloca(LUA_BUF_SIZE);
346         int autoservice;
347
348         workspace[0] = '\0';
349
350         if (!lua_istable(L, 1)) {
351                 lua_pushstring(L, "User probably used '.' instead of ':' for retrieving a channel variable value");
352                 return lua_error(L);
353         }
354         
355         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
356         chan = lua_touserdata(L, -1);
357         lua_pop(L, 1);
358
359         lua_getfield(L, 1, "name");
360         name = ast_strdupa(lua_tostring(L, -1));
361         lua_pop(L, 1);
362         
363         lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
364         autoservice = lua_toboolean(L, -1);
365         lua_pop(L, 1);
366
367         if (autoservice)
368                 ast_autoservice_stop(chan);
369         
370         /* if this is a dialplan function then use ast_func_read(), otherwise
371          * use pbx_retrieve_variable() */
372         if (!ast_strlen_zero(name) && name[strlen(name) - 1] == ')') {
373                 value = ast_func_read(chan, name, workspace, LUA_BUF_SIZE) ? NULL : workspace;
374         } else {
375                 pbx_retrieve_variable(chan, name, &value, workspace, LUA_BUF_SIZE, &chan->varshead);
376         }
377         
378         if (autoservice)
379                 ast_autoservice_start(chan);
380
381         if (value) {
382                 lua_pushstring(L, value);
383         } else {
384                 lua_pushnil(L);
385         }
386
387         return 1;
388 }
389
390 /*!
391  * \brief [lua_CFunction] Used to set the value of a variable or dialplan
392  * function (for access from lua, don't call directly)
393  * 
394  * This function is the 'set()' function in the following example as would be
395  * seen in extensions.lua.
396  *
397  * \code
398  * channel.variable:set("value")
399  * \endcode
400  */
401 static int lua_set_variable_value(lua_State *L)
402 {
403         const char *name, *value;
404         struct ast_channel *chan;
405         int autoservice;
406
407         if (!lua_istable(L, 1)) {
408                 lua_pushstring(L, "User probably used '.' instead of ':' for setting a channel variable");
409                 return lua_error(L);
410         }
411
412         lua_getfield(L, 1, "name");
413         name = ast_strdupa(lua_tostring(L, -1));
414         lua_pop(L, 1);
415
416         value = luaL_checkstring(L, 2);
417         
418         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
419         chan = lua_touserdata(L, -1);
420         lua_pop(L, 1);
421
422         lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
423         autoservice = lua_toboolean(L, -1);
424         lua_pop(L, 1);
425
426         if (autoservice)
427                 ast_autoservice_stop(chan);
428
429         pbx_builtin_setvar_helper(chan, name, value);
430         
431         if (autoservice)
432                 ast_autoservice_start(chan);
433
434         return 0;
435 }
436
437 /*!
438  * \brief Update the lua registry with the given context, exten, and priority.
439  *
440  * \param L the lua_State to use
441  * \param context the new context
442  * \param exten the new exten
443  * \param priority the new priority
444  */
445 static void lua_update_registry(lua_State *L, const char *context, const char *exten, int priority)
446 {
447         lua_pushstring(L, context);
448         lua_setfield(L, LUA_REGISTRYINDEX, "context");
449
450         lua_pushstring(L, exten);
451         lua_setfield(L, LUA_REGISTRYINDEX, "exten");
452
453         lua_pushinteger(L, priority);
454         lua_setfield(L, LUA_REGISTRYINDEX, "priority");
455 }
456
457 /*!
458  * \brief Push a 'variable' table on the stack for access the channel variable
459  * with the given name.
460  *
461  * \param L the lua_State to use
462  * \param name the name of the variable
463  */
464 static void lua_push_variable_table(lua_State *L, const char *name)
465 {
466         lua_newtable(L);
467         luaL_getmetatable(L, "variable");
468         lua_setmetatable(L, -2);
469
470         lua_pushstring(L, name);
471         lua_setfield(L, -2, "name");
472         
473         lua_pushcfunction(L, &lua_get_variable_value);
474         lua_setfield(L, -2, "get");
475         
476         lua_pushcfunction(L, &lua_set_variable_value);
477         lua_setfield(L, -2, "set");
478 }
479
480 /*!
481  * \brief Create the global 'app' table for executing applications
482  *
483  * \param L the lua_State to use
484  */
485 static void lua_create_app_table(lua_State *L)
486 {
487         lua_newtable(L);
488         luaL_newmetatable(L, "app");
489
490         lua_pushstring(L, "__index");
491         lua_pushcfunction(L, &lua_pbx_findapp);
492         lua_settable(L, -3);
493
494         lua_setmetatable(L, -2);
495         lua_setglobal(L, "app");
496 }
497
498 /*!
499  * \brief Create the global 'channel' table for accesing channel variables
500  *
501  * \param L the lua_State to use
502  */
503 static void lua_create_channel_table(lua_State *L)
504 {
505         lua_newtable(L);
506         luaL_newmetatable(L, "channel_data");
507
508         lua_pushstring(L, "__index");
509         lua_pushcfunction(L, &lua_get_variable);
510         lua_settable(L, -3);
511
512         lua_pushstring(L, "__newindex");
513         lua_pushcfunction(L, &lua_set_variable);
514         lua_settable(L, -3);
515
516         lua_setmetatable(L, -2);
517         lua_setglobal(L, "channel");
518 }
519
520 /*!
521  * \brief Create the 'variable' metatable, used to retrieve channel variables
522  *
523  * \param L the lua_State to use
524  */
525 static void lua_create_variable_metatable(lua_State *L)
526 {
527         luaL_newmetatable(L, "variable");
528
529         lua_pushstring(L, "__call");
530         lua_pushcfunction(L, &lua_func_read);
531         lua_settable(L, -3);
532
533         lua_pop(L, 1);
534 }
535
536 /*!
537  * \brief Create the 'application' metatable, used to execute asterisk
538  * applications from lua 
539  *
540  * \param L the lua_State to use
541  */
542 static void lua_create_application_metatable(lua_State *L)
543 {
544         luaL_newmetatable(L, "application");
545
546         lua_pushstring(L, "__call");
547         lua_pushcfunction(L, &lua_pbx_exec);
548         lua_settable(L, -3);
549
550         lua_pop(L, 1);
551 }
552
553 /*!
554  * \brief Create the autoservice functions
555  *
556  * \param L the lua_State to use
557  */
558 static void lua_create_autoservice_functions(lua_State *L)
559 {
560         lua_pushcfunction(L, &lua_autoservice_start);
561         lua_setglobal(L, "autoservice_start");
562         
563         lua_pushcfunction(L, &lua_autoservice_stop);
564         lua_setglobal(L, "autoservice_stop");
565
566         lua_pushcfunction(L, &lua_autoservice_status);
567         lua_setglobal(L, "autoservice_status");
568
569         lua_pushboolean(L, 0);
570         lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
571 }
572
573 /*!
574  * \brief Create the hangup check function
575  *
576  * \param L the lua_State to use
577  */
578 static void lua_create_hangup_function(lua_State *L)
579 {
580         lua_pushcfunction(L, &lua_check_hangup);
581         lua_setglobal(L, "check_hangup");
582 }
583
584 /*!
585  * \brief [lua_CFunction] Return a lua 'variable' object (for access from lua, don't call
586  * directly)
587  * 
588  * This function is called to lookup a variable construct a 'variable' object.
589  * It would be called in the following example as would be seen in
590  * extensions.lua.
591  *
592  * \code
593  * channel.variable
594  * \endcode
595  */
596 static int lua_get_variable(lua_State *L)
597 {
598         struct ast_channel *chan;
599         char *name = ast_strdupa(luaL_checkstring(L, 2));
600         char *value = NULL;
601         char *workspace = alloca(LUA_BUF_SIZE);
602         workspace[0] = '\0';
603         
604         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
605         chan = lua_touserdata(L, -1);
606         lua_pop(L, 1);
607
608         lua_push_variable_table(L, name);
609         
610         /* if this is not a request for a dialplan funciton attempt to retrieve
611          * the value of the variable */
612         if (!ast_strlen_zero(name) && name[strlen(name) - 1] != ')') {
613                 pbx_retrieve_variable(chan, name, &value, workspace, LUA_BUF_SIZE, &chan->varshead);
614         }
615
616         if (value) {
617                 lua_pushstring(L, value);
618                 lua_setfield(L, -2, "value");
619         }
620
621         return 1;       
622 }
623
624 /*!
625  * \brief [lua_CFunction] Set the value of a channel variable or dialplan
626  * function (for access from lua, don't call directly)
627  * 
628  * This function is called to set a variable or dialplan function.  It would be
629  * called in the following example as would be seen in extensions.lua.
630  *
631  * \code
632  * channel.variable = "value"
633  * \endcode
634  */
635 static int lua_set_variable(lua_State *L)
636 {
637         struct ast_channel *chan;
638         int autoservice;
639         const char *name = luaL_checkstring(L, 2);
640         const char *value = luaL_checkstring(L, 3);
641
642         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
643         chan = lua_touserdata(L, -1);
644         lua_pop(L, 1);
645
646         lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
647         autoservice = lua_toboolean(L, -1);
648         lua_pop(L, 1);
649
650         if (autoservice)
651                 ast_autoservice_stop(chan);
652
653         pbx_builtin_setvar_helper(chan, name, value);
654         
655         if (autoservice)
656                 ast_autoservice_start(chan);
657
658         return 0;
659 }
660
661 /*!
662  * \brief [lua_CFunction] Create a 'variable' object for accessing a dialplan
663  * function (for access from lua, don't call directly)
664  * 
665  * This function is called to create a 'variable' object to access a dialplan
666  * function.  It would be called in the following example as would be seen in
667  * extensions.lua.
668  *
669  * \code
670  * channel.func("arg1", "arg2", "arg3")
671  * \endcode
672  *
673  * To actually do anything with the resulting value you must use the 'get()'
674  * and 'set()' methods (the reason is the resulting value is not a value, but
675  * an object in the form of a lua table).
676  */
677 static int lua_func_read(lua_State *L)
678 {
679         int nargs = lua_gettop(L);
680         char fullname[LUA_EXT_DATA_SIZE] = "";
681         char *fullname_next = fullname, *name;
682         size_t fullname_left = sizeof(fullname);
683         
684         lua_getfield(L, 1, "name");
685         name = ast_strdupa(lua_tostring(L, -1));
686         lua_pop(L, 1);
687
688         ast_build_string(&fullname_next, &fullname_left, "%s(", name);
689         
690         if (nargs > 1) {
691                 int i;
692
693                 if (!lua_isnil(L, 2))
694                         ast_build_string(&fullname_next, &fullname_left, "%s", luaL_checkstring(L, 2));
695
696                 for (i = 3; i <= nargs; i++) {
697                         if (lua_isnil(L, i))
698                                 ast_build_string(&fullname_next, &fullname_left, ",");
699                         else
700                                 ast_build_string(&fullname_next, &fullname_left, ",%s", luaL_checkstring(L, i));
701                 }
702         }
703
704         ast_build_string(&fullname_next, &fullname_left, ")");
705         
706         lua_push_variable_table(L, fullname);
707         
708         return 1;
709 }
710
711 /*!
712  * \brief [lua_CFunction] Tell pbx_lua to maintain an autoservice on this
713  * channel (for access from lua, don't call directly)
714  *
715  * \param L the lua_State to use
716  *
717  * This function will set a flag that will cause pbx_lua to maintain an
718  * autoservice on this channel.  The autoservice will automatically be stopped
719  * and restarted before calling applications and functions.
720  *
721  * \return This function returns the result of the ast_autoservice_start()
722  * function as a boolean to its lua caller.
723  */
724 static int lua_autoservice_start(lua_State *L)
725 {
726         struct ast_channel *chan;
727         int res;
728
729         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
730         chan = lua_touserdata(L, -1);
731         lua_pop(L, 1);
732
733         res = ast_autoservice_start(chan);
734
735         lua_pushboolean(L, !res);
736         lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
737
738         lua_pushboolean(L, !res);
739         return 1;
740 }
741
742 /*!
743  * \brief [lua_CFunction] Tell pbx_lua to stop maintaning an autoservice on
744  * this channel (for access from lua, don't call directly)
745  *
746  * \param L the lua_State to use
747  *
748  * This function will stop any autoservice running and turn off the autoservice
749  * flag.  If this function returns false, it's probably because no autoservice
750  * was running to begin with.
751  *
752  * \return This function returns the result of the ast_autoservice_stop()
753  * function as a boolean to its lua caller.
754  */
755 static int lua_autoservice_stop(lua_State *L)
756 {
757         struct ast_channel *chan;
758         int res;
759
760         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
761         chan = lua_touserdata(L, -1);
762         lua_pop(L, 1);
763
764         res = ast_autoservice_stop(chan);
765
766         lua_pushboolean(L, 0);
767         lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
768
769         lua_pushboolean(L, !res);
770         return 1;
771 }
772
773 /*!
774  * \brief [lua_CFunction] Get the status of the autoservice flag (for access
775  * from lua, don't call directly)
776  *
777  * \param L the lua_State to use
778  *
779  * \return This function returns the status of the autoservice flag as a
780  * boolean to its lua caller.
781  */
782 static int lua_autoservice_status(lua_State *L)
783 {
784         lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
785         return 1;
786 }
787
788 /*!
789  * \brief [lua_CFunction] Check if this channel has been hungup or not (for
790  * access from lua, don't call directly)
791  *
792  * \param L the lua_State to use
793  *
794  * \return This function returns true if the channel was hungup
795  */
796 static int lua_check_hangup(lua_State *L)
797 {
798         struct ast_channel *chan;
799         lua_getfield(L, LUA_REGISTRYINDEX, "channel");
800         chan = lua_touserdata(L, -1);
801         lua_pop(L, 1);
802
803         lua_pushboolean(L, ast_check_hangup(chan));
804         return 1;
805 }
806
807 /*!
808  * \brief [lua_CFunction] Handle lua errors (for access from lua, don't call
809  * directly)
810  *
811  * \param L the lua_State to use
812  */
813 static int lua_error_function(lua_State *L)
814 {
815         int message_index;
816
817         /* pass number arguments right through back to asterisk*/
818         if (lua_isnumber(L, -1)) {
819                 return 1;
820         }
821
822         /* if we are here then we have a string error message, let's attach a
823          * backtrace to it */
824         message_index = lua_gettop(L);
825
826         /* prepare to prepend a new line to the traceback */
827         lua_pushliteral(L, "\n");
828
829         lua_getglobal(L, "debug");
830         lua_getfield(L, -1, "traceback");
831         lua_remove(L, -2); /* remove the 'debug' table */
832
833         lua_pushvalue(L, message_index);
834         lua_remove(L, message_index);
835
836         lua_pushnumber(L, 2);
837
838         lua_call(L, 2, 1);
839
840         /* prepend the new line we prepared above */
841         lua_concat(L, 2);
842
843         return 1;
844 }
845
846 /*!
847  * \brief Store the sort order of each context
848  
849  * In the event of an error, an error string will be pushed onto the lua stack.
850  *
851  * \retval 0 success
852  * \retval 1 failure
853  */
854 static int lua_sort_extensions(lua_State *L)
855 {
856         int extensions, extensions_order;
857
858         /* create the extensions_order table */
859         lua_newtable(L);
860         lua_setfield(L, LUA_REGISTRYINDEX, "extensions_order");
861         lua_getfield(L, LUA_REGISTRYINDEX, "extensions_order");
862         extensions_order = lua_gettop(L);
863
864         /* sort each context in the extensions table */
865         /* load the 'extensions' table */
866         lua_getglobal(L, "extensions");
867         extensions = lua_gettop(L);
868         if (lua_isnil(L, -1)) {
869                 lua_pop(L, 1);
870                 lua_pushstring(L, "Unable to find 'extensions' table in extensions.lua\n");
871                 return 1;
872         }
873
874         /* iterate through the extensions table and create a
875          * matching table (holding the sort order) in the
876          * extensions_order table for each context that is found
877          */
878         for (lua_pushnil(L); lua_next(L, extensions); lua_pop(L, 1)) {
879                 int context = lua_gettop(L);
880                 int context_name = context - 1;
881                 int context_order;
882
883                 /* copy the context_name to be used as the key for the
884                  * context_order table in the extensions_order table later */
885                 lua_pushvalue(L, context_name);
886
887                 /* create the context_order table */
888                 lua_newtable(L);
889                 context_order = lua_gettop(L);
890
891                 /* iterate through this context an popluate the corrisponding
892                  * table in the extensions_order table */
893                 for (lua_pushnil(L); lua_next(L, context); lua_pop(L, 1)) {
894                         int exten = lua_gettop(L) - 1;
895
896                         lua_pushinteger(L, lua_objlen(L, context_order) + 1);
897                         lua_pushvalue(L, exten);
898                         lua_settable(L, context_order);
899                 }
900                 lua_settable(L, extensions_order); /* put the context_order table in the extensions_order table */
901
902                 /* now sort the new table */
903
904                 /* push the table.sort function */
905                 lua_getglobal(L, "table");
906                 lua_getfield(L, -1, "sort");
907                 lua_remove(L, -2); /* remove the 'table' table */
908
909                 /* push the context_order table */
910                 lua_pushvalue(L, context_name);
911                 lua_gettable(L, extensions_order);
912
913                 /* push the comp function */
914                 lua_pushcfunction(L, &lua_extension_cmp);
915
916                 if (lua_pcall(L, 2, 0, 0)) {
917                         lua_insert(L, -5);
918                         lua_pop(L, 4);
919                         return 1;
920                 }
921         }
922         
923         /* remove the extensions table and the extensions_order table */
924         lua_pop(L, 2);
925         return 0;
926 }
927
928 /*!
929  * \brief Register dialplan switches for our pbx_lua contexs.
930  *
931  * In the event of an error, an error string will be pushed onto the lua stack.
932  *
933  * \retval 0 success
934  * \retval 1 failure
935  */
936 static int lua_register_switches(lua_State *L)
937 {
938         int extensions;
939         struct ast_context *con = NULL;
940
941         /* create the hash table for our contexts */
942         /* XXX do we ever need to destroy this? pbx_config does not */
943         if (!local_table)
944                 local_table = ast_hashtab_create(17, ast_hashtab_compare_contexts, ast_hashtab_resize_java, ast_hashtab_newsize_java, ast_hashtab_hash_contexts, 0);
945
946         /* load the 'extensions' table */
947         lua_getglobal(L, "extensions");
948         extensions = lua_gettop(L);
949         if (lua_isnil(L, -1)) {
950                 lua_pop(L, 1);
951                 lua_pushstring(L, "Unable to find 'extensions' table in extensions.lua\n");
952                 return 1;
953         }
954
955         /* iterate through the extensions table and register a context and
956          * dialplan switch for each lua context
957          */
958         for (lua_pushnil(L); lua_next(L, extensions); lua_pop(L, 1)) {
959                 int context = lua_gettop(L);
960                 int context_name = context - 1;
961                 const char *context_str = lua_tostring(L, context_name);
962
963                 /* find or create this context */
964                 con = ast_context_find_or_create(&local_contexts, local_table, context_str, registrar);
965                 if (!con) {
966                         /* remove extensions table and context key and value */
967                         lua_pop(L, 3);
968                         lua_pushstring(L, "Failed to find or create context\n");
969                         return 1;
970                 }
971
972                 /* register the switch */
973                 if (ast_context_add_switch2(con, "Lua", "", 0, registrar)) {
974                         /* remove extensions table and context key and value */
975                         lua_pop(L, 3);
976                         lua_pushstring(L, "Unable to create switch for context\n");
977                         return 1;
978                 }
979         }
980         
981         /* remove the extensions table */
982         lua_pop(L, 1);
983         return 0;
984 }
985
986 /*!
987  * \brief Register dialplan hints for our pbx_lua contexs.
988  *
989  * In the event of an error, an error string will be pushed onto the lua stack.
990  *
991  * \retval 0 success
992  * \retval 1 failure
993  */
994 static int lua_register_hints(lua_State *L)
995 {
996         int hints;
997         struct ast_context *con = NULL;
998
999         /* create the hash table for our contexts */
1000         /* XXX do we ever need to destroy this? pbx_config does not */
1001         if (!local_table)
1002                 local_table = ast_hashtab_create(17, ast_hashtab_compare_contexts, ast_hashtab_resize_java, ast_hashtab_newsize_java, ast_hashtab_hash_contexts, 0);
1003
1004         /* load the 'hints' table */
1005         lua_getglobal(L, "hints");
1006         hints = lua_gettop(L);
1007         if (lua_isnil(L, -1)) {
1008                 /* hints table not found, move along */
1009                 lua_pop(L, 1);
1010                 return 0;
1011         }
1012
1013         /* iterate through the hints table and register each context and
1014          * the hints that go along with it
1015          */
1016         for (lua_pushnil(L); lua_next(L, hints); lua_pop(L, 1)) {
1017                 int context = lua_gettop(L);
1018                 int context_name = context - 1;
1019                 const char *context_str = lua_tostring(L, context_name);
1020
1021                 /* find or create this context */
1022                 con = ast_context_find_or_create(&local_contexts, local_table, context_str, registrar);
1023                 if (!con) {
1024                         /* remove hints table and context key and value */
1025                         lua_pop(L, 3);
1026                         lua_pushstring(L, "Failed to find or create context\n");
1027                         return 1;
1028                 }
1029
1030                 /* register each hint */
1031                 for (lua_pushnil(L); lua_next(L, context); lua_pop(L, 1)) {
1032                         const char *hint_value = lua_tostring(L, -1);
1033                         const char *hint_name;
1034
1035                         /* the hint value is not a string, ignore it */
1036                         if (!hint_value) {
1037                                 continue;
1038                         }
1039
1040                         /* copy the name then convert it to a string */
1041                         lua_pushvalue(L, -2);
1042                         if (!(hint_name = lua_tostring(L, -1))) {
1043                                 /* ignore non-string value */
1044                                 lua_pop(L, 1);
1045                                 continue;
1046                         }
1047
1048                         if (ast_add_extension2(con, 0, hint_name, PRIORITY_HINT, NULL, NULL, hint_value, NULL, NULL, registrar)) {
1049                                 /* remove hints table, hint name, hint value,
1050                                  * key copy, context name, and contex table */
1051                                 lua_pop(L, 6);
1052                                 lua_pushstring(L, "Error creating hint\n");
1053                                 return 1;
1054                         }
1055
1056                         /* pop the name copy */
1057                         lua_pop(L, 1);
1058                 }
1059         }
1060
1061         /* remove the hints table */
1062         lua_pop(L, 1);
1063
1064         return 0;
1065 }
1066
1067 /*!
1068  * \brief [lua_CFunction] Compare two extensions (for access from lua, don't
1069  * call directly)
1070  *
1071  * This function returns true if the first extension passed should match after
1072  * the second.  It behaves like the '<' operator.
1073  */
1074 static int lua_extension_cmp(lua_State *L)
1075 {
1076         const char *a = luaL_checkstring(L, -2);
1077         const char *b = luaL_checkstring(L, -1);
1078
1079         if (ast_extension_cmp(a, b) == -1)
1080                 lua_pushboolean(L, 1);
1081         else
1082                 lua_pushboolean(L, 0);
1083
1084         return 1;
1085 }
1086
1087 /*!
1088  * \brief Load the extensions.lua file in to a buffer and execute the file
1089  *
1090  * \param L the lua_State to use
1091  * \param size a pointer to store the size of the buffer
1092  *
1093  * \note The caller is expected to free the buffer at some point.
1094  *
1095  * \return a pointer to the buffer
1096  */
1097 static char *lua_read_extensions_file(lua_State *L, long *size)
1098 {
1099         FILE *f;
1100         int error_func;
1101         char *data;
1102         char *path = alloca(strlen(config) + strlen(ast_config_AST_CONFIG_DIR) + 2);
1103         sprintf(path, "%s/%s", ast_config_AST_CONFIG_DIR, config);
1104
1105         if (!(f = fopen(path, "r"))) {
1106                 lua_pushstring(L, "cannot open '");
1107                 lua_pushstring(L, path);
1108                 lua_pushstring(L, "' for reading: ");
1109                 lua_pushstring(L, strerror(errno));
1110                 lua_concat(L, 4);
1111
1112                 return NULL;
1113         }
1114
1115         if (fseek(f, 0l, SEEK_END)) {
1116                 fclose(f);
1117                 lua_pushliteral(L, "error determining the size of the config file");
1118                 return NULL;
1119         }
1120
1121         *size = ftell(f);
1122
1123         if (fseek(f, 0l, SEEK_SET)) {
1124                 *size = 0;
1125                 fclose(f);
1126                 lua_pushliteral(L, "error reading config file");
1127                 return NULL;
1128         }
1129
1130         if (!(data = ast_malloc(*size))) {
1131                 *size = 0;
1132                 fclose(f);
1133                 lua_pushstring(L, "not enough memory");
1134                 return NULL;
1135         }
1136
1137         if (fread(data, sizeof(char), *size, f) != *size) {
1138                 *size = 0;
1139                 fclose(f);
1140                 lua_pushliteral(L, "problem reading configuration file");
1141                 return NULL;
1142         }
1143         fclose(f);
1144
1145         lua_pushcfunction(L, &lua_error_function);
1146         error_func = lua_gettop(L);
1147
1148         if (luaL_loadbuffer(L, data, *size, "extensions.lua")
1149                         || lua_pcall(L, 0, LUA_MULTRET, error_func)
1150                         || lua_sort_extensions(L)
1151                         || lua_register_switches(L)
1152                         || lua_register_hints(L)) {
1153                 ast_free(data);
1154                 data = NULL;
1155                 *size = 0;
1156         }
1157
1158         lua_remove(L, error_func);
1159         return data;
1160 }
1161
1162 /*!
1163  * \brief Load the extensions.lua file from the internal buffer
1164  *
1165  * \param L the lua_State to use
1166  * \param chan channel to work on
1167  *
1168  * This function also sets up some constructs used by the extensions.lua file.
1169  * In the event of an error, an error string will be pushed onto the lua stack.
1170  *
1171  * \retval 0 success
1172  * \retval 1 failure
1173  */
1174 static int lua_load_extensions(lua_State *L, struct ast_channel *chan)
1175 {
1176         
1177         /* store a pointer to this channel */
1178         lua_pushlightuserdata(L, chan);
1179         lua_setfield(L, LUA_REGISTRYINDEX, "channel");
1180         
1181         luaL_openlibs(L);
1182
1183         /* load and sort extensions */
1184         ast_mutex_lock(&config_file_lock);
1185         if (luaL_loadbuffer(L, config_file_data, config_file_size, "extensions.lua")
1186                         || lua_pcall(L, 0, LUA_MULTRET, 0)
1187                         || lua_sort_extensions(L)) {
1188                 ast_mutex_unlock(&config_file_lock);
1189                 return 1;
1190         }
1191         ast_mutex_unlock(&config_file_lock);
1192
1193         /* now we setup special tables and functions */
1194
1195         lua_create_app_table(L);
1196         lua_create_channel_table(L);
1197
1198         lua_create_variable_metatable(L);
1199         lua_create_application_metatable(L);
1200
1201         lua_create_autoservice_functions(L);
1202         lua_create_hangup_function(L);
1203
1204         return 0;
1205 }
1206
1207 /*!
1208  * \brief Reload the extensions file and update the internal buffers if it
1209  * loads correctly.
1210  *
1211  * \warning This function should not be called on a lua_State returned from
1212  * lua_get_state().
1213  *
1214  * \param L the lua_State to use (must be freshly allocated with
1215  * luaL_newstate(), don't use lua_get_state())
1216  */
1217 static int lua_reload_extensions(lua_State *L)
1218 {
1219         long size = 0;
1220         char *data = NULL;
1221
1222         luaL_openlibs(L);
1223
1224         if (!(data = lua_read_extensions_file(L, &size))) {
1225                 return 1;
1226         }
1227
1228         ast_mutex_lock(&config_file_lock);
1229
1230         if (config_file_data)
1231                 ast_free(config_file_data);
1232
1233         config_file_data = data;
1234         config_file_size = size;
1235         
1236         /* merge our new contexts */
1237         ast_merge_contexts_and_delete(&local_contexts, local_table, registrar);
1238         /* merge_contexts_and_delete will actually, at the correct moment, 
1239            set the global dialplan pointers to your local_contexts and local_table.
1240            It then will free up the old tables itself. Just be sure not to
1241            hang onto the pointers. */
1242         local_table = NULL;
1243         local_contexts = NULL;
1244
1245         ast_mutex_unlock(&config_file_lock);
1246         return 0;
1247 }
1248
1249 /*!
1250  * \brief Free the internal extensions buffer.
1251  */
1252 static void lua_free_extensions()
1253 {
1254         ast_mutex_lock(&config_file_lock);
1255         config_file_size = 0;
1256         ast_free(config_file_data);
1257         ast_mutex_unlock(&config_file_lock);
1258 }
1259
1260 /*!
1261  * \brief Get the lua_State for this channel
1262  *
1263  * If no channel is passed then a new state is allocated.  States with no
1264  * channel assocatied with them should only be used for matching extensions.
1265  * If the channel does not yet have a lua state associated with it, one will be
1266  * created.
1267  *
1268  * \note If no channel was passed then the caller is expected to free the state
1269  * using lua_close().
1270  *
1271  * \return a lua_State
1272  */
1273 static lua_State *lua_get_state(struct ast_channel *chan)
1274 {
1275         struct ast_datastore *datastore = NULL;
1276         lua_State *L;
1277
1278         if (!chan) {
1279                 lua_State *L = luaL_newstate();
1280                 if (!L) {
1281                         ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
1282                         return NULL;
1283                 }
1284
1285                 if (lua_load_extensions(L, NULL)) {
1286                         const char *error = lua_tostring(L, -1);
1287                         ast_log(LOG_ERROR, "Error loading extensions.lua: %s\n", error);
1288                         lua_close(L);
1289                         return NULL;
1290                 }
1291                 return L;
1292         } else {
1293                 ast_channel_lock(chan);
1294                 datastore = ast_channel_datastore_find(chan, &lua_datastore, NULL);
1295                 ast_channel_unlock(chan);
1296
1297                 if (!datastore) {
1298                         /* nothing found, allocate a new lua state */
1299                         datastore = ast_datastore_alloc(&lua_datastore, NULL);
1300                         if (!datastore) {
1301                                 ast_log(LOG_ERROR, "Error allocation channel datastore for lua_State\n");
1302                                 return NULL;
1303                         }
1304
1305                         datastore->data = luaL_newstate();
1306                         if (!datastore->data) {
1307                                 ast_datastore_free(datastore);
1308                                 ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
1309                                 return NULL;
1310                         }
1311
1312                         ast_channel_lock(chan);
1313                         ast_channel_datastore_add(chan, datastore);
1314                         ast_channel_unlock(chan);
1315
1316                         L = datastore->data;
1317
1318                         if (lua_load_extensions(L, chan)) {
1319                                 const char *error = lua_tostring(L, -1);
1320                                 ast_log(LOG_ERROR, "Error loading extensions.lua for %s: %s\n", chan->name, error);
1321
1322                                 ast_channel_lock(chan);
1323                                 ast_channel_datastore_remove(chan, datastore);
1324                                 ast_channel_unlock(chan);
1325
1326                                 ast_datastore_free(datastore);
1327                                 return NULL;
1328                         }
1329                 }
1330
1331                 return datastore->data;
1332         }
1333 }
1334
1335 static int exists(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
1336 {
1337         int res;
1338         lua_State *L;
1339         struct ast_module_user *u = ast_module_user_add(chan);
1340         if (!u) {
1341                 ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
1342                 return 0;
1343         }
1344
1345         L = lua_get_state(chan);
1346         if (!L) {
1347                 ast_module_user_remove(u);
1348                 return 0;
1349         }
1350
1351         res = lua_find_extension(L, context, exten, priority, &exists, 0);
1352
1353         if (!chan) lua_close(L);
1354         ast_module_user_remove(u);
1355         return res;
1356 }
1357
1358 static int canmatch(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
1359 {
1360         int res;
1361         lua_State *L;
1362         struct ast_module_user *u = ast_module_user_add(chan);
1363         if (!u) {
1364                 ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
1365                 return 0;
1366         }
1367
1368         L = lua_get_state(chan);
1369         if (!L) {
1370                 ast_module_user_remove(u);
1371                 return 0;
1372         }
1373
1374         res = lua_find_extension(L, context, exten, priority, &canmatch, 0);
1375
1376         if (!chan) lua_close(L);
1377         ast_module_user_remove(u);
1378         return res;
1379 }
1380
1381 static int matchmore(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
1382 {
1383         int res;
1384         lua_State *L;
1385         struct ast_module_user *u = ast_module_user_add(chan);
1386         if (!u) {
1387                 ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
1388                 return 0;
1389         }
1390
1391         L = lua_get_state(chan);
1392         if (!L) {
1393                 ast_module_user_remove(u);
1394                 return 0;
1395         }
1396         
1397         res = lua_find_extension(L, context, exten, priority, &matchmore, 0);
1398
1399         if (!chan) lua_close(L);
1400         ast_module_user_remove(u);
1401         return res;
1402 }
1403
1404
1405 static int exec(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
1406 {
1407         int res, error_func;
1408         lua_State *L;
1409         struct ast_module_user *u = ast_module_user_add(chan);
1410         if (!u) {
1411                 ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
1412                 return -1;
1413         }
1414         
1415         L = lua_get_state(chan);
1416         if (!L) {
1417                 ast_module_user_remove(u);
1418                 return -1;
1419         }
1420
1421         lua_pushcfunction(L, &lua_error_function);
1422         error_func = lua_gettop(L);
1423
1424         /* push the extension function onto the stack */
1425         if (!lua_find_extension(L, context, exten, priority, &exists, 1)) {
1426                 lua_pop(L, 1); /* pop the debug function */
1427                 ast_log(LOG_ERROR, "Could not find extension %s in context %s\n", exten, context);
1428                 if (!chan) lua_close(L);
1429                 ast_module_user_remove(u);
1430                 return -1;
1431         }
1432                 
1433         lua_update_registry(L, context, exten, priority);
1434         
1435         lua_pushstring(L, context);
1436         lua_pushstring(L, exten);
1437         
1438         res = lua_pcall(L, 2, 0, error_func);
1439         if (res) {
1440                 if (res == LUA_ERRRUN) {
1441                         res = -1;
1442                         if (lua_isnumber(L, -1)) {
1443                                 res = lua_tointeger(L, -1);
1444
1445                                 if (res == LUA_GOTO_DETECTED) {
1446                                         res = 0;
1447                                 }
1448                         } else if (lua_isstring(L, -1)) {
1449                                 const char *error = lua_tostring(L, -1);
1450                                 ast_log(LOG_ERROR, "Error executing lua extension: %s\n", error);
1451                         }
1452                 } else if (res == LUA_ERRERR) {
1453                         res = -1;
1454                         ast_log(LOG_ERROR, "Error in the lua error handler (this is probably a bug in pbx_lua)\n");
1455                 } else if (res == LUA_ERRMEM) {
1456                         res = -1;
1457                         ast_log(LOG_ERROR, "Memory allocation error\n");
1458                 }
1459                 lua_pop(L, 1);
1460         }
1461         lua_remove(L, error_func);
1462         if (!chan) lua_close(L);
1463         ast_module_user_remove(u);
1464         return res;
1465 }
1466
1467 /*!
1468  * \brief Locate an extensions and optionally push the matching function on the
1469  * stack
1470  *
1471  * \param L the lua_State to use
1472  * \param context the context to look in
1473  * \param exten the extension to look up
1474  * \param priority the priority to check, '1' is the only valid priority
1475  * \param func the calling func, used to adjust matching behavior between,
1476  * match, canmatch, and matchmore
1477  * \param push_func whether or not to push the lua function for the given
1478  * extension onto the stack
1479  */
1480 static int lua_find_extension(lua_State *L, const char *context, const char *exten, int priority, ast_switch_f *func, int push_func)
1481 {
1482         int context_table, context_order_table, i;
1483
1484         ast_debug(2, "Looking up %s@%s:%i\n", exten, context, priority);
1485         if (priority != 1)
1486                 return 0;
1487
1488         /* load the 'extensions' table */
1489         lua_getglobal(L, "extensions");
1490         if (lua_isnil(L, -1)) {
1491                 ast_log(LOG_ERROR, "Unable to find 'extensions' table in extensions.lua\n");
1492                 lua_pop(L, 1);
1493                 return 0;
1494         }
1495
1496         /* load the given context */
1497         lua_getfield(L, -1, context);
1498         if (lua_isnil(L, -1)) {
1499                 lua_pop(L, 2);
1500                 return 0;
1501         }
1502
1503         /* remove the extensions table */
1504         lua_remove(L, -2);
1505
1506         context_table = lua_gettop(L);
1507
1508         /* load the extensions order table for this context */
1509         lua_getfield(L, LUA_REGISTRYINDEX, "extensions_order");
1510         lua_getfield(L, -1, context);
1511
1512         lua_remove(L, -2);  /* remove the extensions order table */
1513
1514         context_order_table = lua_gettop(L);
1515         
1516         /* step through the extensions looking for a match */
1517         for (i = 1; i < lua_objlen(L, context_order_table) + 1; i++) {
1518                 int e_index_copy, match = 0;
1519                 const char *e;
1520
1521                 lua_pushinteger(L, i);
1522                 lua_gettable(L, context_order_table);
1523                 lua_gettop(L);
1524
1525                 /* copy the key at the top of the stack for use later */
1526                 lua_pushvalue(L, -1);
1527                 e_index_copy = lua_gettop(L);
1528
1529                 if (!(e = lua_tostring(L, e_index_copy))) {
1530                         lua_pop(L, 2);
1531                         continue;
1532                 }
1533
1534                 /* make sure this is not the 'include' extension */
1535                 if (!strcasecmp(e, "include")) {
1536                         lua_pop(L, 2);
1537                         continue;
1538                 }
1539
1540                 if (func == &matchmore)
1541                         match = ast_extension_close(e, exten, E_MATCHMORE);
1542                 else if (func == &canmatch)
1543                         match = ast_extension_close(e, exten, E_CANMATCH);
1544                 else
1545                         match = ast_extension_match(e, exten);
1546
1547                 /* the extension matching functions return 0 on fail, 1 on
1548                  * match, 2 on earlymatch */
1549
1550                 if (!match) {
1551                         /* pop the copy and the extension */
1552                         lua_pop(L, 2);
1553                         continue;       /* keep trying */
1554                 }
1555
1556                 if (func == &matchmore && match == 2) {
1557                         /* We match an extension ending in '!'. The decision in
1558                          * this case is final and counts as no match. */
1559                         lua_pop(L, 4);
1560                         return 0;
1561                 }
1562
1563                 /* remove the context table, the context order table, the
1564                  * extension, and the extension copy (or replace the extension
1565                  * with the corresponding function) */
1566                 if (push_func) {
1567                         lua_pop(L, 1);  /* pop the copy */
1568                         lua_gettable(L, context_table);
1569                         lua_insert(L, -3);
1570                         lua_pop(L, 2);
1571                 } else {
1572                         lua_pop(L, 4);
1573                 }
1574
1575                 return 1;
1576         }
1577
1578         /* load the includes for this context */
1579         lua_getfield(L, context_table, "include");
1580         if (lua_isnil(L, -1)) {
1581                 lua_pop(L, 3);
1582                 return 0;
1583         }
1584
1585         /* remove the context and the order table*/
1586         lua_remove(L, context_order_table);
1587         lua_remove(L, context_table);
1588
1589         /* Now try any includes we have in this context */
1590         for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1)) {
1591                 const char *c = lua_tostring(L, -1);
1592                 if (!c)
1593                         continue;
1594
1595                 if (lua_find_extension(L, c, exten, priority, func, push_func)) {
1596                         /* remove the value, the key, and the includes table
1597                          * from the stack.  Leave the function behind if
1598                          * necessary */
1599
1600                         if (push_func)
1601                                 lua_insert(L, -4);
1602
1603                         lua_pop(L, 3);
1604                         return 1;
1605                 }
1606         }
1607
1608         /* pop the includes table */
1609         lua_pop(L, 1);
1610         return 0;
1611 }
1612
1613 static struct ast_switch lua_switch = {
1614         .name           = "Lua",
1615         .description    = "Lua PBX Switch",
1616         .exists         = exists,
1617         .canmatch       = canmatch,
1618         .exec           = exec,
1619         .matchmore      = matchmore,
1620 };
1621
1622
1623 static int load_or_reload_lua_stuff(void)
1624 {
1625         int res = AST_MODULE_LOAD_SUCCESS;
1626
1627         lua_State *L = luaL_newstate();
1628         if (!L) {
1629                 ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
1630                 return AST_MODULE_LOAD_DECLINE;
1631         }
1632
1633         if (lua_reload_extensions(L)) {
1634                 const char *error = lua_tostring(L, -1);
1635                 ast_log(LOG_ERROR, "Error loading extensions.lua: %s\n", error);
1636                 res = AST_MODULE_LOAD_DECLINE;
1637         }
1638
1639         lua_close(L);
1640         return res;
1641 }
1642
1643 static int unload_module(void)
1644 {
1645         ast_context_destroy(NULL, registrar);
1646         ast_unregister_switch(&lua_switch);
1647         lua_free_extensions();
1648         return 0;
1649 }
1650
1651 static int reload(void)
1652 {
1653         return load_or_reload_lua_stuff();
1654 }
1655
1656 static int load_module(void)
1657 {
1658         int res;
1659
1660         if ((res = load_or_reload_lua_stuff()))
1661                 return res;
1662
1663         if (ast_register_switch(&lua_switch)) {
1664                 ast_log(LOG_ERROR, "Unable to register LUA PBX switch\n");
1665                 return AST_MODULE_LOAD_DECLINE;
1666         }
1667
1668         return AST_MODULE_LOAD_SUCCESS;
1669 }
1670
1671 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Lua PBX Switch",
1672                 .load = load_module,
1673                 .unload = unload_module,
1674                 .reload = reload,
1675                );
1676