2 -- Copyright (C) 2009-2010 Matthew Wild
3 -- Copyright (C) 2009-2010 Waqas Hussain
4 -- Copyright (C) 2014 Kim Alvefur
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
9 -- This module implements XEP-0191: Blocking Command
12 local user_exists = require"core.usermanager".user_exists;
13 local is_contact_subscribed = require"core.rostermanager".is_contact_subscribed;
14 local st = require"util.stanza";
15 local st_error_reply = st.error_reply;
16 local jid_prep = require"util.jid".prep;
17 local jid_split = require"util.jid".split;
19 local storage = module:open_store();
20 local sessions = prosody.hosts[module.host].sessions;
22 -- Cache of blocklists used since module was loaded
24 if module:get_option_boolean("blocklist_weak_cache") then
25 -- Lower memory usage, more IO and latency
26 setmetatable(cache, { __mode = "v" });
29 local null_blocklist = {};
31 module:add_feature("urn:xmpp:blocking");
33 local function set_blocklist(username, blocklist)
34 local ok, err = storage:set(username, blocklist);
38 -- Successful save, update the cache
39 cache[username] = blocklist;
43 -- Migrates from the old mod_privacy storage
44 local function migrate_privacy_list(username)
45 local migrated_data = { [false] = "not empty" };
46 local legacy_data = module:open_store("privacy"):get(username);
47 if legacy_data and legacy_data.lists and legacy_data.default then
48 legacy_data = legacy_data.lists[legacy_data.default];
49 legacy_data = legacy_data and legacy_data.items;
54 module:log("info", "Migrating blocklist from mod_privacy storage for user '%s'", username);
56 for i = 1, #legacy_data do
57 item = legacy_data[i];
58 if item.type == "jid" and item.action == "deny" then
59 jid = jid_prep(item.value);
61 module:log("warn", "Invalid JID in privacy store for user '%s' not migrated: %s", username, tostring(item.value));
63 migrated_data[jid] = true;
68 set_blocklist(username, migrated_data);
72 local function get_blocklist(username)
73 local blocklist = cache[username];
75 if not user_exists(username, module.host) then
76 return null_blocklist;
78 blocklist = storage:get(username);
80 blocklist = migrate_privacy_list(username);
82 cache[username] = blocklist;
87 module:hook("iq-get/self/urn:xmpp:blocking:blocklist", function (event)
88 local origin, stanza = event.origin, event.stanza;
89 local username = origin.username;
90 local reply = st.reply(stanza):tag("blocklist", { xmlns = "urn:xmpp:blocking" });
91 local blocklist = get_blocklist(username);
92 for jid in pairs(blocklist) do
94 reply:tag("item", { jid = jid }):up();
97 origin.interested_blocklist = true; -- Gets notified about changes
98 return origin.send(reply);
101 -- Add or remove some jid(s) from the blocklist
102 -- We want this to be atomic and not do a partial update
103 local function edit_blocklist(event)
104 local origin, stanza = event.origin, event.stanza;
105 local username = origin.username;
106 local action = stanza.tags[1];
109 for item in action:childtags("item") do
110 local jid = jid_prep(item.attr.jid);
112 return origin.send(st_error_reply(stanza, "modify", "jid-malformed"));
114 item.attr.jid = jid; -- echo back prepped
115 new[jid] = is_contact_subscribed(username, module.host, jid) or false;
118 local mode = action.name == "block" or nil;
120 if mode and not next(new) then
121 -- <block/> element does not contain at least one <item/> child element
122 return origin.send(st_error_reply(stanza, "modify", "bad-request"));
125 local blocklist = get_blocklist(username);
127 local new_blocklist = {};
129 if mode or next(new) then
130 for jid in pairs(blocklist) do
131 new_blocklist[jid] = true;
133 for jid in pairs(new) do
134 new_blocklist[jid] = mode;
136 -- else empty the blocklist
138 new_blocklist[false] = "not empty"; -- In order to avoid doing the migration thing twice
140 local ok, err = set_blocklist(username, new_blocklist);
142 origin.send(st.reply(stanza));
144 return origin.send(st_error_reply(stanza, "wait", "internal-server-error", err));
148 for jid, in_roster in pairs(new) do
149 if not blocklist[jid] and in_roster and sessions[username] then
150 for _, session in pairs(sessions[username].sessions) do
151 if session.presence then
152 module:send(st.presence({ type = "unavailable", to = jid, from = session.full_jid }));
158 if sessions[username] then
159 local blocklist_push = st.iq({ type = "set", id = "blocklist-push" })
160 :add_child(action); -- I am lazy
162 for _, session in pairs(sessions[username].sessions) do
163 if session.interested_blocklist then
164 blocklist_push.attr.to = session.full_jid;
165 session.send(blocklist_push);
173 module:hook("iq-set/self/urn:xmpp:blocking:block", edit_blocklist);
174 module:hook("iq-set/self/urn:xmpp:blocking:unblock", edit_blocklist);
176 -- Cache invalidation, solved!
177 module:hook_global("user-deleted", function (event)
178 if event.host == module.host then
179 cache[event.username] = nil;
184 module:hook("iq-error/self/blocklist-push", function (event)
185 local _, condition, text = event.stanza:get_error();
186 (event.origin.log or module._log)("warn", "Client returned an error in response to notification from mod_%s: %s%s%s", module.name, condition, text and ": " or "", text or "");
190 local function is_blocked(user, jid)
191 local blocklist = cache[user] or get_blocklist(user);
192 if blocklist[jid] then return true; end
193 local node, host = jid_split(jid);
194 return blocklist[host] or node and blocklist[node..'@'..host];
197 -- Event handlers for bouncing or dropping stanzas
198 local function drop_stanza(event)
199 local stanza = event.stanza;
200 local attr = stanza.attr;
201 local to, from = attr.to, attr.from;
202 to = to and jid_split(to);
204 return is_blocked(to, from);
208 local function bounce_stanza(event)
209 local origin, stanza = event.origin, event.stanza;
210 if drop_stanza(event) then
211 return origin.send(st_error_reply(stanza, "cancel", "service-unavailable"));
215 local function bounce_iq(event)
216 local type = event.stanza.attr.type;
217 if type == "set" or type == "get" then
218 return bounce_stanza(event);
220 return drop_stanza(event); -- result or error
223 local function bounce_message(event)
224 local type = event.stanza.attr.type;
225 if type == "chat" or not type or type == "normal" then
226 return bounce_stanza(event);
228 return drop_stanza(event); -- drop headlines, groupchats etc
231 local function drop_outgoing(event)
232 local origin, stanza = event.origin, event.stanza;
233 local username = origin.username or jid_split(stanza.attr.from);
234 if not username then return end
235 local to = stanza.attr.to;
236 if to then return is_blocked(username, to); end
237 -- nil 'to' means a self event, don't bock those
240 local function bounce_outgoing(event)
241 local origin, stanza = event.origin, event.stanza;
242 local type = stanza.attr.type;
243 if type == "error" or stanza.name == "iq" and type == "result" then
244 return drop_outgoing(event);
246 if drop_outgoing(event) then
247 return origin.send(st_error_reply(stanza, "cancel", "not-acceptable", "You have blocked this JID")
248 :tag("blocked", { xmlns = "urn:xmpp:blocking:errors" }));
252 -- Hook all the events!
253 local prio_in, prio_out = 100, 100;
254 module:hook("presence/bare", drop_stanza, prio_in);
255 module:hook("presence/full", drop_stanza, prio_in);
257 module:hook("message/bare", bounce_message, prio_in);
258 module:hook("message/full", bounce_message, prio_in);
260 module:hook("iq/bare", bounce_iq, prio_in);
261 module:hook("iq/full", bounce_iq, prio_in);
263 module:hook("pre-message/bare", bounce_outgoing, prio_out);
264 module:hook("pre-message/full", bounce_outgoing, prio_out);
265 module:hook("pre-message/host", bounce_outgoing, prio_out);
267 module:hook("pre-presence/bare", drop_outgoing, prio_out);
268 module:hook("pre-presence/full", drop_outgoing, prio_out);
269 module:hook("pre-presence/host", drop_outgoing, prio_out);
271 module:hook("pre-iq/bare", bounce_outgoing, prio_out);
272 module:hook("pre-iq/full", bounce_outgoing, prio_out);
273 module:hook("pre-iq/host", bounce_outgoing, prio_out);