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

local jid = require("util.jid")
local mod_muc = module:depends("muc")

local gateway_hosts = module:get_option_array("gateway_hosts", {})

function optimize(remote_host, event)
	local stanza = event.stanza
	module:log("debug", "optimize presence event destined for " .. remote_host)

	local muc_x = stanza:get_child("x", "http://jabber.org/protocol/muc#user")
	if muc_x then
		for status in muc_x:childtags("status") do
			if status.attr.status == "110" then
				module:log("debug", "optimize delivering 110")
				-- Always deliver self-presence
				return
			end
		end
	end

	local bare_jid = jid.bare(stanza.attr.to)
	local room = mod_muc.get_room_from_jid(jid.bare(stanza.attr.from))
	if not room then return end
	for nick, occupant in room:each_occupant() do
		local occupant_host = jid.host(occupant.bare_jid)
		if occupant_host == remote_host then
			-- This is the "first" occupant from the host
			-- which is the only one we will route non-110
			-- presence to
			if occupant.bare_jid == bare_jid then
				module:log("debug", "optimize found first occupant, so route")
				return
			else
				module:log("debug", "optimize found non-first occupant, so drop")
				return true
			end
		end
	end
	-- If we get here we found no occupants for this host
	module:log("debug", "optimize found no occupants for host " .. remote_host)
end

-- Note this will only affect gateways over s2s for now
module:hook("route/remote", function (event)
	if event.stanza.name ~= "presence" then
		return
	end

	local remote_host = jid.host(event.stanza.attr.to)
	for _, gateway_host in pairs(gateway_hosts) do
		if remote_host == gateway_host then
			return optimize(remote_host, event)
		end
	end
end, 1000)