Mercurial > prosody-modules
annotate mod_isr/mod_isr.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 | 1cb762f72a91 |
| children |
| rev | line source |
|---|---|
|
5024
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 local st = require "util.stanza"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 local mod_smacks = module:depends("smacks"); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 local xmlns_sasl2 = "urn:xmpp:sasl:1"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 local xmlns_sm = "urn:xmpp:sm:3"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 local xmlns_isr = "https://xmpp.org/extensions/isr/0"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 local xmlns_errors = "urn:ietf:params:xml:ns:xmpp-stanzas"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 module:hook_tag(xmlns_sasl2, "authenticate", function (session, auth) |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 local isr_resume = auth:get_child("inst-resume", xmlns_isr); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 if not isr_resume then return end |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 local is_using_token = isr_resume.attr["with-isr-token"] ~= "false"; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 if is_using_token then |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 -- TODO: If authing with token, set session.sasl_handler to our own |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 -- event.session.sasl_handler = ... |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 error("not yet implemented"); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 end |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 -- Cache resume element for future processing after SASL success |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 session.isr_sm_resume = isr_resume:get_child("resume", "urn:xmpp:sm:3"); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 end, 100); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 module:hook("sasl2/c2s/success", function (event) |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 local session = event.session; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 local sm_resume = session.isr_sm_resume; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 if sm_resume then |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 session.isr_sm_resume = nil; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 local resumed, err = mod_smacks.do_resume(session, sm_resume); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 if not resumed then |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 local failed = st.stanza("failed", { xmlns = xmlns_sm, h = ("%d"):format(err.context.h) }) |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 :tag(err.condition, { xmlns = xmlns_errors }); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 event.success:add_child(failed); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 else |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 event.session = resumed.session; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 event.isr_resumed = resumed; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 event.success:tag("resumed", { xmlns = xmlns_sm, |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 h = ("%d"):format(event.session.handled_stanza_count); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 previd = resumed.id; }):up(); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 end |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 end |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 end, 100); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 module:hook("sasl2/c2s/success", function (event) |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 -- The authenticate response has already been sent at this point |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 local resumed = event.isr_resumed; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 if resumed then |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 resumed.finish(); -- Finish resume and sync stanzas |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 end |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 end, -1100); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 module:hook("sasl2/c2s/failure", function (event) |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 event.session.isr_sm_resume = nil; |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 end); |
|
1cb762f72a91
mod_isr: XEP-0397: Instant Stream Resumption
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 |
