Software / code / prosody-modules
File
mod_ping_muc/mod_ping_muc.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 | 5979:d6a695abb33c |
line wrap: on
line source
local id = require "util.id"; local jid = require "util.jid"; local set = require "util.set"; local st = require "util.stanza"; if module:get_host_type() ~= "local" then module:log("error", "mod_%s must be loaded as a regular module, not on Components", module.name); return end module:depends "track_muc_joins"; module:add_feature("https://modules.prosody.im/mod_" .. module.name); local local_sessions = prosody.hosts[module.host].sessions; module:hook_global("s2s-destroyed", function(event) local s2s_session = event.session; if s2s_session.direction == "outgoing" and s2s_session.from_host ~= module.host then return elseif s2s_session.direction == "incoming" and s2s_session.to_host ~= module.host then return end local related_hosts = set.new({ s2s_session.direction == "outgoing" and s2s_session.to_host or s2s_session.from_host }); if s2s_session.hosts then -- While rarely used, multiplexing is still supported for host, state in pairs(s2s_session.hosts) do if state.authed then related_hosts:add(host); end end end local ping_delay = module:get_option_number("ping_muc_delay", 60, 1); module:add_timer(ping_delay, function () for _, user_session in pairs(local_sessions) do for _, session in pairs(user_session.sessions) do if session.rooms_joined then for room, info in pairs(session.rooms_joined) do local nick = info.nick or info; local room_nick = room .. "/" .. nick; if related_hosts:contains(jid.host(room)) then -- User is in a MUC room for which the s2s connection was lost. Now what? -- Self-ping -- ========= -- -- Response of <iq type=result> means the user is still in the room -- (and self-ping is supported), so we do nothing. -- -- An error reply either means the user has fallen out of the room, -- or that self-ping is unsupported. In the later case, whether the -- user is still joined is indeterminate and we might as well -- pretend they fell out. module:send_iq(st.iq({ type = "get"; id = id.medium(); from = session.full_jid; to = room_nick }) :tag("ping", { xmlns = "urn:xmpp:ping"; })) :catch(function(err) module:send( st.presence({ type = "unavailable"; id = id.medium(); to = session.full_jid; from = room_nick }) :tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }) :tag("item", { affiliation = "none"; role = "none" }) :text_tag("reason", err.text or "Connection to remote server lost") :up() :tag("status", { code = "110" }):up() :tag("status", { code = "333" }):up() :reset()); end); end end end end end end) end);