Mercurial > prosody-modules
view mod_muc_hats_api/mod_muc_hats_api.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 | 1f90e333b1d8 |
| children |
line wrap: on
line source
local mod_muc = module:depends("muc"); function add_user_hat(user_jid, room_jid, hat_id, attachment) local room = mod_muc.get_room_from_jid(room_jid); if not room then return nil, "item-not-found", "no such room"; end local user_aff = room:get_affiliation(user_jid); if not user_aff then return nil, "item-not-found", "user not affiliated with room"; end local aff_data = room:get_affiliation_data(user_jid) or {}; local hats = aff_data.hats; if not hats then hats = {}; aff_data.hats = hats; end hats[hat_id] = { active = attachment.active; required = attachment.required; title = attachment.title; }; local ok, err = room:set_affiliation(true, user_jid, user_aff, nil, aff_data); if not ok then return nil, err; end return true; end function remove_user_hat(user_jid, room_jid, hat_id) local room = mod_muc.get_room_from_jid(room_jid); if not room then return nil, "item-not-found", "no such room"; end local user_aff = room:get_affiliation(user_jid); if not user_aff then return nil, "item-not-found", "user not affiliated with room"; end local aff_data = room:get_affiliation_data(user_jid); local hats = aff_data and aff_data.hats; if not hats then return true; end hats[hat_id] = nil; local ok, err = room:set_affiliation(true, user_jid, user_aff, nil, aff_data); if not ok then return nil, err; end return true; end function set_user_hats(user_jid, room_jid, new_hats) local room = mod_muc.get_room_from_jid(room_jid); if not room then return nil, "item-not-found", "no such room"; end local user_aff = room:get_affiliation(user_jid); if not user_aff then return nil, "item-not-found", "user not affiliated with room"; end local aff_data = room:get_affiliation_data(user_jid) or {}; aff_data.hats = new_hats; local ok, err = room:set_affiliation(true, user_jid, user_aff, nil, aff_data); if not ok then return nil, err; end return true; end
