src/script/lua_api/l_base.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "lua_api/l_base.h"
  21 #include "lua_api/l_internal.h"
  22 #include "cpp_api/s_base.h"
  23 #include "content/mods.h"
  24 #include "profiler.h"
  25 #include "server.h"
  26 #include <algorithm>
  27 #include <cmath>
  28
  29 ScriptApiBase *ModApiBase::getScriptApiBase(lua_State *L)
  30 {
  31         // Get server from registry
  32         lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
  33         ScriptApiBase *sapi_ptr = (ScriptApiBase*) lua_touserdata(L, -1);
  34         lua_pop(L, 1);
  35         return sapi_ptr;
  36 }
  37
  38 Server *ModApiBase::getServer(lua_State *L)
  39 {
  40         return getScriptApiBase(L)->getServer();
  41 }
  42
  43 #ifndef SERVER
  44 Client *ModApiBase::getClient(lua_State *L)
  45 {
  46         return getScriptApiBase(L)->getClient();
  47 }
  48 #endif
  49
  50 IGameDef *ModApiBase::getGameDef(lua_State *L)
  51 {
  52         return getScriptApiBase(L)->getGameDef();
  53 }
  54
  55 Environment *ModApiBase::getEnv(lua_State *L)
  56 {
  57         return getScriptApiBase(L)->getEnv();
  58 }
  59
  60 GUIEngine *ModApiBase::getGuiEngine(lua_State *L)
  61 {
  62         return getScriptApiBase(L)->getGuiEngine();
  63 }
  64
  65 std::string ModApiBase::getCurrentModPath(lua_State *L)
  66 {
  67         lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
  68         std::string current_mod_name = readParam<std::string>(L, -1, "");
  69         if (current_mod_name.empty())
  70                 return ".";
  71
  72         const ModSpec *mod = getServer(L)->getModSpec(current_mod_name);
  73         if (!mod)
  74                 return ".";
  75
  76         return mod->path;
  77 }
  78
  79
  80 bool ModApiBase::registerFunction(lua_State *L, const char *name,
  81                 lua_CFunction func, int top)
  82 {
  83         // TODO: Check presence first!
  84
  85         lua_pushcfunction(L, func);
  86         lua_setfield(L, top, name);
  87
  88         return true;
  89 }
  90
  91 std::unordered_map<std::string, luaL_Reg> ModApiBase::m_deprecated_wrappers;
  92 bool ModApiBase::m_error_deprecated_calls = false;
  93
  94 int ModApiBase::l_deprecated_function(lua_State *L)
  95 {
  96         thread_local std::vector<u64> deprecated_logged;
  97
  98         u64 start_time = porting::getTimeUs();
  99         lua_Debug ar;
 100
 101         // Get function name for lookup
 102         FATAL_ERROR_IF(!lua_getstack(L, 0, &ar), "lua_getstack() failed");
 103         FATAL_ERROR_IF(!lua_getinfo(L, "n", &ar), "lua_getinfo() failed");
 104
 105         // Combine name with line and script backtrace
 106         FATAL_ERROR_IF(!lua_getstack(L, 1, &ar), "lua_getstack() failed");
 107         FATAL_ERROR_IF(!lua_getinfo(L, "Sl", &ar), "lua_getinfo() failed");
 108
 109         // Get parent class to get the wrappers map
 110         luaL_checktype(L, 1, LUA_TUSERDATA);
 111         void *ud = lua_touserdata(L, 1);
 112         ModApiBase *o = *(ModApiBase**)ud;
 113
 114         // New function and new function name
 115         auto it = o->m_deprecated_wrappers.find(ar.name);
 116
 117         // Get backtrace and hash it to reduce the warning flood
 118         std::string backtrace = ar.short_src;
 119         backtrace.append(":").append(std::to_string(ar.currentline));
 120         u64 hash = murmur_hash_64_ua(backtrace.data(), backtrace.length(), 0xBADBABE);
 121
 122         if (std::find(deprecated_logged.begin(), deprecated_logged.end(), hash)
 123                         == deprecated_logged.end()) {
 124
 125                 deprecated_logged.emplace_back(hash);
 126                 warningstream << "Call to deprecated function '"  << ar.name << "', please use '"
 127                         << it->second.name << "' at " << backtrace << std::endl;
 128
 129                 if (m_error_deprecated_calls)
 130                         script_error(L, LUA_ERRRUN, NULL, NULL);
 131         }
 132
 133         u64 end_time = porting::getTimeUs();
 134         g_profiler->avg("l_deprecated_function", end_time - start_time);
 135
 136         return it->second.func(L);
 137 }
 138
 139 void ModApiBase::markAliasDeprecated(luaL_Reg *reg)
 140 {
 141         std::string value = g_settings->get("deprecated_lua_api_handling");
 142         m_error_deprecated_calls = value == "error";
 143
 144         if (!m_error_deprecated_calls && value != "log")
 145                 return;
 146
 147         const char *last_name = nullptr;
 148         lua_CFunction last_func = nullptr;
 149
 150         // ! Null termination !
 151         while (reg->func) {
 152                 if (last_func == reg->func) {
 153                         // Duplicate found
 154                         luaL_Reg original_reg;
 155                         // Do not inline struct. Breaks MSVC or is error-prone
 156                         original_reg.name = last_name;
 157                         original_reg.func = reg->func;
 158                         m_deprecated_wrappers.emplace(
 159                                 std::pair<std::string, luaL_Reg>(reg->name, original_reg));
 160                         reg->func = l_deprecated_function;
 161                 }
 162
 163                 last_func = reg->func;
 164                 last_name = reg->name;
 165                 ++reg;
 166         }
 167 }