/* Minetest Copyright (C) 2013 celeron55, Perttu Ahola This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #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 "debug.h" #include "filesys.h" #include "log.h" #include "mods.h" #include "porting.h" #include "util/string.h" extern "C" { #include "lualib.h" #if USE_LUAJIT #include "luajit.h" #endif } #include #include 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_setfield(L, LUA_REGISTRYINDEX, SCRIPT_MOD_NAME_FIELD); } ~ModNameStorer() { // Clear current mod name from registry lua_pushnil(L); lua_setfield(L, LUA_REGISTRYINDEX, SCRIPT_MOD_NAME_FIELD); } }; /* ScriptApiBase */ ScriptApiBase::ScriptApiBase() { #ifdef SCRIPTAPI_LOCK_DEBUG m_locked = false; #endif m_luastack = luaL_newstate(); FATAL_ERROR_IF(!m_luastack, "luaL_newstate() failed"); luaL_openlibs(m_luastack); // Add and save an error handler lua_pushcfunction(m_luastack, script_error_handler); m_errorhandler = lua_gettop(m_luastack); // Make the ScriptApiBase* accessible to ModApiBase lua_pushlightuserdata(m_luastack, this); lua_setfield(m_luastack, LUA_REGISTRYINDEX, "scriptapi"); // 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"); lua_pushstring(m_luastack, DIR_DELIM); lua_setglobal(m_luastack, "DIR_DELIM"); lua_pushstring(m_luastack, porting::getPlatformName()); lua_setglobal(m_luastack, "PLATFORM"); // m_secure gets set to true inside // ScriptApiSecurity::initializeSecurity(), if neccessary. // Default to false otherwise m_secure = false; m_server = NULL; m_environment = NULL; m_guiengine = NULL; } ScriptApiBase::~ScriptApiBase() { lua_close(m_luastack); } bool ScriptApiBase::loadMod(const std::string &script_path, const std::string &mod_name, std::string *error) { ModNameStorer mod_name_storer(getStack(), mod_name); return loadScript(script_path, error); } bool ScriptApiBase::loadScript(const std::string &script_path, std::string *error) { verbosestream << "Loading and running script from " << script_path << std::endl; lua_State *L = getStack(); 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, m_errorhandler); if (!ok) { std::string error_msg = lua_tostring(L, -1); if (error) *error = error_msg; errorstream << "========== ERROR FROM LUA ===========" << std::endl << "Failed to load and run script from " << std::endl << script_path << ":" << std::endl << std::endl << error_msg << std::endl << std::endl << "======= END OF ERROR FROM LUA ========" << std::endl; lua_pop(L, 1); // Pop error message from stack return false; } return true; } // Push the list of callbacks (a lua table). // Then push nargs arguments. // Then call this function, which // - runs the callbacks // - replaces the table and arguments with the return value, // computed depending on mode void ScriptApiBase::runCallbacksRaw(int nargs, RunCallbacksMode mode, const char *fxn) { lua_State *L = getStack(); FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments"); // Insert error handler lua_pushcfunction(L, script_error_handler); int errorhandler = lua_gettop(L) - nargs - 1; lua_insert(L, errorhandler); // 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, errorhandler + 1); // Insert mode after table lua_pushnumber(L, (int)mode); lua_insert(L, errorhandler + 3); // Stack now looks like this: // ... ... int result = lua_pcall(L, nargs + 2, 1, errorhandler); if (result != 0) scriptError(result, fxn); lua_remove(L, -2); // Remove error handler } 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); } } void ScriptApiBase::scriptError(int result, const char *fxn) { script_error(getStack(), result, m_last_run_mod.c_str(), fxn); } 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 << "\"" << 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; } 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(); if (index < 0) index = lua_gettop(L) + 1 + index; m_last_run_mod = lua_istable(L, index) ? getstringfield_default(L, index, "origin", "") : ""; //printf(">>>> running %s for mod: %s\n", fxn, m_last_run_mod.c_str()); #endif } void ScriptApiBase::addObjectReference(ServerActiveObject *cobj) { SCRIPTAPI_PRECHECKHEADER //infostream<<"scriptapi_add_object_reference: id="<getId()<getId()); // Push id lua_pushvalue(L, object); // Copy object to top of stack lua_settable(L, objectstable); } void ScriptApiBase::removeObjectReference(ServerActiveObject *cobj) { SCRIPTAPI_PRECHECKHEADER //infostream<<"scriptapi_rm_object_reference: id="<getId()<getId()); // Push id lua_gettable(L, objectstable); // Set object reference to NULL ObjectRef::set_null(L); lua_pop(L, 1); // pop object // Set object_refs[id] = nil lua_pushnumber(L, cobj->getId()); // Push id lua_pushnil(L); lua_settable(L, objectstable); } // Creates a new anonymous reference if cobj=NULL or id=0 void ScriptApiBase::objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj) { if (cobj == NULL || cobj->getId() == 0) { ObjectRef::create(L, cobj); } else { objectrefGet(L, cobj->getId()); } } void ScriptApiBase::objectrefGet(lua_State *L, u16 id) { // Get core.object_refs[i] lua_getglobal(L, "core"); 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); // core }