mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs. diff --git a/mod_voipms/README.md b/mod_voipms/README.md new file mode 100644 --- /dev/null +++ b/mod_voipms/README.md @@ -0,0 +1,51 @@ +--- +labels: +- 'Stage-Alpha' +- 'Type-Web' +summary: Send and receive SMS/MMS via VoIP.ms APIs. +rockspec: + build: + modules: + mod_voipms: mod_voipms.lua +... + +Introduction +============ + +This is a Prosody module to map JIDs to DIDs on VoIP.ms and support sending/receiving SMS/MMS. + +Configuration +============= + +| option | type | default | +|-----------------------|--------|---------| +| voipms\_api\_username | string | nil | +| voipms\_api\_password | string | nil | +| voipms\_query\_key | string | nil | +| voipms\_jid\_map | table | nil | +``` +VirtualHost "sms.example.com" +modules_enabled = { + "voipms"; +} +voipms_api_username = john@example.com -- E-mail registered with VoIP.ms +voipms_api_password = abcd1234 -- API password configured in VoIP.ms +voipms_query_key = some_query_key -- query param 'key' part of your URL callback +voipms_jid_map = { + ["your_jid@your_domain.com"] = "+1234567890" +} +``` + +HTTP +==== + +The module is served on Prosody's default HTTP ports at the path /voipms. More details on configuring HTTP modules in Prosody can be found in the HTTP documentation. + +VoIP.ms Webhook URL +=================== + +This module receives the VoIP.ms Webhook URL (POST) at the /voipms endpoint. It uses the sendSMS/sendMMS GET methods against the VoIP.ms APIs. This is an example webhook to use in VoIP.ms: + +``` +https://sms.example.com/voipms?key=some_query_key +``` diff --git a/mod_voipms/mod_voipms.lua b/mod_voipms/mod_voipms.lua new file mode 100644 --- /dev/null +++ b/mod_voipms/mod_voipms.lua @@ -0,0 +1,166 @@ +local http = require "net.http" +local json = require "util.json" +local st = require "util.stanza" + +local api_username = module:get_option_string("voipms_api_username") +local api_password = module:get_option_string("voipms_api_password") +local query_key = module:get_option("voipms_query_key") +local jid_map = module:get_option("voipms_jid_map") or {} +local rest_endpoint = "https://voip.ms/api/v1/rest.php" + +if not api_username or not api_password or not query_key then + module:log("error", "Missing required config values (voipms_api_username, voipms_api_password, voipms_query_key)") + return +end + +module:depends("http") + +local function normalize_number(num) + if not num then return nil end + if num:sub(1, 1) ~= "+" then + return "+1" .. num + end + return num +end + +local function extract_query_key(event) + return (event.request.url.query or ""):match("key=([^&]+)") +end + +module:provides("http", { + route = { + ["POST"] = function(event) + local req = event.request + local body = req.body or "" + + if extract_query_key(event) ~= query_key then + module:log("warn", "Unauthorized webhook: missing or invalid key") + return { status_code = 403 } + end + + local json_payload, err = json.decode(body) + if not json_payload then + module:log("warn", "Invalid JSON: %s", err or "unknown error") + return { status_code = 400 } + end + + local payload = json_payload.data and json_payload.data.payload + if not payload then + module:log("warn", "Missing payload in JSON") + return { status_code = 400 } + end + + local from = payload.from and payload.from.phone_number + local to_list = payload.to or {} + local to = #to_list > 0 and to_list[1].phone_number or nil + + if not from or not to then + module:log("warn", "Missing phone numbers (from: %s, to: %s)", tostring(from), tostring(to)) + return { status_code = 400 } + end + + local normalized_to = normalize_number(to) + local target_jid = nil + + for jid, did in pairs(jid_map) do + if normalize_number(did) == normalized_to then + target_jid = jid + break + end + end + + if not target_jid then + module:log("warn", "No JID mapping for DID %s", normalized_to) + return { status_code = 404 } + end + + local normalized_from = normalize_number(from) + local message_text = payload.text or "" + + local message = st.message({ + from = normalized_from .. "@" .. module.host, + to = target_jid, + type = "chat" + }):tag("body"):text(message_text):up() + + if payload.media and #payload.media > 0 then + for _, media_item in ipairs(payload.media) do + if media_item.url then + message_text = message_text .. "\n" .. media_item.url + message:tag("x", { xmlns = "jabber:x:oob" }) + :tag("url"):text(media_item.url):up():up() + end + end + end + + module:send(message) + module:log("info", "Delivered SMS from %s to %s", normalized_from, target_jid) + + return { status_code = 204 } + end + } +}) + +module:hook("message/bare", function(event) + local stanza = event.stanza + if stanza.attr.type ~= "chat" then return end + + local from_jid = stanza.attr.from + local to_jid = stanza.attr.to + local body = stanza:get_child_text("body") + if not body or body == "" then return end + + local from_number = jid_map[from_jid] + if not from_number then + module:log("warn", "No DID mapping for JID %s", from_jid) + return + end + + local to_number = to_jid:match("^([^@]+)") + if not to_number then + module:log("warn", "Malformed JID in message.to: %s", to_jid) + return + end + + to_number = normalize_number(to_number) + + local media_urls = {} + for line in body:gmatch("[^\r\n]+") do + if line:match("^https?://") then + table.insert(media_urls, line) + end + end + + local method = (#media_urls > 0) and "sendMMS" or "sendSMS" + local query = { + api_username = api_username, + api_password = api_password, + method = method, + did = from_number, + dst = to_number, + message = body + } + + if method == "sendMMS" then + for i, url in ipairs(media_urls) do + query["media_url[" .. (i - 1) .. "]"] = url + end + end + + local query_str = http.formencode(query) + + http.request(rest_endpoint .. "?" .. query_str, { + method = "GET"; + }, function(response_body, code) + if code == 200 then + local resp, err = json.decode(response_body) + if not resp or resp.status ~= "success" then + module:log("error", "Failed to send %s: %s", method, err or (resp and resp.status) or "unknown") + else + module:log("info", "Sent %s from %s to %s", method, from_number, to_number) + end + else + module:log("error", "HTTP error sending %s: code %s", method, tostring(code)) + end + end) +end)

module:set_global();

local stats = module:require("mod_statistics/stats");
local filters = require "util.filters";
local serialize = require "util.serialization".serialize;

local cached_values = {};

local sessions = {};

local function push_stat(conn, name, value)
	local value_str = serialize(value);
	return conn:write((("STAT %q (%s)\n"):format(name, value_str):gsub("\\\n", "\\n")));
end

local function push_stat_to_all(name, value)
	for conn in pairs(sessions) do
		push_stat(conn, name, value);
	end
end

local session_stats_tpl = ([[{
	message_in = %d, message_out = %d;
	presence_in = %d, presence_out = %d;
	iq_in = %d, iq_out = %d;
	bytes_in = %d, bytes_out = %d;
}]]):gsub("%s", "");


local jid_fields = {
	c2s = "full_jid";
	s2sin = "from_host";
	s2sout = "to_host";
	component = "host";
};

local function push_session_to_all(session, stats)
	local id = tostring(session):match("[a-f0-9]+$"); -- FIXME: Better id? :/
	local stanzas_in, stanzas_out = stats.stanzas_in, stats.stanzas_out;
	local s = (session_stats_tpl):format(
		stanzas_in.message, stanzas_out.message,
		stanzas_in.presence, stanzas_out.presence,
		stanzas_in.iq, stanzas_out.iq,
		stats.bytes_in, stats.bytes_out);
	local jid = session[jid_fields[session.type]] or "";
	for conn in pairs(sessions) do
		conn:write(("SESS %q %q %s\n"):format(id, jid, s));
	end
end

local available_stats = stats.stats;
local active_sessions = stats.active_sessions;

-- Handle statistics provided by other modules
local function item_handlers(host)
	host = host and (host.."/") or "";

	return function (event) -- Added
		local stats = event.item.statistics;
		local group = host..(stats.name and (stats.name.."::") or "");
		for name, stat in pairs(stats) do
			available_stats[group..name] = stat;
		end
	end, function (event) -- Removed
		local stats = event.item.statistics;
		local group = host..(stats.name and (stats.name.."::") or "");
		for name, stat in pairs(stats) do
			available_stats[group..name] = nil;
		end
	end;
end

module:handle_items("statistics-provider", item_handlers());
function module.add_host(module)
	module:handle_items("statistics-provider", item_handlers(module.host));
end

-- Network listener
local listener = {};

function listener.onconnect(conn)
	sessions[conn] = {};
	push_stat(conn, "version", prosody.version);
	for name, value in pairs(cached_values) do
		push_stat(conn, name, value);
	end
	conn:write("\n"); -- Signal end of first batch (for non-streaming clients)
end

function listener.onincoming(conn, data)
end

function listener.ondisconnect(conn)
	sessions[conn] = nil;
end

function listener.onreadtimeout()
	return true;
end

function module.load()
	if not(prosody and prosody.arg) then
		return;
	end
	filters.add_filter_hook(stats.filter_hook);

	module:add_timer(1, function ()
		for stat_name, stat in pairs(available_stats) do
			if stat.get then
				local cached = cached_values[stat_name];
				local new_value = stat.get();
				if new_value ~= cached then
					push_stat_to_all(stat_name, new_value);
					cached_values[stat_name] = new_value;
				end
			end
		end
		for session, session_stats in pairs(active_sessions) do
			active_sessions[session] = nil;
			push_session_to_all(session, session_stats);
		end
		return 1;
	end);

end
function module.unload()
	filters.remove_filter_hook(stats.filter_hook);
end
function module.command( args )
	local command = args[1];
	if command == "top" then
		local dir = module:get_directory();
		package.path = dir.."/?.lua;"..dir.."/?.lib.lua;"..package.path;
		local prosodytop = module:require "prosodytop";
		prosodytop.run();
	end
end

if prosody and prosody.arg then
	module:provides("net", {
		default_port = 5782;
		listener = listener;
		private = true;
	});
end