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

-- mod_storage_multi

local storagemanager = require"core.storagemanager";
local backends = module:get_option_array(module.name); -- TODO better name?

-- TODO migrate data "upwards"

-- one → one successful write is success
-- all → all backends must report success
-- majority → majority of backends must report success
local policy = module:get_option_string(module.name.."_policy", "all");

local keyval_store = {};
keyval_store.__index = keyval_store;

function keyval_store:get(username)
	local backends = self.backends;
	local data, err;
	for i = 1, #backends do
		module:log("debug", "%s:%s:get(%q)", tostring(backends[i].get), backends[i]._store, username);
		data, err = backends[i]:get(username);
		if err then
			module:log("error", tostring(err));
		elseif not data then
			module:log("debug", "No data returned");
		else
			module:log("debug", "Data returned");
			return data, err;
		end
	end
end

-- This is where it gets complicated
function keyval_store:set(username, data)
	local backends = self.backends;
	local ok, err, backend;
	local all, one, oks = true, false, 0;
	for i = 1, #backends do
		backend = backends[i];
		module:log("debug", "%s:%s:set(%q)", tostring(backends[i].get), backends[i].store, username);
		ok, err = backend:set(username, data);
		if not ok then
			module:log("error", "Error in storage driver %s: %s", backend.name, tostring(err));
		else
			oks = oks + 1;
		end
		one = one or ok; -- At least one successful write
		all = all and ok; -- All successful
	end
	if policy == "all" then
		return all, err
	elseif policy == "majority" then
		return oks > (#backends/2), err;
	end
	-- elseif policy == "one" then
	return one, err;
end

local stores = {
	keyval = keyval_store;
}

local driver = {};

function driver:open(store, typ)
	local store_mt = stores[typ or "keyval"];
	if store_mt then
		local my_backends = {};
		local driver, opened
		for i = 1, #backends do
			 driver = storagemanager.load_driver(module.host, backends[i]);
			 opened = driver:open(store, typ);
			 my_backends[i] = assert(driver:open(store, typ));
			 my_backends[i]._store = store;
		end
		return setmetatable({ backends = my_backends }, store_mt);
	end
	return nil, "unsupported-store";
end

module:provides("storage", driver);