mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License. diff --git a/mod_muc_anonymize_moderation_actions/README.md b/mod_muc_anonymize_moderation_actions/README.md --- a/mod_muc_anonymize_moderation_actions/README.md +++ b/mod_muc_anonymize_moderation_actions/README.md @@ -1,8 +1,10 @@ -<!-- -SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> -SPDX-License-Identifier: AGPL-3.0-only ---> -# mod_muc_anonymize_moderation_actions +--- +labels: +- 'Stage-Alpha' +summary: Anonymize moderator actions for participants +--- + +## Introduction This modules allows to anonymize affiliation and role changes in MUC rooms. @@ -11,13 +13,10 @@ When the feature is enabled, when a mode This is particularly usefull to prevent some revenge when a moderator bans someone. -This module is under AGPL-3.0 license. - -It was tested on Prosody 0.12.x. ## Configuration -Just enable the module on your MUC VirtualHost. +Just enable the module on your MUC Component. The feature will be accessible throught the room configuration form. You can tweak the position of the settings in the MUC configuration form using `anonymize_moderation_actions_form_position`. @@ -26,7 +25,20 @@ This value will be passed as priority fo By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom (default value is `78`). ``` lua -VirtualHost "muc.example.com" +Component "muc.example.com" "muc" modules_enabled = { "muc_anonymize_moderation_actions" } anonymize_moderation_actions_form_position = 96 ``` + +## Compatibility + + ------ ---------------------- + trunk Works as of 25-05-12 + 0.13 Works + 0.12 Works + ------ ---------------------- + +### License + +SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> +SPDX-License-Identifier: AGPL-3.0-only

local now = os.time;

local s2smanager = require "core.s2smanager";
local timer = require "util.timer";

local s2s_sessions = setmetatable({}, { __mode = "kv" });

local idle_timeout = module:get_option("s2s_idle_timeout") or 300;
local check_interval = math.ceil(idle_timeout * 0.75);

local function install_checks(session)
	if not session.last_received_time then
		session.last_received_time = now();
		if session.direction == "incoming" then
			local _data = session.data;
			function session.data(conn, data)
				session.last_received_time = now();
				return _data(conn, data);
			end
		else
			local _sends2s = session.sends2s;
			function session.sends2s(data)
				session.last_received_time = now();
				return _sends2s(data);
			end
		end
		s2s_sessions[session] = true;
	end
end

module:hook("s2s-authenticated", function (event)
	install_checks(event.session);
end);

function check_idle_sessions(time)
	time = time or now();
	for session in pairs(s2s_sessions) do
		local last_received_time = session.last_received_time;
		if last_received_time and time - last_received_time > idle_timeout then
			module:log("debug", "Closing idle connection %s->%s",
				session.from_host or "(unknown)", session.to_host or "(unknown)");
			session:close(); -- Close-on-idle isn't an error
			s2s_sessions[session] = nil;
		end
	end
	return check_interval;
end
timer.add_task(check_interval, check_idle_sessions);

function module.save()
	return { s2s_sessions = s2s_sessions };
end

function module.restore(data)
	s2s_sessions = setmetatable(data.s2s_sessions or {}, { __mode = "kv" });
end