Software / code / prosody-modules
Annotate
mod_log_json/mod_log_json.lua @ 6302:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md
--- a/mod_cloud_notify/README.md
+++ b/mod_cloud_notify/README.md
@@ -1,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+This protocol is described for developers in [XEP-0357: Push
+Notifications].
-For this module to work reliably, you must have \[mod_smacks\],
-\[mod_mam\] and \[mod_carbons\] also enabled on your server.
+For this module to work reliably, you must have [mod_smacks],
+[mod_mam] and [mod_carbons] also enabled on your server.
Some clients, notably Siskin and Snikket iOS need some additional
extensions that are not currently defined in a standard XEP. To support
-these clients, see \[mod_cloud_notify_extensions\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# Internal design notes
App servers are notified about offline messages, messages stored by
-\[mod_mam\] or messages waiting in the smacks queue. The business rules
+[mod_mam] or messages waiting in the smacks queue. The business rules
outlined
[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
are all honored[^2].
-To cooperate with \[mod_smacks\] this module consumes some events:
+To cooperate with [mod_smacks] this module consumes some events:
`smacks-ack-delayed`, `smacks-hibernation-start` and
`smacks-hibernation-end`. These events allow this module to send out
notifications for messages received while the session is hibernated by
-\[mod_smacks\] or even when smacks acknowledgements for messages are
+[mod_smacks] or even when smacks acknowledgements for messages are
delayed by a certain amount of seconds configurable with the
-\[mod_smacks\] setting `smacks_max_ack_delay`.
+[mod_smacks] setting `smacks_max_ack_delay`.
The `smacks_max_ack_delay` setting allows to send out notifications to
clients which aren't already in smacks hibernation state (because the
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parent | 5956:0b347a7c5b5f |
| 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 | |
|
5956
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); |
