Mercurial > prosody-modules
view mod_xhtmlim/mod_xhtmlim.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 | 1f68287138e3 |
| children | 7547c2869e78 |
line wrap: on
line source
-- XEP-0071: XHTML-IM sanitizing local assert = assert; local st = require "util.stanza"; local url = require "socket.url"; local no_styles = module:get_option_boolean("strip_xhtml_style", true); -- Tables from XEP-0071 local xeptables = [[ <body/> class, id, title; style <head/> profile <html/> version <title/> <abbr/> class, id, title; style <acronym/> class, id, title; style <address/> class, id, title; style <blockquote/> class, id, title; style; cite <br/> class, id, title; style <cite/> class, id, title; style <code/> class, id, title; style <dfn/> class, id, title; style <div/> class, id, title; style <em/> class, id, title; style <h1/> class, id, title; style <h2/> class, id, title; style <h3/> class, id, title; style <h4/> class, id, title; style <h5/> class, id, title; style <h6/> class, id, title; style <kbd/> class, id, title; style <p/> class, id, title; style <pre/> class, id, title; style <q/> class, id, title; style; cite <samp/> class, id, title; style <span/> class, id, title; style <strong/> class, id, title; style <var/> class, id, title; style <a/> class, id, title; style; accesskey, charset, href, hreflang, rel, rev, tabindex, type <dl/> class, id, title; style <dt/> class, id, title; style <dd/> class, id, title; style <ol/> class, id, title; style <ul/> class, id, title; style <li/> class, id, title; style <img/> class, id, title; style; alt, height, longdesc, src, width ]]; -- map of whitelisted tag names to set of allowed attributes local tags = {}; -- { string : { string : boolean } } for tag, attrs in xeptables:gmatch("<(%w+)/>([^\n]*)") do tags[tag] = { xmlns = true, ["xml:lang"] = true }; for attr in attrs:gmatch("%w+") do tags[tag][attr] = true; end if no_styles then tags[tag]["style"] = nil; end end -- module:log("debug", "tags = %s;", require "util.serialization".serialize(tags)); -- TODO Decide if disallowed tags should be bounced or silently discarded. -- XEP says "ignore" and replace tag with text content, but that would -- need a different transform which can't use `maptags`. if not module:get_option_boolean("bounce_invalid_xhtml", false) then assert = function (x) return x end end local function sanitize_xhtml(tag) -- module:log("debug", "sanitize_xhtml(<{%s}%s>)", tag.attr.xmlns, tag.name); if tag.attr.xmlns == "http://www.w3.org/1999/xhtml" then local allowed = assert(tags[tag.name], tag.name); if allowed then for attr, value in pairs(tag.attr) do if not allowed[attr] then -- module:log("debug", "Removing disallowed attribute %q from <%s>", attr, tag.name); tag.attr[attr] = nil; elseif attr == "src" or attr == "href" then local urlattr = url.parse(value); local scheme = urlattr and urlattr.scheme; if scheme ~= "http" and scheme ~= "https" and scheme ~= "mailto" and scheme ~= "xmpp" and scheme ~= "cid" then tag.attr[attr] = "https://url.was.invalid/"; end end end else tag.name = "span" tag.attr = { xmlns = "http://www.w3.org/1999/xhtml" } end -- Check child tags tag:maptags(sanitize_xhtml); -- This tag is clean! return tag; end -- Not xhtml, probably best to discard it return nil; end -- Check for xhtml-im, sanitize if exists local function message_handler(event) local stanza = event.stanza; if stanza:get_child("html", "http://jabber.org/protocol/xhtml-im") then stanza = st.clone(stanza); if pcall(function() -- try stanza:get_child("html", "http://jabber.org/protocol/xhtml-im"):maptags(sanitize_xhtml); end) then event.stanza = stanza; else -- catch if stanza.attr.type ~= "error" then event.origin.send(st.error_reply(stanza, "modify", "not-acceptable", "Stanza contained illegal XHTML-IM tag")); end return true; end end end -- Stanzas received from clients module:hook("pre-message/bare", message_handler, 71); module:hook("pre-message/full", message_handler, 71); module:hook("pre-message/host", message_handler, 71); -- Stanzas about to be delivered to clients module:hook("message/bare", message_handler, 71); module:hook("message/full", message_handler, 71);
