pbx_lua.c File Reference

Lua PBX Switch. More...

#include "asterisk.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/term.h"
#include "asterisk/paths.h"
#include "asterisk/hashtab.h"
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h>

Include dependency graph for pbx_lua.c:

Go to the source code of this file.

Macros
#define	LUA_BUF_SIZE   4096
#define	LUA_EXT_DATA_SIZE   8192
#define	LUA_GOTO_DETECTED   5

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	canmatch (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
static int	exec (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
static int	exists (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
static int	load_module (void)
static int	load_or_reload_lua_stuff (void)
static int	lua_autoservice_start (lua_State *L)
	[lua_CFunction] Tell pbx_lua to maintain an autoservice on this channel (for access from lua, don't call directly) More...
static int	lua_autoservice_status (lua_State *L)
	[lua_CFunction] Get the status of the autoservice flag (for access from lua, don't call directly) More...
static int	lua_autoservice_stop (lua_State *L)
	[lua_CFunction] Tell pbx_lua to stop maintaning an autoservice on this channel (for access from lua, don't call directly) More...
static int	lua_check_hangup (lua_State *L)
	[lua_CFunction] Check if this channel has been hungup or not (for access from lua, don't call directly) More...
static void	lua_concat_args (lua_State *L, int start, int nargs)
	Concatenate a list of lua function arguments into a comma separated string. More...
static void	lua_create_app_table (lua_State *L)
	Create the global 'app' table for executing applications. More...
static void	lua_create_application_metatable (lua_State *L)
	Create the 'application' metatable, used to execute asterisk applications from lua. More...
static void	lua_create_autoservice_functions (lua_State *L)
	Create the autoservice functions. More...
static void	lua_create_channel_table (lua_State *L)
	Create the global 'channel' table for accesing channel variables. More...
static void	lua_create_hangup_function (lua_State *L)
	Create the hangup check function. More...
static void	lua_create_variable_metatable (lua_State *L)
	Create the 'variable' metatable, used to retrieve channel variables. More...
static void	lua_datastore_fixup (void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
	The fixup function for the lua_datastore. More...
static int	lua_error_function (lua_State *L)
	[lua_CFunction] Handle lua errors (for access from lua, don't call directly) More...
static int	lua_extension_cmp (lua_State *L)
	[lua_CFunction] Compare two extensions (for access from lua, don't call directly) More...
static int	lua_find_extension (lua_State *L, const char *context, const char *exten, int priority, ast_switch_f *func, int push_func)
	Locate an extensions and optionally push the matching function on the stack. More...
static void	lua_free_extensions ()
	Free the internal extensions buffer. More...
static int	lua_func_read (lua_State *L)
	[lua_CFunction] Create a 'variable' object for accessing a dialplan function (for access from lua, don't call directly) More...
static lua_State *	lua_get_state (struct ast_channel *chan)
	Get the lua_State for this channel. More...
static int	lua_get_variable (lua_State *L)
	[lua_CFunction] Return a lua 'variable' object (for access from lua, don't call directly) More...
static int	lua_get_variable_value (lua_State *L)
	[lua_CFunction] Used to get the value of a variable or dialplan function (for access from lua, don't call directly) More...
static int	lua_load_extensions (lua_State *L, struct ast_channel *chan)
	Load the extensions.lua file from the internal buffer. More...
static int	lua_pbx_exec (lua_State *L)
	[lua_CFunction] This function is part of the 'application' metatable and is used to execute applications similar to pbx_exec() (for access from lua, don't call directly) More...
static int	lua_pbx_findapp (lua_State *L)
	[lua_CFunction] Find an app and return it in a lua table (for access from lua, don't call directly) More...
static void	lua_push_variable_table (lua_State *L)
	Push a 'variable' table on the stack for access the channel variable with the given name. More...
static char *	lua_read_extensions_file (lua_State *L, long *size, int *file_not_openable)
	Load the extensions.lua file in to a buffer and execute the file. More...
static int	lua_register_hints (lua_State *L)
	Register dialplan hints for our pbx_lua contexs. More...
static int	lua_register_switches (lua_State *L)
	Register dialplan switches for our pbx_lua contexs. More...
static int	lua_reload_extensions (lua_State *L)
	Reload the extensions file and update the internal buffers if it loads correctly. More...
static int	lua_set_variable (lua_State *L)
	[lua_CFunction] Set the value of a channel variable or dialplan function (for access from lua, don't call directly) More...
static int	lua_set_variable_value (lua_State *L)
	[lua_CFunction] Used to set the value of a variable or dialplan function (for access from lua, don't call directly) More...
static int	lua_sort_extensions (lua_State *L)
	Store the sort order of each context. More...
static void	lua_state_destroy (void *data)
	The destructor for lua_datastore. More...
static void	lua_update_registry (lua_State *L, const char *context, const char *exten, int priority)
	Update the lua registry with the given context, exten, and priority. More...
static int	matchmore (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
static int	reload (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS , .description = "Lua PBX Switch" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static char *	config = "extensions.lua"
static char *	config_file_data = NULL
static ast_mutex_t	config_file_lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }
static long	config_file_size = 0
static struct ast_context *	local_contexts = NULL
static struct ast_hashtab *	local_table = NULL
static const struct ast_datastore_info	lua_datastore
static struct ast_switch	lua_switch
static char *	registrar = "pbx_lua"

Detailed Description

Lua PBX Switch.

Author

Matthew Nicholson mnich.nosp@m.olso.nosp@m.n@dig.nosp@m.ium..nosp@m.com

Definition in file pbx_lua.c.

Macro Definition Documentation

LUA_BUF_SIZE

#define LUA_BUF_SIZE   4096

Definition at line 56 of file pbx_lua.c.

Referenced by lua_get_variable(), and lua_get_variable_value().

LUA_EXT_DATA_SIZE

#define LUA_EXT_DATA_SIZE   8192

Definition at line 54 of file pbx_lua.c.

Referenced by lua_pbx_exec().

LUA_GOTO_DETECTED

#define LUA_GOTO_DETECTED   5

Definition at line 61 of file pbx_lua.c.

Referenced by exec(), and lua_pbx_exec().

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 1700 of file pbx_lua.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 1700 of file pbx_lua.c.

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 1700 of file pbx_lua.c.

canmatch()

static int canmatch ( struct ast_channel *  chan, const char *  context, const char *  exten, int  priority, const char *  callerid, const char *  data  )

static

Definition at line 1358 of file pbx_lua.c.

References ast_log, ast_module_user_add, ast_module_user_remove, LOG_ERROR, lua_find_extension(), and lua_get_state().

Referenced by lua_find_extension().

{
   int res;
   lua_State *L;
   struct ast_module_user *u = ast_module_user_add(chan);
   if (!u) {
      ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
      return 0;
   }

   L = lua_get_state(chan);
   if (!L) {
      ast_module_user_remove(u);
      return 0;
   }

   res = lua_find_extension(L, context, exten, priority, &canmatch, 0);

   if (!chan) lua_close(L);
   ast_module_user_remove(u);
   return res;
}

exec()

static int exec ( struct ast_channel *  chan, const char *  context, const char *  exten, int  priority, const char *  callerid, const char *  data  )

static

Definition at line 1405 of file pbx_lua.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_log, ast_module_user_add, ast_module_user_remove, error(), exists(), LOG_ERROR, lua_error_function(), lua_find_extension(), lua_get_state(), LUA_GOTO_DETECTED, and lua_update_registry().

{
   int res, error_func;
   lua_State *L;
   struct ast_module_user *u = ast_module_user_add(chan);
   if (!u) {
      ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
      return -1;
   }

   L = lua_get_state(chan);
   if (!L) {
      ast_module_user_remove(u);
      return -1;
   }

   lua_pushcfunction(L, &lua_error_function);
   error_func = lua_gettop(L);

   /* push the extension function onto the stack */
   if (!lua_find_extension(L, context, exten, priority, &exists, 1)) {
      lua_pop(L, 1); /* pop the debug function */
      ast_log(LOG_ERROR, "Could not find extension %s in context %s\n", exten, context);
      if (!chan) lua_close(L);
      ast_module_user_remove(u);
      return -1;
   }

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   if (lua_toboolean(L, -1)) {
      ast_autoservice_start(chan);
   }
   lua_pop(L, 1);

   lua_update_registry(L, context, exten, priority);

   lua_pushstring(L, context);
   lua_pushstring(L, exten);

   res = lua_pcall(L, 2, 0, error_func);
   if (res) {
      if (res == LUA_ERRRUN) {
         res = -1;
         if (lua_isnumber(L, -1)) {
            res = lua_tointeger(L, -1);

            if (res == LUA_GOTO_DETECTED) {
               res = 0;
            }
         } else if (lua_isstring(L, -1)) {
            const char *error = lua_tostring(L, -1);
            ast_log(LOG_ERROR, "Error executing lua extension: %s\n", error);
         }
      } else if (res == LUA_ERRERR) {
         res = -1;
         ast_log(LOG_ERROR, "Error in the lua error handler (this is probably a bug in pbx_lua)\n");
      } else if (res == LUA_ERRMEM) {
         res = -1;
         ast_log(LOG_ERROR, "Memory allocation error\n");
      }
      lua_pop(L, 1);
   }
   lua_remove(L, error_func);

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   if (lua_toboolean(L, -1)) {
      ast_autoservice_stop(chan);
   }
   lua_pop(L, 1);

   if (!chan) lua_close(L);
   ast_module_user_remove(u);
   return res;
}

exists()

static int exists ( struct ast_channel *  chan, const char *  context, const char *  exten, int  priority, const char *  callerid, const char *  data  )

static

Definition at line 1335 of file pbx_lua.c.

References ast_log, ast_module_user_add, ast_module_user_remove, LOG_ERROR, lua_find_extension(), and lua_get_state().

Referenced by exec().

{
   int res;
   lua_State *L;
   struct ast_module_user *u = ast_module_user_add(chan);
   if (!u) {
      ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
      return 0;
   }

   L = lua_get_state(chan);
   if (!L) {
      ast_module_user_remove(u);
      return 0;
   }

   res = lua_find_extension(L, context, exten, priority, &exists, 0);

   if (!chan) lua_close(L);
   ast_module_user_remove(u);
   return res;
}

load_module()

static int load_module ( void  )

static

Definition at line 1680 of file pbx_lua.c.

References ast_log, AST_MODFLAG_GLOBAL_SYMBOLS, AST_MODULE_INFO(), AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, AST_MODULE_SUPPORT_EXTENDED, ast_register_switch(), ASTERISK_GPL_KEY, load_or_reload_lua_stuff(), LOG_ERROR, reload(), and unload_module().

{
   int res;

   if ((res = load_or_reload_lua_stuff()))
      return res;

   if (ast_register_switch(&lua_switch)) {
      ast_log(LOG_ERROR, "Unable to register LUA PBX switch\n");
      return AST_MODULE_LOAD_FAILURE;
   }

   return AST_MODULE_LOAD_SUCCESS;
}

load_or_reload_lua_stuff()

static int load_or_reload_lua_stuff ( void  )

static

Definition at line 1640 of file pbx_lua.c.

References ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, error(), loaded, LOG_ERROR, and lua_reload_extensions().

Referenced by load_module(), and reload().

{
   int res = AST_MODULE_LOAD_SUCCESS;
   int loaded = 0;

   lua_State *L = luaL_newstate();
   if (!L) {
      ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
      return AST_MODULE_LOAD_FAILURE;
   }

   loaded = lua_reload_extensions(L);
   if (loaded) {
      const char *error = lua_tostring(L, -1);
      ast_log(LOG_ERROR, "Error loading extensions.lua: %s\n", error);

      if (loaded < 0) {
         res = AST_MODULE_LOAD_DECLINE;
      } else {
         res = AST_MODULE_LOAD_FAILURE;
      }
   }

   lua_close(L);
   return res;
}

lua_autoservice_start()

static int lua_autoservice_start ( lua_State *  L )

static

[lua_CFunction] Tell pbx_lua to maintain an autoservice on this channel (for access from lua, don't call directly)

Parameters

L	the lua_State to use

This function will set a flag that will cause pbx_lua to maintain an autoservice on this channel. The autoservice will automatically be stopped and restarted before calling applications and functions.

Definition at line 695 of file pbx_lua.c.

References ast_autoservice_start().

Referenced by lua_create_autoservice_functions().

{
   struct ast_channel *chan;

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   if (lua_toboolean(L, -1)) {
      /* autservice already running */
      lua_pop(L, 1);
      return 0;
   }
   lua_pop(L, 1);

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   ast_autoservice_start(chan);

   lua_pushboolean(L, 1);
   lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
   return 0;
}

lua_autoservice_status()

static int lua_autoservice_status ( lua_State *  L )

static

[lua_CFunction] Get the status of the autoservice flag (for access from lua, don't call directly)

Parameters

L	the lua_State to use

Returns

This function returns the status of the autoservice flag as a boolean to its lua caller.

Definition at line 760 of file pbx_lua.c.

Referenced by lua_create_autoservice_functions().

{
   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   return 1;
}

lua_autoservice_stop()

static int lua_autoservice_stop ( lua_State *  L )

static

[lua_CFunction] Tell pbx_lua to stop maintaning an autoservice on this channel (for access from lua, don't call directly)

Parameters

L	the lua_State to use

This function will stop any autoservice running and turn off the autoservice flag. If this function returns false, it's probably because no autoservice was running to begin with.

Definition at line 728 of file pbx_lua.c.

References ast_autoservice_stop().

Referenced by lua_create_autoservice_functions().

{
   struct ast_channel *chan;

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   if (!lua_toboolean(L, -1)) {
      /* no autservice running */
      lua_pop(L, 1);
      return 0;
   }
   lua_pop(L, 1);

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   ast_autoservice_stop(chan);

   lua_pushboolean(L, 0);
   lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
   return 0;
}

lua_check_hangup()

static int lua_check_hangup ( lua_State *  L )

static

[lua_CFunction] Check if this channel has been hungup or not (for access from lua, don't call directly)

Parameters

L	the lua_State to use

Returns

This function returns true if the channel was hungup

Definition at line 774 of file pbx_lua.c.

References ast_check_hangup().

Referenced by lua_create_hangup_function().

{
   struct ast_channel *chan;
   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   lua_pushboolean(L, ast_check_hangup(chan));
   return 1;
}

lua_concat_args()

static void lua_concat_args ( lua_State *  L, int  start, int  nargs  )

static

Concatenate a list of lua function arguments into a comma separated string.

Parameters

L	the lua_State to use
start	the index of the first argument
nargs	the number of args

The resulting string will be left on the top of the stack.

Definition at line 631 of file pbx_lua.c.

Referenced by lua_func_read(), and lua_pbx_exec().

                                                                {
   int concat = 0;
   int i = start + 1;

   if (start <= nargs && !lua_isnil(L, start)) {
      lua_pushvalue(L, start);
      concat += 1;
   }

   for (; i <= nargs; i++) {
      if (lua_isnil(L, i)) {
         lua_pushliteral(L, ",");
         concat += 1;
      } else {
         lua_pushliteral(L, ",");
         lua_pushvalue(L, i);
         concat += 2;
      }
   }

   lua_concat(L, concat);
}

lua_create_app_table()

static void lua_create_app_table ( lua_State *  L )

static

Create the global 'app' table for executing applications.

Parameters

L	the lua_State to use

Definition at line 445 of file pbx_lua.c.

References lua_pbx_findapp().

Referenced by lua_load_extensions().

{
   lua_newtable(L);
   luaL_newmetatable(L, "app");

   lua_pushstring(L, "__index");
   lua_pushcfunction(L, &lua_pbx_findapp);
   lua_settable(L, -3);

   lua_setmetatable(L, -2);
   lua_setglobal(L, "app");
}

lua_create_application_metatable()

static void lua_create_application_metatable ( lua_State *  L )

static

Create the 'application' metatable, used to execute asterisk applications from lua.

Parameters

L	the lua_State to use

Definition at line 502 of file pbx_lua.c.

References lua_pbx_exec().

Referenced by lua_load_extensions().

{
   luaL_newmetatable(L, "application");

   lua_pushstring(L, "__call");
   lua_pushcfunction(L, &lua_pbx_exec);
   lua_settable(L, -3);

   lua_pop(L, 1);
}

lua_create_autoservice_functions()

static void lua_create_autoservice_functions ( lua_State *  L )

static

Create the autoservice functions.

Parameters

L	the lua_State to use

Definition at line 518 of file pbx_lua.c.

References lua_autoservice_start(), lua_autoservice_status(), and lua_autoservice_stop().

Referenced by lua_load_extensions().

{
   lua_pushcfunction(L, &lua_autoservice_start);
   lua_setglobal(L, "autoservice_start");

   lua_pushcfunction(L, &lua_autoservice_stop);
   lua_setglobal(L, "autoservice_stop");

   lua_pushcfunction(L, &lua_autoservice_status);
   lua_setglobal(L, "autoservice_status");

   lua_pushboolean(L, 1);
   lua_setfield(L, LUA_REGISTRYINDEX, "autoservice");
}

lua_create_channel_table()

static void lua_create_channel_table ( lua_State *  L )

static

Create the global 'channel' table for accesing channel variables.

Parameters

L	the lua_State to use

Definition at line 463 of file pbx_lua.c.

References lua_get_variable(), and lua_set_variable().

Referenced by lua_load_extensions().

{
   lua_newtable(L);
   luaL_newmetatable(L, "channel_data");

   lua_pushstring(L, "__index");
   lua_pushcfunction(L, &lua_get_variable);
   lua_settable(L, -3);

   lua_pushstring(L, "__newindex");
   lua_pushcfunction(L, &lua_set_variable);
   lua_settable(L, -3);

   lua_setmetatable(L, -2);
   lua_setglobal(L, "channel");
}

lua_create_hangup_function()

static void lua_create_hangup_function ( lua_State *  L )

static

Create the hangup check function.

Parameters

L	the lua_State to use

Definition at line 538 of file pbx_lua.c.

References lua_check_hangup().

Referenced by lua_load_extensions().

{
   lua_pushcfunction(L, &lua_check_hangup);
   lua_setglobal(L, "check_hangup");
}

lua_create_variable_metatable()

static void lua_create_variable_metatable ( lua_State *  L )

static

Create the 'variable' metatable, used to retrieve channel variables.

Parameters

L	the lua_State to use

Definition at line 485 of file pbx_lua.c.

References lua_func_read().

Referenced by lua_load_extensions().

{
   luaL_newmetatable(L, "variable");

   lua_pushstring(L, "__call");
   lua_pushcfunction(L, &lua_func_read);
   lua_settable(L, -3);

   lua_pop(L, 1);
}

lua_datastore_fixup()

static void lua_datastore_fixup ( void *  data, struct ast_channel *  old_chan, struct ast_channel *  new_chan  )

static

The fixup function for the lua_datastore.

Parameters

data	the datastore data, in this case it will be a lua_State
old_chan	the channel we are moving from
new_chan	the channel we are moving to

This function updates our internal channel pointer.

Definition at line 137 of file pbx_lua.c.

{
   lua_State *L = data;
   lua_pushlightuserdata(L, new_chan);
   lua_setfield(L, LUA_REGISTRYINDEX, "channel");
}

lua_error_function()

static int lua_error_function ( lua_State *  L )

static

[lua_CFunction] Handle lua errors (for access from lua, don't call directly)

Parameters

L	the lua_State to use

Definition at line 791 of file pbx_lua.c.

Referenced by exec(), and lua_read_extensions_file().

{
   int message_index;

   /* pass number arguments right through back to asterisk*/
   if (lua_isnumber(L, -1)) {
      return 1;
   }

   /* if we are here then we have a string error message, let's attach a
    * backtrace to it */
   message_index = lua_gettop(L);

   /* prepare to prepend a new line to the traceback */
   lua_pushliteral(L, "\n");

   lua_getglobal(L, "debug");
   if (!lua_istable(L, -1)) {
      /* Have no 'debug' table for whatever reason */
      lua_pop(L, 2);
      /*  Original err message is on stack top now */
      return 1;
   }
   lua_getfield(L, -1, "traceback");
   if (!lua_isfunction(L, -1)) {
      /* Same here for traceback function */
      lua_pop(L, 3);
      /*  Original err message is on stack top now */
      return 1;
   }
   lua_remove(L, -2); /* remove the 'debug' table */

   lua_pushvalue(L, message_index);
   lua_remove(L, message_index);

   lua_pushnumber(L, 2);

   lua_call(L, 2, 1);

   /* prepend the new line we prepared above */
   lua_concat(L, 2);

   return 1;
}

lua_extension_cmp()

static int lua_extension_cmp ( lua_State *  L )

static

[lua_CFunction] Compare two extensions (for access from lua, don't call directly)

This function returns true if the first extension passed should match after the second. It behaves like the '<' operator.

Definition at line 1067 of file pbx_lua.c.

References a, ast_extension_cmp(), and b.

Referenced by lua_sort_extensions().

{
   const char *a = luaL_checkstring(L, -2);
   const char *b = luaL_checkstring(L, -1);

   if (ast_extension_cmp(a, b) == -1)
      lua_pushboolean(L, 1);
   else
      lua_pushboolean(L, 0);

   return 1;
}

lua_find_extension()

static int lua_find_extension ( lua_State *  L, const char *  context, const char *  exten, int  priority, ast_switch_f *  func, int  push_func  )

static

Locate an extensions and optionally push the matching function on the stack.

Parameters

L	the lua_State to use
context	the context to look in
exten	the extension to look up
priority	the priority to check, '1' is the only valid priority
func	the calling func, used to adjust matching behavior between, match, canmatch, and matchmore
push_func	whether or not to push the lua function for the given extension onto the stack

Definition at line 1493 of file pbx_lua.c.

References ast_debug, ast_extension_close(), ast_extension_match(), ast_log, c, canmatch(), E_CANMATCH, E_MATCHMORE, LOG_ERROR, match(), and matchmore().

Referenced by canmatch(), exec(), exists(), and matchmore().

{
   int context_table, context_order_table, i;

   ast_debug(2, "Looking up %s@%s:%i\n", exten, context, priority);
   if (priority != 1)
      return 0;

   /* load the 'extensions' table */
   lua_getglobal(L, "extensions");
   if (lua_isnil(L, -1)) {
      ast_log(LOG_ERROR, "Unable to find 'extensions' table in extensions.lua\n");
      lua_pop(L, 1);
      return 0;
   }

   /* load the given context */
   lua_getfield(L, -1, context);
   if (lua_isnil(L, -1)) {
      lua_pop(L, 2);
      return 0;
   }

   /* remove the extensions table */
   lua_remove(L, -2);

   context_table = lua_gettop(L);

   /* load the extensions order table for this context */
   lua_getfield(L, LUA_REGISTRYINDEX, "extensions_order");
   lua_getfield(L, -1, context);

   lua_remove(L, -2);  /* remove the extensions order table */

   context_order_table = lua_gettop(L);

   /* step through the extensions looking for a match */
#if LUA_VERSION_NUM < 502
   for (i = 1; i < lua_objlen(L, context_order_table) + 1; i++) {
#else
   for (i = 1; i < lua_rawlen(L, context_order_table) + 1; i++) {
#endif
      int e_index_copy, match = 0;
      const char *e;

      lua_pushinteger(L, i);
      lua_gettable(L, context_order_table);
      lua_gettop(L);

      /* copy the key at the top of the stack for use later */
      lua_pushvalue(L, -1);
      e_index_copy = lua_gettop(L);

      if (!(e = lua_tostring(L, e_index_copy))) {
         lua_pop(L, 2);
         continue;
      }

      /* make sure this is not the 'include' extension */
      if (!strcasecmp(e, "include")) {
         lua_pop(L, 2);
         continue;
      }

      if (func == &matchmore)
         match = ast_extension_close(e, exten, E_MATCHMORE);
      else if (func == &canmatch)
         match = ast_extension_close(e, exten, E_CANMATCH);
      else
         match = ast_extension_match(e, exten);

      /* the extension matching functions return 0 on fail, 1 on
       * match, 2 on earlymatch */

      if (!match) {
         /* pop the copy and the extension */
         lua_pop(L, 2);
         continue;   /* keep trying */
      }

      if (func == &matchmore && match == 2) {
         /* We match an extension ending in '!'. The decision in
          * this case is final and counts as no match. */
         lua_pop(L, 4);
         return 0;
      }

      /* remove the context table, the context order table, the
       * extension, and the extension copy (or replace the extension
       * with the corresponding function) */
      if (push_func) {
         lua_pop(L, 1);  /* pop the copy */
         lua_gettable(L, context_table);
         lua_insert(L, -3);
         lua_pop(L, 2);
      } else {
         lua_pop(L, 4);
      }

      return 1;
   }

   /* load the includes for this context */
   lua_getfield(L, context_table, "include");
   if (lua_isnil(L, -1)) {
      lua_pop(L, 3);
      return 0;
   }

   /* remove the context and the order table*/
   lua_remove(L, context_order_table);
   lua_remove(L, context_table);

   /* Now try any includes we have in this context */
   for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1)) {
      const char *c = lua_tostring(L, -1);
      if (!c)
         continue;

      if (lua_find_extension(L, c, exten, priority, func, push_func)) {
         /* remove the value, the key, and the includes table
          * from the stack.  Leave the function behind if
          * necessary */

         if (push_func)
            lua_insert(L, -4);

         lua_pop(L, 3);
         return 1;
      }
   }

   /* pop the includes table */
   lua_pop(L, 1);
   return 0;
}

lua_free_extensions()

static void lua_free_extensions ( void  )

static

Free the internal extensions buffer.

Definition at line 1252 of file pbx_lua.c.

References ast_free, ast_mutex_lock, ast_mutex_unlock, config_file_data, config_file_lock, and config_file_size.

Referenced by unload_module().

{
   ast_mutex_lock(&config_file_lock);
   config_file_size = 0;
   ast_free(config_file_data);
   ast_mutex_unlock(&config_file_lock);
}

lua_func_read()

static int lua_func_read ( lua_State *  L )

static

[lua_CFunction] Create a 'variable' object for accessing a dialplan function (for access from lua, don't call directly)

This function is called to create a 'variable' object to access a dialplan function. It would be called in the following example as would be seen in extensions.lua.

channel.func("arg1", "arg2", "arg3")

To actually do anything with the resulting value you must use the 'get()' and 'set()' methods (the reason is the resulting value is not a value, but an object in the form of a lua table).

Definition at line 670 of file pbx_lua.c.

References lua_concat_args(), and lua_push_variable_table().

Referenced by lua_create_variable_metatable().

{
   int nargs = lua_gettop(L);

   /* build a string in the form of "func_name(arg1,arg2,arg3)" */
   lua_getfield(L, 1, "name");
   lua_pushliteral(L, "(");
   lua_concat_args(L, 2, nargs);
   lua_pushliteral(L, ")");
   lua_concat(L, 4);

   lua_push_variable_table(L);
   return 1;
}

lua_get_state()

static lua_State * lua_get_state ( struct ast_channel *  chan )

static

Get the lua_State for this channel.

If no channel is passed then a new state is allocated. States with no channel assocatied with them should only be used for matching extensions. If the channel does not yet have a lua state associated with it, one will be created.

Note

If no channel was passed then the caller is expected to free the state using lua_close().

Returns

a lua_State

Definition at line 1273 of file pbx_lua.c.

References ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), ast_log, ast_datastore::data, error(), LOG_ERROR, lua_load_extensions(), and NULL.

Referenced by canmatch(), exec(), exists(), and matchmore().

{
   struct ast_datastore *datastore = NULL;
   lua_State *L;

   if (!chan) {
      L = luaL_newstate();
      if (!L) {
         ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
         return NULL;
      }

      if (lua_load_extensions(L, NULL)) {
         const char *error = lua_tostring(L, -1);
         ast_log(LOG_ERROR, "Error loading extensions.lua: %s\n", error);
         lua_close(L);
         return NULL;
      }
      return L;
   } else {
      ast_channel_lock(chan);
      datastore = ast_channel_datastore_find(chan, &lua_datastore, NULL);
      ast_channel_unlock(chan);

      if (!datastore) {
         /* nothing found, allocate a new lua state */
         datastore = ast_datastore_alloc(&lua_datastore, NULL);
         if (!datastore) {
            ast_log(LOG_ERROR, "Error allocation channel datastore for lua_State\n");
            return NULL;
         }

         datastore->data = luaL_newstate();
         if (!datastore->data) {
            ast_datastore_free(datastore);
            ast_log(LOG_ERROR, "Error allocating lua_State, no memory\n");
            return NULL;
         }

         ast_channel_lock(chan);
         ast_channel_datastore_add(chan, datastore);
         ast_channel_unlock(chan);

         L = datastore->data;

         if (lua_load_extensions(L, chan)) {
            const char *error = lua_tostring(L, -1);
            ast_log(LOG_ERROR, "Error loading extensions.lua for %s: %s\n", ast_channel_name(chan), error);

            ast_channel_lock(chan);
            ast_channel_datastore_remove(chan, datastore);
            ast_channel_unlock(chan);

            ast_datastore_free(datastore);
            return NULL;
         }
      }

      return datastore->data;
   }
}

lua_get_variable()

static int lua_get_variable ( lua_State *  L )

static

[lua_CFunction] Return a lua 'variable' object (for access from lua, don't call directly)

This function is called to lookup a variable construct a 'variable' object. It would be called in the following example as would be seen in extensions.lua.

channel.variable

Definition at line 556 of file pbx_lua.c.

References ast_alloca, ast_channel_varshead(), ast_strlen_zero, LUA_BUF_SIZE, lua_push_variable_table(), name, NULL, pbx_retrieve_variable(), and value.

Referenced by lua_create_channel_table().

{
   struct ast_channel *chan;
   const char *name = luaL_checkstring(L, 2);
   char *value = NULL;
   char *workspace = ast_alloca(LUA_BUF_SIZE);
   workspace[0] = '\0';

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   lua_pushvalue(L, 2);
   lua_push_variable_table(L);

   /* if this is not a request for a dialplan funciton attempt to retrieve
    * the value of the variable */
   if (!ast_strlen_zero(name) && name[strlen(name) - 1] != ')') {
      pbx_retrieve_variable(chan, name, &value, workspace, LUA_BUF_SIZE, ast_channel_varshead(chan));
   }

   if (value) {
      lua_pushstring(L, value);
      lua_setfield(L, -2, "value");
   }

   return 1;
}

lua_get_variable_value()

static int lua_get_variable_value ( lua_State *  L )

static

[lua_CFunction] Used to get the value of a variable or dialplan function (for access from lua, don't call directly)

The value of the variable or function is returned. This function is the 'get()' function in the following example as would be seen in extensions.lua.

channel.variable:get()

Definition at line 300 of file pbx_lua.c.

References ast_alloca, ast_autoservice_start(), ast_autoservice_stop(), ast_channel_varshead(), ast_func_read(), ast_strdupa, ast_strlen_zero, LUA_BUF_SIZE, name, NULL, pbx_retrieve_variable(), and value.

Referenced by lua_push_variable_table().

{
   struct ast_channel *chan;
   char *value = NULL, *name;
   char *workspace = ast_alloca(LUA_BUF_SIZE);
   int autoservice;

   workspace[0] = '\0';

   if (!lua_istable(L, 1)) {
      lua_pushstring(L, "User probably used '.' instead of ':' for retrieving a channel variable value");
      return lua_error(L);
   }

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   lua_getfield(L, 1, "name");
   name = ast_strdupa(lua_tostring(L, -1));
   lua_pop(L, 1);

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   autoservice = lua_toboolean(L, -1);
   lua_pop(L, 1);

   if (autoservice)
      ast_autoservice_stop(chan);

   /* if this is a dialplan function then use ast_func_read(), otherwise
    * use pbx_retrieve_variable() */
   if (!ast_strlen_zero(name) && name[strlen(name) - 1] == ')') {
      value = ast_func_read(chan, name, workspace, LUA_BUF_SIZE) ? NULL : workspace;
   } else {
      pbx_retrieve_variable(chan, name, &value, workspace, LUA_BUF_SIZE, ast_channel_varshead(chan));
   }

   if (autoservice)
      ast_autoservice_start(chan);

   if (value) {
      lua_pushstring(L, value);
   } else {
      lua_pushnil(L);
   }

   return 1;
}

lua_load_extensions()

static int lua_load_extensions ( lua_State *  L, struct ast_channel *  chan  )

static

Load the extensions.lua file from the internal buffer.

Parameters

L	the lua_State to use
chan	channel to work on

This function also sets up some constructs used by the extensions.lua file. In the event of an error, an error string will be pushed onto the lua stack.

Return values

0	success
1	failure

Definition at line 1170 of file pbx_lua.c.

References ast_mutex_lock, ast_mutex_unlock, config_file_data, config_file_lock, config_file_size, lua_create_app_table(), lua_create_application_metatable(), lua_create_autoservice_functions(), lua_create_channel_table(), lua_create_hangup_function(), lua_create_variable_metatable(), and lua_sort_extensions().

Referenced by lua_get_state().

{

   /* store a pointer to this channel */
   lua_pushlightuserdata(L, chan);
   lua_setfield(L, LUA_REGISTRYINDEX, "channel");

   luaL_openlibs(L);

   /* load and sort extensions */
   ast_mutex_lock(&config_file_lock);
   if (luaL_loadbuffer(L, config_file_data, config_file_size, "extensions.lua")
         || lua_pcall(L, 0, LUA_MULTRET, 0)
         || lua_sort_extensions(L)) {
      ast_mutex_unlock(&config_file_lock);
      return 1;
   }
   ast_mutex_unlock(&config_file_lock);

   /* now we setup special tables and functions */

   lua_create_app_table(L);
   lua_create_channel_table(L);

   lua_create_variable_metatable(L);
   lua_create_application_metatable(L);

   lua_create_autoservice_functions(L);
   lua_create_hangup_function(L);

   return 0;
}

lua_pbx_exec()

static int lua_pbx_exec ( lua_State *  L )

static

[lua_CFunction] This function is part of the 'application' metatable and is used to execute applications similar to pbx_exec() (for access from lua, don't call directly)

Parameters

L	the lua_State to use

Returns

nothing

This funciton is executed as the '()' operator for apps accessed through the 'app' table.

app.playback('demo-congrats')

Definition at line 186 of file pbx_lua.c.

References app, app_name(), ast_autoservice_start(), ast_autoservice_stop(), ast_channel_context(), ast_channel_exten(), ast_channel_name(), ast_channel_priority(), ast_debug, ast_strdupa, ast_verb, COLOR_BRCYAN, COLOR_BRMAGENTA, context, exten, lua_concat_args(), LUA_EXT_DATA_SIZE, LUA_GOTO_DETECTED, lua_update_registry(), pbx_exec(), pbx_findapp(), priority, term_color(), and tmp().

Referenced by lua_create_application_metatable().

{
   int res, nargs = lua_gettop(L);
   const char *data = "";
   char *app_name, *context, *exten;
   char tmp[80], tmp2[80], tmp3[LUA_EXT_DATA_SIZE];
   int priority, autoservice;
   struct ast_app *app;
   struct ast_channel *chan;

   lua_getfield(L, 1, "name");
   app_name = ast_strdupa(lua_tostring(L, -1));
   lua_pop(L, 1);

   if (!(app = pbx_findapp(app_name))) {
      lua_pushstring(L, "application '");
      lua_pushstring(L, app_name);
      lua_pushstring(L, "' not found");
      lua_concat(L, 3);
      return lua_error(L);
   }


   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   context = ast_strdupa(ast_channel_context(chan));
   exten = ast_strdupa(ast_channel_exten(chan));
   priority = ast_channel_priority(chan);

   lua_concat_args(L, 2, nargs);
   data = lua_tostring(L, -1);

   ast_verb(3, "Executing [%s@%s:%d] %s(\"%s\", \"%s\")\n",
         exten, context, priority,
         term_color(tmp, app_name, COLOR_BRCYAN, 0, sizeof(tmp)),
         term_color(tmp2, ast_channel_name(chan), COLOR_BRMAGENTA, 0, sizeof(tmp2)),
         term_color(tmp3, data, COLOR_BRMAGENTA, 0, sizeof(tmp3)));

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   autoservice = lua_toboolean(L, -1);
   lua_pop(L, 1);

   if (autoservice)
      ast_autoservice_stop(chan);

   res = pbx_exec(chan, app, data);

   lua_pop(L, 1); /* pop data */
   data = "";

   if (autoservice)
      ast_autoservice_start(chan);

   /* error executing an application, report it */
   if (res) {
      lua_pushinteger(L, res);
      return lua_error(L);
   }

   if (strcmp(context, ast_channel_context(chan))) {
      lua_pushstring(L, context);
      lua_pushstring(L, ast_channel_context(chan));
      lua_pushliteral(L, "context");
   } else if (strcmp(exten, ast_channel_exten(chan))) {
      lua_pushstring(L, exten);
      lua_pushstring(L, ast_channel_exten(chan));
      lua_pushliteral(L, "exten");
   } else if (priority != ast_channel_priority(chan)) {
      lua_pushinteger(L, priority);
      lua_pushinteger(L, ast_channel_priority(chan));
      lua_pushliteral(L, "priority");
   } else {
      /* no goto - restore the original position back
       * to lua state, in case this was a recursive dialplan
       * call (a dialplan application re-entering dialplan) */
      lua_update_registry(L, context, exten, priority);
      return 0;
   }

   /* goto detected - construct error message */
   lua_insert(L, -3);

   lua_pushliteral(L, " changed from ");
   lua_insert(L, -3);

   lua_pushliteral(L, " to ");
   lua_insert(L, -2);

   lua_concat(L, 5);

   ast_debug(2, "Goto detected: %s\n", lua_tostring(L, -1));
   lua_pop(L, 1);

   /* let the lua engine know it needs to return control to the pbx */
   lua_pushinteger(L, LUA_GOTO_DETECTED);
   lua_error(L);

   return 0;
}

lua_pbx_findapp()

static int lua_pbx_findapp ( lua_State *  L )

static

[lua_CFunction] Find an app and return it in a lua table (for access from lua, don't call directly)

This function would be called in the following example as it would be found in extensions.lua.

app.dial

Definition at line 155 of file pbx_lua.c.

References app_name().

Referenced by lua_create_app_table().

{
   const char *app_name = luaL_checkstring(L, 2);

   lua_newtable(L);

   lua_pushstring(L, "name");
   lua_pushstring(L, app_name);
   lua_settable(L, -3);

   luaL_getmetatable(L, "application");
   lua_setmetatable(L, -2);

   return 1;
}

lua_push_variable_table()

static void lua_push_variable_table ( lua_State *  L )

static

Push a 'variable' table on the stack for access the channel variable with the given name.

The value on the top of the stack is popped and used as the name.

Parameters

L	the lua_State to use

Definition at line 424 of file pbx_lua.c.

References lua_get_variable_value(), and lua_set_variable_value().

Referenced by lua_func_read(), and lua_get_variable().

{
   lua_newtable(L);
   luaL_getmetatable(L, "variable");
   lua_setmetatable(L, -2);

   lua_insert(L, -2); /* move the table after the name */
   lua_setfield(L, -2, "name");

   lua_pushcfunction(L, &lua_get_variable_value);
   lua_setfield(L, -2, "get");

   lua_pushcfunction(L, &lua_set_variable_value);
   lua_setfield(L, -2, "set");
}

lua_read_extensions_file()

static char * lua_read_extensions_file ( lua_State *  L, long *  size, int *  file_not_openable  )

static

Load the extensions.lua file in to a buffer and execute the file.

Parameters

L	the lua_State to use
size	a pointer to store the size of the buffer
file_not_openable	a pointer to store if config file could be opened

Note

The caller is expected to free the buffer at some point.

Returns

a pointer to the buffer

Definition at line 1091 of file pbx_lua.c.

References ast_alloca, ast_config_AST_CONFIG_DIR, ast_free, ast_malloc, config, errno, lua_error_function(), lua_register_hints(), lua_register_switches(), lua_sort_extensions(), and NULL.

Referenced by lua_reload_extensions().

{
   FILE *f;
   int error_func;
   char *data;
   char *path = ast_alloca(strlen(config) + strlen(ast_config_AST_CONFIG_DIR) + 2);
   sprintf(path, "%s/%s", ast_config_AST_CONFIG_DIR, config);

   if (!(f = fopen(path, "r"))) {
      lua_pushstring(L, "cannot open '");
      lua_pushstring(L, path);
      lua_pushstring(L, "' for reading: ");
      lua_pushstring(L, strerror(errno));
      lua_concat(L, 4);

      *file_not_openable = 1;

      return NULL;
   }

   if (fseek(f, 0l, SEEK_END)) {
      fclose(f);
      lua_pushliteral(L, "error determining the size of the config file");
      return NULL;
   }

   *size = ftell(f);

   if (fseek(f, 0l, SEEK_SET)) {
      *size = 0;
      fclose(f);
      lua_pushliteral(L, "error reading config file");
      return NULL;
   }

   if (!(data = ast_malloc(*size))) {
      *size = 0;
      fclose(f);
      lua_pushstring(L, "not enough memory");
      return NULL;
   }

   if (fread(data, sizeof(char), *size, f) != *size) {
      *size = 0;
      fclose(f);
      lua_pushliteral(L, "problem reading configuration file");
      return NULL;
   }
   fclose(f);

   lua_pushcfunction(L, &lua_error_function);
   error_func = lua_gettop(L);

   if (luaL_loadbuffer(L, data, *size, "extensions.lua")
         || lua_pcall(L, 0, LUA_MULTRET, error_func)
         || lua_sort_extensions(L)
         || lua_register_switches(L)
         || lua_register_hints(L)) {
      ast_free(data);
      data = NULL;
      *size = 0;
   }

   lua_remove(L, error_func);
   return data;
}

lua_register_hints()

static int lua_register_hints ( lua_State *  L )

static

Register dialplan hints for our pbx_lua contexs.

In the event of an error, an error string will be pushed onto the lua stack.

Return values

0	success
1	failure

Definition at line 987 of file pbx_lua.c.

References ast_add_extension2(), ast_context_find_or_create(), ast_hashtab_compare_contexts(), ast_hashtab_create, ast_hashtab_hash_contexts(), ast_hashtab_newsize_java(), ast_hashtab_resize_java(), context, context_name, hints, NULL, PRIORITY_HINT, and registrar.

Referenced by lua_read_extensions_file().

{
   int hints;
   struct ast_context *con = NULL;

   /* create the hash table for our contexts */
   /* XXX do we ever need to destroy this? pbx_config does not */
   if (!local_table)
      local_table = ast_hashtab_create(17, ast_hashtab_compare_contexts, ast_hashtab_resize_java, ast_hashtab_newsize_java, ast_hashtab_hash_contexts, 0);

   /* load the 'hints' table */
   lua_getglobal(L, "hints");
   hints = lua_gettop(L);
   if (lua_isnil(L, -1)) {
      /* hints table not found, move along */
      lua_pop(L, 1);
      return 0;
   }

   /* iterate through the hints table and register each context and
    * the hints that go along with it
    */
   for (lua_pushnil(L); lua_next(L, hints); lua_pop(L, 1)) {
      int context = lua_gettop(L);
      int context_name = context - 1;
      const char *context_str = lua_tostring(L, context_name);

      /* find or create this context */
      con = ast_context_find_or_create(&local_contexts, local_table, context_str, registrar);
      if (!con) {
         /* remove hints table and context key and value */
         lua_pop(L, 3);
         lua_pushstring(L, "Failed to find or create context\n");
         return 1;
      }

      /* register each hint */
      for (lua_pushnil(L); lua_next(L, context); lua_pop(L, 1)) {
         const char *hint_value = lua_tostring(L, -1);
         const char *hint_name;

         /* the hint value is not a string, ignore it */
         if (!hint_value) {
            continue;
         }

         /* copy the name then convert it to a string */
         lua_pushvalue(L, -2);
         if (!(hint_name = lua_tostring(L, -1))) {
            /* ignore non-string value */
            lua_pop(L, 1);
            continue;
         }

         if (ast_add_extension2(con, 0, hint_name, PRIORITY_HINT, NULL, NULL, hint_value, NULL, NULL, registrar, NULL, 0)) {
            /* remove hints table, hint name, hint value,
             * key copy, context name, and contex table */
            lua_pop(L, 6);
            lua_pushstring(L, "Error creating hint\n");
            return 1;
         }

         /* pop the name copy */
         lua_pop(L, 1);
      }
   }

   /* remove the hints table */
   lua_pop(L, 1);

   return 0;
}

lua_register_switches()

static int lua_register_switches ( lua_State *  L )

static

Register dialplan switches for our pbx_lua contexs.

In the event of an error, an error string will be pushed onto the lua stack.

Return values

0	success
1	failure

Definition at line 929 of file pbx_lua.c.

References ast_context_add_switch2(), ast_context_find_or_create(), ast_hashtab_compare_contexts(), ast_hashtab_create, ast_hashtab_hash_contexts(), ast_hashtab_newsize_java(), ast_hashtab_resize_java(), context, context_name, NULL, and registrar.

Referenced by lua_read_extensions_file().

{
   int extensions;
   struct ast_context *con = NULL;

   /* create the hash table for our contexts */
   /* XXX do we ever need to destroy this? pbx_config does not */
   if (!local_table)
      local_table = ast_hashtab_create(17, ast_hashtab_compare_contexts, ast_hashtab_resize_java, ast_hashtab_newsize_java, ast_hashtab_hash_contexts, 0);

   /* load the 'extensions' table */
   lua_getglobal(L, "extensions");
   extensions = lua_gettop(L);
   if (lua_isnil(L, -1)) {
      lua_pop(L, 1);
      lua_pushstring(L, "Unable to find 'extensions' table in extensions.lua\n");
      return 1;
   }

   /* iterate through the extensions table and register a context and
    * dialplan switch for each lua context
    */
   for (lua_pushnil(L); lua_next(L, extensions); lua_pop(L, 1)) {
      int context = lua_gettop(L);
      int context_name = context - 1;
      const char *context_str = lua_tostring(L, context_name);

      /* find or create this context */
      con = ast_context_find_or_create(&local_contexts, local_table, context_str, registrar);
      if (!con) {
         /* remove extensions table and context key and value */
         lua_pop(L, 3);
         lua_pushstring(L, "Failed to find or create context\n");
         return 1;
      }

      /* register the switch */
      if (ast_context_add_switch2(con, "Lua", "", 0, registrar)) {
         /* remove extensions table and context key and value */
         lua_pop(L, 3);
         lua_pushstring(L, "Unable to create switch for context\n");
         return 1;
      }
   }

   /* remove the extensions table */
   lua_pop(L, 1);
   return 0;
}

lua_reload_extensions()

static int lua_reload_extensions ( lua_State *  L )

static

Reload the extensions file and update the internal buffers if it loads correctly.

Warning

This function should not be called on a lua_State returned from lua_get_state().

Parameters

L	the lua_State to use (must be freshly allocated with luaL_newstate(), don't use lua_get_state())

Definition at line 1213 of file pbx_lua.c.

References ast_free, ast_merge_contexts_and_delete(), ast_mutex_lock, ast_mutex_unlock, config_file_data, config_file_lock, config_file_size, lua_read_extensions_file(), NULL, and registrar.

Referenced by load_or_reload_lua_stuff().

{
   long size = 0;
   char *data = NULL;
   int file_not_openable = 0;

   luaL_openlibs(L);

   if (!(data = lua_read_extensions_file(L, &size, &file_not_openable))) {
      if (file_not_openable) {
         return -1;
      }
      return 1;
   }

   ast_mutex_lock(&config_file_lock);

   if (config_file_data)
      ast_free(config_file_data);

   config_file_data = data;
   config_file_size = size;

   /* merge our new contexts */
   ast_merge_contexts_and_delete(&local_contexts, local_table, registrar);
   /* merge_contexts_and_delete will actually, at the correct moment,
      set the global dialplan pointers to your local_contexts and local_table.
      It then will free up the old tables itself. Just be sure not to
      hang onto the pointers. */
   local_table = NULL;
   local_contexts = NULL;

   ast_mutex_unlock(&config_file_lock);
   return 0;
}

lua_set_variable()

static int lua_set_variable ( lua_State *  L )

static

[lua_CFunction] Set the value of a channel variable or dialplan function (for access from lua, don't call directly)

This function is called to set a variable or dialplan function. It would be called in the following example as would be seen in extensions.lua.

channel.variable = "value"

Definition at line 596 of file pbx_lua.c.

References ast_autoservice_start(), ast_autoservice_stop(), name, pbx_builtin_setvar_helper(), and value.

Referenced by lua_create_channel_table().

{
   struct ast_channel *chan;
   int autoservice;
   const char *name = luaL_checkstring(L, 2);
   const char *value = luaL_checkstring(L, 3);

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   autoservice = lua_toboolean(L, -1);
   lua_pop(L, 1);

   if (autoservice)
      ast_autoservice_stop(chan);

   pbx_builtin_setvar_helper(chan, name, value);

   if (autoservice)
      ast_autoservice_start(chan);

   return 0;
}

lua_set_variable_value()

static int lua_set_variable_value ( lua_State *  L )

static

[lua_CFunction] Used to set the value of a variable or dialplan function (for access from lua, don't call directly)

This function is the 'set()' function in the following example as would be seen in extensions.lua.

channel.variable:set("value")

Definition at line 360 of file pbx_lua.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_strdupa, name, pbx_builtin_setvar_helper(), and value.

Referenced by lua_push_variable_table().

{
   const char *name, *value;
   struct ast_channel *chan;
   int autoservice;

   if (!lua_istable(L, 1)) {
      lua_pushstring(L, "User probably used '.' instead of ':' for setting a channel variable");
      return lua_error(L);
   }

   lua_getfield(L, 1, "name");
   name = ast_strdupa(lua_tostring(L, -1));
   lua_pop(L, 1);

   value = luaL_checkstring(L, 2);

   lua_getfield(L, LUA_REGISTRYINDEX, "channel");
   chan = lua_touserdata(L, -1);
   lua_pop(L, 1);

   lua_getfield(L, LUA_REGISTRYINDEX, "autoservice");
   autoservice = lua_toboolean(L, -1);
   lua_pop(L, 1);

   if (autoservice)
      ast_autoservice_stop(chan);

   pbx_builtin_setvar_helper(chan, name, value);

   if (autoservice)
      ast_autoservice_start(chan);

   return 0;
}

lua_sort_extensions()

static int lua_sort_extensions ( lua_State *  L )

static

Store the sort order of each context.

In the event of an error, an error string will be pushed onto the lua stack.

Return values

0	success
1	failure

Definition at line 844 of file pbx_lua.c.

References context, context_name, exten, and lua_extension_cmp().

Referenced by lua_load_extensions(), and lua_read_extensions_file().

{
   int extensions, extensions_order;

   /* create the extensions_order table */
   lua_newtable(L);
   lua_setfield(L, LUA_REGISTRYINDEX, "extensions_order");
   lua_getfield(L, LUA_REGISTRYINDEX, "extensions_order");
   extensions_order = lua_gettop(L);

   /* sort each context in the extensions table */
   /* load the 'extensions' table */
   lua_getglobal(L, "extensions");
   extensions = lua_gettop(L);
   if (lua_isnil(L, -1)) {
      lua_pop(L, 1);
      lua_pushstring(L, "Unable to find 'extensions' table in extensions.lua\n");
      return 1;
   }

   /* iterate through the extensions table and create a
    * matching table (holding the sort order) in the
    * extensions_order table for each context that is found
    */
   for (lua_pushnil(L); lua_next(L, extensions); lua_pop(L, 1)) {
      int context = lua_gettop(L);
      int context_name = context - 1;
      int context_order;

      /* copy the context_name to be used as the key for the
       * context_order table in the extensions_order table later */
      lua_pushvalue(L, context_name);

      /* create the context_order table */
      lua_newtable(L);
      context_order = lua_gettop(L);

      /* iterate through this context an popluate the corrisponding
       * table in the extensions_order table */
      for (lua_pushnil(L); lua_next(L, context); lua_pop(L, 1)) {
         int exten = lua_gettop(L) - 1;
#if LUA_VERSION_NUM < 502
         lua_pushinteger(L, lua_objlen(L, context_order) + 1);
#else
         lua_pushinteger(L, lua_rawlen(L, context_order) + 1);
#endif
         lua_pushvalue(L, exten);
         lua_settable(L, context_order);
      }
      lua_settable(L, extensions_order); /* put the context_order table in the extensions_order table */

      /* now sort the new table */

      /* push the table.sort function */
      lua_getglobal(L, "table");
      lua_getfield(L, -1, "sort");
      lua_remove(L, -2); /* remove the 'table' table */

      /* push the context_order table */
      lua_pushvalue(L, context_name);
      lua_gettable(L, extensions_order);

      /* push the comp function */
      lua_pushcfunction(L, &lua_extension_cmp);

      if (lua_pcall(L, 2, 0, 0)) {
         lua_insert(L, -5);
         lua_pop(L, 4);
         return 1;
      }
   }

   /* remove the extensions table and the extensions_order table */
   lua_pop(L, 2);
   return 0;
}

lua_state_destroy()

static void lua_state_destroy ( void *  data )

static

The destructor for lua_datastore.

Definition at line 123 of file pbx_lua.c.

{
   if (data)
      lua_close(data);
}

lua_update_registry()

static void lua_update_registry ( lua_State *  L, const char *  context, const char *  exten, int  priority  )

static

Update the lua registry with the given context, exten, and priority.

Parameters

L	the lua_State to use
context	the new context
exten	the new exten
priority	the new priority

Definition at line 404 of file pbx_lua.c.

Referenced by exec(), and lua_pbx_exec().

{
   lua_pushstring(L, context);
   lua_setfield(L, LUA_REGISTRYINDEX, "context");

   lua_pushstring(L, exten);
   lua_setfield(L, LUA_REGISTRYINDEX, "exten");

   lua_pushinteger(L, priority);
   lua_setfield(L, LUA_REGISTRYINDEX, "priority");
}

matchmore()

static int matchmore ( struct ast_channel *  chan, const char *  context, const char *  exten, int  priority, const char *  callerid, const char *  data  )

static

Definition at line 1381 of file pbx_lua.c.

References ast_log, ast_module_user_add, ast_module_user_remove, LOG_ERROR, lua_find_extension(), and lua_get_state().

Referenced by complete_dpreply(), and lua_find_extension().

{
   int res;
   lua_State *L;
   struct ast_module_user *u = ast_module_user_add(chan);
   if (!u) {
      ast_log(LOG_ERROR, "Error adjusting use count, probably could not allocate memory\n");
      return 0;
   }

   L = lua_get_state(chan);
   if (!L) {
      ast_module_user_remove(u);
      return 0;
   }

   res = lua_find_extension(L, context, exten, priority, &matchmore, 0);

   if (!chan) lua_close(L);
   ast_module_user_remove(u);
   return res;
}

reload()

static int reload ( void  )

static

Definition at line 1675 of file pbx_lua.c.

References load_or_reload_lua_stuff().

Referenced by load_module().

{
   return load_or_reload_lua_stuff();
}

unload_module()

static int unload_module ( void  )

static

Definition at line 1667 of file pbx_lua.c.

References ast_context_destroy(), ast_unregister_switch(), lua_free_extensions(), NULL, and registrar.

Referenced by load_module().

{
   ast_context_destroy(NULL, registrar);
   ast_unregister_switch(&lua_switch);
   lua_free_extensions();
   return 0;
}

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS , .description = "Lua PBX Switch" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, }

static

Definition at line 1700 of file pbx_lua.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 1700 of file pbx_lua.c.

config

char* config = "extensions.lua"

static

Definition at line 48 of file pbx_lua.c.

Referenced by lua_read_extensions_file().

config_file_data

char* config_file_data = NULL

static

Definition at line 107 of file pbx_lua.c.

Referenced by lua_free_extensions(), lua_load_extensions(), and lua_reload_extensions().

config_file_lock

ast_mutex_t config_file_lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }

static

Definition at line 106 of file pbx_lua.c.

Referenced by lua_free_extensions(), lua_load_extensions(), and lua_reload_extensions().

config_file_size

long config_file_size = 0

static

Definition at line 108 of file pbx_lua.c.

Referenced by lua_free_extensions(), lua_load_extensions(), and lua_reload_extensions().

local_contexts

struct ast_context* local_contexts = NULL

static

Definition at line 110 of file pbx_lua.c.

local_table

struct ast_hashtab* local_table = NULL

static

Definition at line 111 of file pbx_lua.c.

lua_datastore

const struct ast_datastore_info lua_datastore

static

Initial value:

= {
   .type = "lua",
   .destroy = lua_state_destroy,
   .chan_fixup = lua_datastore_fixup,
}

Definition at line 113 of file pbx_lua.c.

lua_switch

struct ast_switch lua_switch

static

Definition at line 1630 of file pbx_lua.c.

registrar

char* registrar = "pbx_lua"

static

Definition at line 49 of file pbx_lua.c.

Referenced by lua_register_hints(), lua_register_switches(), lua_reload_extensions(), and unload_module().