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 muc = module:depends("muc");
local rand = require"util.random";

local s_match = string.match;
local s_gmatch = string.gmatch;
local t_insert = table.insert;
local t_concat = table.concat;

local rooms = module:get_option_set("muc_dicebot_rooms", nil);
local xmlns_nick = "http://jabber.org/protocol/nick";

local function is_room_affected(roomjid)
	return not rooms or rooms:contains(roomjid)
end

local function roll(sides)
	if sides > 256 then
		return nil, "too many sides"
	end
	local factor = math.floor(256 / sides);
	local cutoff = sides * factor;
	module:log("error", "%d -> %d %d %d", sides, max, factor, cutoff);
	for i=1,10 do
		local randomness = string.byte(rand.bytes(1), 1);
		module:log("error", "%d", randomness);
		if randomness < cutoff then
			return (randomness % sides) + 1
		end
	end
	return nil, "failed to find valid number"
end

local function muc_broadcast_message(event)
	if not is_room_affected(event.room.jid) then
		return
	end

	local stanza = event.stanza;
	local body = stanza:get_child("body");
	if not body then
		return
	end

	local text = body:get_text();
	module:log("error", "%q %q %q", stanza, body, text);
	local dice = s_match(text, "^[%.!]r%s(.+)$");
	if not dice or dice == "" then
		return
	end

	local results = {};
	local count = 0;
	local sum = 0;
	for ndice, sep, sides in s_gmatch(dice, "(%d*)([wd]?)(%d+)") do
		if not sep or sep == "" then
			sides = ndice .. sides
			ndice = "1"
		end
		local ndice = tonumber(ndice);
		count = count + ndice;
		if count > 100 then
			return true
		end
		local sides = tonumber(sides);
		for i=1,ndice do
			local value = roll(sides);
			t_insert(results, tostring(value));
			sum = sum + value;
		end
	end
	body:text("\n⇒ "..t_concat(results, " ").." (sum: "..sum..")");
end

module:hook("muc-broadcast-message", muc_broadcast_message);