Lua API: Log incorrect parameter types as error (#9954)

Incorrect parameter types are logged as errors, taking coercion into account.
This is a workaround to ensure mod compatibility.
Duplicate warnings are ignored per server instance.
This commit is contained in:
SmallJoker 2020-06-01 19:02:15 +02:00 committed by GitHub
parent a08d18acad
commit 42a9b45c21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -28,6 +28,7 @@ extern "C" {
#include "common/c_converter.h" #include "common/c_converter.h"
#include "common/c_internal.h" #include "common/c_internal.h"
#include "constants.h" #include "constants.h"
#include <set>
#define CHECK_TYPE(index, name, type) { \ #define CHECK_TYPE(index, name, type) { \
@ -458,11 +459,36 @@ size_t read_stringlist(lua_State *L, int index, std::vector<std::string> *result
bool check_field_or_nil(lua_State *L, int index, int type, const char *fieldname) bool check_field_or_nil(lua_State *L, int index, int type, const char *fieldname)
{ {
if (lua_isnil(L, index)) static thread_local std::set<u64> warned_msgs;
int t = lua_type(L, index);
if (t == LUA_TNIL)
return false; return false;
CHECK_TYPE(index, std::string("field \"") + fieldname + '"', type); if (t == type)
return true; return true;
// Check coercion types
if (type == LUA_TNUMBER) {
if (lua_isnumber(L, index))
return true;
} else if (type == LUA_TSTRING) {
if (lua_isstring(L, index))
return true;
}
// Types mismatch. Log unique line.
std::string backtrace = std::string("Invalid field ") + fieldname +
" (expected " + lua_typename(L, type) +
" got " + lua_typename(L, t) + ").\n" + script_get_backtrace(L);
u64 hash = murmur_hash_64_ua(backtrace.data(), backtrace.length(), 0xBADBABE);
if (warned_msgs.find(hash) == warned_msgs.end()) {
errorstream << backtrace << std::endl;
warned_msgs.insert(hash);
}
return false;
} }
bool getstringfield(lua_State *L, int table, bool getstringfield(lua_State *L, int table,