mirror of
https://github.com/pi-hole/FTL.git
synced 2024-10-26 16:52:18 +02:00
Merge branch 'development' into update/lua
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
@@ -26,3 +26,6 @@ tools/macvendor.db
|
||||
# Test Leftovers
|
||||
dig.log
|
||||
ptr.log
|
||||
|
||||
# Compiled LUA scripts
|
||||
/src/lua/scripts/*.hex
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
+3
-1
@@ -264,7 +264,9 @@ void parse_args(int argc, char* argv[])
|
||||
printf("\n\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");
|
||||
|
||||
+48
-3
@@ -16,6 +16,7 @@
|
||||
#include "../log.h"
|
||||
#include <readline/history.h>
|
||||
#include <wordexp.h>
|
||||
#include "scripts/scripts.h"
|
||||
|
||||
int run_lua_interpreter(const int argc, char **argv, bool dnsmasq_debug)
|
||||
{
|
||||
@@ -98,9 +99,53 @@ LUAMOD_API int luaopen_pihole(lua_State *L) {
|
||||
return LUA_YIELD;
|
||||
}
|
||||
|
||||
// Load bundled libraries and make the available globally
|
||||
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)
|
||||
{
|
||||
// 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);
|
||||
printf("LUA error while trying to import %s.lua: %s\n", name, lua_err);
|
||||
return false;
|
||||
}
|
||||
|
||||
if(make_global)
|
||||
{
|
||||
/* Set global[name] = luaL_dostring return */
|
||||
lua_setglobal(L, name);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
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)
|
||||
{
|
||||
if(dolibrary(L, "inspect") != LUA_OK)
|
||||
printf("Failed to load library inspect.lua\n");
|
||||
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);
|
||||
}
|
||||
|
||||
@@ -23,6 +23,7 @@ int luac_main (int argc, char **argv);
|
||||
|
||||
extern int dolibrary (lua_State *L, char *name);
|
||||
|
||||
void print_embedded_scripts(void);
|
||||
void ftl_lua_init(lua_State *L);
|
||||
|
||||
#endif //FTL_LUA_H
|
||||
@@ -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)
|
||||
@@ -0,0 +1,333 @@
|
||||
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 = {}, }
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
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
|
||||
end
|
||||
|
||||
|
||||
|
||||
local function smartQuote(str)
|
||||
if match(str, '"') and not match(str, "'") then
|
||||
return "'" .. str .. "'"
|
||||
end
|
||||
return '"' .. gsub(str, '"', '\\"') .. '"'
|
||||
end
|
||||
|
||||
|
||||
local shortControlCharEscapes = {
|
||||
["\a"] = "\\a", ["\b"] = "\\b", ["\f"] = "\\f", ["\n"] = "\\n",
|
||||
["\r"] = "\\r", ["\t"] = "\\t", ["\v"] = "\\v", ["\127"] = "\\127",
|
||||
}
|
||||
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 (gsub(gsub(gsub(str, "\\", "\\\\"),
|
||||
"(%c)%f[0-9]", longControlCharEscapes),
|
||||
"%c", shortControlCharEscapes))
|
||||
end
|
||||
|
||||
local function isIdentifier(str)
|
||||
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
|
||||
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,
|
||||
}
|
||||
|
||||
local function sortKeys(a, b)
|
||||
local ta, tb = type(a), type(b)
|
||||
|
||||
|
||||
if ta == tb and (ta == 'string' or ta == 'number') then
|
||||
return (a) < (b)
|
||||
end
|
||||
|
||||
local dta = defaultTypeOrders[ta] or 100
|
||||
local dtb = defaultTypeOrders[tb] or 100
|
||||
|
||||
|
||||
return dta == dtb and ta < tb or dta < dtb
|
||||
end
|
||||
|
||||
local function getKeys(t)
|
||||
|
||||
local seqLen = 1
|
||||
while rawget(t, seqLen) ~= nil do
|
||||
seqLen = seqLen + 1
|
||||
end
|
||||
seqLen = seqLen - 1
|
||||
|
||||
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 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, a, b)
|
||||
local newPath = {}
|
||||
local len = #path
|
||||
for i = 1, len do newPath[i] = path[i] end
|
||||
|
||||
newPath[len + 1] = a
|
||||
newPath[len + 2] = b
|
||||
|
||||
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
|
||||
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 }
|
||||
|
||||
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 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, '<metatable> = ')
|
||||
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 cycles = {}
|
||||
countCycles(root, cycles)
|
||||
|
||||
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
|
||||
@@ -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
|
||||
@@ -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"
|
||||
|
||||
Reference in New Issue
Block a user