annotate mod_csi_grace_period/mod_csi_grace_period.lua @ 3532:85c357b69eec

mod_csi_muc_priorities: Reduce importance of group chat messages This helps if you are in more noisy public channels than small private group chats. The short term plan is to give users the ability to set MUC JIDs as either high or low priority and use that. Long term it would be great to be able to automatically classify MUCs as public channels vs private group chats.
author Kim Alvefur <zash@zash.se>
date Mon, 01 Apr 2019 00:15:13 +0200
parents 5c37d759b1e2
children 7570976318a9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3507
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 -- Copyright (c) 2019 Kim Alvefur
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 --
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 -- This project is MIT/X11 licensed. Please see the
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 -- COPYING file in the source package for more information.
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 --
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 -- Yes, this module touches stores data in user sessions
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 -- luacheck: ignore 122
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local grace_period = module:get_option_number("grace_period", 30);
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 local user_sessions = prosody.hosts[module.host].sessions;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 module:hook("csi-is-stanza-important", function (event)
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 if event.stanza.name ~= "message" then return end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 local session = event.session;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 if not session then return; end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 local user_session = user_sessions[session.username];
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 if not user_session then return; end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 if user_sessions.grace_time_start then
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 if user_sessions.last_active == session.resource then
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 return;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 if (os.time() - user_sessions.grace_time_start) < grace_period then
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 session.log("debug", "Within grace period, probably seen");
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 return false;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 end, 1);
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 local function on_activity(event)
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 local stanza, origin = event.stanza, event.origin;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 local user_session = user_sessions[origin.username];
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 if not user_session then return; end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 if stanza:get_child("body") or stanza:get_child("active", "http://jabber.org/protocol/chatstates") then
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 user_sessions.last_active = origin.resource;
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 user_sessions.grace_time_start = os.time();
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 end
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 module:hook("pre-message/full", on_activity);
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 module:hook("pre-message/bare", on_activity);
5c37d759b1e2 mod_csi_grace_period: Server-side grace period logic for CSI
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 module:hook("pre-message/host", on_activity);