prosody
30fac9154fd4
plugins/mod_mam/mod_mam.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

plugins/mod_mam/mod_mam.lua @ 7836:30fac9154fd4

mod_mam: Import from prosody-modules
author Kim Alvefur <zash@zash.se>
date Fri, 04 Nov 2016 13:48:21 +0100
child 7837:a17bddf62a28
comparison
equal deleted inserted replaced
7835:a809dcfd0c5b 7836:30fac9154fd4
1 -- XEP-0313: Message Archive Management for Prosody
2 -- Copyright (C) 2011-2016 Kim Alvefur
3 --
4 -- This file is MIT/X11 licensed.
5
6 local xmlns_mam = "urn:xmpp:mam:0";
7 local xmlns_delay = "urn:xmpp:delay";
8 local xmlns_forward = "urn:xmpp:forward:0";
9
10 local um = require "core.usermanager";
11 local st = require "util.stanza";
12 local rsm = module:require "rsm";
13 local get_prefs = module:require"mamprefs".get;
14 local set_prefs = module:require"mamprefs".set;
15 local prefs_to_stanza = module:require"mamprefsxml".tostanza;
16 local prefs_from_stanza = module:require"mamprefsxml".fromstanza;
17 local jid_bare = require "util.jid".bare;
18 local jid_split = require "util.jid".split;
19 local dataform = require "util.dataforms".new;
20 local host = module.host;
21
22 local rm_load_roster = require "core.rostermanager".load_roster;
23
24 local getmetatable = getmetatable;
25 local function is_stanza(x)
26 return getmetatable(x) == st.stanza_mt;
27 end
28
29 local tostring = tostring;
30 local time_now = os.time;
31 local m_min = math.min;
32 local timestamp, timestamp_parse = require "util.datetime".datetime, require "util.datetime".parse;
33 local default_max_items, max_max_items = 20, module:get_option_number("max_archive_query_results", 50);
34 local global_default_policy = module:get_option("default_archive_policy", true);
35 if global_default_policy ~= "roster" then
36 global_default_policy = module:get_option_boolean("default_archive_policy", global_default_policy);
37 end
38
39 local archive_store = "archive2";
40 local archive = assert(module:open_store(archive_store, "archive"));
41
42 if archive.name == "null" or not archive.find then
43 if not archive.find then
44 module:log("debug", "Attempt to open archive storage returned a valid driver but it does not seem to implement the storage API");
45 module:log("debug", "mod_%s does not support archiving", archive._provided_by or archive.name and "storage_"..archive.name.."(?)" or "<unknown>");
46 else
47 module:log("debug", "Attempt to open archive storage returned null driver");
48 end
49 module:log("debug", "See https://prosody.im/doc/storage and https://prosody.im/doc/archiving for more information");
50 module:log("info", "Using in-memory fallback archive driver");
51 archive = module:require "fallback_archive";
52 end
53
54 local cleanup;
55
56 -- Handle prefs.
57 module:hook("iq/self/"..xmlns_mam..":prefs", function(event)
58 local origin, stanza = event.origin, event.stanza;
59 local user = origin.username;
60 if stanza.attr.type == "get" then
61 local prefs = prefs_to_stanza(get_prefs(user));
62 local reply = st.reply(stanza):add_child(prefs);
63 origin.send(reply);
64 else -- type == "set"
65 local new_prefs = stanza:get_child("prefs", xmlns_mam);
66 local prefs = prefs_from_stanza(new_prefs);
67 local ok, err = set_prefs(user, prefs);
68 if not ok then
69 origin.send(st.error_reply(stanza, "cancel", "internal-server-error", "Error storing preferences: "..tostring(err)));
70 else
71 origin.send(st.reply(stanza));
72 end
73 end
74 return true;
75 end);
76
77 local query_form = dataform {
78 { name = "FORM_TYPE"; type = "hidden"; value = xmlns_mam; };
79 { name = "with"; type = "jid-single"; };
80 { name = "start"; type = "text-single" };
81 { name = "end"; type = "text-single"; };
82 };
83
84 -- Serve form
85 module:hook("iq-get/self/"..xmlns_mam..":query", function(event)
86 local origin, stanza = event.origin, event.stanza;
87 origin.send(st.reply(stanza):add_child(query_form:form()));
88 return true;
89 end);
90
91 -- Handle archive queries
92 module:hook("iq-set/self/"..xmlns_mam..":query", function(event)
93 local origin, stanza = event.origin, event.stanza;
94 local query = stanza.tags[1];
95 local qid = query.attr.queryid;
96
97 if cleanup then cleanup[origin.username] = true; end
98
99 -- Search query parameters
100 local qwith, qstart, qend;
101 local form = query:get_child("x", "jabber:x:data");
102 if form then
103 local err;
104 form, err = query_form:data(form);
105 if err then
106 origin.send(st.error_reply(stanza, "modify", "bad-request", select(2, next(err))));
107 return true;
108 end
109 qwith, qstart, qend = form["with"], form["start"], form["end"];
110 qwith = qwith and jid_bare(qwith); -- dataforms does jidprep
111 end
112
113 if qstart or qend then -- Validate timestamps
114 local vstart, vend = (qstart and timestamp_parse(qstart)), (qend and timestamp_parse(qend));
115 if (qstart and not vstart) or (qend and not vend) then
116 origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid timestamp"))
117 return true;
118 end
119 qstart, qend = vstart, vend;
120 end
121
122 module:log("debug", "Archive query, id %s with %s from %s until %s)",
123 tostring(qid), qwith or "anyone", qstart or "the dawn of time", qend or "now");
124
125 -- RSM stuff
126 local qset = rsm.get(query);
127 local qmax = m_min(qset and qset.max or default_max_items, max_max_items);
128 local reverse = qset and qset.before or false;
129 local before, after = qset and qset.before, qset and qset.after;
130 if type(before) ~= "string" then before = nil; end
131
132
133 -- Load all the data!
134 local data, err = archive:find(origin.username, {
135 start = qstart; ["end"] = qend; -- Time range
136 with = qwith;
137 limit = qmax + 1;
138 before = before; after = after;
139 reverse = reverse;
140 total = true;
141 });
142
143 if not data then
144 origin.send(st.error_reply(stanza, "cancel", "internal-server-error", err));
145 return true;
146 end
147 local total = tonumber(err);
148
149 origin.send(st.reply(stanza));
150 local msg_reply_attr = { to = stanza.attr.from, from = stanza.attr.to };
151
152 local results = {};
153
154 -- Wrap it in stuff and deliver
155 local first, last;
156 local count = 0;
157 local complete = "true";
158 for id, item, when in data do
159 count = count + 1;
160 if count > qmax then
161 complete = nil;
162 break;
163 end
164 local fwd_st = st.message(msg_reply_attr)
165 :tag("result", { xmlns = xmlns_mam, queryid = qid, id = id })
166 :tag("forwarded", { xmlns = xmlns_forward })
167 :tag("delay", { xmlns = xmlns_delay, stamp = timestamp(when) }):up();
168
169 if not is_stanza(item) then
170 item = st.deserialize(item);
171 end
172 item.attr.xmlns = "jabber:client";
173 fwd_st:add_child(item);
174
175 if not first then first = id; end
176 last = id;
177
178 if reverse then
179 results[count] = fwd_st;
180 else
181 origin.send(fwd_st);
182 end
183 end
184
185 if reverse then
186 for i = #results, 1, -1 do
187 origin.send(results[i]);
188 end
189 first, last = last, first;
190 end
191
192 -- That's all folks!
193 module:log("debug", "Archive query %s completed", tostring(qid));
194
195 origin.send(st.message(msg_reply_attr)
196 :tag("fin", { xmlns = xmlns_mam, queryid = qid, complete = complete })
197 :add_child(rsm.generate {
198 first = first, last = last, count = total }));
199 return true;
200 end);
201
202 local function has_in_roster(user, who)
203 local roster = rm_load_roster(user, host);
204 module:log("debug", "%s has %s in roster? %s", user, who, roster[who] and "yes" or "no");
205 return roster[who];
206 end
207
208 local function shall_store(user, who)
209 -- TODO Cache this?
210 if not um.user_exists(user, host) then
211 return false;
212 end
213 local prefs = get_prefs(user);
214 local rule = prefs[who];
215 module:log("debug", "%s's rule for %s is %s", user, who, tostring(rule));
216 if rule ~= nil then
217 return rule;
218 end
219 -- Below could be done by a metatable
220 local default = prefs[false];
221 module:log("debug", "%s's default rule is %s", user, tostring(default));
222 if default == nil then
223 default = global_default_policy;
224 module:log("debug", "Using global default rule, %s", tostring(default));
225 end
226 if default == "roster" then
227 return has_in_roster(user, who);
228 end
229 return default;
230 end
231
232 -- Handle messages
233 local function message_handler(event, c2s)
234 local origin, stanza = event.origin, event.stanza;
235 local log = c2s and origin.log or module._log;
236 local orig_type = stanza.attr.type or "normal";
237 local orig_from = stanza.attr.from;
238 local orig_to = stanza.attr.to or orig_from;
239 -- Stanza without 'to' are treated as if it was to their own bare jid
240
241 -- We store chat messages or normal messages that have a body
242 if not(orig_type == "chat" or (orig_type == "normal" and stanza:get_child("body")) ) then
243 log("debug", "Not archiving stanza: %s (type)", stanza:top_tag());
244 return;
245 end
246 -- or if hints suggest we shouldn't
247 if stanza:get_child("no-permanent-storage", "urn:xmpp:hints") -- The XEP needs to decide on "store" or "storage"
248 or stanza:get_child("no-permanent-store", "urn:xmpp:hints")
249 or stanza:get_child("no-storage", "urn:xmpp:hints")
250 or stanza:get_child("no-store", "urn:xmpp:hints") then
251 log("debug", "Not archiving stanza: %s (hint)", stanza:top_tag());
252 return;
253 end
254
255 -- Whos storage do we put it in?
256 local store_user = c2s and origin.username or jid_split(orig_to);
257 -- And who are they chatting with?
258 local with = jid_bare(c2s and orig_to or orig_from);
259
260 -- Check with the users preferences
261 if shall_store(store_user, with) then
262 log("debug", "Archiving stanza: %s", stanza:top_tag());
263
264 -- And stash it
265 local ok, id = archive:append(store_user, nil, stanza, time_now(), with);
266 if ok then
267 if cleanup then cleanup[store_user] = true; end
268 module:fire_event("archive-message-added", { origin = origin, stanza = stanza, for_user = store_user, id = id });
269 end
270 else
271 log("debug", "Not archiving stanza: %s (prefs)", stanza:top_tag());
272 end
273 end
274
275 local function c2s_message_handler(event)
276 return message_handler(event, true);
277 end
278
279 local cleanup_after = module:get_option_string("archive_expires_after", "1w");
280 local cleanup_interval = module:get_option_number("archive_cleanup_interval", 4 * 60 * 60);
281 if cleanup_after ~= "never" then
282 local day = 86400;
283 local multipliers = { d = day, w = day * 7, m = 31 * day, y = 365.2425 * day };
284 local n, m = cleanup_after:lower():match("(%d+)%s*([dwmy]?)");
285 if not n then
286 module:log("error", "Could not parse archive_expires_after string %q", cleanup_after);
287 return false;
288 end
289
290 cleanup_after = tonumber(n) * ( multipliers[m] or 1 );
291
292 module:log("debug", "archive_expires_after = %d -- in seconds", cleanup_after);
293
294 if not archive.delete then
295 module:log("error", "archive_expires_after set but mod_%s does not support deleting", archive._provided_by);
296 return false;
297 end
298
299 cleanup = {};
300
301 pcall(function ()
302 for user in um.users(module.host) do
303 cleanup[user] = true;
304 end
305 end);
306
307 module:add_timer(math.random(10, 60), function()
308 local user = next(cleanup);
309 if user then
310 module:log("debug", "Removing old messages for user %q", user);
311 local ok, err = archive:delete(user, { ["end"] = os.time() - cleanup_after; })
312 if not ok then
313 module:log("warn", "Could not expire archives for user %s: %s", user, err);
314 else
315 -- :affected() is a recent addition for eg SQLite3 in LuaDBI
316 pcall(function(stmt)
317 module:log("debug", "Removed %d messages", stmt:affected());
318 end, err);
319 end
320 cleanup[user] = nil;
321 end
322 return math.random(cleanup_interval, cleanup_interval * 2);
323 end);
324 end
325
326 -- Stanzas sent by local clients
327 module:hook("pre-message/bare", c2s_message_handler, 2);
328 module:hook("pre-message/full", c2s_message_handler, 2);
329 -- Stanszas to local clients
330 module:hook("message/bare", message_handler, 2);
331 module:hook("message/full", message_handler, 2);
332
333 module:add_feature(xmlns_mam); -- COMPAT with XEP-0313 v 0.1
334
335 module:hook("account-disco-info", function(event)
336 (event.reply or event.stanza):tag("feature", {var=xmlns_mam}):up();
337 end);
338