Mercurial > prosody-modules
view mod_muc_bot/mod_muc_bot.lua @ 6214:cc5c0f1dc89b
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
| author | Menel <menel@snikket.de> |
|---|---|
| date | Mon, 12 May 2025 10:42:26 +0200 |
| parents | 205b9d06fe6b |
| children |
line wrap: on
line source
local st = require "util.stanza"; local jid = require "util.jid"; local bots = module:get_option_set("known_bots", {}); module:hook("muc-occupant-groupchat", function(event) if event.occupant then return end -- skip messages from actual occupants local room = event.room; if bots:contains(jid.bare(event.from)) or bots:contains(jid.host(event.from)) then local nick = room:get_registered_nick(jid); if not nick then -- Allow bot to specify its own nick, but we're appending '[bot]' to it. -- FIXME HATS!!! nick = event.stanza:get_child_text("nick", "http://jabber.org/protocol/nick"); nick = (nick or jid.bare(event.from)) .. "[bot]"; end local virtual_occupant_jid = jid.prep(room.jid .. "/" .. nick, true); if not virtual_occupant_jid then module:send(st.error_reply(event.stanza, "modify", "jid-malformed", "Nickname must pass strict validation", room.jid)); return true; end local occupant = room:new_occupant(jid.bare(event.from), virtual_occupant_jid); local join = st.presence({from = event.from; to = virtual_occupant_jid}); local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"}); occupant:set_session(event.from, join, true); room:save_occupant(occupant); room:publicise_occupant_status(occupant, dest_x); -- Inject virtual occupant to trick all the other hooks on this event that -- this is an actual legitimate participant. event.occupant = occupant; end end, 66); module:hook("muc-occupant-pre-join", function(event) local room = event.room; local nick = jid.resource(event.occupant.nick); if nick:sub(-5, -1) == "[bot]" then event.origin.send(st.error_reply(event.stanza, "modify", "policy-violation", "Only known bots may use the [bot] suffix", room.jid)); return true; end end, 3); module:hook("muc-occupant-pre-change", function(event) local room = event.room; local nick = jid.resource(event.dest_occupant.nick); if nick:sub(-5, -1) == "[bot]" then event.origin.send(st.error_reply(event.stanza, "modify", "policy-violation", "Only known bots may use the [bot] suffix", room.jid)); return true; end end, 3); if not module:get_option_boolean("bots_get_messages", true) then module:hook("muc-broadcast-message", function (event) event.room:broadcast(event.stanza, function (nick, occupant) if nick:sub(-5, -1) == "[bot]" or bots:contains(occupant.bare_jid) or bots:contains(jid.host(occupant.bare_jid)) then return false; else return true; end end); return true; end, -100); end if module:get_option_boolean("ignore_bot_errors", true) then module:hook("message/full", function (event) local stanza = event.stanza; if stanza.attr.type == "error" then if bots:contains(jid.bare(stanza.attr.from)) or bots:contains(jid.host(stanza.attr.from)) then module:log("debug", "Ignoring error from known bot"); return true; end end end, 1); end assert(string.sub("foo[bot]", -5, -1) == "[bot]", "substring indicies, how do they work?");
