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

var xmlns_ibb = "http://jabber.org/protocol/ibb";
var xmlns_tcp = "http://prosody.im/protocol/tcpproxy";

function XMPPIO(xmppconn, xmpptcp_host)
{
	this.xmppconn = xmppconn;
	this.xmpphost = xmpptcp_host;
	this.sid = "FIXME";

	this.listeners = [];
	return this;
}

XMPPIO.prototype = {
	connect: function (host, port)
	{
		var conn = this;
		console.log("Connecting...");

		function onConnect()
		{
			this.xmppconn.addHandler(function (stanza)
			{
				var data = stanza.getElementsByTagName("data")[0];
				if(data)
					conn.emit("data", Strophe.Base64.decode(Strophe.getText(data)));
			}, null, "message", null, null, this.xmpphost, {});
			this.xmppconn.addHandler(function (stanza)
			{
				var data = stanza.getElementsByTagName("close")[0];
				if(close)
				{
					conn.write = function () { throw "Connection closed"; };
					conn.emit("end");
				}
			}, xmlns_ibb, "iq", "set", null, this.xmpphost, {});
			conn.emit("connect");
		}

		this.xmppconn.sendIQ($iq({to:this.xmpphost,type:"set"})
			.c("open", {
				"xmlns": xmlns_ibb,
				"xmlns:tcp": xmlns_tcp,
				"tcp:host": host,
				"tcp:port": port.toString(),
				"block-size": "4096",
				"sid": this.sid.toString(),
				"stanza": "message"
			}), onConnect,
			function () { conn.emit("error"); });
	},
	emit: function ()
	{
		console.log("xmpp.io: Emitting "+arguments[0]);
		var args = Array.prototype.slice.call(arguments, 1);
		var listeners = this.listeners[arguments[0]];
		if(listeners)
		{
			for(var i=0;i<listeners.length;i++)
			{
				listeners[i][1].apply(listeners[i][0], args);
			}
		}
	},
	addListener: function (event, method, obj)
	{
		if(typeof(obj)=="undefined")
			obj = this;
		if(!(event in this.listeners))
			this.listeners[event] = [];
		this.listeners[event].push([obj, method]);
	},
	write: function (data)
	{
		return this.xmppconn.send($msg({to:this.xmpphost})
			.c("data", {xmlns:xmlns_ibb, sid:this.sid.toString()})
				.t(Strophe.Base64.encode(data)));
	},
	end: function ()
	{
		return this.xmppconn.send($iq({to:this.xmpphost})
			.c("close", {xmlns:xmlns_ibb, sid:this.sid.toString()}));
	}
};