Mercurial > prosody-modules
annotate mod_pubsub_stats/mod_pubsub_stats.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 | b2ce818ec19c |
| children |
| rev | line source |
|---|---|
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 local st = require "util.stanza"; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 local pubsub = module:depends"pubsub"; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 local actor = module.host .. "/modules/" .. module.name; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
|
3160
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
7 local pubsub_xmlns = "http://jabber.org/protocol/pubsub" |
|
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
8 |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
9 local node = module:get_option_string(module.name .. "_node", "stats"); |
|
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
10 |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 local function publish_stats(stats, stats_extra) |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 local id = "current"; |
|
3160
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
13 local xitem = st.stanza("item", { xmlns = pubsub_xmlns, id = id }) |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 :tag("query", { xmlns = "http://jabber.org/protocol/stats" }); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 for name, value in pairs(stats) do |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 local stat_extra = stats_extra[name]; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 local unit = stat_extra and stat_extra.units; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 xitem:tag("stat", { name = name, unit = unit, value = tostring(value) }):up(); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
22 local ok, err = pubsub.service:publish(node, actor, id, xitem); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 if not ok then |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 module:log("error", "Error publishing stats: %s", err); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 function module.load() |
|
3175
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
29 pubsub.service:create(node, true, { |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
30 persistent_items = false; |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
31 max_items = 1; |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
32 }); |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
33 pubsub.service:set_affiliation(node, true, actor, "publisher"); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 module:hook_global("stats-updated", function (event) |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 publish_stats(event.stats, event.stats_extra); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 end); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 function module.unload() |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
41 pubsub.service:delete(node, true); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 end |
|
3407
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
43 |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
44 module:hook("pubsub-summary/http://jabber.org/protocol/stats", function (event) |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
45 local payload = event.payload; |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
46 local summary = {}; |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
47 for stat in payload:childtags("stat") do |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
48 if stat.attr.name and stat.attr.value then |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
49 table.insert(summary, string.format("%s: %g %s", stat.attr.name, tonumber(stat.attr.value), stat.attr.units or "")); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
50 end |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
51 end |
| 3408 | 52 table.sort(summary); |
|
3407
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
53 return table.concat(summary, "\n"); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
54 end); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
55 |
