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 mm = require "core.modulemanager";
local st = require "util.stanza";
local jid_host, jid_prep = import("util.jid", "host", "prep");

local invite_to_room = assert(jid_prep(module:get_option_string(module.name)),
	"The option " .. module.name .. " must be set");
local inviter = module:get_option_string(module.name .. "_inviter", module.host);
local invite_reason = module:get_option_string(module.name .. "_reason");

module:hook("user-registered", function (event)
	local user_jid = event.username .. "@" .. event.host;
	local muc = mm.get_module(jid_host(invite_to_room), "muc");
	if not muc then
		module:log("error", "There is no MUC service '%s'", jid_host(invite_to_room));
		return;
	end
	local room = muc.get_room_from_jid(invite_to_room);
	if room then
		room:set_affiliation(true, user_jid, "member", invite_reason, { reserved_nickname = event.username });
		-- Invite them to the room too
		module:send(st.message({ from = inviter, to = user_jid })
			:tag("x", { xmlns = "jabber:x:conference", jid = invite_to_room, reason = invite_reason }):up());
	else
		module:log("error", "The room %s does not exist, can't invite newly registered user", invite_to_room);
	end
end);