view mod_sms_free/mod_sms_free.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 5a70dd2349a7
children
line wrap: on
line source

local http = require "net.http";
local jid_split = require "util.jid".split;
local dataforms_new = require "util.dataforms".new;
local adhoc_new = module:require "adhoc".new;
local adhoc_simple_form = require "util.adhoc".new_simple_form;
local t_concat = table.concat;

local store = module:open_store();

local function api_handler(body, code)
	if code == 200 then
		module:log("debug", "SMS correctly sent.");
	elseif code == 0 then
		module:log("error", "error querying Free API: %s", body);
	elseif code >= 400 then
		module:log("warn", "received error code %d: %s", code, body);
	end
end

local function message_handler(event)
	local message = event.stanza;
	local username, host = jid_split(message.attr.to);

	-- Only proceed if the user has set Free credentials.
	local data = store:get(username);
	if not data then
		return;
	end

	-- Only proceed if the message is of type chat or normal.
	local message_type = message.attr.type;
	if message_type == "error" or message_type == "headline" or message_type == "groupchat" then
		-- TODO: Maybe handle groupchat or headline in the future.
		return;
	end

	-- Only proceed if the message contains a body.
	local body = message:get_child_text("body");
	if not body then
		return;
	end

	-- Only proceed if all sessions are "xa", or if there are no sessions.
	local sessions = prosody.hosts[host].sessions[username];
	if sessions then
		local do_send = true;
		for _, session in pairs(sessions.sessions) do
			local show = session.presence:get_child_text("show");
			if show ~= "xa" then
				do_send = false;
			end
		end
		if not do_send then
			return;
		end
	end

	-- Then do the actual request to send the SMS.
	local headers = {
		user = data.user,
		pass = data.pass,
		msg = http.urlencode(body),
	};
	http.request("https://smsapi.free-mobile.fr/sendmsg", { headers = headers }, api_handler);
end

local set_form = dataforms_new {
	title = "Set mobile.free.fr SMS credentials";
	instructions = "Enable the “Notifications by SMS” service at https://mobile.free.fr/moncompte/ and paste the credentials in this form.";
	{
		type = "hidden";
		name = "FORM_TYPE";
		value = "http://prosody.im/protocol/sms_free#set";
	};
	{
		type = "text-single";
		name = "user";
		label = "Your login on Free’s website";
	};
	{
		type = "text-single";
		name = "pass";
		label = "Your authentication key";
	};
};

local set_adhoc = adhoc_simple_form(set_form, function (data, errors, state)
	if errors then
		local errmsg = {};
		for name, text in pairs(errors) do
			errmsg[#errmsg + 1] = name .. ": " .. text;
		end
		return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
	end

	local username, host = jid_split(state.from);
	module:log("debug", "Setting mobile.free.fr credentials for %s@%s: user=%s, pass=%s", username, host, data.user, data.pass);
	local ok, err = store:set(username, { user = data.user, pass = data.pass });
	if ok then
		return { status = "completed", info = "SMS notifications to your phone enabled." };
	else
		return { status = "completed", error = { message = err } };
	end
end);

module:provides("adhoc", adhoc_new("Set mobile.free.fr SMS notification credentials", "http://prosody.im/protocol/sms_free#set", set_adhoc));

module:provides("adhoc", adhoc_new("Unset mobile.free.fr SMS notifications", "http://prosody.im/protocol/sms_free#unset", function (_, data)
	if data.action ~= "execute" then
		return { status = "canceled" };
	end

	module:log("debug", "Unsetting mobile.free.fr credentials.");
	local username, host = jid_split(data.from);
	local ok, err = store:set(username, nil);
	if ok then
		return { status = "completed", info = "SMS notifications to your phone disabled." };
	else
		return { status = "completed", error = { message = err } };
	end
end));

-- Stanzas sent to local clients.
module:hook("message/bare", message_handler);
module:hook("message/full", message_handler);