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 s_find = string.find;

local pctl = require "util.prosodyctl";

local rostermanager = require "core.rostermanager";
local storagemanager = require "core.storagemanager";
local usermanager = require "core.usermanager";

-- copypaste from util.stanza
local function valid_xml_cdata(str, attr)
	return not s_find(str, attr and "[^\1\9\10\13\20-~\128-\247]" or "[^\9\10\13\20-~\128-\247]");
end

function module.command(_arg)
	if select(2, pctl.isrunning()) then
		pctl.show_warning("Stop Prosody before running this command");
		return 1;
	end

	for hostname, host in pairs(prosody.hosts) do
		if hostname ~= "*" then
			if host.users.name == "null" then
				storagemanager.initialize_host(hostname);
				usermanager.initialize_host(hostname);
			end
			local fixes = 0;
			for username in host.users.users() do
				local roster = rostermanager.load_roster(username, hostname);
				local changed = false;
				for contact, item in pairs(roster) do
					if contact ~= false then
						if item.name and not valid_xml_cdata(item.name, false) then
							item.name = item.name:gsub("[^\9\10\13\20-~\128-\247]", "�");
							fixes = fixes + 1;
							changed = true;
						end
						local clean_groups = {};
						for group in pairs(item.groups) do
							if valid_xml_cdata(group, false) then
								clean_groups[group] = true;
							else
								clean_groups[group:gsub("[^\9\10\13\20-~\128-\247]",  "�")] = true;
								fixes = fixes + 1;
								changed = true;
							end
						end
						item.groups = clean_groups;
					else
						-- pending entries etc
					end
				end
				if changed then
					assert(rostermanager.save_roster(username, hostname, roster));
				end
			end
			pctl.show_message("Fixed %d items on host %s", fixes, hostname);
		end
	end
	return 0;
end