Mercurial > prosody-modules
annotate mod_log_json/mod_log_json.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 | 0b347a7c5b5f |
| children |
| rev | line source |
|---|---|
|
4974
807007913f67
mod_log_json: Prefer native Lua table.pack over Prosody util.table one
Kim Alvefur <zash@zash.se>
parents:
4462
diff
changeset
|
1 local pack = table.pack or require "util.table".pack; |
| 3732 | 2 local json = require "util.json"; |
| 3 local array = require "util.array"; | |
| 4 local datetime = require "util.datetime".datetime; | |
| 3746 | 5 local socket = require "socket"; |
| 3732 | 6 |
| 7 module:set_global(); | |
| 8 | |
| 9 local function sink_maker(config) | |
| 3746 | 10 local send = function () end |
| 11 if config.filename then | |
|
5928
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
12 local logfile; |
|
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
13 if config.filename == "/dev/stdout" then |
|
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
14 logfile = io.stdout; |
|
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
15 else |
|
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
16 logfile = io.open(config.filename, "a+"); |
|
0b347a7c5b5f
mod_log_json: Support for logging to stdout
Matthew Wild <mwild1@gmail.com>
parents:
4974
diff
changeset
|
17 end |
| 3746 | 18 logfile:setvbuf("no"); |
| 19 function send(payload) | |
| 20 logfile:write(payload, "\n"); | |
| 21 end | |
| 22 elseif config.udp_host and config.udp_port then | |
| 23 local conn = socket.udp(); | |
|
3748
27abf3b6819a
mod_log_json: Use correct method to specify remote endpoint
Kim Alvefur <zash@zash.se>
parents:
3747
diff
changeset
|
24 conn:setpeername(config.udp_host, config.udp_port); |
| 3746 | 25 function send(payload) |
| 26 conn:send(payload); | |
| 27 end | |
| 28 end | |
|
4462
4356088ad675
mod_log_json: allow logging of formatted message
Jonas Schäfer <jonas@wielicki.name>
parents:
3758
diff
changeset
|
29 local format = require "util.format".format; |
|
4356088ad675
mod_log_json: allow logging of formatted message
Jonas Schäfer <jonas@wielicki.name>
parents:
3758
diff
changeset
|
30 local do_format = config.formatted_as or false; |
| 3732 | 31 return function (source, level, message, ...) |
| 32 local args = pack(...); | |
| 33 for i = 1, args.n do | |
| 34 if args[i] == nil then | |
| 35 args[i] = json.null; | |
| 36 elseif type(args[i]) ~= "string" or type(args[i]) ~= "number" then | |
| 37 args[i] = tostring(args[i]); | |
| 38 end | |
| 39 end | |
| 40 args.n = nil; | |
| 41 local payload = { | |
| 42 datetime = datetime(), | |
| 43 source = source, | |
| 44 level = level, | |
| 45 message = message, | |
| 46 args = array(args); | |
| 47 }; | |
|
4462
4356088ad675
mod_log_json: allow logging of formatted message
Jonas Schäfer <jonas@wielicki.name>
parents:
3758
diff
changeset
|
48 if do_format then |
|
4356088ad675
mod_log_json: allow logging of formatted message
Jonas Schäfer <jonas@wielicki.name>
parents:
3758
diff
changeset
|
49 payload[do_format] = format(message, ...) |
|
4356088ad675
mod_log_json: allow logging of formatted message
Jonas Schäfer <jonas@wielicki.name>
parents:
3758
diff
changeset
|
50 end |
| 3746 | 51 send(json.encode(payload)); |
| 3732 | 52 end |
| 53 end | |
| 54 | |
|
3758
900ea02ab00b
mod_log_json: Deregister log sink on unload
Kim Alvefur <zash@zash.se>
parents:
3748
diff
changeset
|
55 function module.unload() |
|
900ea02ab00b
mod_log_json: Deregister log sink on unload
Kim Alvefur <zash@zash.se>
parents:
3748
diff
changeset
|
56 -- deregister |
|
900ea02ab00b
mod_log_json: Deregister log sink on unload
Kim Alvefur <zash@zash.se>
parents:
3748
diff
changeset
|
57 require"core.loggingmanager".register_sink_type("json", nil); |
|
900ea02ab00b
mod_log_json: Deregister log sink on unload
Kim Alvefur <zash@zash.se>
parents:
3748
diff
changeset
|
58 end |
|
900ea02ab00b
mod_log_json: Deregister log sink on unload
Kim Alvefur <zash@zash.se>
parents:
3748
diff
changeset
|
59 |
| 3732 | 60 require"core.loggingmanager".register_sink_type("json", sink_maker); |
