Mercurial > prosody-modules
view mod_export_skeletons/mod_export_skeletons.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 | 17fbe82d4bfe |
| children |
line wrap: on
line source
local t_insert = table.insert; local t_sort = table.sort; local sm = require "core.storagemanager"; local um = require "core.usermanager"; local argparse = require "util.argparse"; local dt = require "util.datetime"; local jid = require "util.jid"; local st = require "util.stanza"; local function skeleton(s) local o = st.stanza(s.name, { xmlns = s.attr.xmlns }); local children = {}; for _, child in ipairs(s.tags) do t_insert(children, skeleton(child)) end t_sort(children, function(a, b) if a.attr.xmlns == b.attr.xmlns then return a.name < b.name; end return (a.attr.xmlns or "") < (b.attr.xmlns or ""); end); for _, child in ipairs(children) do o:add_direct_child(child); end return o; end local function classify_jid(s) if not s then return "" end local u, h, r = jid.split(s); if r then return "full" elseif u then return "bare" elseif h then return "host" else return "invalid" end end function module.command(arg) local opts = argparse.parse(arg, { value_params = { store = true; with = true; start = true; ["end"] = true } }); local store = opts.store or "archive"; -- so you can pass 'archive2' opts.store = nil; local query = { with = jid.prep(opts.with); start = dt.parse(opts.start); ["end"] = dt.parse(opts["end"]) }; local host_initialized = {}; for _, export_jid in ipairs(arg) do local username, host = jid.split(export_jid); if not host_initialized[host] then sm.initialize_host(host); um.initialize_host(host); host_initialized[host] = true; end local archive = module:context(host):open_store(store, "archive"); local iter, total = assert(archive:find(username, query)) if total then io.stderr:write(string.format("Processing %d entries\n", total)); end for _, item in iter do local clean = skeleton(item); -- Normalize top level attributes clean.attr.type = item.attr.type; if clean.attr.type == nil and clean.name == "message" then clean.attr.type = "normal"; end clean.attr.id = string.rep("x", math.floor(math.log(1+#(item.attr.id or ""), 2))); clean.attr.from = classify_jid(item.attr.from); clean.attr.to = classify_jid(item.attr.to); print(clean); end end end
