From 0fea2d586b5d8e683d1e441535c2ff207e5a32ff Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sun, 20 Nov 2022 12:44:07 +0100 Subject: [PATCH 1/6] Add facility to embedd LUA scripts into FTL and run them during luainit Signed-off-by: DL6ER --- .gitignore | 3 + src/CMakeLists.txt | 1 + src/lua/ftl_lua.c | 24 ++- src/lua/ftl_lua.h | 2 - src/lua/lua.c | 4 +- src/lua/scripts/CMakeLists.txt | 35 ++++ src/lua/scripts/inspect.lua | 335 +++++++++++++++++++++++++++++++++ src/lua/scripts/scripts.h | 17 ++ 8 files changed, 414 insertions(+), 7 deletions(-) create mode 100644 src/lua/scripts/CMakeLists.txt create mode 100644 src/lua/scripts/inspect.lua create mode 100644 src/lua/scripts/scripts.h diff --git a/.gitignore b/.gitignore index 9cf9308d9..878214691 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,6 @@ tools/macvendor.db # Test Leftovers dig.log ptr.log + +# Compiled LUA scripts +/src/lua/scripts/*.hex diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index ef90d7c90..e71381793 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -250,5 +250,6 @@ add_subdirectory(api) add_subdirectory(database) add_subdirectory(dnsmasq) add_subdirectory(lua) +add_subdirectory(lua/scripts) add_subdirectory(tre-regex) add_subdirectory(syscalls) diff --git a/src/lua/ftl_lua.c b/src/lua/ftl_lua.c index 2da6cb22e..e8130a1bd 100644 --- a/src/lua/ftl_lua.c +++ b/src/lua/ftl_lua.c @@ -16,6 +16,7 @@ #include "../log.h" #include #include +#include "scripts/scripts.h" int run_lua_interpreter(const int argc, char **argv, bool dnsmasq_debug) { @@ -98,9 +99,28 @@ LUAMOD_API int luaopen_pihole(lua_State *L) { return LUA_YIELD; } +const char *script = inspect_lua; + +static bool ftl_lua_load_embedded_script(lua_State *L, const char *name, const char *script, const bool make_global) +{ + if (luaL_dostring(L, script) != 0) + { + const char *lua_err = lua_tostring(L, -1); + logg("LUA error: %s", lua_err); + return false; + } + + if(make_global) + { + /* Set global[name] = luaL_dostring return */ + lua_setglobal(L, name); + } + + return true; +} + // Load bundled libraries and make the available globally void ftl_lua_init(lua_State *L) { - if(dolibrary(L, "inspect") != LUA_OK) - printf("Failed to load library inspect.lua\n"); + ftl_lua_load_embedded_script(L, "inspect", inspect_lua, true); } diff --git a/src/lua/ftl_lua.h b/src/lua/ftl_lua.h index c2ef12ab7..c91ab5c3f 100644 --- a/src/lua/ftl_lua.h +++ b/src/lua/ftl_lua.h @@ -21,8 +21,6 @@ int run_luac(const int argc, char **argv); int lua_main (int argc, char **argv); int luac_main (int argc, char **argv); -extern int dolibrary (lua_State *L, const char *name); - void ftl_lua_init(lua_State *L); #endif //FTL_LUA_H \ No newline at end of file diff --git a/src/lua/lua.c b/src/lua/lua.c index fa52d2525..63e591e42 100644 --- a/src/lua/lua.c +++ b/src/lua/lua.c @@ -194,9 +194,7 @@ static int dostring (lua_State *L, const char *s, const char *name) { ** Calls 'require(name)' and stores the result in a global variable ** with the given name. */ -/************** Pi-hole modification ***************/ -int dolibrary (lua_State *L, const char *name) { -/***************************************************/ +static int dolibrary (lua_State *L, const char *name) { int status; lua_getglobal(L, "require"); lua_pushstring(L, name); diff --git a/src/lua/scripts/CMakeLists.txt b/src/lua/scripts/CMakeLists.txt new file mode 100644 index 000000000..1278f8f9f --- /dev/null +++ b/src/lua/scripts/CMakeLists.txt @@ -0,0 +1,35 @@ +# Pi-hole: A black hole for Internet advertisements +# (c) 2022 Pi-hole, LLC (https://pi-hole.net) +# Network-wide ad blocking via your own hardware. +# +# FTL Engine +# /src/lua/scripts/CMakeList.txt +# +# This file is copyright under the latest version of the EUPL. +# Please see LICENSE file for your rights under this license. + +set(sources + inspect.lua.hex + scripts.h + ) + +# Compile files from raw/ into hex/ +find_program(RESOURCE_COMPILER xxd) +file(GLOB_RECURSE COMPILED_RESOURCES RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}/" "./*.lua") +foreach(INPUT_FILE ${COMPILED_RESOURCES}) + set(IN ${CMAKE_CURRENT_SOURCE_DIR}/${INPUT_FILE}) + set(OUTPUT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/${INPUT_FILE}.hex) + add_custom_command( + OUTPUT ${INPUT_FILE}.hex + COMMAND ${RESOURCE_COMPILER} -i < ${IN} > ${OUTPUT_FILE} + COMMENT "Compiling ${INPUT_FILE} to binary" + VERBATIM) + list(APPEND COMPILED_RESOURCES ${OUTPUT_FILE}) +endforeach() + +# Ensure target lua_scripts is build before target lua +add_dependencies(lua lua_scripts) + +add_library(lua_scripts OBJECT ${sources}) +target_compile_options(lua_scripts PRIVATE ${EXTRAWARN}) +target_include_directories(lua_scripts PRIVATE ${PROJECT_SOURCE_DIR}/src) diff --git a/src/lua/scripts/inspect.lua b/src/lua/scripts/inspect.lua new file mode 100644 index 000000000..8d33a9816 --- /dev/null +++ b/src/lua/scripts/inspect.lua @@ -0,0 +1,335 @@ +local inspect ={ + _VERSION = 'inspect.lua 3.1.0', + _URL = 'http://github.com/kikito/inspect.lua', + _DESCRIPTION = 'human-readable representations of tables', + _LICENSE = [[ + MIT LICENSE + + Copyright (c) 2013 Enrique García Cota + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + ]] +} + +local tostring = tostring + +inspect.KEY = setmetatable({}, {__tostring = function() return 'inspect.KEY' end}) +inspect.METATABLE = setmetatable({}, {__tostring = function() return 'inspect.METATABLE' end}) + +local function rawpairs(t) + return next, t, nil +end + +-- Apostrophizes the string if it has quotes, but not aphostrophes +-- Otherwise, it returns a regular quoted string +local function smartQuote(str) + if str:match('"') and not str:match("'") then + return "'" .. str .. "'" + end + return '"' .. str:gsub('"', '\\"') .. '"' +end + +-- \a => '\\a', \0 => '\\0', 31 => '\31' +local shortControlCharEscapes = { + ["\a"] = "\\a", ["\b"] = "\\b", ["\f"] = "\\f", ["\n"] = "\\n", + ["\r"] = "\\r", ["\t"] = "\\t", ["\v"] = "\\v" +} +local longControlCharEscapes = {} -- \a => nil, \0 => \000, 31 => \031 +for i=0, 31 do + local ch = string.char(i) + if not shortControlCharEscapes[ch] then + shortControlCharEscapes[ch] = "\\"..i + longControlCharEscapes[ch] = string.format("\\%03d", i) + end +end + +local function escape(str) + return (str:gsub("\\", "\\\\") + :gsub("(%c)%f[0-9]", longControlCharEscapes) + :gsub("%c", shortControlCharEscapes)) +end + +local function isIdentifier(str) + return type(str) == 'string' and str:match( "^[_%a][_%a%d]*$" ) +end + +local function isSequenceKey(k, sequenceLength) + return type(k) == 'number' + and 1 <= k + and k <= sequenceLength + and math.floor(k) == k +end + +local defaultTypeOrders = { + ['number'] = 1, ['boolean'] = 2, ['string'] = 3, ['table'] = 4, + ['function'] = 5, ['userdata'] = 6, ['thread'] = 7 +} + +local function sortKeys(a, b) + local ta, tb = type(a), type(b) + + -- strings and numbers are sorted numerically/alphabetically + if ta == tb and (ta == 'string' or ta == 'number') then return a < b end + + local dta, dtb = defaultTypeOrders[ta], defaultTypeOrders[tb] + -- Two default types are compared according to the defaultTypeOrders table + if dta and dtb then return defaultTypeOrders[ta] < defaultTypeOrders[tb] + elseif dta then return true -- default types before custom ones + elseif dtb then return false -- custom types after default ones + end + + -- custom types are sorted out alphabetically + return ta < tb +end + +-- For implementation reasons, the behavior of rawlen & # is "undefined" when +-- tables aren't pure sequences. So we implement our own # operator. +local function getSequenceLength(t) + local len = 1 + local v = rawget(t,len) + while v ~= nil do + len = len + 1 + v = rawget(t,len) + end + return len - 1 +end + +local function getNonSequentialKeys(t) + local keys, keysLength = {}, 0 + local sequenceLength = getSequenceLength(t) + for k,_ in rawpairs(t) do + if not isSequenceKey(k, sequenceLength) then + keysLength = keysLength + 1 + keys[keysLength] = k + end + end + table.sort(keys, sortKeys) + return keys, keysLength, sequenceLength +end + +local function countTableAppearances(t, tableAppearances) + tableAppearances = tableAppearances or {} + + if type(t) == 'table' then + if not tableAppearances[t] then + tableAppearances[t] = 1 + for k,v in rawpairs(t) do + countTableAppearances(k, tableAppearances) + countTableAppearances(v, tableAppearances) + end + countTableAppearances(getmetatable(t), tableAppearances) + else + tableAppearances[t] = tableAppearances[t] + 1 + end + end + + return tableAppearances +end + +local copySequence = function(s) + local copy, len = {}, #s + for i=1, len do copy[i] = s[i] end + return copy, len +end + +local function makePath(path, ...) + local keys = {...} + local newPath, len = copySequence(path) + for i=1, #keys do + newPath[len + i] = keys[i] + end + return newPath +end + +local function processRecursive(process, item, path, visited) + if item == nil then return nil end + if visited[item] then return visited[item] end + + local processed = process(item, path) + if type(processed) == 'table' then + local processedCopy = {} + visited[item] = processedCopy + local processedKey + + for k,v in rawpairs(processed) do + processedKey = processRecursive(process, k, makePath(path, k, inspect.KEY), visited) + if processedKey ~= nil then + processedCopy[processedKey] = processRecursive(process, v, makePath(path, processedKey), visited) + end + end + + local mt = processRecursive(process, getmetatable(processed), makePath(path, inspect.METATABLE), visited) + if type(mt) ~= 'table' then mt = nil end -- ignore not nil/table __metatable field + setmetatable(processedCopy, mt) + processed = processedCopy + end + return processed +end + + + +------------------------------------------------------------------- + +local Inspector = {} +local Inspector_mt = {__index = Inspector} + +function Inspector:puts(...) + local args = {...} + local buffer = self.buffer + local len = #buffer + for i=1, #args do + len = len + 1 + buffer[len] = args[i] + end +end + +function Inspector:down(f) + self.level = self.level + 1 + f() + self.level = self.level - 1 +end + +function Inspector:tabify() + self:puts(self.newline, string.rep(self.indent, self.level)) +end + +function Inspector:alreadyVisited(v) + return self.ids[v] ~= nil +end + +function Inspector:getId(v) + local id = self.ids[v] + if not id then + local tv = type(v) + id = (self.maxIds[tv] or 0) + 1 + self.maxIds[tv] = id + self.ids[v] = id + end + return tostring(id) +end + +function Inspector:putKey(k) + if isIdentifier(k) then return self:puts(k) end + self:puts("[") + self:putValue(k) + self:puts("]") +end + +function Inspector:putTable(t) + if t == inspect.KEY or t == inspect.METATABLE then + self:puts(tostring(t)) + elseif self:alreadyVisited(t) then + self:puts('') + elseif self.level >= self.depth then + self:puts('{...}') + else + if self.tableAppearances[t] > 1 then self:puts('<', self:getId(t), '>') end + + local nonSequentialKeys, nonSequentialKeysLength, sequenceLength = getNonSequentialKeys(t) + local mt = getmetatable(t) + + self:puts('{') + self:down(function() + local count = 0 + for i=1, sequenceLength do + if count > 0 then self:puts(',') end + self:puts(' ') + self:putValue(t[i]) + count = count + 1 + end + + for i=1, nonSequentialKeysLength do + local k = nonSequentialKeys[i] + if count > 0 then self:puts(',') end + self:tabify() + self:putKey(k) + self:puts(' = ') + self:putValue(t[k]) + count = count + 1 + end + + if type(mt) == 'table' then + if count > 0 then self:puts(',') end + self:tabify() + self:puts(' = ') + self:putValue(mt) + end + end) + + if nonSequentialKeysLength > 0 or type(mt) == 'table' then -- result is multi-lined. Justify closing } + self:tabify() + elseif sequenceLength > 0 then -- array tables have one extra space before closing } + self:puts(' ') + end + + self:puts('}') + end +end + +function Inspector:putValue(v) + local tv = type(v) + + if tv == 'string' then + self:puts(smartQuote(escape(v))) + elseif tv == 'number' or tv == 'boolean' or tv == 'nil' or + tv == 'cdata' or tv == 'ctype' then + self:puts(tostring(v)) + elseif tv == 'table' then + self:putTable(v) + else + self:puts('<', tv, ' ', self:getId(v), '>') + end +end + +------------------------------------------------------------------- + +function inspect.inspect(root, options) + options = options or {} + + local depth = options.depth or math.huge + local newline = options.newline or '\n' + local indent = options.indent or ' ' + local process = options.process + + if process then + root = processRecursive(process, root, {}, {}) + end + + local inspector = setmetatable({ + depth = depth, + level = 0, + buffer = {}, + ids = {}, + maxIds = {}, + newline = newline, + indent = indent, + tableAppearances = countTableAppearances(root) + }, Inspector_mt) + + inspector:putValue(root) + + return table.concat(inspector.buffer) +end + +setmetatable(inspect, { __call = function(_, ...) return inspect.inspect(...) end }) + +return inspect + + diff --git a/src/lua/scripts/scripts.h b/src/lua/scripts/scripts.h new file mode 100644 index 000000000..2a78d5a44 --- /dev/null +++ b/src/lua/scripts/scripts.h @@ -0,0 +1,17 @@ +/* Pi-hole: A black hole for Internet advertisements +* (c) 2022 Pi-hole, LLC (https://pi-hole.net) +* Network-wide ad blocking via your own hardware. +* +* FTL Engine +* Embedded LUA scripts processor +* +* This file is copyright under the latest version of the EUPL. +* Please see LICENSE file for your rights under this license. */ +#ifndef LUA_SCRIPTS_H +#define LUA_SCRIPTS_H + +static const char inspect_lua[] = { +#include "inspect.lua.hex" +}; + +#endif // LUA_SCRIPTS_H \ No newline at end of file From 6b6c069b227a45ff7f47ff8a91198d32eeb911e8 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sun, 20 Nov 2022 12:45:35 +0100 Subject: [PATCH 2/6] Remove downloading step of inspect.lua from the testing suite - the script is now embedded into FTL Signed-off-by: DL6ER --- test/run.sh | 4 ---- 1 file changed, 4 deletions(-) diff --git a/test/run.sh b/test/run.sh index e267a39bb..348980dc6 100755 --- a/test/run.sh +++ b/test/run.sh @@ -60,10 +60,6 @@ bash test/pdns/setup.sh OLDUMASK=$(umask) umask 0022 -# Prepare LUA scripts -mkdir -p /opt/pihole/libs -wget -O /opt/pihole/libs/inspect.lua https://ftl.pi-hole.net/libraries/inspect.lua - # Start FTL if ! su pihole -s /bin/sh -c /home/pihole/pihole-FTL; then echo "pihole-FTL failed to start" From 395e0792d8db4a35138c9f85c101eda547f5540d Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sun, 20 Nov 2022 13:53:41 +0100 Subject: [PATCH 3/6] Use luaL_loadbufferx to pass name directly to interpreter Signed-off-by: DL6ER --- src/lua/ftl_lua.c | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/lua/ftl_lua.c b/src/lua/ftl_lua.c index e8130a1bd..72c371c3d 100644 --- a/src/lua/ftl_lua.c +++ b/src/lua/ftl_lua.c @@ -99,14 +99,15 @@ LUAMOD_API int luaopen_pihole(lua_State *L) { return LUA_YIELD; } -const char *script = inspect_lua; - -static bool ftl_lua_load_embedded_script(lua_State *L, const char *name, const char *script, const bool make_global) +static bool ftl_lua_load_embedded_script(lua_State *L, const char *name, const char *script, const size_t script_len, const bool make_global) { - if (luaL_dostring(L, script) != 0) + // Explanation: + // luaL_dostring(L, script) expands to (luaL_loadstring(L, script) || lua_pcall(L, 0, LUA_MULTRET, 0)) + // luaL_loadstring(L, script) calls luaL_loadbuffer(L, s, strlen(s), s) + if (luaL_loadbufferx(L, script, script_len, name, NULL) || lua_pcall(L, 0, LUA_MULTRET, 0) != 0) { const char *lua_err = lua_tostring(L, -1); - logg("LUA error: %s", lua_err); + printf("LUA error while trying to import %s.lua: %s\n", name, lua_err); return false; } @@ -122,5 +123,5 @@ static bool ftl_lua_load_embedded_script(lua_State *L, const char *name, const c // Load bundled libraries and make the available globally void ftl_lua_init(lua_State *L) { - ftl_lua_load_embedded_script(L, "inspect", inspect_lua, true); + ftl_lua_load_embedded_script(L, "inspect", inspect_lua, sizeof(inspect_lua), true); } From 167d1a6f93493c169aa36d9c973542a954da16cc Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 25 Nov 2022 11:51:53 +0100 Subject: [PATCH 4/6] Ensure compiled scripts are updated if the scripts themselves are updated Signed-off-by: DL6ER --- build.sh | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/build.sh b/build.sh index e2fd1b561..169cbe044 100755 --- a/build.sh +++ b/build.sh @@ -31,6 +31,14 @@ if [[ -n "${clean}" ]]; then fi fi +# Remove compiled LUA scripts if older than the plain ones +for scriptname in src/lua/scripts/*.lua; do + if [ -f "${scriptname}.hex" ] && [ "${scriptname}.hex" -ot "${scriptname}" ]; then + echo "INFO: ${scriptname} is outdated and will be recompiled" + rm "${scriptname}.hex" + fi +done + # Configure build, pass CMake CACHE entries if present # Wrap multiple options in "" as first argument to ./build.sh: # ./build.sh "-DA=1 -DB=2" install From a1ba4bc97d91c25b5d443a37521e341ae917fbfd Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 25 Nov 2022 11:52:12 +0100 Subject: [PATCH 5/6] Update inspect.lua Signed-off-by: DL6ER --- src/lua/scripts/inspect.lua | 528 ++++++++++++++++++------------------ 1 file changed, 263 insertions(+), 265 deletions(-) diff --git a/src/lua/scripts/inspect.lua b/src/lua/scripts/inspect.lua index 8d33a9816..ebe722d92 100644 --- a/src/lua/scripts/inspect.lua +++ b/src/lua/scripts/inspect.lua @@ -1,335 +1,333 @@ -local inspect ={ - _VERSION = 'inspect.lua 3.1.0', - _URL = 'http://github.com/kikito/inspect.lua', - _DESCRIPTION = 'human-readable representations of tables', - _LICENSE = [[ - MIT LICENSE - - Copyright (c) 2013 Enrique García Cota - - Permission is hereby granted, free of charge, to any person obtaining a - copy of this software and associated documentation files (the - "Software"), to deal in the Software without restriction, including - without limitation the rights to use, copy, modify, merge, publish, - distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to - the following conditions: - - The above copyright notice and this permission notice shall be included - in all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS - OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ]] -} +local _tl_compat; if (tonumber((_VERSION or ''):match('[%d.]*$')) or 0) < 5.3 then local p, m = pcall(require, 'compat53.module'); if p then _tl_compat = m end end; local math = _tl_compat and _tl_compat.math or math; local string = _tl_compat and _tl_compat.string or string; local table = _tl_compat and _tl_compat.table or table +local inspect = {Options = {}, } + + + + + + + + + + + + -local tostring = tostring -inspect.KEY = setmetatable({}, {__tostring = function() return 'inspect.KEY' end}) -inspect.METATABLE = setmetatable({}, {__tostring = function() return 'inspect.METATABLE' end}) + + + +inspect._VERSION = 'inspect.lua 3.1.0' +inspect._URL = 'http://github.com/kikito/inspect.lua' +inspect._DESCRIPTION = 'human-readable representations of tables' +inspect._LICENSE = [[ + MIT LICENSE + Copyright (c) 2022 Enrique García Cota + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +]] +inspect.KEY = setmetatable({}, { __tostring = function() return 'inspect.KEY' end }) +inspect.METATABLE = setmetatable({}, { __tostring = function() return 'inspect.METATABLE' end }) + +local tostring = tostring +local rep = string.rep +local match = string.match +local char = string.char +local gsub = string.gsub +local fmt = string.format local function rawpairs(t) - return next, t, nil + return next, t, nil end --- Apostrophizes the string if it has quotes, but not aphostrophes --- Otherwise, it returns a regular quoted string + + local function smartQuote(str) - if str:match('"') and not str:match("'") then - return "'" .. str .. "'" - end - return '"' .. str:gsub('"', '\\"') .. '"' + if match(str, '"') and not match(str, "'") then + return "'" .. str .. "'" + end + return '"' .. gsub(str, '"', '\\"') .. '"' end --- \a => '\\a', \0 => '\\0', 31 => '\31' + local shortControlCharEscapes = { - ["\a"] = "\\a", ["\b"] = "\\b", ["\f"] = "\\f", ["\n"] = "\\n", - ["\r"] = "\\r", ["\t"] = "\\t", ["\v"] = "\\v" + ["\a"] = "\\a", ["\b"] = "\\b", ["\f"] = "\\f", ["\n"] = "\\n", + ["\r"] = "\\r", ["\t"] = "\\t", ["\v"] = "\\v", ["\127"] = "\\127", } -local longControlCharEscapes = {} -- \a => nil, \0 => \000, 31 => \031 -for i=0, 31 do - local ch = string.char(i) - if not shortControlCharEscapes[ch] then - shortControlCharEscapes[ch] = "\\"..i - longControlCharEscapes[ch] = string.format("\\%03d", i) - end +local longControlCharEscapes = { ["\127"] = "\127" } +for i = 0, 31 do + local ch = char(i) + if not shortControlCharEscapes[ch] then + shortControlCharEscapes[ch] = "\\" .. i + longControlCharEscapes[ch] = fmt("\\%03d", i) + end end local function escape(str) - return (str:gsub("\\", "\\\\") - :gsub("(%c)%f[0-9]", longControlCharEscapes) - :gsub("%c", shortControlCharEscapes)) + return (gsub(gsub(gsub(str, "\\", "\\\\"), + "(%c)%f[0-9]", longControlCharEscapes), + "%c", shortControlCharEscapes)) end local function isIdentifier(str) - return type(str) == 'string' and str:match( "^[_%a][_%a%d]*$" ) + return type(str) == "string" and not not str:match("^[_%a][_%a%d]*$") end +local flr = math.floor local function isSequenceKey(k, sequenceLength) - return type(k) == 'number' - and 1 <= k - and k <= sequenceLength - and math.floor(k) == k + return type(k) == "number" and + flr(k) == k and + 1 <= (k) and + k <= sequenceLength end local defaultTypeOrders = { - ['number'] = 1, ['boolean'] = 2, ['string'] = 3, ['table'] = 4, - ['function'] = 5, ['userdata'] = 6, ['thread'] = 7 + ['number'] = 1, ['boolean'] = 2, ['string'] = 3, ['table'] = 4, + ['function'] = 5, ['userdata'] = 6, ['thread'] = 7, } local function sortKeys(a, b) - local ta, tb = type(a), type(b) + local ta, tb = type(a), type(b) - -- strings and numbers are sorted numerically/alphabetically - if ta == tb and (ta == 'string' or ta == 'number') then return a < b end - local dta, dtb = defaultTypeOrders[ta], defaultTypeOrders[tb] - -- Two default types are compared according to the defaultTypeOrders table - if dta and dtb then return defaultTypeOrders[ta] < defaultTypeOrders[tb] - elseif dta then return true -- default types before custom ones - elseif dtb then return false -- custom types after default ones - end + if ta == tb and (ta == 'string' or ta == 'number') then + return (a) < (b) + end - -- custom types are sorted out alphabetically - return ta < tb -end + local dta = defaultTypeOrders[ta] or 100 + local dtb = defaultTypeOrders[tb] or 100 --- For implementation reasons, the behavior of rawlen & # is "undefined" when --- tables aren't pure sequences. So we implement our own # operator. -local function getSequenceLength(t) - local len = 1 - local v = rawget(t,len) - while v ~= nil do - len = len + 1 - v = rawget(t,len) - end - return len - 1 -end -local function getNonSequentialKeys(t) - local keys, keysLength = {}, 0 - local sequenceLength = getSequenceLength(t) - for k,_ in rawpairs(t) do - if not isSequenceKey(k, sequenceLength) then - keysLength = keysLength + 1 - keys[keysLength] = k - end - end - table.sort(keys, sortKeys) - return keys, keysLength, sequenceLength + return dta == dtb and ta < tb or dta < dtb end -local function countTableAppearances(t, tableAppearances) - tableAppearances = tableAppearances or {} +local function getKeys(t) - if type(t) == 'table' then - if not tableAppearances[t] then - tableAppearances[t] = 1 - for k,v in rawpairs(t) do - countTableAppearances(k, tableAppearances) - countTableAppearances(v, tableAppearances) - end - countTableAppearances(getmetatable(t), tableAppearances) - else - tableAppearances[t] = tableAppearances[t] + 1 - end - end + local seqLen = 1 + while rawget(t, seqLen) ~= nil do + seqLen = seqLen + 1 + end + seqLen = seqLen - 1 - return tableAppearances + local keys, keysLen = {}, 0 + for k in rawpairs(t) do + if not isSequenceKey(k, seqLen) then + keysLen = keysLen + 1 + keys[keysLen] = k + end + end + table.sort(keys, sortKeys) + return keys, keysLen, seqLen end -local copySequence = function(s) - local copy, len = {}, #s - for i=1, len do copy[i] = s[i] end - return copy, len +local function countCycles(x, cycles) + if type(x) == "table" then + if cycles[x] then + cycles[x] = cycles[x] + 1 + else + cycles[x] = 1 + for k, v in rawpairs(x) do + countCycles(k, cycles) + countCycles(v, cycles) + end + countCycles(getmetatable(x), cycles) + end + end end -local function makePath(path, ...) - local keys = {...} - local newPath, len = copySequence(path) - for i=1, #keys do - newPath[len + i] = keys[i] - end - return newPath -end +local function makePath(path, a, b) + local newPath = {} + local len = #path + for i = 1, len do newPath[i] = path[i] end -local function processRecursive(process, item, path, visited) - if item == nil then return nil end - if visited[item] then return visited[item] end + newPath[len + 1] = a + newPath[len + 2] = b + + return newPath +end - local processed = process(item, path) - if type(processed) == 'table' then - local processedCopy = {} - visited[item] = processedCopy - local processedKey - for k,v in rawpairs(processed) do - processedKey = processRecursive(process, k, makePath(path, k, inspect.KEY), visited) - if processedKey ~= nil then - processedCopy[processedKey] = processRecursive(process, v, makePath(path, processedKey), visited) +local function processRecursive(process, + item, + path, + visited) + if item == nil then return nil end + if visited[item] then return visited[item] end + + local processed = process(item, path) + if type(processed) == "table" then + local processedCopy = {} + visited[item] = processedCopy + local processedKey + + for k, v in rawpairs(processed) do + processedKey = processRecursive(process, k, makePath(path, k, inspect.KEY), visited) + if processedKey ~= nil then + processedCopy[processedKey] = processRecursive(process, v, makePath(path, processedKey), visited) + end end - end - - local mt = processRecursive(process, getmetatable(processed), makePath(path, inspect.METATABLE), visited) - if type(mt) ~= 'table' then mt = nil end -- ignore not nil/table __metatable field - setmetatable(processedCopy, mt) - processed = processedCopy - end - return processed + + local mt = processRecursive(process, getmetatable(processed), makePath(path, inspect.METATABLE), visited) + if type(mt) ~= 'table' then mt = nil end + setmetatable(processedCopy, mt) + processed = processedCopy + end + return processed end +local function puts(buf, str) + buf.n = buf.n + 1 + buf[buf.n] = str +end -------------------------------------------------------------------- local Inspector = {} -local Inspector_mt = {__index = Inspector} - -function Inspector:puts(...) - local args = {...} - local buffer = self.buffer - local len = #buffer - for i=1, #args do - len = len + 1 - buffer[len] = args[i] - end -end -function Inspector:down(f) - self.level = self.level + 1 - f() - self.level = self.level - 1 -end -function Inspector:tabify() - self:puts(self.newline, string.rep(self.indent, self.level)) -end -function Inspector:alreadyVisited(v) - return self.ids[v] ~= nil -end -function Inspector:getId(v) - local id = self.ids[v] - if not id then - local tv = type(v) - id = (self.maxIds[tv] or 0) + 1 - self.maxIds[tv] = id - self.ids[v] = id - end - return tostring(id) -end -function Inspector:putKey(k) - if isIdentifier(k) then return self:puts(k) end - self:puts("[") - self:putValue(k) - self:puts("]") -end -function Inspector:putTable(t) - if t == inspect.KEY or t == inspect.METATABLE then - self:puts(tostring(t)) - elseif self:alreadyVisited(t) then - self:puts('
') - elseif self.level >= self.depth then - self:puts('{...}') - else - if self.tableAppearances[t] > 1 then self:puts('<', self:getId(t), '>') end - - local nonSequentialKeys, nonSequentialKeysLength, sequenceLength = getNonSequentialKeys(t) - local mt = getmetatable(t) - - self:puts('{') - self:down(function() - local count = 0 - for i=1, sequenceLength do - if count > 0 then self:puts(',') end - self:puts(' ') - self:putValue(t[i]) - count = count + 1 - end - for i=1, nonSequentialKeysLength do - local k = nonSequentialKeys[i] - if count > 0 then self:puts(',') end - self:tabify() - self:putKey(k) - self:puts(' = ') - self:putValue(t[k]) - count = count + 1 - end - if type(mt) == 'table' then - if count > 0 then self:puts(',') end - self:tabify() - self:puts(' = ') - self:putValue(mt) - end - end) - if nonSequentialKeysLength > 0 or type(mt) == 'table' then -- result is multi-lined. Justify closing } - self:tabify() - elseif sequenceLength > 0 then -- array tables have one extra space before closing } - self:puts(' ') - end - self:puts('}') - end +local Inspector_mt = { __index = Inspector } + +local function tabify(inspector) + puts(inspector.buf, inspector.newline .. rep(inspector.indent, inspector.level)) +end + +function Inspector:getId(v) + local id = self.ids[v] + local ids = self.ids + if not id then + local tv = type(v) + id = (ids[tv] or 0) + 1 + ids[v], ids[tv] = id, id + end + return tostring(id) end function Inspector:putValue(v) - local tv = type(v) - - if tv == 'string' then - self:puts(smartQuote(escape(v))) - elseif tv == 'number' or tv == 'boolean' or tv == 'nil' or - tv == 'cdata' or tv == 'ctype' then - self:puts(tostring(v)) - elseif tv == 'table' then - self:putTable(v) - else - self:puts('<', tv, ' ', self:getId(v), '>') - end + local buf = self.buf + local tv = type(v) + if tv == 'string' then + puts(buf, smartQuote(escape(v))) + elseif tv == 'number' or tv == 'boolean' or tv == 'nil' or + tv == 'cdata' or tv == 'ctype' then + puts(buf, tostring(v)) + elseif tv == 'table' and not self.ids[v] then + local t = v + + if t == inspect.KEY or t == inspect.METATABLE then + puts(buf, tostring(t)) + elseif self.level >= self.depth then + puts(buf, '{...}') + else + if self.cycles[t] > 1 then puts(buf, fmt('<%d>', self:getId(t))) end + + local keys, keysLen, seqLen = getKeys(t) + + puts(buf, '{') + self.level = self.level + 1 + + for i = 1, seqLen + keysLen do + if i > 1 then puts(buf, ',') end + if i <= seqLen then + puts(buf, ' ') + self:putValue(t[i]) + else + local k = keys[i - seqLen] + tabify(self) + if isIdentifier(k) then + puts(buf, k) + else + puts(buf, "[") + self:putValue(k) + puts(buf, "]") + end + puts(buf, ' = ') + self:putValue(t[k]) + end + end + + local mt = getmetatable(t) + if type(mt) == 'table' then + if seqLen + keysLen > 0 then puts(buf, ',') end + tabify(self) + puts(buf, ' = ') + self:putValue(mt) + end + + self.level = self.level - 1 + + if keysLen > 0 or type(mt) == 'table' then + tabify(self) + elseif seqLen > 0 then + puts(buf, ' ') + end + + puts(buf, '}') + end + + else + puts(buf, fmt('<%s %d>', tv, self:getId(v))) + end end -------------------------------------------------------------------- + + function inspect.inspect(root, options) - options = options or {} - - local depth = options.depth or math.huge - local newline = options.newline or '\n' - local indent = options.indent or ' ' - local process = options.process - - if process then - root = processRecursive(process, root, {}, {}) - end - - local inspector = setmetatable({ - depth = depth, - level = 0, - buffer = {}, - ids = {}, - maxIds = {}, - newline = newline, - indent = indent, - tableAppearances = countTableAppearances(root) - }, Inspector_mt) - - inspector:putValue(root) - - return table.concat(inspector.buffer) -end + options = options or {} + + local depth = options.depth or (math.huge) + local newline = options.newline or '\n' + local indent = options.indent or ' ' + local process = options.process + + if process then + root = processRecursive(process, root, {}, {}) + end -setmetatable(inspect, { __call = function(_, ...) return inspect.inspect(...) end }) + local cycles = {} + countCycles(root, cycles) -return inspect + local inspector = setmetatable({ + buf = { n = 0 }, + ids = {}, + cycles = cycles, + depth = depth, + level = 0, + newline = newline, + indent = indent, + }, Inspector_mt) + + inspector:putValue(root) + + return table.concat(inspector.buf) +end +setmetatable(inspect, { + __call = function(_, root, options) + return inspect.inspect(root, options) + end, +}) +return inspect \ No newline at end of file From d066946e3f146da1f96baa6c2abf7a3c6abf1f54 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 25 Nov 2022 12:04:26 +0100 Subject: [PATCH 6/6] Print embedded libraries in pihole-FTL -vv Signed-off-by: DL6ER --- src/args.c | 4 +++- src/lua/ftl_lua.c | 28 ++++++++++++++++++++++++++-- src/lua/ftl_lua.h | 1 + 3 files changed, 30 insertions(+), 3 deletions(-) diff --git a/src/args.c b/src/args.c index 439edd561..92965719f 100644 --- a/src/args.c +++ b/src/args.c @@ -264,7 +264,9 @@ void parse_args(int argc, char* argv[]) printf("\n"); printf("******************************** LUA ********************************\n"); printf(LUA_COPYRIGHT"\n"); - printf("\n"); + printf("Embedded libraries: "); + print_embedded_scripts(); + printf("\n\n"); printf("***************************** LIBNETTLE *****************************\n"); printf("Version: %d.%d\n", NETTLE_VERSION_MAJOR, NETTLE_VERSION_MINOR); printf("GMP: %s\n", NETTLE_USE_MINI_GMP ? "Mini" : "Full"); diff --git a/src/lua/ftl_lua.c b/src/lua/ftl_lua.c index 72c371c3d..2577b90b1 100644 --- a/src/lua/ftl_lua.c +++ b/src/lua/ftl_lua.c @@ -120,8 +120,32 @@ static bool ftl_lua_load_embedded_script(lua_State *L, const char *name, const c return true; } -// Load bundled libraries and make the available globally +struct { + const char *name; + const char *content; + const size_t contentlen; + const bool global; +} scripts[] = +{ + {"inspect", inspect_lua, sizeof(inspect_lua), true}, +}; + +// Loop over bundled LUA libraries and print their names on the console +void print_embedded_scripts(void) +{ + for(unsigned int i = 0; i < sizeof(scripts)/sizeof(scripts[0]); i++) + { + char prefix[2] = { 0 }; + double formatted = 0.0; + format_memory_size(prefix, scripts[i].contentlen, &formatted); + + printf("%s.lua (%.2f %sB) ", scripts[i].name, formatted, prefix); + } +} + +// Loop over bundled LUA libraries and load them void ftl_lua_init(lua_State *L) { - ftl_lua_load_embedded_script(L, "inspect", inspect_lua, sizeof(inspect_lua), true); + for(unsigned int i = 0; i < sizeof(scripts)/sizeof(scripts[0]); i++) + ftl_lua_load_embedded_script(L, scripts[i].name, scripts[i].content, scripts[i].contentlen, scripts[i].global); } diff --git a/src/lua/ftl_lua.h b/src/lua/ftl_lua.h index c91ab5c3f..6c51a871f 100644 --- a/src/lua/ftl_lua.h +++ b/src/lua/ftl_lua.h @@ -21,6 +21,7 @@ int run_luac(const int argc, char **argv); int lua_main (int argc, char **argv); int luac_main (int argc, char **argv); +void print_embedded_scripts(void); void ftl_lua_init(lua_State *L); #endif //FTL_LUA_H \ No newline at end of file