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

module:set_global();
local stats = module:shared"stats";
local iter = require "util.iterators";
local count, keys = iter.count, iter.keys;

stats.stats = stats.stats or {};
stats.conns = stats.conns or {};

setmetatable(stats, {
	__index = {

		broadcast = function (self, stat)
			local value = self.stats[stat];
			for conn in pairs(self.conns) do
				conn:write(stat..":"..value.."\n");
			end
		end;

		adjust = function (self, stat, delta)
			if delta == 0 then return; end
			self.stats[stat] = (self.stats[stat] or 0) + delta;
			self:broadcast(stat);
		end;

		set = function (self, stat, value)
			if value == self.stats[stat] then return; end
			self.stats[stat] = value;
			self:broadcast(stat);
		end;

		add_conn = function (self, conn)
			self.conns[conn] = true;
			for stat, value in pairs(self.stats) do
				conn:write(stat..":"..value.."\n");
			end
		end;

		remove_conn = function (self, conn)
			self.conns[conn] = nil;
		end;
	};
});

local network = {};

function network.onconnect(conn)
	stats:add_conn(conn);
end

function network.onincoming(conn, data)
end

function network.ondisconnect(conn, reason)
	stats:remove_conn(conn);
end

module:add_timer(1, function ()
	stats:set("s2s-in", count(keys(prosody.incoming_s2s)));
	return math.random(10, 20);
end);
module:add_timer(3, function ()
	local s2sout_count = 0;
	for _, host in pairs(prosody.hosts) do
		s2sout_count = s2sout_count + count(keys(host.s2sout));
	end
	stats:set("s2s-out", s2sout_count);
	return math.random(10, 20);
end);


function module.add_host(module)
	module:hook("resource-bind", function ()
		stats:adjust("c2s", 1);
	end);
	module:hook("resource-unbind", function ()
		stats:adjust("c2s", -1);
	end);

	local c2s_count = 0;
	for username, user in pairs(hosts[module.host].sessions or {}) do
		for resource, session in pairs(user.sessions or {}) do
			c2s_count = c2s_count + 1;
		end
	end
	stats:set("c2s", c2s_count);

	module:hook("s2sin-established", function (event)
		stats:adjust("s2s-in", 1);
	end);
	module:hook("s2sin-destroyed", function (event)
		stats:adjust("s2s-in", -1);
	end);
	module:hook("s2sout-established", function (event)
		stats:adjust("s2s-out", 1);
	end);
	module:hook("s2sout-destroyed", function (event)
		stats:adjust("s2s-out", -1);
	end);
end

module:provides("net", {
	default_port = 5444;
	listener = network;
});