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)

-- luacheck: ignore 212/self 431/err 131/open

local datamanager = require"core.storagemanager".olddm;
local xml_parse = require"util.xml".parse;
local data_load, data_store = datamanager.load, datamanager.store;
local datastore = "muc_log";
local datetime = require"util.datetime"
local lfs = require"lfs";
local os_date = os.date;

local timef, datef = "!%H:%M:%S", "!%y%m%d";
local host = module.host;

local driver = {};
local driver_mt = { __index = driver };

do
	-- Sanity check
	-- Fun fact: 09:00 and 21:00 en_HK are both "09:00:00 UTC"
	local t = os_date("!*t");
	t.hour = 9;
	local am = os_date("!%X", os.time(t));
	t.hour = 21;
	local pm = os_date("!%X", os.time(t));
	if am == pm then
		module:log("warn", "Timestamps in AM and PM are identical in your locale, expect timestamps to be wrong");
	end
	if os_date("!%X", os.time(t)) ~= os_date(timef, os.time(t)) then
		module:log("warn", "Timestamp format differ from what mod_muc_log used, this module may not work correctly");
	end
end

local function parse_silly(date, time)
	local year, month, day = date:match("^(%d%d)(%d%d)(%d%d)");
	year = "20"..year;
	-- year = (year < "70" and "20" or "19") .. year;
	local hour, min, sec = time:match("(%d%d)%D+(%d%d)%D+(%d%d)");
	if hour == "12" and time:find("[Aa][Mm]") then
		hour = "00";
	elseif hour < "12" and time:find("[Pp][Mm]") then
		hour = tostring(tonumber(hour) % 12 + 12);
	end
	return datetime.parse(("%s-%s-%sT%s:%s:%sZ"):format(year, month, day, hour or "00", min or "00", sec or "00"));
end

local function st_with(tag)
	local with = tag.attr.type;
	return with and tag.name .. "<" .. with or tag.name;
end

function driver:append(node, key, stanza, when, with) -- luacheck: ignore 212/key
	-- luacheck: ignore 311/with
	-- 'with' doesn't exist in the original mod_muc_log, so gets derived here
	if type(when) ~= "number" then
		when, with, stanza = stanza, when, with;
	end
	local today = os_date(datef, when);
	local now = os_date(timef, when);
	local data = data_load(node, host, datastore .. "/" .. today) or {};
	data[#data + 1] = "<stanza time=\"".. now .. "\">" .. tostring(stanza) .. "</stanza>\n";
	datamanager.getpath(node, host, datastore, nil, true); -- create the datastore dir
	local ok, err = data_store(node, host, datastore .. "/" .. today, data);
	if not ok then
		return ok, err;
	end
	return today .. "_" .. #data;
end

function driver:dates(node)
	local path = datamanager.getpath(node, host, datastore):match("(.*)/");

	local ok, iter, state, var = pcall(lfs.dir, path);
	if not ok then
		module:log("warn", iter);
		return nil, iter;
	end

	local dates, i = {}, 1;
	for dir in iter, state, var do
		if lfs.attributes(datamanager.getpath(node, host, datastore .. "/" .. dir), "mode") == "file" then
			dates[i], i = dir, i+1;
		end
	end
	if dates[1] == nil then return nil end
	table.sort(dates);
	return dates;
end

function driver:find(node, query)
	local dates, err = self:dates(node);
	if not dates then return dates, err; end

	return coroutine.wrap(function ()
		local start_date = query and query.start and os_date(datef, query.start) or dates[1];
		local end_date = query and query["end"] and os_date(datef, query["end"]) or dates[#dates];
		local start_time = query and query.start and os_date(timef, query.start) or dates[1];
		local end_time = query and query["end"] and os_date(timef, query["end"]) or dates[#dates];
		local query_with = query and query.with;
		local query_limit = query and query.limit;
		local seek_once = query and query.after;

		local today, time, data, err, item;
		local inner_start, inner_stop, inner_step;
		local outer_start, outer_stop, outer_step = 1, #dates, 1;
		if query and query.reverse then
			outer_start, outer_stop, outer_step = outer_stop, outer_start, -outer_step;
			seek_once = query.before;
			if seek_once then
				end_date = seek_once:match"^(%d+)_%d";
			end
		elseif seek_once then
			start_date = seek_once:match"^(%d+)_%d";
		end
		local matches = 0;
		for i = outer_start, outer_stop, outer_step do
			today = dates[i];
			if today >= start_date and today <= end_date then
				data, err = data_load(node, host, datastore .. "/" .. today);
				if data then
					inner_start, inner_stop, inner_step = 1, #data, 1;
					if query and query.reverse then
						inner_start, inner_stop, inner_step = inner_stop, inner_start, -inner_step;
					end
					if seek_once then
						inner_start = tonumber(seek_once:match("_(%d+)$"));
						inner_start = inner_start + (query and query.reverse and -1 or 1);
						seek_once = nil;
					end
					for i = inner_start, inner_stop, inner_step do -- luacheck: ignore 423/i
						item, err = data[i], nil;
						if item then
							item, err = xml_parse(item);
						end
						if item then
							time = item.attr.time;
							item = item.tags[1];
							local with = st_with(item);
							if (today >= start_date or time >= start_time) and
								(today <= end_date or time <= end_time) and
								(not query_with or query_with == with) and
								item:get_child_text("alreadyJoined") ~= "true" then
								matches = matches + 1;
								coroutine.yield(today.."_"..i, item, parse_silly(today, time), with);
								if query_limit and matches >= query_limit then
									return;
								end
							end
						elseif err then
							module:log("warn", err);
						end
					end
				elseif err then
					module:log("warn", err);
				end
			end
		end
	end);
end

function open(_, store, typ)
	if typ ~= "archive" then
		return nil, "unsupported-store";
	end
	return setmetatable({ store = store, type = typ }, driver_mt);
end

module:provides "storage";