minetest-sscsm/init.lua

--
-- SSCSM: Server-Sent Client-Side Mods proof-of-concept
--
-- Copyright © 2019-2020 by luk3yx
--
-- 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 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, see <https://www.gnu.org/licenses/>.
--

local modname = minetest.get_current_modname()

-- If this is running as a CSM (improper installation), load the CSM code.
if INIT == "client" then
	local modpath
	if minetest.get_modpath then
		modpath = minetest.get_modpath(modname)
	else
		modpath = modname .. ":"
	end
	dofile(modpath .. "csm/init.lua")
	return
end

local sscsm = {minify=true}
_G[modname] = sscsm
local modpath = minetest.get_modpath(modname)

-- Remove excess whitespace from code to allow larger files to be sent.
if sscsm.minify then
	local f = loadfile(modpath .. "/minify.lua")
	if f then
		sscsm.minify_code = f()
	else
		minetest.log("warning", "[SSCSM] Could not load minify.lua!")
	end
end

if not sscsm.minify_code then
	function sscsm.minify_code(code)
		assert(type(code) == "string")
		return code
	end
end

-- Register code
sscsm.registered_csms = {}
local csm_order = false

-- Recalculate the CSM loading order
-- TODO: Make this nicer
local function recalc_csm_order()
	local staging = {}
	local order = {":init"}
	local unsatisfied = {}
	for name, def in pairs(sscsm.registered_csms) do
		assert(name == def.name)
		if name:sub(1, 1) ~= ":" then
			if not def.depends or #def.depends == 0 then
				table.insert(staging, name)
			else
				unsatisfied[name] = {}
				for _, mod in ipairs(def.depends) do
					if mod:sub(1, 1) ~= ":" then
						unsatisfied[name][mod] = true
					end
				end
			end
		end
	end
	while #staging > 0 do
		local name = staging[1]
		for name2, u in pairs(unsatisfied) do
			if u[name] then
				u[name] = nil
				if #u == 0 then
					table.insert(staging, name2)
				end
			end
		end

		table.insert(order, name)
		table.remove(staging, 1)
	end

	for name, u in pairs(unsatisfied) do
		if next(u) then
			local msg = 'SSCSM "' .. name .. '" has unsatisfied dependencies: '
			local n = false
			for dep, _ in pairs(u) do
				if n then msg = msg .. ", " else n = true end
				msg = msg .. '"' .. dep .. '"'
			end
			minetest.log("error", msg)
		end
	end

	-- Set csm_order
	table.insert(order, ":cleanup")
	csm_order = order
end

-- Register SSCSMs
local block_colon = false
sscsm.registered_csms = {}
function sscsm.register(def)
	-- Read files now in case MT decides to block access later.
	if not def.code and def.file then
		local f = io.open(def.file, "rb")
		if not f then
			error('Invalid "file" parameter passed to sscsm.register_csm.', 2)
		end
		def.code = f:read("*a")
		f:close()
		def.file = nil
	end

	if type(def.name) ~= "string" or def.name:find("\n")
			or (def.name:sub(1, 1) == ":" and block_colon) then
		error('Invalid "name" parameter passed to sscsm.register_csm.', 2)
	end

	if type(def.code) ~= "string" then
		error('Invalid "code" parameter passed to sscsm.register_csm.', 2)
	end

	def.code = sscsm.minify_code(def.code)
	if (#def.name + #def.code) > 65300 then
		error("The code (or name) passed to sscsm.register_csm is too large."
			.. " Consider refactoring your SSCSM code.", 2)
	end

	-- Copy the table to prevent mods from betraying our trust.
	sscsm.registered_csms[def.name] = table.copy(def)
	if csm_order then recalc_csm_order() end
end

function sscsm.unregister(name)
	sscsm.registered_csms[name] = nil
	if csm_order then recalc_csm_order() end
end

-- Recalculate the CSM order once all other mods are loaded
minetest.register_on_mods_loaded(recalc_csm_order)

-- Handle players joining
local has_sscsms = {}
local mod_channel = minetest.mod_channel_join("sscsm:exec_pipe")
minetest.register_on_modchannel_message(function(channel_name, sender, message)
	if channel_name ~= "sscsm:exec_pipe" or not sender or
			not mod_channel:is_writeable() or message ~= "0" or
			sender:find("\n") or has_sscsms[sender] then
		return
	end
	minetest.log("action", "[SSCSM] Sending CSMs on request for " .. sender
		.. "...")
	for _, name in ipairs(csm_order) do
		mod_channel:send_all("0" .. sender .. "\n" .. name
			.. "\n" .. sscsm.registered_csms[name].code)
	end
end)

-- Register the SSCSM "builtins"
sscsm.register({
	name = ":init",
	file = modpath .. "/sscsm_init.lua"
})

sscsm.register({
	name = ":cleanup",
	code = "sscsm._done_loading_()"
})

block_colon = true

-- Set the CSM restriction flags
local flags = tonumber(minetest.settings:get("csm_restriction_flags"))
if not flags or flags ~= flags then
	flags = 62
end
flags = math.floor(math.max(flags, 0)) % 64

do
	local def = sscsm.registered_csms[":init"]
	def.code = def.code:gsub("__FLAGS__", tostring(flags))
end

if math.floor(flags / 2) % 2 == 1 then
	minetest.log("warning", "[SSCSM] SSCSMs enabled, however CSMs cannot "
		.. "send chat messages! This will prevent SSCSMs from sending "
		.. "messages to the server.")
	sscsm.com_write_only = true
else
	sscsm.com_write_only = false
end

-- SSCSM communication
local function validate_channel(channel)
	if type(channel) ~= "string" then
		error("SSCSM com channels must be strings!", 3)
	end
	if channel:find("\001", nil, true) then
		error("SSCSM com channels cannot contain U+0001!", 3)
	end
end

local msgids = {}
function sscsm.com_send(pname, channel, msg)
	if minetest.is_player(pname) then
		pname = pname:get_player_name()
	end
	validate_channel(channel)
	if type(msg) == "string" then
		msg = "\002" .. msg
	else
		msg = assert(minetest.write_json(msg))
	end

	-- Short messages can be sent all at once
	local prefix = "\001SSCSM_COM\001" .. channel .. "\001"
	if #msg < 65300 then
		minetest.chat_send_player(pname, prefix .. msg)
		return
	end

	-- You should never send messages over 128MB to clients
	assert(#msg < 134217728)

	-- Otherwise split the message into multiple chunks
	prefix = prefix .. "\001"
	local id = #msgids + 1
	local i = 0
	msgids[id] = true
	local total_msgs = math.ceil(#msg / 65000)
	repeat
		i = i + 1
		minetest.chat_send_player(pname, prefix .. id .. "\001" .. i ..
			"\001" .. total_msgs .. "\001" .. msg:sub(1, 65000))
		msg = msg:sub(65001)
	until msg == ""

	-- Allow the ID to be reused on the next globalstep.
	minetest.after(0, function()
		msgids[id] = nil
	end)
end

local registered_on_receive = {}
function sscsm.register_on_com_receive(channel, func)
	if not registered_on_receive[channel] then
		registered_on_receive[channel] = {}
	end
	table.insert(registered_on_receive[channel], func)
end

local admin_func = minetest.registered_chatcommands["admin"].func
minetest.override_chatcommand("admin", {
	func = function(name, param)
		local chan, msg = param:match("^\001SSCSM_COM\001([^\001]*)\001(.*)$")
		if not chan or not msg then
			return admin_func(name, param)
		end

		-- Get the callbacks
		local callbacks = registered_on_receive[chan]
		if not callbacks then return end

		-- Load the message
		if msg:sub(1, 1) == "\002" then
			msg = msg:sub(2)
		else
			msg = minetest.parse_json(msg)
		end

		-- Run callbacks
		for _, func in ipairs(callbacks) do
			func(name, msg)
		end
	end,
})

-- Add a callback for sscsm:com_test
local registered_on_loaded = {}
function sscsm.register_on_sscsms_loaded(func)
	table.insert(registered_on_loaded, func)
end

sscsm.register_on_com_receive("sscsm:com_test", function(name, msg)
	if type(msg) ~= "table" or msg.flags ~= flags or has_sscsms[name] then
		return
	end
	has_sscsms[name] = true
	for _, func in ipairs(registered_on_loaded) do
		func(name)
	end
end)

function sscsm.has_sscsms_enabled(name)
	return has_sscsms[name] or false
end

minetest.register_on_leaveplayer(function(player)
	has_sscsms[player:get_player_name()] = nil
end)

function sscsm.com_send_all(channel, msg)
	for name, _ in pairs(has_sscsms) do
		sscsm.com_send(name, channel, msg)
	end
end