prosody-modules: mod_mam/mod

annotate mod_mam/mod_mam.lua @ 2514:d47a7e6e9adc

mod_storage_xmlarchive: Raise error instead of warning if there's ever more than one stanza in a chunk (this indicates some kind of corruption)

author	Kim Alvefur <zash@zash.se>
date	Mon, 20 Feb 2017 01:47:44 +0100
parents	66a61f48e376
children	4cb549622862

rev	line source
635 30be50d2537f mod_mam: Update header Kim Alvefur <zash@zash.se> parents: 634 diff changeset	1 -- XEP-0313: Message Archive Management for Prosody
2000 b5adfe72709b mod_mam: Improve error messages when failed to open storage Kim Alvefur <zash@zash.se> parents: 1957 diff changeset	2 -- Copyright (C) 2011-2016 Kim Alvefur
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	3 --
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	4 -- This file is MIT/X11 licensed.
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	5
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	6 local xmlns_mam0 = "urn:xmpp:mam:0";
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	7 local xmlns_mam1 = "urn:xmpp:mam:1";
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	8 local xmlns_delay = "urn:xmpp:delay";
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	9 local xmlns_forward = "urn:xmpp:forward:0";
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	10
2293 144b74caa5ef mod_mam: Check that user exists (#731) Kim Alvefur <zash@zash.se> parents: 2270 diff changeset	11 local um = require "core.usermanager";
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	12 local st = require "util.stanza";
701 cc5805f83583 mod_mam: Implement support for Result Set Management in queries. Kim Alvefur <zash@zash.se> parents: 675 diff changeset	13 local rsm = module:require "rsm";
1399 7fb6b607afd6 mod_mam: Shuffle imports Kim Alvefur <zash@zash.se> parents: 1369 diff changeset	14 local get_prefs = module:require"mamprefs".get;
7fb6b607afd6 mod_mam: Shuffle imports Kim Alvefur <zash@zash.se> parents: 1369 diff changeset	15 local set_prefs = module:require"mamprefs".set;
7fb6b607afd6 mod_mam: Shuffle imports Kim Alvefur <zash@zash.se> parents: 1369 diff changeset	16 local prefs_to_stanza = module:require"mamprefsxml".tostanza;
7fb6b607afd6 mod_mam: Shuffle imports Kim Alvefur <zash@zash.se> parents: 1369 diff changeset	17 local prefs_from_stanza = module:require"mamprefsxml".fromstanza;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	18 local jid_bare = require "util.jid".bare;
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	19 local jid_split = require "util.jid".split;
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	20 local dataform = require "util.dataforms".new;
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	21 local host = module.host;
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	22
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	23 local rm_load_roster = require "core.rostermanager".load_roster;
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	24
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	25 local getmetatable = getmetatable;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	26 local function is_stanza(x)
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	27 return getmetatable(x) == st.stanza_mt;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	28 end
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	29
672 8ae5317ba032 mod_mam: local tostring and some comments Kim Alvefur <zash@zash.se> parents: 671 diff changeset	30 local tostring = tostring;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	31 local time_now = os.time;
707 f987c7b79008 mod_mam: Fix typo Kim Alvefur <zash@zash.se> parents: 706 diff changeset	32 local m_min = math.min;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	33 local timestamp, timestamp_parse = require "util.datetime".datetime, require "util.datetime".parse;
706 5c2b96c4dde6 mod_mam: Enforce a max number of items returned, with a default. Kim Alvefur <zash@zash.se> parents: 705 diff changeset	34 local default_max_items, max_max_items = 20, module:get_option_number("max_archive_query_results", 50);
2017 d44ac0756c46 mod_mam: Enable archiving by default, less of a privacy issue if messages expire Kim Alvefur <zash@zash.se> parents: 2016 diff changeset	35 local global_default_policy = module:get_option("default_archive_policy", true);
1587 3ac2b835c7b3 mod_mam: Make sure default_archive_policy is a boolean or "roster" (thanks souliane) Kim Alvefur <zash@zash.se> parents: 1484 diff changeset	36 if global_default_policy ~= "roster" then
3ac2b835c7b3 mod_mam: Make sure default_archive_policy is a boolean or "roster" (thanks souliane) Kim Alvefur <zash@zash.se> parents: 1484 diff changeset	37 global_default_policy = module:get_option_boolean("default_archive_policy", global_default_policy);
3ac2b835c7b3 mod_mam: Make sure default_archive_policy is a boolean or "roster" (thanks souliane) Kim Alvefur <zash@zash.se> parents: 1484 diff changeset	38 end
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	39
2510 d81882aa0e1e mod_mam: Make the store configurable to ease move to 0.10 version Kim Alvefur <zash@zash.se> parents: 2506 diff changeset	40 local archive_store = module:get_option_string("archive_store", "archive2");
2000 b5adfe72709b mod_mam: Improve error messages when failed to open storage Kim Alvefur <zash@zash.se> parents: 1957 diff changeset	41 local archive = assert(module:open_store(archive_store, "archive"));
2020 37b30f10fbba mod_mam: Bit of spacing between blocks of code Kim Alvefur <zash@zash.se> parents: 2019 diff changeset	42
2024 6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	43 if archive.name == "null" or not archive.find then
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	44 if not archive.find then
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	45 module:log("debug", "Attempt to open archive storage returned a valid driver but it does not seem to implement the storage API");
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	46 module:log("debug", "mod_%s does not support archiving", archive._provided_by or archive.name and "storage_"..archive.name.."(?)" or "<unknown>");
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	47 else
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	48 module:log("debug", "Attempt to open archive storage returned null driver");
6f4dcc723a60 mod_mam: Use the fallback driver if either the null driver or a driver that does not implement the archive api is returned Kim Alvefur <zash@zash.se> parents: 2023 diff changeset	49 end
2030 66156e4d5274 mod_mam: This was meant to be a debug message Kim Alvefur <zash@zash.se> parents: 2025 diff changeset	50 module:log("debug", "See https://prosody.im/doc/storage and https://prosody.im/doc/archiving for more information");
2023 98b4794b72e4 mod_mam: Include an in-memory fallback driver Kim Alvefur <zash@zash.se> parents: 2022 diff changeset	51 module:log("info", "Using in-memory fallback archive driver");
98b4794b72e4 mod_mam: Include an in-memory fallback driver Kim Alvefur <zash@zash.se> parents: 2022 diff changeset	52 archive = module:require "fallback_archive";
1185 30b681898c2d mod_mam: Log error message if unable to open archive storage Kim Alvefur <zash@zash.se> parents: 1152 diff changeset	53 end
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	54
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	55 local cleanup;
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	56
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	57 -- Handle prefs.
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	58 local function handle_prefs(event)
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	59 local origin, stanza = event.origin, event.stanza;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	60 local xmlns_mam = stanza.tags[1].attr.xmlns;
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	61 local user = origin.username;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	62 if stanza.attr.type == "get" then
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	63 local prefs = prefs_to_stanza(get_prefs(user), xmlns_mam);
1135 0d6ab5e4bc30 mod_mam: Break out routines for converting prefs between XML and our internal representation into a library Kim Alvefur <zash@zash.se> parents: 1116 diff changeset	64 local reply = st.reply(stanza):add_child(prefs);
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	65 origin.send(reply);
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	66 else -- type == "set"
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	67 local new_prefs = stanza:get_child("prefs", xmlns_mam);
1135 0d6ab5e4bc30 mod_mam: Break out routines for converting prefs between XML and our internal representation into a library Kim Alvefur <zash@zash.se> parents: 1116 diff changeset	68 local prefs = prefs_from_stanza(new_prefs);
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	69 local ok, err = set_prefs(user, prefs);
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	70 if not ok then
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	71 origin.send(st.error_reply(stanza, "cancel", "internal-server-error", "Error storing preferences: "..tostring(err)));
d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	72 else
d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	73 origin.send(st.reply(stanza));
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	74 end
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	75 end
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	76 return true;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	77 end
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	78
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	79 module:hook("iq/self/"..xmlns_mam0..":prefs", handle_prefs);
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	80 module:hook("iq/self/"..xmlns_mam1..":prefs", handle_prefs);
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	81
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	82 local query_form = dataform {
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	83 { name = "FORM_TYPE"; type = "hidden"; value = xmlns_mam0; };
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	84 { name = "with"; type = "jid-single"; };
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	85 { name = "start"; type = "text-single" };
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	86 { name = "end"; type = "text-single"; };
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	87 };
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	88
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	89 -- Serve form
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	90 local function handle_get_form(event)
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	91 local origin, stanza = event.origin, event.stanza;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	92 local xmlns_mam = stanza.tags[1].attr.xmlns;
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	93 query_form[1].value = xmlns_mam;
2505 1398f3f76c0f mod_mam: Add missing wrapping <query> element when returning the query form Kim Alvefur <zash@zash.se> parents: 2293 diff changeset	94 origin.send(st.reply(stanza):query(xmlns_mam):add_child(query_form:form()));
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	95 return true;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	96 end
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	97
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	98 module:hook("iq-get/self/"..xmlns_mam0..":query", handle_get_form);
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	99 module:hook("iq-get/self/"..xmlns_mam1..":query", handle_get_form);
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	100
1325 b21236b6b8d8 Backed out changeset 853a382c9bd6 Kim Alvefur <zash@zash.se> parents: 1324 diff changeset	101 -- Handle archive queries
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	102 local function handle_mam_query(event)
1324 853a382c9bd6 mod_turncredentials: Advertise the XEP-0215 feature (thanks Gryffus) Kim Alvefur <zash@zash.se> parents: 1187 diff changeset	103 local origin, stanza = event.origin, event.stanza;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	104 local xmlns_mam = stanza.tags[1].attr.xmlns;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	105 local query = stanza.tags[1];
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	106 local qid = query.attr.queryid;
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	107
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	108 if cleanup then cleanup[origin.username] = true; end
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	109
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	110 -- Search query parameters
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	111 local qwith, qstart, qend;
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	112 local form = query:get_child("x", "jabber:x:data");
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	113 if form then
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	114 local err;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	115 query_form[1].value = xmlns_mam;
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	116 form, err = query_form:data(form);
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	117 if err then
1698 55bc42c1d8c5 mod_mam: Semicolons! Kim Alvefur <zash@zash.se> parents: 1685 diff changeset	118 origin.send(st.error_reply(stanza, "modify", "bad-request", select(2, next(err))));
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	119 return true;
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	120 end
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	121 qwith, qstart, qend = form["with"], form["start"], form["end"];
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	122 qwith = qwith and jid_bare(qwith); -- dataforms does jidprep
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	123 end
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	124
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	125 if qstart or qend then -- Validate timestamps
1698 55bc42c1d8c5 mod_mam: Semicolons! Kim Alvefur <zash@zash.se> parents: 1685 diff changeset	126 local vstart, vend = (qstart and timestamp_parse(qstart)), (qend and timestamp_parse(qend));
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	127 if (qstart and not vstart) or (qend and not vend) then
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	128 origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid timestamp"))
1698 55bc42c1d8c5 mod_mam: Semicolons! Kim Alvefur <zash@zash.se> parents: 1685 diff changeset	129 return true;
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	130 end
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	131 qstart, qend = vstart, vend;
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	132 end
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	133
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	134 module:log("debug", "Archive query, id %s with %s from %s until %s)",
53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	135 tostring(qid), qwith or "anyone", qstart or "the dawn of time", qend or "now");
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	136
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	137 -- RSM stuff
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	138 local qset = rsm.get(query);
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	139 local qmax = m_min(qset and qset.max or default_max_items, max_max_items);
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	140 local reverse = qset and qset.before or false;
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	141 local before, after = qset and qset.before, qset and qset.after;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	142 if type(before) ~= "string" then before = nil; end
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	143
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	144 -- Load all the data!
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	145 local data, err = archive:find(origin.username, {
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	146 start = qstart; ["end"] = qend; -- Time range
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	147 with = qwith;
1682 6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	148 limit = qmax + 1;
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	149 before = before; after = after;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	150 reverse = reverse;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	151 total = true;
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	152 });
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	153
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	154 if not data then
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	155 origin.send(st.error_reply(stanza, "cancel", "internal-server-error", err));
d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	156 return true;
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	157 end
2019 7198c129657c mod_mam: Always convert 'total' to a number Kim Alvefur <zash@zash.se> parents: 2018 diff changeset	158 local total = tonumber(err);
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	159
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	160 if xmlns_mam == xmlns_mam0 then
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	161 origin.send(st.reply(stanza));
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	162 end
1403 6b3db167374a mod_mam: Mirror to and from attributes from iq on result messages Kim Alvefur <zash@zash.se> parents: 1400 diff changeset	163 local msg_reply_attr = { to = stanza.attr.from, from = stanza.attr.to };
6b3db167374a mod_mam: Mirror to and from attributes from iq on result messages Kim Alvefur <zash@zash.se> parents: 1400 diff changeset	164
1685 cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	165 local results = {};
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	166
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	167 -- Wrap it in stuff and deliver
1684 838150167871 mod_mam: Move variable into loop scope Kim Alvefur <zash@zash.se> parents: 1683 diff changeset	168 local first, last;
1682 6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	169 local count = 0;
6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	170 local complete = "true";
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	171 for id, item, when in data do
1682 6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	172 count = count + 1;
6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	173 if count > qmax then
6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	174 complete = nil;
6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	175 break;
6b2122630b92 mod_mam: Support the mandatory 'complete' attribute by requesting one extra item from storage Kim Alvefur <zash@zash.se> parents: 1681 diff changeset	176 end
1684 838150167871 mod_mam: Move variable into loop scope Kim Alvefur <zash@zash.se> parents: 1683 diff changeset	177 local fwd_st = st.message(msg_reply_attr)
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	178 :tag("result", { xmlns = xmlns_mam, queryid = qid, id = id })
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	179 :tag("forwarded", { xmlns = xmlns_forward })
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	180 :tag("delay", { xmlns = xmlns_delay, stamp = timestamp(when) }):up();
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	181
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	182 if not is_stanza(item) then
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	183 item = st.deserialize(item);
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	184 end
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	185 item.attr.xmlns = "jabber:client";
2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	186 fwd_st:add_child(item);
701 cc5805f83583 mod_mam: Implement support for Result Set Management in queries. Kim Alvefur <zash@zash.se> parents: 675 diff changeset	187
1325 b21236b6b8d8 Backed out changeset 853a382c9bd6 Kim Alvefur <zash@zash.se> parents: 1324 diff changeset	188 if not first then first = id; end
b21236b6b8d8 Backed out changeset 853a382c9bd6 Kim Alvefur <zash@zash.se> parents: 1324 diff changeset	189 last = id;
1116 2345a30dd8b4 mod_mam: Update to use 'archive' storage type. Note: this breaks support with 0.9 and older. Kim Alvefur <zash@zash.se> parents: 1114 diff changeset	190
1685 cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	191 if reverse then
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	192 results[count] = fwd_st;
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	193 else
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	194 origin.send(fwd_st);
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	195 end
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	196 end
2020 37b30f10fbba mod_mam: Bit of spacing between blocks of code Kim Alvefur <zash@zash.se> parents: 2019 diff changeset	197
1685 cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	198 if reverse then
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	199 for i = #results, 1, -1 do
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	200 origin.send(results[i]);
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	201 end
2021 5fb917b86838 mod_mam: Merge identical conditional blocks Kim Alvefur <zash@zash.se> parents: 2020 diff changeset	202 first, last = last, first;
1685 cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	203 end
cd87a2eba8f2 mod_mam: Reverse the order of reversed queries back to chronological order Kim Alvefur <zash@zash.se> parents: 1684 diff changeset	204
1112 1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	205 -- That's all folks!
1dc07833355e mod_mam: Use more specific hook Kim Alvefur <zash@zash.se> parents: 1111 diff changeset	206 module:log("debug", "Archive query %s completed", tostring(qid));
705 c9d0ba39a33b mod_mam: Move RSM pointer to last message into a MAM-namespaced child Kim Alvefur <zash@zash.se> parents: 702 diff changeset	207
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	208 local fin;
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	209 if xmlns_mam == xmlns_mam0 then
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	210 fin = st.message(msg_reply_attr);
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	211 else
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	212 fin = st.reply(stanza);
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	213 end
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	214 do
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	215 fin:tag("fin", { xmlns = xmlns_mam, queryid = qid, complete = complete })
1484 53a3a19d6093 mod_mam: Update to version 0.3 of XEP-0313 Kim Alvefur <zash@zash.se> parents: 1403 diff changeset	216 :add_child(rsm.generate {
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	217 first = first, last = last, count = total })
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	218 end
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	219 origin.send(fin);
1681 d20cfc5ba827 mod_mam: Always return true when a stanza event has been handled Kim Alvefur <zash@zash.se> parents: 1678 diff changeset	220 return true;
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	221 end
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	222 module:hook("iq-set/self/"..xmlns_mam0..":query", handle_mam_query);
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	223 module:hook("iq-set/self/"..xmlns_mam1..":query", handle_mam_query);
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	224
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	225 local function has_in_roster(user, who)
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	226 local roster = rm_load_roster(user, host);
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	227 module:log("debug", "%s has %s in roster? %s", user, who, roster[who] and "yes" or "no");
798 2b8ceb4d1a73 mod_mam: remove useless check Kim Alvefur <zash@zash.se> parents: 751 diff changeset	228 return roster[who];
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	229 end
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	230
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	231 local function shall_store(user, who)
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	232 -- TODO Cache this?
2293 144b74caa5ef mod_mam: Check that user exists (#731) Kim Alvefur <zash@zash.se> parents: 2270 diff changeset	233 if not um.user_exists(user, host) then
144b74caa5ef mod_mam: Check that user exists (#731) Kim Alvefur <zash@zash.se> parents: 2270 diff changeset	234 return false;
144b74caa5ef mod_mam: Check that user exists (#731) Kim Alvefur <zash@zash.se> parents: 2270 diff changeset	235 end
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	236 local prefs = get_prefs(user);
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	237 local rule = prefs[who];
1698 55bc42c1d8c5 mod_mam: Semicolons! Kim Alvefur <zash@zash.se> parents: 1685 diff changeset	238 module:log("debug", "%s's rule for %s is %s", user, who, tostring(rule));
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	239 if rule ~= nil then
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	240 return rule;
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	241 end
1788 d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	242 -- Below could be done by a metatable
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	243 local default = prefs[false];
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	244 module:log("debug", "%s's default rule is %s", user, tostring(default));
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	245 if default == nil then
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	246 default = global_default_policy;
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	247 module:log("debug", "Using global default rule, %s", tostring(default));
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	248 end
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	249 if default == "roster" then
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	250 return has_in_roster(user, who);
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	251 end
d2b82b90c413 mod_mam: Unindent 'else' block Kim Alvefur <zash@zash.se> parents: 1773 diff changeset	252 return default;
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	253 end
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	254
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	255 -- Handle messages
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	256 local function message_handler(event, c2s)
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	257 local origin, stanza = event.origin, event.stanza;
2270 9c99200afd17 mod_mam: Log messages from local clients on the clients session Kim Alvefur <zash@zash.se> parents: 2049 diff changeset	258 local log = c2s and origin.log or module._log;
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	259 local orig_type = stanza.attr.type or "normal";
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	260 local orig_from = stanza.attr.from;
1149 d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	261 local orig_to = stanza.attr.to or orig_from;
d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	262 -- Stanza without 'to' are treated as if it was to their own bare jid
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	263
1790 4c2146f5bf39 mod_mam: Store chat messages and normal messages with a body Kim Alvefur <zash@zash.se> parents: 1788 diff changeset	264 -- We store chat messages or normal messages that have a body
1957 ca33cca2e028 mod_mam: Clarify condition presendence Kim Alvefur <zash@zash.se> parents: 1790 diff changeset	265 if not(orig_type == "chat" or (orig_type == "normal" and stanza:get_child("body")) ) then
2270 9c99200afd17 mod_mam: Log messages from local clients on the clients session Kim Alvefur <zash@zash.se> parents: 2049 diff changeset	266 log("debug", "Not archiving stanza: %s (type)", stanza:top_tag());
1790 4c2146f5bf39 mod_mam: Store chat messages and normal messages with a body Kim Alvefur <zash@zash.se> parents: 1788 diff changeset	267 return;
4c2146f5bf39 mod_mam: Store chat messages and normal messages with a body Kim Alvefur <zash@zash.se> parents: 1788 diff changeset	268 end
2512 bc7539ccbde1 mod_mam: Normalize whitespace Kim Alvefur <zash@zash.se> parents: 2511 diff changeset	269
1150 296820f18ba6 mod_mam: Add support for XEP-0334: Message Processing Hints Kim Alvefur <zash@zash.se> parents: 1149 diff changeset	270 -- or if hints suggest we shouldn't
2511 34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	271 if not stanza:get_child("store", "urn:xmpp:hints") then -- No hint telling us we should store
34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	272 if stanza:get_child("no-permanent-store", "urn:xmpp:hints")
34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	273 or stanza:get_child("no-store", "urn:xmpp:hints") then -- Hint telling us we should NOT store
34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	274 log("debug", "Not archiving stanza: %s (hint)", stanza:top_tag());
34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	275 return;
34a6ba5dfe4f mod_mam: Bring hints processing in line with 0.10 version Kim Alvefur <zash@zash.se> parents: 2510 diff changeset	276 end
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	277 end
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	278
1149 d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	279 -- Whos storage do we put it in?
d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	280 local store_user = c2s and origin.username or jid_split(orig_to);
d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	281 -- And who are they chatting with?
d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	282 local with = jid_bare(c2s and orig_to or orig_from);
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	283
1149 d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	284 -- Check with the users preferences
d055c44a7f61 mod_mam: Clean up and explain the code that determines who's archive we put the message in Kim Alvefur <zash@zash.se> parents: 1135 diff changeset	285 if shall_store(store_user, with) then
2270 9c99200afd17 mod_mam: Log messages from local clients on the clients session Kim Alvefur <zash@zash.se> parents: 2049 diff changeset	286 log("debug", "Archiving stanza: %s", stanza:top_tag());
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	287
66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	288 -- And stash it
2018 13f46d9e526f mod_mam: Fix order of arguments to archive append Kim Alvefur <zash@zash.se> parents: 2017 diff changeset	289 local ok, id = archive:append(store_user, nil, stanza, time_now(), with);
1746 5734a6199938 mod_mam: Fire event on successful storage of message Kim Alvefur <zash@zash.se> parents: 1737 diff changeset	290 if ok then
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	291 if cleanup then cleanup[store_user] = true; end
1746 5734a6199938 mod_mam: Fire event on successful storage of message Kim Alvefur <zash@zash.se> parents: 1737 diff changeset	292 module:fire_event("archive-message-added", { origin = origin, stanza = stanza, for_user = store_user, id = id });
5734a6199938 mod_mam: Fire event on successful storage of message Kim Alvefur <zash@zash.se> parents: 1737 diff changeset	293 end
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	294 else
2270 9c99200afd17 mod_mam: Log messages from local clients on the clients session Kim Alvefur <zash@zash.se> parents: 2049 diff changeset	295 log("debug", "Not archiving stanza: %s (prefs)", stanza:top_tag());
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	296 end
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	297 end
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	298
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	299 local function c2s_message_handler(event)
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	300 return message_handler(event, true);
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	301 end
eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	302
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	303 local cleanup_after = module:get_option_string("archive_expires_after", "1w");
2022 77b9c7e5fd63 mod_mam: Allow interval between archive cleanup to be changed Kim Alvefur <zash@zash.se> parents: 2021 diff changeset	304 local cleanup_interval = module:get_option_number("archive_cleanup_interval", 4 * 60 * 60);
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	305 if cleanup_after ~= "never" then
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	306 local day = 86400;
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	307 local multipliers = { d = day, w = day * 7, m = 31 * day, y = 365.2425 * day };
2049 50c188cf0ae3 mod_mam: Include 'w' (week) in pattern for "archive_expires_after" option (fixes #627) Kim Alvefur <zash@zash.se> parents: 2042 diff changeset	308 local n, m = cleanup_after:lower():match("(%d+)%s*([dwmy]?)");
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	309 if not n then
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	310 module:log("error", "Could not parse archive_expires_after string %q", cleanup_after);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	311 return false;
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	312 end
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	313
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	314 cleanup_after = tonumber(n) * ( multipliers[m] or 1 );
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	315
2042 752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	316 module:log("debug", "archive_expires_after = %d -- in seconds", cleanup_after);
752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	317
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	318 if not archive.delete then
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	319 module:log("error", "archive_expires_after set but mod_%s does not support deleting", archive._provided_by);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	320 return false;
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	321 end
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	322
2513 66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	323 -- Set of known users to do message expiry for
66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	324 -- Populated either below or when new messages are added
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	325 cleanup = {};
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	326
2513 66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	327 -- Iterating over users is not supported by all authentication modules
66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	328 -- Catch and ignore error if not supported
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	329 pcall(function ()
2513 66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	330 -- If this works, then we schedule cleanup for all known users on startup
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	331 for user in um.users(module.host) do
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	332 cleanup[user] = true;
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	333 end
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	334 end);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	335
2513 66a61f48e376 mod_mam: Add comments Kim Alvefur <zash@zash.se> parents: 2512 diff changeset	336 -- At odd intervals, delete old messages for one user
2039 464edd03099a mod_mam: Add a bit of randomness to cleanup intervals to keep some time between multiple instances Kim Alvefur <zash@zash.se> parents: 2033 diff changeset	337 module:add_timer(math.random(10, 60), function()
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	338 local user = next(cleanup);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	339 if user then
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	340 module:log("debug", "Removing old messages for user %q", user);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	341 local ok, err = archive:delete(user, { ["end"] = os.time() - cleanup_after; })
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	342 if not ok then
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	343 module:log("warn", "Could not expire archives for user %s: %s", user, err);
2042 752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	344 else
752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	345 -- :affected() is a recent addition for eg SQLite3 in LuaDBI
752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	346 pcall(function(stmt)
752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	347 module:log("debug", "Removed %d messages", stmt:affected());
752eee154891 mod_mam: Add some debug logging Kim Alvefur <zash@zash.se> parents: 2039 diff changeset	348 end, err);
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	349 end
2025 ae98bb884110 mod_mam: Fix Top Level Error from string[table] = nil instead of table[string] = nil Kim Alvefur <zash@zash.se> parents: 2024 diff changeset	350 cleanup[user] = nil;
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	351 end
2039 464edd03099a mod_mam: Add a bit of randomness to cleanup intervals to keep some time between multiple instances Kim Alvefur <zash@zash.se> parents: 2033 diff changeset	352 return math.random(cleanup_interval, cleanup_interval * 2);
2016 279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	353 end);
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	354 end
279885fd9728 mod_mam: Add support for trimming old archived messages Kim Alvefur <zash@zash.se> parents: 2001 diff changeset	355
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	356 -- Stanzas sent by local clients
621 7bdd02056e2b mod_mam: Bumb priority up above carbons, so that archive ids are included Kim Alvefur <zash@zash.se> parents: 620 diff changeset	357 module:hook("pre-message/bare", c2s_message_handler, 2);
7bdd02056e2b mod_mam: Bumb priority up above carbons, so that archive ids are included Kim Alvefur <zash@zash.se> parents: 620 diff changeset	358 module:hook("pre-message/full", c2s_message_handler, 2);
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	359 -- Stanszas to local clients
621 7bdd02056e2b mod_mam: Bumb priority up above carbons, so that archive ids are included Kim Alvefur <zash@zash.se> parents: 620 diff changeset	360 module:hook("message/bare", message_handler, 2);
7bdd02056e2b mod_mam: Bumb priority up above carbons, so that archive ids are included Kim Alvefur <zash@zash.se> parents: 620 diff changeset	361 module:hook("message/full", message_handler, 2);
523 eff140d53b83 mod_mam: Add experimental implementation of the Message Archive Management ProtoXEP Kim Alvefur <zash@zash.se> parents: diff changeset	362
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	363 module:add_feature(xmlns_mam0); -- COMPAT with XEP-0313 v 0.1
558 66de25ffc8d9 mod_mam: Implement archiving preferences. Kim Alvefur <zash@zash.se> parents: 523 diff changeset	364
1678 9ee56cc1be2c mod_mam: Advertise feature in disco#info for account as per XEP-0313 >= 0.2 Kim Alvefur <zash@zash.se> parents: 1587 diff changeset	365 module:hook("account-disco-info", function(event)
2506 5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	366 (event.reply or event.stanza):tag("feature", {var=xmlns_mam0}):up();
5941aac79f06 mod_mam: Add support for XEP-0313 v0.5 Kim Alvefur <zash@zash.se> parents: 2505 diff changeset	367 (event.reply or event.stanza):tag("feature", {var=xmlns_mam1}):up();
1678 9ee56cc1be2c mod_mam: Advertise feature in disco#info for account as per XEP-0313 >= 0.2 Kim Alvefur <zash@zash.se> parents: 1587 diff changeset	368 end);
9ee56cc1be2c mod_mam: Advertise feature in disco#info for account as per XEP-0313 >= 0.2 Kim Alvefur <zash@zash.se> parents: 1587 diff changeset	369

Mercurial > prosody-modules

annotate mod_mam/mod_mam.lua @ 2514:d47a7e6e9adc