minetest-engine-multicraft2/builtin/client/sscsm.lua

--
-- SSCSM: Server-Sent Client-Side Mods
--
-- Copyright © 2019-2021 by luk3yx
-- Copyright © 2020-2021 MultiCraft Development Team
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU Lesser General Public License as published by
-- the Free Software Foundation; either version 3.0 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Lesser General Public License for more details.
--
-- You should have received a copy of the GNU Lesser General Public License
-- along with this program; if not, write to the Free Software Foundation,
-- Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
--

-- Spectre mitigations make measuring performance harder
local ENABLE_SPECTRE_MITIGATIONS = true

-- Load the Env class
-- Mostly copied from https://stackoverflow.com/a/26367080
-- Don't copy metatables
local function copy(obj, s)
	if s and s[obj] ~= nil then return s[obj] end
	if type(obj) ~= "table" then return obj end
	s = s or {}
	local res = {}
	s[obj] = res
	for k, v in pairs(obj) do res[copy(k, s)] = copy(v, s) end
	return res
end

-- Safe functions
local Env = {}
local safe_funcs = {}

-- No getmetatable()
if rawget(_G, "getmetatable") then
	safe_funcs[getmetatable] = function() end
end

local function handle_error(err)
	core.log("error", "[SSCSM] " .. tostring(err))
end

local function log_pcall(ok, ...)
	if ok then
		return ...
	end

	local handled_ok, err = pcall(handle_error, ...)
	if not handled_ok then
		core.log("error", "[SSCSM] handle_error: " .. tostring(err))
	end
end

-- Get the current value of string.rep in case other CSMs decide to break
do
	local rep = string.rep
	safe_funcs[string.rep] = function(str, n)
		if #str * n > 1048576 then
			error("string.rep: string length overflow", 2)
		end
		return rep(str, n)
	end

	local show_formspec = core.show_formspec
	safe_funcs[show_formspec] = function(formname, ...)
		if type(formname) == "string" then
			return show_formspec("sscsm:_" .. formname, ...)
		end
	end

	local after = core.after
	safe_funcs[after] = function(n, ...)
		if type(n) == "number" then return after(n, pcall, ...) end
	end

	local on_fs_input = core.register_on_formspec_input
	safe_funcs[on_fs_input] = function(func)
		on_fs_input(function(formname, fields)
			if formname:sub(1, 7) == "sscsm:_" then
				return log_pcall(pcall(func, formname:sub(8), copy(fields)))
			end
		end)
	end

	local deserialize = core.deserialize
	safe_funcs[deserialize] = function(str)
		return deserialize(str, true)
	end

	if ENABLE_SPECTRE_MITIGATIONS then
		local get_us_time, floor = core.get_us_time, math.floor
		safe_funcs[get_us_time] = function()
			return floor(get_us_time() / 100) * 100
		end
	end

	local wrap = function(n)
		local orig = core[n] or core[n .. "s"]
		if type(orig) == "function" then
			return function(func)
				orig(function(...)
					return log_pcall(pcall(func, ...))
				end)
			end
		end
	end

	for _, k in ipairs({"register_globalstep", "register_on_death",
			"register_on_hp_modification", "register_on_damage_taken",
			"register_on_dignode", "register_on_punchnode",
			"register_on_placenode", "register_on_item_use",
			"register_on_modchannel_message", "register_on_modchannel_signal",
			"register_on_inventory_open", "register_on_sending_chat_message",
			"register_on_receiving_chat_message"}) do
		safe_funcs[core[k]] = wrap(k)
	end
end

-- Environment
function Env.new_empty()
	local self = {_raw = {}, _seen = copy(safe_funcs)}
	self._raw["_G"] = self._raw
	return setmetatable(self, {__index = Env}) or self
end
function Env:set(k, v) self._raw[copy(k, self._seen)] = copy(v, self._seen) end
function Env:set_copy(k, v)
	self:set(k, v)
	self._seen[k] = nil
	self._seen[v] = nil
end
function Env:add_globals(...)
	for i = 1, select("#", ...) do
		local var = select(i, ...)
		self:set(var, _G[var])
	end
end
function Env:update(data) for k, v in pairs(data) do self:set(k, v) end end
function Env:del(k)
	if self._seen[k] then
		self._raw[self._seen[k]] = nil
		self._seen[k] = nil
	end
	self._raw[k] = nil
end

-- Load code into a callable function.
function Env:loadstring(code, file)
	if code:byte(1) == 27 then return nil, "Invalid code!" end
	local f, msg = loadstring(code, ("=%q"):format(file))
	if not f then return nil, msg end
	setfenv(f, self._raw)
	return function(...)
		return log_pcall(pcall(f, ...))
	end
end

function Env:exec(code, file)
	local f, msg = self:loadstring(code, file)
	if not f then
		core.log("error", "[SSCSM] Syntax error: " .. tostring(msg))
		return false
	end
	f()
	return true
end

-- Create the environment
local env = Env:new_empty()

-- Clone everything
env:add_globals("assert", "dump", "dump2", "error", "ipairs", "math",
	"next", "pairs", "pcall", "select", "setmetatable", "string", "table",
	"tonumber", "tostring", "type", "vector", "xpcall", "_VERSION", "utf8")

env:set_copy("os", {clock = os.clock, difftime = os.difftime, time = os.time})

-- Create a slightly locked down "core" table
do
	local t = {}
	for _, k in ipairs({"add_particle", "add_particlespawner", "after",
			"clear_out_chat_queue", "colorize", "compress", "debug",
			"decode_base64", "decompress", "delete_particlespawner",
			"deserialize", "disconnect", "display_chat_message",
			"encode_base64", "explode_scrollbar_event", "explode_table_event",
			"explode_textlist_event", "find_node_near", "find_nodes_in_area",
			"find_nodes_in_area_under_air", "find_nodes_with_meta",
			"formspec_escape", "get_background_escape_sequence",
			"get_color_escape_sequence", "get_day_count", "get_item_def",
			"get_language", "get_meta", "get_node_def", "get_node_level",
			"get_node_light", "get_node_max_level", "get_node_or_nil",
			"get_player_names", "get_privilege_list", "get_server_info",
			"get_timeofday", "get_translator", "get_us_time", "get_version",
			"get_wielded_item", "gettext", "is_nan", "is_yes", "line_of_sight",
			"log", "mod_channel_join", "parse_json",
			"pointed_thing_to_face_pos", "pos_to_string", "privs_to_string",
			"raycast", "register_globalstep", "register_on_damage_taken",
			"register_on_death", "register_on_dignode",
			"register_on_formspec_input", "register_on_hp_modification",
			"register_on_inventory_open", "register_on_item_use",
			"register_on_modchannel_message", "register_on_modchannel_signal",
			"register_on_placenode", "register_on_punchnode",
			"register_on_receiving_chat_message",
			"register_on_sending_chat_message", "rgba",
			"run_server_chatcommand", "send_chat_message", "send_respawn",
			"serialize", "sha1", "show_formspec", "sound_play", "sound_stop",
			"string_to_area", "string_to_pos", "string_to_privs",
			"strip_background_colors", "strip_colors",
			"strip_foreground_colors", "translate", "wrap_text",
			"write_json"}) do
		local func = core[k]
		t[k] = safe_funcs[func] or func
	end

	env:set_copy("minetest", t)
end

-- Add table.unpack
if not table.unpack then
	env._raw.table.unpack = unpack
end

-- Make sure copy() worked correctly
assert(env._raw.minetest.register_on_sending_chat_message ~=
	core.register_on_sending_chat_message, "Error in copy()!")

-- SSCSM functions
-- When calling these from an SSCSM, make sure they exist first.
local mod_channel
local loaded_sscsms = {}
env:set("join_mod_channel", function()
	if not mod_channel then
		mod_channel = core.mod_channel_join("sscsm:exec_pipe")
	end
end)

env:set("leave_mod_channel", function()
	if mod_channel then
		mod_channel:leave()
		mod_channel = nil
	end
end)

env:set("set_error_handler", function(func)
	handle_error = func
end)

-- exec() code sent by the server.
core.register_on_modchannel_message(function(channel_name, sender, message)
	if channel_name ~= "sscsm:exec_pipe" or (sender and sender ~= "") then
		return
	end

	-- The first character is currently a version code, currently 0.
	-- Do not change unless absolutely necessary.
	local version = message:sub(1, 1)
	local name, code
	if version == "0" then
		local s, e = message:find("\n")
		if not s or not e then return end
		local target = message:sub(2, s - 1)
		if target ~= core.localplayer:get_name() then return end
		message = message:sub(e + 1)
		s, e = message:find("\n")
		if not s or not e then return end
		name = message:sub(1, s - 1)
		code = message:sub(e + 1)
	else
		return
	end

	-- Don't load the same SSCSM twice
	if not loaded_sscsms[name] then
		core.log("action", "[SSCSM] Loading " .. name)
		loaded_sscsms[name] = true
		env:exec(code, name)
	end
end)

-- Send "0" when the "sscsm:exec_pipe" channel is first joined.
local sent_request = false
core.register_on_modchannel_signal(function(channel_name, signal)
	if sent_request or channel_name ~= "sscsm:exec_pipe" then
		return
	end

	if signal == 0 then
		env._raw.minetest.localplayer = core.localplayer
		env._raw.minetest.camera = core.camera
		env._raw.minetest.ui = copy(core.ui)
		mod_channel:send_all("0")
		sent_request = true
	elseif signal == 1 then
		mod_channel:leave()
		mod_channel = nil
	end
end)

local function is_fully_connected()
	-- TOSERVER_CLIENT_READY is sent on a different reliable channel to all mod
	-- channel messages. There's no "is_connected" or "register_on_connected"
	-- in CSMs, the next best thing is checking the privilege list and position
	-- as those are only sent after the server receives TOSERVER_CLIENT_READY.
	return core.localplayer and (next(core.get_privilege_list()) or
		not vector.equals(minetest.localplayer:get_pos(), {x = 0, y = -0.5, z = 0}))
end

local function attempt_to_join_mod_channel()
	-- Wait for core.localplayer to become available.
	if not is_fully_connected() then
		core.after(0.05, attempt_to_join_mod_channel)
		return
	end

	-- Join the mod channel
	mod_channel = core.mod_channel_join("sscsm:exec_pipe")
end
core.after(0, attempt_to_join_mod_channel)