view mod_muc_search/mod_muc_search.lua @ 6258:06fbbd45ba75

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
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 10:44:37 +0200
parents 5f4bcaad18ee
children
line wrap: on
line source

-- mod_muc_search
-- https://muclumbus.jabbercat.org/docs/api#xmpp
-- TODO
-- Result set management (pagination, limits)
-- Sorting
-- min_users

local dataforms = require "util.dataforms";
local st = require "util.stanza";

local mod_muc = module:depends("muc");
assert(mod_muc.live_rooms, "Missing required MUC API. Prosody >= hg:f5c43e829d93 required");

local search_form = dataforms.new {
	{
		type = "hidden";
		value = "https://xmlns.zombofant.net/muclumbus/search/1.0#params";
		name = "FORM_TYPE";
	};
	{
		type = "text-single";
		label = "Search for";
		name = "q";
	};
	{
		type = "boolean";
		value = true;
		label = "Search in name";
		name = "sinname";
	};
	{
		type = "boolean";
		value = true;
		label = "Search in description";
		name = "sindescription";
	};
	{
		type = "boolean";
		value = true;
		label = "Search in address";
		name = "sinaddr";
	};
	{
		type = "text-single";
		value = "1";
		label = "Minimum number of users";
		name = "min_users";
	};
	{
		options = {
			{
				label = "Number of online users";
				value = "nusers";
			};
			{
				label = "Address";
				value = "address";
			};
		};
		type = "list-single";
		value = "nusers";
		label = "Sort results by";
		name = "key";
	};
};

module:hook("iq-get/host/https://xmlns.zombofant.net/muclumbus/search/1.0:search", function (event)
	local origin, stanza = event.origin, event.stanza;
	origin.send(st.reply(stanza)
		:tag("search", { xmlns = "https://xmlns.zombofant.net/muclumbus/search/1.0" })
			:add_child(search_form:form()));
	return true;
end);

module:hook("iq-set/host/https://xmlns.zombofant.net/muclumbus/search/1.0:search", function (event)
	local origin, stanza = event.origin, event.stanza;
	local search = stanza.tags[1];
	local submitted = search:get_child("x", "jabber:x:data");
	if not submitted then
		origin.send(st.error_reply("modify", "bad-request", "Missing dataform"));
		return;
	end
	local query = search_form:data(submitted);
	module:log("debug", "Got query: %q", query);

	local result = st.reply(stanza)
		:tag("result", { xmlns = "https://xmlns.zombofant.net/muclumbus/search/1.0" });

	for room in mod_muc.live_rooms() do -- TODO s/live/all/ but preferably along with pagination/rsm
		if room:get_public() and not room:get_members_only() then
			module:log("debug", "Looking at room %s %q", room.jid, room._data);
			if (query.sinname and room:get_name():find(query.q, 1, true))
			or (query.sindescription and (room:get_description() or ""):find(query.q, 1, true))
			or (query.sinaddr and room.jid:find(query.q, 1, true)) then
				result:tag("item", { address = room.jid })
					:text_tag("name", room:get_name())
					:text_tag("description", room:get_description())
					:text_tag("language", room:get_language())
					:tag("is-open"):up()
				:up();
			end
		end
	end
	origin.send(result);
	return true;
end);