prosody-modules: mod_csi_muc_priorities/mod_csi_muc

annotate mod_csi_muc_priorities/mod_csi_muc_priorities.lua @ 3965:2b10e51d85a6

mod_muc_limits: Add config option to limit to join stanzas only This is a bit more limited in pre-0.11 MUC modules, because it just detects stanzas sent to full JIDs (which would include all presence and nick changes). This option is useful for setups where users are typically unaffiliated, but trusted (e.g. if access to the room is gated through some other means such as password/token auth).

author	Matthew Wild <mwild1@gmail.com>
date	Fri, 03 Apr 2020 12:26:56 +0100
parents	d77a61d81555
children	569f754bd126

rev	line source
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	1 local jid_bare, jid_split = import("util.jid", "bare", "split");
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	2
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	3 -- luacheck: ignore 122
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	4 local user_sessions = prosody.hosts[module.host].sessions;
3532 85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	5
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	6 module:hook("csi-is-stanza-important", function (event)
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	7 local stanza, session = event.stanza, event.session;
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	8 if stanza.name == "message" then
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	9 if stanza.attr.type == "groupchat" then
3534 700340b57851 mod_csi_muc_priorities: Break out room jid into a variable Kim Alvefur <zash@zash.se> parents: 3533 diff changeset	10 local room_jid = jid_bare(stanza.attr.from);
700340b57851 mod_csi_muc_priorities: Break out room jid into a variable Kim Alvefur <zash@zash.se> parents: 3533 diff changeset	11
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	12 local username = session.username;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	13 local priorities = user_sessions[username].csi_muc_priorities;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	14
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	15 if priorities then
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	16 local priority = priorities[room_jid];
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	17 if priority ~= nil then
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	18 return priority;
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	19 end
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	20 end
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	21
3535 bcb0eb9121a9 mod_csi_muc_priorities: Add a comment Kim Alvefur <zash@zash.se> parents: 3534 diff changeset	22 -- Look for mention
3532 85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	23 local rooms = session.rooms_joined;
3538 946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	24 if rooms then
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	25 local body = stanza:get_child_text("body");
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	26 if not body then return end
3538 946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	27 local room_nick = rooms[room_jid];
946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	28 if room_nick then
946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	29 if body:find(room_nick, 1, true) then
946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	30 return true;
946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	31 end
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	32 -- Your own messages
3539 6d51f44bc725 mod_csi_muc_priorities: Consider own MUC messages as important Kim Alvefur <zash@zash.se> parents: 3538 diff changeset	33 if stanza.attr.from == (room_jid .. "/" .. room_nick) then
6d51f44bc725 mod_csi_muc_priorities: Consider own MUC messages as important Kim Alvefur <zash@zash.se> parents: 3538 diff changeset	34 return true;
6d51f44bc725 mod_csi_muc_priorities: Consider own MUC messages as important Kim Alvefur <zash@zash.se> parents: 3538 diff changeset	35 end
3538 946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	36 end
946902fa4088 mod_csi_muc_priorities: Undo early return to make following commit clearer Kim Alvefur <zash@zash.se> parents: 3537 diff changeset	37 end
3628 2444fb3b05b7 mod_csi_muc_priorities: Signal unimportance (thanks tmolitor) Kim Alvefur <zash@zash.se> parents: 3601 diff changeset	38
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	39 -- Standard importance and no mention, leave to other modules to decide for now
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	40 return nil;
3532 85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	41 end
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	42 end
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	43 end);
85c357b69eec mod_csi_muc_priorities: Reduce importance of group chat messages Kim Alvefur <zash@zash.se> parents: diff changeset	44
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	45 module:depends("adhoc");
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	46
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	47 local dataform = require"util.dataforms";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	48 local adhoc_inital_data = require "util.adhoc".new_initial_data_form;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	49 local instructions = [[
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	50 These settings affect battery optimizations performed by the server
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	51 while your client has indicated that it is inactive.
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	52 ]]
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	53
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	54 local priority_settings_form = dataform.new {
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	55 title = "Prioritize addresses of group chats";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	56 instructions = instructions;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	57 {
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	58 type = "hidden";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	59 name = "FORM_TYPE";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	60 value = "xmpp:modules.prosody.im/mod_"..module.name;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	61 };
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	62 {
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	63 type = "jid-multi";
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	64 name = "important";
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	65 label = "Higher priority";
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	66 desc = "Group chats more important to you";
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	67 };
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	68 {
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	69 type = "jid-multi";
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	70 name = "unimportant";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	71 label = "Lower priority";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	72 desc = "E.g. large noisy public channels";
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	73 };
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	74 }
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	75
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	76 local store = module:open_store();
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	77 module:hook("resource-bind", function (event)
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	78 local username = event.session.username;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	79 user_sessions[username].csi_muc_priorities = store:get(username);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	80 end);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	81
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	82 local adhoc_command_handler = adhoc_inital_data(priority_settings_form, function (data)
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	83 local username = jid_split(data.from);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	84 local prioritized_jids = user_sessions[username].csi_muc_priorities or store:get(username);
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	85 local important = {};
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	86 local unimportant = {};
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	87 if prioritized_jids then
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	88 for jid, priority in pairs(prioritized_jids) do
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	89 if priority then
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	90 table.insert(important, jid);
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	91 else
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	92 table.insert(unimportant, jid);
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	93 end
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	94 end
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	95 table.sort(important);
3537 7d6fb9570395 mod_csi_muc_priorities: Sort list of JIDs Kim Alvefur <zash@zash.se> parents: 3536 diff changeset	96 table.sort(unimportant);
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	97 end
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	98 return {
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	99 important = important;
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	100 unimportant = unimportant;
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	101 };
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	102 end, function(fields, form_err, data)
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	103 if form_err then
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	104 return { status = "completed", error = { message = "Problem in submitted form" } };
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	105 end
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	106 local prioritized_jids = {};
3601 013ef96a6d4d mod_csi_muc_priorities: Fix traceback due to empty field Kim Alvefur <zash@zash.se> parents: 3540 diff changeset	107 if fields.unimportant then
013ef96a6d4d mod_csi_muc_priorities: Fix traceback due to empty field Kim Alvefur <zash@zash.se> parents: 3540 diff changeset	108 for _, jid in ipairs(fields.unimportant) do
013ef96a6d4d mod_csi_muc_priorities: Fix traceback due to empty field Kim Alvefur <zash@zash.se> parents: 3540 diff changeset	109 prioritized_jids[jid] = false;
013ef96a6d4d mod_csi_muc_priorities: Fix traceback due to empty field Kim Alvefur <zash@zash.se> parents: 3540 diff changeset	110 end
3754 d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	111 for _, jid in ipairs(fields.important) do
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	112 prioritized_jids[jid] = true;
d77a61d81555 mod_csi_muc_priorities: Add a high priority list (BC) Kim Alvefur <zash@zash.se> parents: 3628 diff changeset	113 end
3536 eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	114 end
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	115
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	116 local username = jid_split(data.from);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	117 local ok, err = store:set(username, prioritized_jids);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	118 if ok then
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	119 user_sessions[username].csi_muc_priorities = prioritized_jids;
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	120 return { status = "completed", info = "Priorities updated" };
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	121 else
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	122 return { status = "completed", error = { message = "Error saving priorities: "..err } };
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	123 end
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	124 end);
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	125
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	126 module:add_item("adhoc", module:require "adhoc".new("Configure group chat priorities",
eed657091329 mod_csi_muc_priorities: Allow specifying which MUC JIDs are less important Kim Alvefur <zash@zash.se> parents: 3535 diff changeset	127 "xmpp:modules.prosody.im/mod_"..module.name, adhoc_command_handler, "local_user"));

Mercurial > prosody-modules

annotate mod_csi_muc_priorities/mod_csi_muc_priorities.lua @ 3965:2b10e51d85a6