aboutsummaryrefslogtreecommitdiff
path: root/src/script/cpp_api
Commit message (Expand)AuthorAge
* Fix CSM crash (#5779)red-0012017-05-20
* Fix a warning pointed by GCC 7.1Loic Blot2017-05-18
* Use a settings object for the main settingsShadowNinja2017-05-06
* [CSM] add `on_item_use` (#5544)red-0012017-05-06
* [CSM] Add event on_place_node API lua (#5548)Vincent Glize2017-04-29
* Fix various points reported by cppcheck (#5656)Loïc Blot2017-04-25
* Pass clang-format on various cpp/header files (#5559)Loïc Blot2017-04-23
* Add on_flood() callback.Auke Kok2017-04-22
* Fix various copy instead of const ref reported by cppcheck (part 3) (#5616)Loïc Blot2017-04-20
* Plug two minor Leaks (#5603)Auke Kok2017-04-17
* Hardware coloring for itemstacksDániel Juhász2017-04-08
* code style fix on src/script/cpp_api/s_client.hLoic Blot2017-04-08
* [CSM] Add event on_connect player API lua (#5540)Vincent Glize2017-04-08
* Pass clang-format on 14 trivial header files fixesLoic Blot2017-04-07
* Paramtype2: Add missing type CPT2_GLASSLIKE_LIQUID_LEVELparamat2017-03-30
* Block access to the `io` libraryred-0012017-03-19
* [CSM] Add core.get_timeofday & core.get_day_count env calls (#5401)Loïc Blot2017-03-17
* Add `get_wielded_item`red-0012017-03-13
* [CSM] Add enable_client_modding param (default: false)nerzhul2017-03-13
* [CSM] Add `on_punchnode` callbackred-0012017-03-13
* [CSM] Add `on_dignode` callback (#5140)red-0012017-03-13
* [CSM] Improve security for client-sided mods (#5100)red-0012017-03-13
* [CSM] Add local formspecs. (#5094)red-0012017-03-13
* [CSM] sound_play & sound_stop support + client_lua_api doc (#5096)Loïc Blot2017-03-13
* [CSM] Add on_death, on_hp_modification & oh_damage_taken callbacks (#5093)Loïc Blot2017-03-13
* [CSM] Client side moddingLoic Blot2017-03-13
* Tell on_punch to expect a return valueDuane Robertson2017-02-01
* Make entity on_punch have same signature and behaviour as player on_punchsapier2017-01-28
* Add hardware node coloring. Includes:Dániel Juhász2017-01-23
* Remove os.exit from the Lua secure sandbox (#5090)Loïc Blot2017-01-21
* Added lua tracebacks to some errors where you have been blind to what… (#5043)sapier2017-01-15
* Make minetest abort on lua panicRogier2016-12-24
* Security: Fix resolving of some relative pathsShadowNinja2016-12-20
* Mod security: Allow read-only access to all mod pathsShadowNinja2016-12-20
* Fix secure io.linesShadowNinja2016-11-24
* Fix secure io.open without modeShadowNinja2016-11-24
* Fix memory leak in ::safeLoadFile (#4730)Zeno-2016-11-05
* Emergeblocks: Fix occasional crashRogier2016-10-16
* use unordered containers where possible (patch 4 on X)Loic Blot2016-10-06
* Make plantlike drawtype more funAuke Kok2016-08-26
* couple of memory leaks fixes.David Carlier2016-08-10
* Server: Add reason for leave to `on_leaveplayer` callbacksDiego Martinez2016-06-11
* Remove unused code in s_security.cpp (#4172)Zeno-2016-05-30
* Nodebox: Allow nodeboxes to "connect"Auke Kok2016-03-12
* s_env.{cpp, h} cleanupsest312016-03-07
* Add minetest.register_lbm() to run code on block load onlyest312016-03-07
* Use LuaErrors in security check macrosShadowNinja2016-03-07
* Remove debug.getupvalue from the Lua sandbox whitelistShadowNinja2016-03-03
* Fix C++11 compilabilityest312016-01-23
* Add on_secondary_use when right clicking an item in the airAlex Ford2015-12-02
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-29 19:14:05 +0000
, 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 "filesys.h" #include "content/mods.h" #include "porting.h" #include "util/string.h" #include "server.h" #ifndef SERVER #include "client/client.h" #endif extern "C" { #include "lualib.h" #if USE_LUAJIT #include "luajit.h" #endif } #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); } int ScriptApiBase::luaPanic(lua_State *L) { 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::loadMod(const std::string &script_path, const std::string &mod_name) { ModNameStorer mod_name_storer(getStack(), mod_name); loadScript(script_path); } 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) { 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); } 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 // - 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 error handler PUSH_ERROR_HANDLER(L); int error_handler = lua_gettop(L) - nargs - 1; lua_insert(L, error_handler); // 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); // Insert mode after table lua_pushnumber(L, (int)mode); lua_insert(L, error_handler + 3); // 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); lua_remove(L, 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 << "\"" << 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) { SCRIPTAPI_PRECHECKHEADER //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl; // Create object on stack ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack int object = lua_gettop(L); // 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); // object_refs[id] = object lua_pushnumber(L, cobj->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="<<cobj->getId()<<std::endl; // 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); // Get object_refs[id] lua_pushnumber(L, cobj->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 { 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::pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason &reason) { if (reason.lua_reference >= 0) { lua_rawgeti(L, LUA_REGISTRYINDEX, reason.lua_reference); luaL_unref(L, LUA_REGISTRYINDEX, reason.lua_reference); } else lua_newtable(L); lua_pushstring(L, reason.getTypeAsString().c_str()); lua_setfield(L, -2, "type"); 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"); } } Server* ScriptApiBase::getServer() { return dynamic_cast<Server *>(m_gamedef); } #ifndef SERVER Client* ScriptApiBase::getClient() { return dynamic_cast<Client *>(m_gamedef); } #endif