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)

-- mod_minimix
--
-- Rewrite MUC stanzas suich that the account / bare JID joins rooms instead of clients / full JIDs
--
local jid_split, jid_join, jid_node, jid_bare = import("util.jid", "split", "join", "node", "bare");
local st = require "util.stanza";
local mt = require "util.multitable";

local users = prosody.hosts[module.host].sessions;

local data = mt.new();

-- FIXME You can join but you can never leave.

module:hook("pre-presence/full", function (event)
	local origin, stanza = event.origin, event.stanza;

	local room_node, room_host, nickname = jid_split(stanza.attr.to);
	local room_jid = jid_join(room_node, room_host);
	local username = origin.username;

	if stanza.attr.type == nil and stanza:get_child("x", "http://jabber.org/protocol/muc") then
		module:log("debug", "Joining %s as %s", room_jid, nickname);

		-- TODO Should this be kept track of before the *initial* join has been confirmed or?
		if origin.joined_rooms then
			origin.joined_rooms[room_jid] = nickname;
		else
			origin.joined_rooms = { [room_jid] = nickname };
		end

		if data:get(username, room_jid, "subject") then
			module:log("debug", "Already joined to %s as %s", room_jid, nickname);
			local presences = data:get(username, room_jid, "presence");
			if presences then
				-- Joined but no presence? Weird
				for _, pres in pairs(presences) do
					pres = st.clone(pres);
					pres.attr.to = origin.full_jid;
					origin.send(pres);
				end
			end
			-- FIXME should send ones own presence last
			local subject = data:get(username, room_jid, "subject");
			if subject then
				origin.send(st.clone(subject));
			end
			-- Send on-join stanzas from local state, somehow
			-- Maybe tell them their nickname was changed if it doesn't match the account one
			return true;
		end

		local account_join = st.clone(stanza);
		account_join.attr.from = jid_join(origin.username, origin.host);
		module:send(account_join);

		data:set(username, room_jid, "joined", nickname);

		return true;
	elseif stanza.attr.type == "unavailable" then
		if origin.joined_rooms and origin.joined_rooms[room_jid] then
			origin.joined_rooms[room_jid] = nil;
		end
		origin.send(st.reply(stanza));
		return true;
	elseif stanza.attr.type == nil and origin.joined_rooms and origin.joined_rooms[room_jid] then
		return true; -- Suppress these
	end
end);

module:hook("pre-message/bare", function (event)
	local origin, stanza = event.origin, event.stanza;
	local username = origin.username;
	local room_jid = jid_bare(stanza.attr.to);

	module:log("info", "%s", stanza)
	if origin.joined_rooms and origin.joined_rooms[room_jid] then
		local from_account = st.clone(stanza);
		from_account.attr.from = jid_join(username, origin.host);
		module:log("debug", "Sending:\n%s\nInstead of:\n%s", from_account, stanza);
		module:send(from_account, origin);
		return true;
	end
end);

local function handle_to_bare_jid(event)
	local stanza = event.stanza;
	local username = jid_node(stanza.attr.to);
	local room_jid = jid_bare(stanza.attr.from);

	if data:get(username, room_jid) then
		module:log("debug", "handle_to_bare_jid %q, %s", room_jid, stanza);
		-- Broadcast to clients

		if stanza.name == "message" and stanza.attr.type == "groupchat"
			and not stanza:get_child("body") and stanza:get_child("subject") then
			data:set(username, room_jid, "subject", st.clone(stanza));
		elseif stanza.name == "presence" then
			if stanza.attr.type == nil then
				data:set(username, room_jid, "presence", stanza.attr.from, st.clone(stanza));
			elseif stanza.attr.type == "unavailable" then
				data:set(username, room_jid, "presence", stanza.attr.from, nil);
			end
		end

		if users[username] then
			module:log("debug", "%s has sessions", username);
			for _, session in pairs(users[username].sessions) do
				module:log("debug", "Session: %s", jid_join(session.username, session.host, session.resource));
				if session.joined_rooms and session.joined_rooms[room_jid] then
					module:log("debug", "Is joined");
					local s = st.clone(stanza);
					s.attr.to = session.full_jid;
					session.send(s);
				else
					module:log("debug", "session.joined_rooms = %s", session.joined_rooms);
				end
			end
		end

		return true;
	end
end

module:hook("presence/bare", handle_to_bare_jid);
module:hook("message/bare", handle_to_bare_jid);