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 muc = module:depends("muc");
local rand = require"util.random";

local s_match = string.match;
local s_gmatch = string.gmatch;
local t_insert = table.insert;
local t_concat = table.concat;

local rooms = module:get_option_set("muc_dicebot_rooms", nil);
local xmlns_nick = "http://jabber.org/protocol/nick";

local function is_room_affected(roomjid)
	return not rooms or rooms:contains(roomjid)
end

local function roll(sides)
	if sides > 256 then
		return nil, "too many sides"
	end
	local factor = math.floor(256 / sides);
	local cutoff = sides * factor;
	module:log("error", "%d -> %d %d %d", sides, max, factor, cutoff);
	for i=1,10 do
		local randomness = string.byte(rand.bytes(1), 1);
		module:log("error", "%d", randomness);
		if randomness < cutoff then
			return (randomness % sides) + 1
		end
	end
	return nil, "failed to find valid number"
end

local function muc_broadcast_message(event)
	if not is_room_affected(event.room.jid) then
		return
	end

	local stanza = event.stanza;
	local body = stanza:get_child("body");
	if not body then
		return
	end

	local text = body:get_text();
	module:log("error", "%q %q %q", stanza, body, text);
	local dice = s_match(text, "^[%.!]r%s(.+)$");
	if not dice or dice == "" then
		return
	end

	local results = {};
	local count = 0;
	local sum = 0;
	for ndice, sep, sides in s_gmatch(dice, "(%d*)([wd]?)(%d+)") do
		if not sep or sep == "" then
			sides = ndice .. sides
			ndice = "1"
		end
		local ndice = tonumber(ndice);
		count = count + ndice;
		if count > 100 then
			return true
		end
		local sides = tonumber(sides);
		for i=1,ndice do
			local value = roll(sides);
			t_insert(results, tostring(value));
			sum = sum + value;
		end
	end
	body:text("\n⇒ "..t_concat(results, " ").." (sum: "..sum..")");
end

module:hook("muc-broadcast-message", muc_broadcast_message);