Mercurial > prosody-modules
view mod_muc_notifications/mod_muc_notifications.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 | ef752c5115f7 |
| children |
line wrap: on
line source
-- mod_muc_notifications -- -- Copyright (C) 2019 Marcos de Vera Piquero <marcos.devera@quobis.com> -- -- This file is MIT/X11 licensed. -- -- A module to notify non-present members of messages in a group chat -- local id = require"util.id" local st = require"util.stanza" local use_invite = module:get_option_boolean("muc_notification_invite", false) -- Given a stanza, compute if it qualifies as important (notifiable) -- return true for message stanzas with non-empty body -- Should probably use something similar to muc-message-is-historic event local function is_important(stanza) local body = stanza:find("body#") return body and #body end local function handle_muc_message(event) -- event.room and event.stanza are available local room = event.room local stanza = event.stanza for jid, aff in pairs(room._affiliations) do if aff ~= "outcast" then local is_occupant = false for _, occupant in pairs(room._occupants) do if occupant.bare_jid == jid then is_occupant = true break end end if not is_occupant and is_important(stanza) then -- send notification to jid local attrs = { to = jid, id = id.short(), from = room.jid, } local not_attrs = { xmlns = "http://quobis.com/xmpp/muc#push", jid = room.jid, } local reason = "You have messages in group chat "..(room:get_name() or room.jid) local notification = st.message(attrs) :body(reason):up() :tag("notification", not_attrs):up() :tag("no-store", {xmlns = "urn:xmpp:hints"}) local invite = st.message(attrs):tag("x", {xmlns = "http://jabber.org/protocol/muc#user"}) :tag("invite", {from = stanza.attr.from}) :tag("reason"):text(reason):up():up():up() :tag("notification", not_attrs):up() :tag("no-store", {xmlns = "urn:xmpp:hints"}) module:log("debug", "notifying with %s", tostring(use_invite and invite or notification)) module:send(use_invite and invite or notification) module:log("debug", "sent notification of MUC message %s", use_invite and invite or notification) end end end end module:hook("muc-broadcast-message", handle_muc_message) module:log("debug", "Module loaded")
