Software /
code /
prosody-modules
Changeset
4163:320f6d374b5d
mod_muc_inject_mentions: Add new configuration setting to strip out prefixes from mentions
author | Seve Ferrer <seve@delape.net> |
---|---|
date | Wed, 30 Sep 2020 13:14:46 +0200 (2020-09-30) |
parents | 4162:f7bc0e4ab4a2 |
children | 4164:a82b0745383b |
files | mod_muc_inject_mentions/README.markdown mod_muc_inject_mentions/mod_muc_inject_mentions.lua |
diffstat | 2 files changed, 59 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_muc_inject_mentions/README.markdown Tue Sep 29 17:14:41 2020 +0200 +++ b/mod_muc_inject_mentions/README.markdown Wed Sep 30 13:14:46 2020 +0200 @@ -62,6 +62,15 @@ ``` +Prefixes can be removed using: +``` +muc_inject_mentions_strip_out_prefixes = true +``` +Turning `Hey @someone` into `Hey someone`. +Currently, prefixes can only be removed from module added mentions. +If the client sends a mention type reference pointing to a nickname using a prefix (`Hey @someone`), the prefix will not be removed. + + It is also possible to modify how this module detects mentions. In short, the module will detect if a mention is actually a mention if the nickname (with or without affixes) is between spaces, new lines, or at the beginning/end of the message.
--- a/mod_muc_inject_mentions/mod_muc_inject_mentions.lua Tue Sep 29 17:14:41 2020 +0200 +++ b/mod_muc_inject_mentions/mod_muc_inject_mentions.lua Wed Sep 30 13:14:46 2020 +0200 @@ -1,6 +1,7 @@ module:depends("muc"); local jid_resource = require "util.jid".resource; +local st = require "util.stanza"; local prefixes = module:get_option("muc_inject_mentions_prefixes", nil) local suffixes = module:get_option("muc_inject_mentions_suffixes", nil) @@ -8,10 +9,21 @@ local disabled_rooms = module:get_option("muc_inject_mentions_disabled_rooms", nil) local mention_delimiters = module:get_option_set("muc_inject_mentions_mention_delimiters", {" ", "", "\n"}) local append_mentions = module:get_option("muc_inject_mentions_append_mentions", false) +local strip_out_prefixes = module:get_option("muc_inject_mentions_strip_out_prefixes", false) local reference_xmlns = "urn:xmpp:reference:0" +local function add_mention(mentions, bare_jid, first, last, prefix_indices, has_prefix) + if strip_out_prefixes then + if has_prefix then + table.insert(prefix_indices, first-1) + end + first = first - #prefix_indices + last = last - #prefix_indices + end + mentions[first] = {bare_jid=bare_jid, first=first, last=last} +end local function get_client_mentions(stanza) local has_mentions = false @@ -58,16 +70,16 @@ -- There are no configured prefixes if not prefixes or #prefixes < 1 then return false end - -- Preffix must have a space before it, + -- Prefix must have a space before it, -- be the first character of the body -- or be the first character after a new line if not mention_delimiters:contains(body:sub(first - 2, first - 2)) then return false end - local preffix = body:sub(first - 1, first - 1) - for _, _preffix in ipairs(prefixes) do - if preffix == _preffix then + local prefix = body:sub(first - 1, first - 1) + for _, _prefix in ipairs(prefixes) do + if prefix == _prefix then return true end end @@ -97,7 +109,7 @@ end local function search_mentions(room, body, client_mentions) - local mentions = {} + local mentions, prefix_indices = {}, {} for _, occupant in pairs(room._occupants) do local nick = jid_resource(occupant.nick); @@ -124,26 +136,26 @@ if mention_delimiters:contains(body:sub(first - 1, first - 1)) and mention_delimiters:contains(body:sub(last + 1, last + 1)) then - mentions[first] = {bare_jid=bare_jid, first=first, last=last} + add_mention(mentions, bare_jid, first, last, prefix_indices, false) else -- Check if occupant is mentioned using affixes - local has_preffix = has_nick_prefix(body, first) + local has_prefix = has_nick_prefix(body, first) local has_suffix = has_nick_suffix(body, last) -- @nickname: ... - if has_preffix and has_suffix then - mentions[first] = {bare_jid=bare_jid, first=first, last=last} + if has_prefix and has_suffix then + add_mention(mentions, bare_jid, first, last, prefix_indices, has_prefix) -- @nickname ... - elseif has_preffix and not has_suffix then + elseif has_prefix and not has_suffix then if mention_delimiters:contains(body:sub(last + 1, last + 1)) then - mentions[first] = {bare_jid=bare_jid, first=first, last=last} + add_mention(mentions, bare_jid, first, last, prefix_indices, has_prefix) end -- nickname: ... - elseif not has_preffix and has_suffix then + elseif not has_prefix and has_suffix then if mention_delimiters:contains(body:sub(first - 1, first - 1)) then - mentions[first] = {bare_jid=bare_jid, first=first, last=last} + add_mention(mentions, bare_jid, first, last, prefix_indices, has_prefix) end end end @@ -151,7 +163,7 @@ end end - return mentions + return mentions, prefix_indices end local function muc_inject_mentions(event) @@ -168,7 +180,8 @@ local has_mentions, client_mentions = get_client_mentions(stanza) if has_mentions and not append_mentions then return; end - local mentions = search_mentions(room, body:get_text(), client_mentions) + local body_text = body:get_text() + local mentions, prefix_indices = search_mentions(room, body_text, client_mentions) for _, mention in pairs(mentions) do -- https://xmpp.org/extensions/xep-0372.html#usecase_mention stanza:tag( @@ -181,6 +194,28 @@ } ):up() end + + if strip_out_prefixes then + local body_without_prefixes = "" + local from = 0 + if #prefix_indices > 0 then + for _, prefix_index in ipairs(prefix_indices) do + body_without_prefixes = body_without_prefixes .. body_text:sub(from, prefix_index-1) + from = prefix_index + 1 + end + body_without_prefixes = body_without_prefixes .. body_text:sub(from, #body_text) + + -- Replace original body containing prefixes + stanza:maptags( + function(tag) + if tag.name ~= "body" then + return tag + end + return st.stanza("body"):text(body_without_prefixes) + end + ) + end + end end module:hook("muc-occupant-groupchat", muc_inject_mentions) \ No newline at end of file