51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#include <stdio.h>
-#include <cstdarg>
-
-extern "C" {
-#include "lua.h"
-#include "lauxlib.h"
-}
-
#include "cpp_api/s_base.h"
+#include "cpp_api/s_internal.h"
+#include "cpp_api/s_security.h"
#include "lua_api/l_object.h"
+#include "common/c_converter.h"
#include "serverobject.h"
+#include "filesys.h"
+#include "content/mods.h"
+#include "porting.h"
+#include "util/string.h"
+#include "server.h"
+#ifndef SERVER
+#include "client/client.h"
+#endif
+
-ScriptApiBase::ScriptApiBase() :
- m_luastackmutex(),
-#ifdef LOCK_DEBUG
- m_locked(false),
+extern "C" {
+#include "lualib.h"
+#if USE_LUAJIT
+ #include "luajit.h"
#endif
- m_luastack(0),
- m_server(0),
- m_environment(0)
+}
+
+#include <cstdio>
+#include <cstdarg>
+#include "script/common/c_content.h"
+#include "content_sao.h"
+#include <sstream>
+
+
+class ModNameStorer
{
+private:
+ lua_State *L;
+public:
+ ModNameStorer(lua_State *L_, const std::string &mod_name):
+ L(L_)
+ {
+ // Store current mod name in registry
+ lua_pushstring(L, mod_name.c_str());
+ lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
+ }
+ ~ModNameStorer()
+ {
+ // Clear current mod name from registry
+ lua_pushnil(L);
+ lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
+ }
+};
+
+
+/*
+ ScriptApiBase
+*/
+
+ScriptApiBase::ScriptApiBase(ScriptingType type):
+ m_type(type)
+{
+#ifdef SCRIPTAPI_LOCK_DEBUG
+ m_lock_recursion_count = 0;
+#endif
+
+ m_luastack = luaL_newstate();
+ FATAL_ERROR_IF(!m_luastack, "luaL_newstate() failed");
+
+ lua_atpanic(m_luastack, &luaPanic);
+
+ if (m_type == ScriptingType::Client)
+ clientOpenLibs(m_luastack);
+ else
+ luaL_openlibs(m_luastack);
+
+ // Make the ScriptApiBase* accessible to ModApiBase
+ lua_pushlightuserdata(m_luastack, this);
+ lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
+
+ // Add and save an error handler
+ lua_getglobal(m_luastack, "debug");
+ lua_getfield(m_luastack, -1, "traceback");
+ lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_BACKTRACE);
+ lua_pop(m_luastack, 1); // pop debug
+ // If we are using LuaJIT add a C++ wrapper function to catch
+ // exceptions thrown in Lua -> C++ calls
+#if USE_LUAJIT
+ lua_pushlightuserdata(m_luastack, (void*) script_exception_wrapper);
+ luaJIT_setmode(m_luastack, -1, LUAJIT_MODE_WRAPCFUNC | LUAJIT_MODE_ON);
+ lua_pop(m_luastack, 1);
+#endif
+
+ // Add basic globals
+ lua_newtable(m_luastack);
+ lua_setglobal(m_luastack, "core");
+
+ if (m_type == ScriptingType::Client)
+ lua_pushstring(m_luastack, "/");
+ else
+ lua_pushstring(m_luastack, DIR_DELIM);
+ lua_setglobal(m_luastack, "DIR_DELIM");
+
+ lua_pushstring(m_luastack, porting::getPlatformName());
+ lua_setglobal(m_luastack, "PLATFORM");
+
+ // Make sure Lua uses the right locale
+ setlocale(LC_NUMERIC, "C");
}
+ScriptApiBase::~ScriptApiBase()
+{
+ lua_close(m_luastack);
+}
-void ScriptApiBase::realityCheck()
+int ScriptApiBase::luaPanic(lua_State *L)
{
- int top = lua_gettop(m_luastack);
- if(top >= 30){
- dstream<<"Stack is over 30:"<<std::endl;
- stackDump(dstream);
- scriptError("Stack is over 30 (reality check)");
+ std::ostringstream oss;
+ oss << "LUA PANIC: unprotected error in call to Lua API ("
+ << readParam<std::string>(L, -1) << ")";
+ FATAL_ERROR(oss.str().c_str());
+ // NOTREACHED
+ return 0;
+}
+
+void ScriptApiBase::clientOpenLibs(lua_State *L)
+{
+ static const std::vector<std::pair<std::string, lua_CFunction>> m_libs = {
+ { "", luaopen_base },
+ { LUA_TABLIBNAME, luaopen_table },
+ { LUA_OSLIBNAME, luaopen_os },
+ { LUA_STRLIBNAME, luaopen_string },
+ { LUA_MATHLIBNAME, luaopen_math },
+ { LUA_DBLIBNAME, luaopen_debug },
+#if USE_LUAJIT
+ { LUA_JITLIBNAME, luaopen_jit },
+#endif
+ };
+
+ for (const std::pair<std::string, lua_CFunction> &lib : m_libs) {
+ lua_pushcfunction(L, lib.second);
+ lua_pushstring(L, lib.first.c_str());
+ lua_call(L, 1, 0);
}
}
-void ScriptApiBase::scriptError(const char *fmt, ...)
+void ScriptApiBase::loadMod(const std::string &script_path,
+ const std::string &mod_name)
{
- va_list argp;
- va_start(argp, fmt);
- char buf[10000];
- vsnprintf(buf, 10000, fmt, argp);
- va_end(argp);
- //errorstream<<"SCRIPT ERROR: "<<buf;
- throw LuaError(m_luastack, buf);
+ ModNameStorer mod_name_storer(getStack(), mod_name);
+
+ loadScript(script_path);
}
-void ScriptApiBase::stackDump(std::ostream &o)
+void ScriptApiBase::loadScript(const std::string &script_path)
+{
+ verbosestream << "Loading and running script from " << script_path << std::endl;
+
+ lua_State *L = getStack();
+
+ int error_handler = PUSH_ERROR_HANDLER(L);
+
+ bool ok;
+ if (m_secure) {
+ ok = ScriptApiSecurity::safeLoadFile(L, script_path.c_str());
+ } else {
+ ok = !luaL_loadfile(L, script_path.c_str());
+ }
+ ok = ok && !lua_pcall(L, 0, 0, error_handler);
+ if (!ok) {
+ std::string error_msg = readParam<std::string>(L, -1);
+ lua_pop(L, 2); // Pop error message and error handler
+ throw ModError("Failed to load and run script from " +
+ script_path + ":\n" + error_msg);
+ }
+ lua_pop(L, 1); // Pop error handler
+}
+
+#ifndef SERVER
+void ScriptApiBase::loadModFromMemory(const std::string &mod_name)
{
- int i;
- int top = lua_gettop(m_luastack);
- for (i = 1; i <= top; i++) { /* repeat for each level */
- int t = lua_type(m_luastack, i);
- switch (t) {
-
- case LUA_TSTRING: /* strings */
- o<<"\""<<lua_tostring(m_luastack, i)<<"\"";
- break;
-
- case LUA_TBOOLEAN: /* booleans */
- o<<(lua_toboolean(m_luastack, i) ? "true" : "false");
- break;
-
- case LUA_TNUMBER: /* numbers */ {
- char buf[10];
- snprintf(buf, 10, "%g", lua_tonumber(m_luastack, i));
- o<<buf;
- break; }
-
- default: /* other values */
- o<<lua_typename(m_luastack, t);
- break;
+ ModNameStorer mod_name_storer(getStack(), mod_name);
+
+ const std::string *init_filename = getClient()->getModFile(mod_name + ":init.lua");
+ const std::string display_filename = mod_name + ":init.lua";
+ if(init_filename == NULL)
+ throw ModError("Mod:\"" + mod_name + "\" lacks init.lua");
+ verbosestream << "Loading and running script " << display_filename << std::endl;
+
+ lua_State *L = getStack();
+
+ int error_handler = PUSH_ERROR_HANDLER(L);
+
+ bool ok = ScriptApiSecurity::safeLoadFile(L, init_filename->c_str(), display_filename.c_str());
+ if (ok)
+ ok = !lua_pcall(L, 0, 0, error_handler);
+ if (!ok) {
+ std::string error_msg = luaL_checkstring(L, -1);
+ lua_pop(L, 2); // Pop error message and error handler
+ throw ModError("Failed to load and run mod \"" +
+ mod_name + "\":\n" + error_msg);
}
- o<<" ";
- }
- o<<std::endl;
+ lua_pop(L, 1); // Pop error handler
}
+#endif
// Push the list of callbacks (a lua table).
// Then push nargs arguments.
// Then call this function, which
// - runs the callbacks
-// - removes the table and arguments from the lua stack
-// - pushes the return value, computed depending on mode
-void ScriptApiBase::runCallbacks(int nargs,RunCallbacksMode mode)
+// - replaces the table and arguments with the return value,
+// computed depending on mode
+// This function must only be called with scriptlock held (i.e. inside of a
+// code block with SCRIPTAPI_PRECHECKHEADER declared)
+void ScriptApiBase::runCallbacksRaw(int nargs,
+ RunCallbacksMode mode, const char *fxn)
{
+#ifdef SCRIPTAPI_LOCK_DEBUG
+ assert(m_lock_recursion_count > 0);
+#endif
lua_State *L = getStack();
+ FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments");
- // Insert the return value into the lua stack, below the table
- assert(lua_gettop(L) >= nargs + 1);
- lua_pushnil(L);
- lua_insert(L, -(nargs + 1) - 1);
- // Stack now looks like this:
- // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
+ // Insert error handler
+ PUSH_ERROR_HANDLER(L);
+ int error_handler = lua_gettop(L) - nargs - 1;
+ lua_insert(L, error_handler);
- int rv = lua_gettop(L) - nargs - 1;
- int table = rv + 1;
- int arg = table + 1;
+ // Insert run_callbacks between error handler and table
+ lua_getglobal(L, "core");
+ lua_getfield(L, -1, "run_callbacks");
+ lua_remove(L, -2);
+ lua_insert(L, error_handler + 1);
- luaL_checktype(L, table, LUA_TTABLE);
+ // Insert mode after table
+ lua_pushnumber(L, (int)mode);
+ lua_insert(L, error_handler + 3);
- // Foreach
- lua_pushnil(L);
- bool first_loop = true;
- while(lua_next(L, table) != 0){
- // key at index -2 and value at index -1
- luaL_checktype(L, -1, LUA_TFUNCTION);
- // Call function
- for(int i = 0; i < nargs; i++)
- lua_pushvalue(L, arg+i);
- if(lua_pcall(L, nargs, 1, 0))
- scriptError("error: %s", lua_tostring(L, -1));
-
- // Move return value to designated space in stack
- // Or pop it
- if(first_loop){
- // Result of first callback is always moved
- lua_replace(L, rv);
- first_loop = false;
- } else {
- // Otherwise, what happens depends on the mode
- if(mode == RUN_CALLBACKS_MODE_FIRST)
- lua_pop(L, 1);
- else if(mode == RUN_CALLBACKS_MODE_LAST)
- lua_replace(L, rv);
- else if(mode == RUN_CALLBACKS_MODE_AND ||
- mode == RUN_CALLBACKS_MODE_AND_SC){
- if((bool)lua_toboolean(L, rv) == true &&
- (bool)lua_toboolean(L, -1) == false)
- lua_replace(L, rv);
- else
- lua_pop(L, 1);
- }
- else if(mode == RUN_CALLBACKS_MODE_OR ||
- mode == RUN_CALLBACKS_MODE_OR_SC){
- if((bool)lua_toboolean(L, rv) == false &&
- (bool)lua_toboolean(L, -1) == true)
- lua_replace(L, rv);
- else
- lua_pop(L, 1);
- }
- else
- assert(0);
- }
+ // Stack now looks like this:
+ // ... <error handler> <run_callbacks> <table> <mode> <arg#1> <arg#2> ... <arg#n>
+
+ int result = lua_pcall(L, nargs + 2, 1, error_handler);
+ if (result != 0)
+ scriptError(result, fxn);
- // Handle short circuit modes
- if(mode == RUN_CALLBACKS_MODE_AND_SC &&
- (bool)lua_toboolean(L, rv) == false)
- break;
- else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
- (bool)lua_toboolean(L, rv) == true)
- break;
+ lua_remove(L, error_handler);
+}
- // value removed, keep key for next iteration
+void ScriptApiBase::realityCheck()
+{
+ int top = lua_gettop(m_luastack);
+ if (top >= 30) {
+ dstream << "Stack is over 30:" << std::endl;
+ stackDump(dstream);
+ std::string traceback = script_get_backtrace(m_luastack);
+ throw LuaError("Stack is over 30 (reality check)\n" + traceback);
}
+}
- // Remove stuff from stack, leaving only the return value
- lua_settop(L, rv);
+void ScriptApiBase::scriptError(int result, const char *fxn)
+{
+ script_error(getStack(), result, m_last_run_mod.c_str(), fxn);
+}
- // Fix return value in case no callbacks were called
- if(first_loop){
- if(mode == RUN_CALLBACKS_MODE_AND ||
- mode == RUN_CALLBACKS_MODE_AND_SC){
- lua_pop(L, 1);
- lua_pushboolean(L, true);
- }
- else if(mode == RUN_CALLBACKS_MODE_OR ||
- mode == RUN_CALLBACKS_MODE_OR_SC){
- lua_pop(L, 1);
- lua_pushboolean(L, false);
+void ScriptApiBase::stackDump(std::ostream &o)
+{
+ int top = lua_gettop(m_luastack);
+ for (int i = 1; i <= top; i++) { /* repeat for each level */
+ int t = lua_type(m_luastack, i);
+ switch (t) {
+ case LUA_TSTRING: /* strings */
+ o << "\"" << readParam<std::string>(m_luastack, i) << "\"";
+ break;
+ case LUA_TBOOLEAN: /* booleans */
+ o << (readParam<bool>(m_luastack, i) ? "true" : "false");
+ break;
+ case LUA_TNUMBER: /* numbers */ {
+ char buf[10];
+ porting::mt_snprintf(buf, sizeof(buf), "%lf", lua_tonumber(m_luastack, i));
+ o << buf;
+ break;
+ }
+ default: /* other values */
+ o << lua_typename(m_luastack, t);
+ break;
}
+ o << " ";
}
+ o << std::endl;
+}
+
+void ScriptApiBase::setOriginDirect(const char *origin)
+{
+ m_last_run_mod = origin ? origin : "??";
+}
+
+void ScriptApiBase::setOriginFromTableRaw(int index, const char *fxn)
+{
+#ifdef SCRIPTAPI_DEBUG
+ lua_State *L = getStack();
+
+ m_last_run_mod = lua_istable(L, index) ?
+ getstringfield_default(L, index, "mod_origin", "") : "";
+ //printf(">>>> running %s for mod: %s\n", fxn, m_last_run_mod.c_str());
+#endif
}
void ScriptApiBase::addObjectReference(ServerActiveObject *cobj)
ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
int object = lua_gettop(L);
- // Get minetest.object_refs table
- lua_getglobal(L, "minetest");
+ // Get core.object_refs table
+ lua_getglobal(L, "core");
lua_getfield(L, -1, "object_refs");
luaL_checktype(L, -1, LUA_TTABLE);
int objectstable = lua_gettop(L);
SCRIPTAPI_PRECHECKHEADER
//infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
- // Get minetest.object_refs table
- lua_getglobal(L, "minetest");
+ // Get core.object_refs table
+ lua_getglobal(L, "core");
lua_getfield(L, -1, "object_refs");
luaL_checktype(L, -1, LUA_TTABLE);
int objectstable = lua_gettop(L);
}
// Creates a new anonymous reference if cobj=NULL or id=0
-void ScriptApiBase::objectrefGetOrCreate(
+void ScriptApiBase::objectrefGetOrCreate(lua_State *L,
ServerActiveObject *cobj)
{
- lua_State *L = getStack();
-
- if(cobj == NULL || cobj->getId() == 0){
+ if (cobj == NULL || cobj->getId() == 0) {
ObjectRef::create(L, cobj);
} else {
- objectrefGet(cobj->getId());
+ push_objectRef(L, cobj->getId());
+ if (cobj->isGone())
+ warningstream << "ScriptApiBase::objectrefGetOrCreate(): "
+ << "Pushing ObjectRef to removed/deactivated object"
+ << ", this is probably a bug." << std::endl;
}
}
-void ScriptApiBase::objectrefGet(u16 id)
+void ScriptApiBase::pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason &reason)
{
- lua_State *L = getStack();
+ if (reason.hasLuaReference())
+ lua_rawgeti(L, LUA_REGISTRYINDEX, reason.lua_reference);
+ else
+ lua_newtable(L);
+
+ lua_getfield(L, -1, "type");
+ bool has_type = (bool)lua_isstring(L, -1);
+ lua_pop(L, 1);
+ if (!has_type) {
+ lua_pushstring(L, reason.getTypeAsString().c_str());
+ lua_setfield(L, -2, "type");
+ }
- // Get minetest.object_refs[i]
- lua_getglobal(L, "minetest");
- lua_getfield(L, -1, "object_refs");
- luaL_checktype(L, -1, LUA_TTABLE);
- lua_pushnumber(L, id);
- lua_gettable(L, -2);
- lua_remove(L, -2); // object_refs
- lua_remove(L, -2); // minetest
+ lua_pushstring(L, reason.from_mod ? "mod" : "engine");
+ lua_setfield(L, -2, "from");
+
+ if (reason.object) {
+ objectrefGetOrCreate(L, reason.object);
+ lua_setfield(L, -2, "object");
+ }
+ if (!reason.node.empty()) {
+ lua_pushstring(L, reason.node.c_str());
+ lua_setfield(L, -2, "node");
+ }
}
+
+Server* ScriptApiBase::getServer()
+{
+ return dynamic_cast<Server *>(m_gamedef);
+}
+#ifndef SERVER
+Client* ScriptApiBase::getClient()
+{
+ return dynamic_cast<Client *>(m_gamedef);
+}
+#endif
projects / minetest.git / blobdiff