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

-- Copyright (C) 2021 Kim Alvefur
--
-- This file is MIT licensed.

local lfs = require "lfs";
local st = require "util.stanza";
local jid = require "util.jid";
local paths = require "util.paths";
local unpack = table.unpack or _G.unpack;

function module.command(arg)
	local sm = require "core.storagemanager";
	local dm = sm.olddm;

	local component, user_host = unpack(arg);

	sm.initialize_host(component);

	local new_uploads = sm.open(component, "uploads", "archive");

	local legacy_storage_path = module:context(component):get_option_string("http_upload_path", paths.join(prosody.paths.data, "http_upload"));

	local legacy_uploads = {};
	for user in assert(dm.users(user_host, "http_upload", "list")) do
		legacy_uploads[user] = dm.list_load(user, user_host, "http_upload");
	end
	while true do
		local oldest_uploads, uploader;
		for user, uploads in pairs(legacy_uploads) do
			if uploads[1] and (not oldest_uploads or uploads[1].time < oldest_uploads[1].time) then
				oldest_uploads, uploader = uploads, jid.join(user, user_host);
			end
		end
		if not oldest_uploads then break end
		local item = table.remove(oldest_uploads, 1);
		local source_directory = paths.join(legacy_storage_path, item.dir);
		local source_filename = paths.join(source_directory, item.filename);
		local target_filename = dm.getpath(item.dir, component, "http_file_share", "bin", true);
		if not lfs.attributes(source_filename, "mode") then
			print("Not migrating missing file " .. source_filename);
		else
			print("Moving " .. source_filename .. " to " .. target_filename .. " for " .. uploader);
			local upload = st.stanza("request", {
				xmlns = "urn:xmpp:http:upload:0";
				filename = item.filename;
				size = string.format("%d", item.size);
				-- content-type not included with mod_http_upload
			});
			assert(new_uploads:append(nil, item.dir, upload, item.time, uploader));
			assert(os.rename(source_filename, target_filename));
		end
		os.remove(source_directory); -- failure not fatal
	end
	for user, uploads in pairs(legacy_uploads) do
		assert(dm.list_store(user, user_host, "http_upload", uploads));
	end
	os.remove(legacy_storage_path);
	return 0;
end