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 st = require "util.stanza";
local datetime = require "util.datetime";

local function shorten(x) return string.sub(x, 1, -32) end

local function firstline(x) return x:match("^[^\r\n]*") end

local function branch(x) return string.sub(x, 12) end

local function tag(x) return string.sub(x, 11) end

local function noop(x) return x end

local filters = {
	shorten = shorten,
	firstline = firstline,
	branch = branch,
	tag = tag
}

local render = require"util.interpolation".new("%b{}", noop, filters);

local function get_item(data, templates)
	local function render_tpl(name) return render(templates[name], {data = data}) end

	local now = datetime.datetime()
	local id = render(templates["id"], {data = data})
	-- LuaFormatter off
	return st.stanza("item", {id = id, xmlns = "http://jabber.org/protocol/pubsub"})
		:tag("entry", {xmlns = "http://www.w3.org/2005/Atom"})
			:tag("id"):text(id):up()
			:tag("title"):text(render_tpl("title")):up()
			:tag("content", {type = "text"}):text(render_tpl("content")):up()
			:tag("link", {rel = "alternate", href = render_tpl("link")}):up()
			:tag("published"):text(now):up()
			:tag("updated"):text(now):up()
			:tag("author")
			:tag("name")
				:text(data.sender.username):up()
				:tag("email"):text(data.sender.email)
    -- LuaFormatter on
end

return get_item