prosody-modules
06fbbd45ba75
mod_csi_compat/mod_csi_compat.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_csi_compat/mod_csi_compat.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 1865:db8b256f51ff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1486
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 local st = require "util.stanza";
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 module:depends("csi");
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 module:add_feature("google:queue");
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 module:hook("iq-set/self/google:queue:query", function(event)
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 local origin, stanza = event.origin, event.stanza;
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 (origin.log or module._log)("debug", "Google queue invoked (CSI compat mode)")
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 local payload = stanza:get_child("query", "google:queue");
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 if payload:get_child("enable") then
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 module:fire_event("csi-client-inactive", event);
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 elseif payload:get_child("disable") then
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 module:fire_event("csi-client-active", event);
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 end
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 -- <flush/> is implemented as a noop, any IQ stanza would flush the queue anyways.
1865
db8b256f51ff mod_admin_web,mod_carbons,mod_csi_compat,mod_mam_muc,mod_tcpproxy: Explicitly return true
Kim Alvefur <zash@zash.se>
parents: 1486
diff changeset
17 origin.send(st.reply(stanza));
db8b256f51ff mod_admin_web,mod_carbons,mod_csi_compat,mod_mam_muc,mod_tcpproxy: Explicitly return true
Kim Alvefur <zash@zash.se>
parents: 1486
diff changeset
18 return true;
1486
b3e692ee16b5 mod_csi_compat: Implement the google:queue protocol and map to mod_csi events
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 end, 10);