verse
266a96ae4c0d
plugins/archive.lua

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

Software / code / verse

Annotate

plugins/archive.lua @ 345:266a96ae4c0d

plugins.archive: Update for MAM 0.2
author Kim Alvefur <zash@zash.se>
date Sun, 30 Jun 2013 00:46:49 +0200
parent 305:4a0206505b9d
child 353:8cd05c3d0f1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
291
b78137f5118e plugins.archive: Add a header comment
Kim Alvefur <zash@zash.se>
parents: 275
diff changeset
1 -- This implements XEP-0313: Message Archive Management
b78137f5118e plugins.archive: Add a header comment
Kim Alvefur <zash@zash.se>
parents: 275
diff changeset
2 -- http://xmpp.org/extensions/xep-0313.html
b78137f5118e plugins.archive: Add a header comment
Kim Alvefur <zash@zash.se>
parents: 275
diff changeset
3 -- (ie not XEP-0136)
b78137f5118e plugins.archive: Add a header comment
Kim Alvefur <zash@zash.se>
parents: 275
diff changeset
4
292
b674f5ca85d4 plugins.archive: Add local verse
Kim Alvefur <zash@zash.se>
parents: 291
diff changeset
5 local verse = require "verse";
293
65fb9ae79014 plugins.archive: Import util.stanza directly and use it
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
6 local st = require "util.stanza";
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 local xmlns_mam = "urn:xmpp:mam:tmp"
295
5f7203bf1dae plugins.archive: Move namespaces to the top
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
8 local xmlns_forward = "urn:xmpp:forward:0";
5f7203bf1dae plugins.archive: Move namespaces to the top
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
9 local xmlns_delay = "urn:xmpp:delay";
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 local uuid = require "util.uuid".generate;
297
447dffdaf46c plugins.archive: Parse the timestamp
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
11 local parse_datetime = require "util.datetime".parse;
303
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
12 local datetime = require "util.datetime".datetime;
304
e09ae2395d41 squishy, plugins.archive: Fetch RSM lib from prosody-modules and use.
Kim Alvefur <zash@zash.se>
parents: 303
diff changeset
13 local rsm = require "util.rsm";
303
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
14 local tonumber = tonumber;
304
e09ae2395d41 squishy, plugins.archive: Fetch RSM lib from prosody-modules and use.
Kim Alvefur <zash@zash.se>
parents: 303
diff changeset
15 local NULL = {};
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 function verse.plugins.archive(stream)
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 function stream:query_archive(where, query_params, callback)
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 local queryid = uuid();
293
65fb9ae79014 plugins.archive: Import util.stanza directly and use it
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
20 local query_st = st.iq{ type="get", to = where }
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 :tag("query", { xmlns = xmlns_mam, queryid = queryid });
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
303
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
23 local qwith = query_params["with"];
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
24 if qwith then
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
25 query_st:tag("with"):text(qwith):up();
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
26 end
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
27
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
28 local qstart, qend = tonumber(query_params["start"]), tonumber(query_params["end"]);
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
29 if qstart then
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
30 query_st:tag("start"):text(datetime(qstart)):up();
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
31 end
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
32 if qend then
0dda04d5eb84 plugins.archive: Treat query params correctly
Kim Alvefur <zash@zash.se>
parents: 297
diff changeset
33 query_st:tag("end"):text(datetime(qend)):up();
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 end
304
e09ae2395d41 squishy, plugins.archive: Fetch RSM lib from prosody-modules and use.
Kim Alvefur <zash@zash.se>
parents: 303
diff changeset
35
305
4a0206505b9d plugins.archive: Don't modify the query params table
Kim Alvefur <zash@zash.se>
parents: 304
diff changeset
36 query_st:add_child(rsm.generate(query_params));
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 local results = {};
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 local function handle_archived_message(message)
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 local result_tag = message:get_child("result", xmlns_mam);
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 if result_tag and result_tag.attr.queryid == queryid then
345
266a96ae4c0d plugins.archive: Update for MAM 0.2
Kim Alvefur <zash@zash.se>
parents: 305
diff changeset
42 local forwarded = result_tag:get_child("forwarded", xmlns_forward);
266a96ae4c0d plugins.archive: Update for MAM 0.2
Kim Alvefur <zash@zash.se>
parents: 305
diff changeset
43 forwarded = forwarded or message:get_child("forwarded", xmlns_forward); -- COMPAT XEP-0313 pre 2013-05-31
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44
296
78ddfd30c74e plugins.archive: Collect the archive id
Kim Alvefur <zash@zash.se>
parents: 295
diff changeset
45 local id = result_tag.attr.id;
295
5f7203bf1dae plugins.archive: Move namespaces to the top
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
46 local delay = forwarded:get_child("delay", xmlns_delay);
297
447dffdaf46c plugins.archive: Parse the timestamp
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
47 local stamp = delay and parse_datetime(delay.attr.stamp) or nil;
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 local message = forwarded:get_child("message", "jabber:client")
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50
296
78ddfd30c74e plugins.archive: Collect the archive id
Kim Alvefur <zash@zash.se>
parents: 295
diff changeset
51 results[#results+1] = { id = id, stamp = stamp, message = message };
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 return true
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53 end
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 end
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 self:hook("message", handle_archived_message, 1);
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 self:send_iq(query_st, function(reply)
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
58 self:unhook("message", handle_archived_message);
304
e09ae2395d41 squishy, plugins.archive: Fetch RSM lib from prosody-modules and use.
Kim Alvefur <zash@zash.se>
parents: 303
diff changeset
59 local rset = reply.tags[1] and rsm.get(reply.tags[1]);
e09ae2395d41 squishy, plugins.archive: Fetch RSM lib from prosody-modules and use.
Kim Alvefur <zash@zash.se>
parents: 303
diff changeset
60 for k,v in pairs(rset or NULL) do results[k]=v; end
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
61 callback(reply.attr.type == "result" and #results, results);
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
62 return true
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
63 end);
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
64 end
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
65
294
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
66 local default_attrs = {
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
67 always = true, [true] = "always",
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
68 never = false, [false] = "never",
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
69 roster = "roster",
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
70 }
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
71
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
72 local function prefs_decode(stanza) -- from XML
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
73 local prefs = {};
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
74 local default = stanza.attr.default;
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
75
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
76 if default then
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
77 prefs[false] = default_attrs[default];
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
78 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
79
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
80 local always = stanza:get_child("always");
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
81 if always then
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
82 for rule in always:childtags("jid") do
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
83 local jid = rule:get_text();
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
84 prefs[jid] = true;
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
85 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
86 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
87
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
88 local never = stanza:get_child("never");
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
89 if never then
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
90 for rule in never:childtags("jid") do
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
91 local jid = rule:get_text();
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
92 prefs[jid] = false;
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
93 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
94 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
95 return prefs;
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
96 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
97
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
98 local function prefs_encode(prefs) -- into XML
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
99 local default
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
100 default, prefs[false] = prefs[false], nil;
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
101 if default ~= nil then
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
102 default = default_attrs[default];
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
103 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
104 local reply = st.stanza("prefs", { xmlns = xmlns_mam, default = default })
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
105 local always = st.stanza("always");
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
106 local never = st.stanza("never");
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
107 for k,v in pairs(prefs) do
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
108 (v and always or never):tag("jid"):text(k):up();
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
109 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
110 return reply:add_child(always):add_child(never);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
111 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
112
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
113 function stream:archive_prefs_get(callback)
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
114 self:send_iq(st.iq{ type="get" }:tag("prefs", { xmlns = xmlns_mam }),
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
115 function(result)
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
116 if result and result.attr.type == "result" and result.tags[1] then
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
117 local prefs = prefs_decode(result.tags[1]);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
118 callback(prefs, result);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
119 else
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
120 callback(nil, result);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
121 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
122 end);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
123 end
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
124
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
125 function stream:archive_prefs_set(prefs, callback)
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
126 self:send_iq(st.iq{ type="set" }:add_child(prefs_encode(prefs)), callback);
ac039aa3a4ef plugins.archive: Implement archiving preferences
Kim Alvefur <zash@zash.se>
parents: 293
diff changeset
127 end
273
c5b7a4c717a6 plugins.archive: Experimental implementation of the Message Archive Management ProtoXEP
Kim Alvefur <zash@zash.se>
parents:
diff changeset
128 end