File

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 st = require "stanza";
local urlencode = require "net.http".urlencode;

local xmlns_xhtmlim = "http://jabber.org/protocol/xhtml-im";
local xmlns_xhtml = "http://www.w3.org/1999/xhtml";

local function replace_latex(data)
	local origin, stanza = data.origin, data.stanza;
	local body = stanza:get_child_text("body");
	if not body or not body:match("%$%$") then
		return;
	end
	module:log("debug", "Replacing latex...");

	local html = st.stanza("html", { xmlns = xmlns_xhtmlim })
		:tag("body", { xmlns = xmlns_xhtml });

	local in_latex, last_char;
	for snippet, up_to in body:gmatch("(.-)%$%$()") do
		last_char = up_to;
		if in_latex then
			-- Render latex and add image, next snippet is text
			in_latex = nil;
			html:tag("img", { src = "http://www.mathtran.org/cgi-bin/mathtran?D=2;tex="..urlencode(snippet), alt = snippet }):up();
		else
			-- Add text to HTML, next snippet is latex
			in_latex = true;
			html:tag("span"):text(snippet):up();

		end
	end
	if last_char < #body then
		html:tag("span"):text(body:sub(last_char, #body)):up();
	end

	for n, tag in ipairs(stanza.tags) do
		module:log("debug", "Tag: %s|%s", tag.attr.xmlns or "", tag.name or "");
		if tag.name == "html" and tag.attr.xmlns == xmlns_xhtmlim then
			stanza.tags[n] = html;
			for n, child in ipairs(stanza) do
				if child == tag then
					stanza[n] = html;
				end
			end
			return;
		end
	end

	stanza[#stanza+1] = html;
	stanza.tags[#stanza.tags+1] = html;
end

module:hook("message/bare", replace_latex, 30);
module:hook("message/full", replace_latex, 30);