plugins/mod_mam/mod_mam.lua
author Kim Alvefur <zash@zash.se>
Mon, 12 Dec 2022 07:07:13 +0100
branch0.12
changeset 12803 3784a8ce0596
parent 12311 dcad3a207915
child 12559 519e6403f455
child 12861 cc86d77481fc
permissions -rw-r--r--
Merge 0.11->0.12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7854
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     1
-- Prosody IM
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     2
-- Copyright (C) 2008-2017 Matthew Wild
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     3
-- Copyright (C) 2008-2017 Waqas Hussain
11276
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
     4
-- Copyright (C) 2011-2021 Kim Alvefur
7854
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     5
--
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     6
-- This project is MIT/X11 licensed. Please see the
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     7
-- COPYING file in the source package for more information.
80ee0d9cd56f mod_mam: Normalize copyright headers
Kim Alvefur <zash@zash.se>
parents: 7853
diff changeset
     8
--
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
-- XEP-0313: Message Archive Management for Prosody
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
--
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
7906
036c771b842a mod_mam: Update namespace to XEP-0313 v0.6
Kim Alvefur <zash@zash.se>
parents: 7905
diff changeset
    12
local xmlns_mam     = "urn:xmpp:mam:2";
11272
e3f6f0b39e7b mod_mam: Advertise extended MAM 0.7.x behind a feature flag
Kim Alvefur <zash@zash.se>
parents: 11264
diff changeset
    13
local xmlns_mam_ext = "urn:xmpp:mam:2#extended";
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
local xmlns_delay   = "urn:xmpp:delay";
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
local xmlns_forward = "urn:xmpp:forward:0";
7893
9e4de27e8e08 mod_mam: Move stanza ID namespace to a common variable
Kim Alvefur <zash@zash.se>
parents: 7885
diff changeset
    16
local xmlns_st_id   = "urn:xmpp:sid:0";
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
local um = require "core.usermanager";
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
local st = require "util.stanza";
7885
1017a4f8929d mod_mam: Correct import of util.rsm
Kim Alvefur <zash@zash.se>
parents: 7859
diff changeset
    20
local rsm = require "util.rsm";
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
local get_prefs = module:require"mamprefs".get;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
local set_prefs = module:require"mamprefs".set;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
local prefs_to_stanza = module:require"mamprefsxml".tostanza;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
local prefs_from_stanza = module:require"mamprefsxml".fromstanza;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
local jid_bare = require "util.jid".bare;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
local jid_split = require "util.jid".split;
12034
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
    27
local jid_resource = require "util.jid".resource;
7848
eeb22f912577 mod_mam: Filter out spoofed XEP-0359 tags
Kim Alvefur <zash@zash.se>
parents: 7847
diff changeset
    28
local jid_prepped_split = require "util.jid".prepped_split;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
local dataform = require "util.dataforms".new;
10563
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
    30
local get_form_type = require "util.dataforms".get_type;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    31
local host = module.host;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    33
local rm_load_roster = require "core.rostermanager".load_roster;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    34
7841
e5d5e5946af5 mod_mam: Use is_stanza from util.stanza
Kim Alvefur <zash@zash.se>
parents: 7840
diff changeset
    35
local is_stanza = st.is_stanza;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    36
local tostring = tostring;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    37
local time_now = os.time;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    38
local m_min = math.min;
11879
210a785dfa8a mod_mam: Use util.dataforms timestamp validation
Kim Alvefur <zash@zash.se>
parents: 11823
diff changeset
    39
local timestamp, datestamp = import( "util.datetime", "datetime", "date");
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    40
local default_max_items, max_max_items = 20, module:get_option_number("max_archive_query_results", 50);
7852
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
    41
local strip_tags = module:get_option_set("dont_archive_namespaces", { "http://jabber.org/protocol/chatstates" });
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    42
7853
10d91860172f mod_mam: Change store name to "archive" but make it configurable for people who have data in "archive2"
Kim Alvefur <zash@zash.se>
parents: 7852
diff changeset
    43
local archive_store = module:get_option_string("archive_store", "archive");
8050
eb9784561387 mod_mam: Remove extraneous assert when opening the store
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8003
diff changeset
    44
local archive = module:open_store(archive_store, "archive");
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    45
9890
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
    46
local cleanup_after = module:get_option_string("archive_expires_after", "1w");
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
    47
local archive_item_limit = module:get_option_number("storage_archive_item_limit", archive.caps and archive.caps.quota or 1000);
10804
62794e065e33 MAM: Remove 1% of contents when reaching limits, fix #1545
Kim Alvefur <zash@zash.se>
parents: 10777
diff changeset
    48
local archive_truncate = math.floor(archive_item_limit * 0.99);
62794e065e33 MAM: Remove 1% of contents when reaching limits, fix #1545
Kim Alvefur <zash@zash.se>
parents: 10777
diff changeset
    49
9556
9a5485550bfd mod_mam: Ignore case of null storage driver
Kim Alvefur <zash@zash.se>
parents: 8908
diff changeset
    50
if not archive.find then
9557
cba6e6168d26 mod_mam: Upgrade case of invalid archive store driver to hard error
Kim Alvefur <zash@zash.se>
parents: 9556
diff changeset
    51
	error("mod_"..(archive._provided_by or archive.name and "storage_"..archive.name).." does not support archiving\n"
cba6e6168d26 mod_mam: Upgrade case of invalid archive store driver to hard error
Kim Alvefur <zash@zash.se>
parents: 9556
diff changeset
    52
		.."See https://prosody.im/doc/storage and https://prosody.im/doc/archiving for more information");
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    53
end
8580
75d5eee6fcdf mod_mam: Add an option for whether to include 'total' counts by default in queries
Kim Alvefur <zash@zash.se>
parents: 8579
diff changeset
    54
local use_total = module:get_option_boolean("mam_include_total", true);
8135
6ddddfe05a74 mod_mam: Don't ask the storage backend to count all items when expiry is disabled
Kim Alvefur <zash@zash.se>
parents: 8050
diff changeset
    55
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
    56
function schedule_cleanup()
12311
dcad3a207915 mod_mam: Fix a comment
Kim Alvefur <zash@zash.se>
parents: 12310
diff changeset
    57
	-- replaced later if cleanup is enabled
8233
154852646095 mod_mam: Use a FIFO queue for scheduling archive expiry
Kim Alvefur <zash@zash.se>
parents: 8210
diff changeset
    58
end
154852646095 mod_mam: Use a FIFO queue for scheduling archive expiry
Kim Alvefur <zash@zash.se>
parents: 8210
diff changeset
    59
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    60
-- Handle prefs.
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    61
module:hook("iq/self/"..xmlns_mam..":prefs", function(event)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    62
	local origin, stanza = event.origin, event.stanza;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    63
	local user = origin.username;
8255
63e505578d4f mod_mam: Also return the preferences on set
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8253
diff changeset
    64
	if stanza.attr.type == "set" then
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    65
		local new_prefs = stanza:get_child("prefs", xmlns_mam);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    66
		local prefs = prefs_from_stanza(new_prefs);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    67
		local ok, err = set_prefs(user, prefs);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    68
		if not ok then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    69
			origin.send(st.error_reply(stanza, "cancel", "internal-server-error", "Error storing preferences: "..tostring(err)));
8255
63e505578d4f mod_mam: Also return the preferences on set
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8253
diff changeset
    70
			return true;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    71
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    72
	end
8541
3eb4cafb3b64 mod_mam: Implement option to enable MAM implicitly when client support is detected (#867)
Kim Alvefur <zash@zash.se>
parents: 8255
diff changeset
    73
	local prefs = prefs_to_stanza(get_prefs(user, true));
8255
63e505578d4f mod_mam: Also return the preferences on set
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8253
diff changeset
    74
	local reply = st.reply(stanza):add_child(prefs);
63e505578d4f mod_mam: Also return the preferences on set
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8253
diff changeset
    75
	origin.send(reply);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    76
	return true;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    77
end);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    78
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    79
local query_form = dataform {
11879
210a785dfa8a mod_mam: Use util.dataforms timestamp validation
Kim Alvefur <zash@zash.se>
parents: 11823
diff changeset
    80
	{ name = "FORM_TYPE"; type = "hidden"; value = xmlns_mam };
210a785dfa8a mod_mam: Use util.dataforms timestamp validation
Kim Alvefur <zash@zash.se>
parents: 11823
diff changeset
    81
	{ name = "with"; type = "jid-single" };
210a785dfa8a mod_mam: Use util.dataforms timestamp validation
Kim Alvefur <zash@zash.se>
parents: 11823
diff changeset
    82
	{ name = "start"; type = "text-single"; datatype = "xs:dateTime" };
210a785dfa8a mod_mam: Use util.dataforms timestamp validation
Kim Alvefur <zash@zash.se>
parents: 11823
diff changeset
    83
	{ name = "end"; type = "text-single"; datatype = "xs:dateTime" };
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    84
};
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    85
11276
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
    86
if archive.caps and archive.caps.full_id_range then
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
    87
	table.insert(query_form, { name = "before-id"; type = "text-single"; });
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
    88
	table.insert(query_form, { name = "after-id"; type = "text-single"; });
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
    89
end
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
    90
11284
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
    91
if archive.caps and archive.caps.ids then
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
    92
	table.insert(query_form, { name = "ids"; type = "list-multi"; });
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
    93
end
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
    94
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
    95
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    96
-- Serve form
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    97
module:hook("iq-get/self/"..xmlns_mam..":query", function(event)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    98
	local origin, stanza = event.origin, event.stanza;
8541
3eb4cafb3b64 mod_mam: Implement option to enable MAM implicitly when client support is detected (#867)
Kim Alvefur <zash@zash.se>
parents: 8255
diff changeset
    99
	get_prefs(origin.username, true);
7907
c011cecad576 mod_mam: Add missing wrapping <query> element when returning the query form
Kim Alvefur <zash@zash.se>
parents: 7906
diff changeset
   100
	origin.send(st.reply(stanza):query(xmlns_mam):add_child(query_form:form()));
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   101
	return true;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   102
end);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   103
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   104
-- Handle archive queries
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   105
module:hook("iq-set/self/"..xmlns_mam..":query", function(event)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   106
	local origin, stanza = event.origin, event.stanza;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   107
	local query = stanza.tags[1];
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   108
	local qid = query.attr.queryid;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   109
10302
906ea5e1ec75 mod_mam: Add flag to session when it performs a MAM query
Matthew Wild <mwild1@gmail.com>
parents: 10032
diff changeset
   110
	origin.mam_requested = true;
906ea5e1ec75 mod_mam: Add flag to session when it performs a MAM query
Matthew Wild <mwild1@gmail.com>
parents: 10032
diff changeset
   111
8541
3eb4cafb3b64 mod_mam: Implement option to enable MAM implicitly when client support is detected (#867)
Kim Alvefur <zash@zash.se>
parents: 8255
diff changeset
   112
	get_prefs(origin.username, true);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   113
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   114
	-- Search query parameters
11284
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
   115
	local qwith, qstart, qend, qbefore, qafter, qids;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   116
	local form = query:get_child("x", "jabber:x:data");
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   117
	if form then
10563
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   118
		local form_type, err = get_form_type(form);
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   119
		if not form_type then
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   120
			origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid dataform: "..err));
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   121
			return true;
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   122
		elseif form_type ~= xmlns_mam then
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   123
			origin.send(st.error_reply(stanza, "modify", "bad-request", "Unexpected FORM_TYPE, expected '"..xmlns_mam.."'"));
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   124
			return true;
cfc05e46b979 mod_mam: More careful validation of MAM query form
Kim Alvefur <zash@zash.se>
parents: 10303
diff changeset
   125
		end
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   126
		form, err = query_form:data(form);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   127
		if err then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   128
			origin.send(st.error_reply(stanza, "modify", "bad-request", select(2, next(err))));
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   129
			return true;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   130
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   131
		qwith, qstart, qend = form["with"], form["start"], form["end"];
11276
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
   132
		qbefore, qafter = form["before-id"], form["after-id"];
11284
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
   133
		qids = form["ids"];
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   134
		qwith = qwith and jid_bare(qwith); -- dataforms does jidprep
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   135
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   136
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   137
	-- RSM stuff
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   138
	local qset = rsm.get(query);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   139
	local qmax = m_min(qset and qset.max or default_max_items, max_max_items);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   140
	local reverse = qset and qset.before or false;
11276
44c9cb4094bb mod_mam: Add support for before-id and after-id fields
Kim Alvefur <zash@zash.se>
parents: 11274
diff changeset
   141
	local before, after = qset and qset.before or qbefore, qset and qset.after or qafter;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   142
	if type(before) ~= "string" then before = nil; end
11823
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   143
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   144
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   145
	module:log("debug", "Archive query by %s id=%s with=%s when=%s...%s rsm=%q",
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   146
		origin.username,
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   147
		qid or stanza.attr.id,
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   148
		qwith or "*",
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   149
		qstart and timestamp(qstart) or "",
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   150
		qend and timestamp(qend) or "",
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   151
		qset);
f590e3c51eff mod_mam: Merge main and RSM-specific log message here too
Kim Alvefur <zash@zash.se>
parents: 11799
diff changeset
   152
11273
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   153
	-- A reverse query needs to be flipped
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   154
	local flip = reverse;
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   155
	-- A flip-page query needs to be the opposite of that.
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   156
	if query:get_child("flip-page") then flip = not flip end
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   157
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   158
	-- Load all the data!
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   159
	local data, err = archive:find(origin.username, {
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   160
		start = qstart; ["end"] = qend; -- Time range
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   161
		with = qwith;
8907
faca839ddbbb mod_mam: Handle edge-case of max=0 so that complete attr is set (fixes #1128)
Kim Alvefur <zash@zash.se>
parents: 8583
diff changeset
   162
		limit = qmax == 0 and 0 or qmax + 1;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   163
		before = before; after = after;
11284
e35e98541ca0 mod_mam: Allow querying by set of IDs
Kim Alvefur <zash@zash.se>
parents: 11276
diff changeset
   164
		ids = qids;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   165
		reverse = reverse;
8175
66e32c34250b mod_mam: Request a total count if no items are requested
Kim Alvefur <zash@zash.se>
parents: 8152
diff changeset
   166
		total = use_total or qmax == 0;
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   167
	});
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   168
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   169
	if not data then
10080
ee85cea08127 mod_mam: Log query failure reason
Kim Alvefur <zash@zash.se>
parents: 10079
diff changeset
   170
		module:log("debug", "Archive query id=%s failed: %s", qid or stanza.attr.id, err);
10025
4715c5d1eb69 mod_mam: Propagate item-not-found to client (fixes #1325)
Kim Alvefur <zash@zash.se>
parents: 9898
diff changeset
   171
		if err == "item-not-found" then
4715c5d1eb69 mod_mam: Propagate item-not-found to client (fixes #1325)
Kim Alvefur <zash@zash.se>
parents: 9898
diff changeset
   172
			origin.send(st.error_reply(stanza, "modify", "item-not-found"));
4715c5d1eb69 mod_mam: Propagate item-not-found to client (fixes #1325)
Kim Alvefur <zash@zash.se>
parents: 9898
diff changeset
   173
		else
4715c5d1eb69 mod_mam: Propagate item-not-found to client (fixes #1325)
Kim Alvefur <zash@zash.se>
parents: 9898
diff changeset
   174
			origin.send(st.error_reply(stanza, "cancel", "internal-server-error"));
4715c5d1eb69 mod_mam: Propagate item-not-found to client (fixes #1325)
Kim Alvefur <zash@zash.se>
parents: 9898
diff changeset
   175
		end
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   176
		return true;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   177
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   178
	local total = tonumber(err);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   179
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   180
	local msg_reply_attr = { to = stanza.attr.from, from = stanza.attr.to };
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   181
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   182
	local results = {};
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   183
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   184
	-- Wrap it in stuff and deliver
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   185
	local first, last;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   186
	local count = 0;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   187
	local complete = "true";
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   188
	for id, item, when in data do
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   189
		count = count + 1;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   190
		if count > qmax then
8908
65d1a80d3565 mod_mam: Add coment on how 'complete' works
Kim Alvefur <zash@zash.se>
parents: 8907
diff changeset
   191
			-- We requested qmax+1 items. If that many items are retrieved then
65d1a80d3565 mod_mam: Add coment on how 'complete' works
Kim Alvefur <zash@zash.se>
parents: 8907
diff changeset
   192
			-- there are more results to page through, so:
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   193
			complete = nil;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   194
			break;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   195
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   196
		local fwd_st = st.message(msg_reply_attr)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   197
			:tag("result", { xmlns = xmlns_mam, queryid = qid, id = id })
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   198
				:tag("forwarded", { xmlns = xmlns_forward })
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   199
					:tag("delay", { xmlns = xmlns_delay, stamp = timestamp(when) }):up();
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   200
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   201
		if not is_stanza(item) then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   202
			item = st.deserialize(item);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   203
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   204
		item.attr.xmlns = "jabber:client";
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   205
		fwd_st:add_child(item);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   206
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   207
		if not first then first = id; end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   208
		last = id;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   209
11273
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   210
		if flip then
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   211
			results[count] = fwd_st;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   212
		else
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   213
			origin.send(fwd_st);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   214
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   215
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   216
11273
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   217
	if flip then
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   218
		for i = #results, 1, -1 do
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   219
			origin.send(results[i]);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   220
		end
11273
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   221
	end
342ac5d806fb mod_mam: Add support for page flipping
Kim Alvefur <zash@zash.se>
parents: 11272
diff changeset
   222
	if reverse then
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   223
		first, last = last, first;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   224
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   225
7842
f3e1925f29c2 mod_mam: Update to XEP-0313 v0.5.1
Kim Alvefur <zash@zash.se>
parents: 7841
diff changeset
   226
	origin.send(st.reply(stanza)
11341
f89c8e6beaa6 mod_mam: Remove obsolete 'queryid' attribute from iq-result (thanks paul)
Kim Alvefur <zash@zash.se>
parents: 11285
diff changeset
   227
		:tag("fin", { xmlns = xmlns_mam, complete = complete })
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   228
			:add_child(rsm.generate {
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   229
				first = first, last = last, count = total }));
10082
44371850c6b0 mod_mam: Move final log message to end of query procedure
Kim Alvefur <zash@zash.se>
parents: 10081
diff changeset
   230
44371850c6b0 mod_mam: Move final log message to end of query procedure
Kim Alvefur <zash@zash.se>
parents: 10081
diff changeset
   231
	-- That's all folks!
10083
a36c731ed540 mod_mam: Report correct count of results for forward queries
Kim Alvefur <zash@zash.se>
parents: 10082
diff changeset
   232
	module:log("debug", "Archive query id=%s completed, %d items returned", qid or stanza.attr.id, complete and count or count - 1);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   233
	return true;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   234
end);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   235
11274
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   236
module:hook("iq-get/self/"..xmlns_mam..":metadata", function (event)
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   237
	local origin, stanza = event.origin, event.stanza;
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   238
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   239
	local reply = st.reply(stanza):tag("metadata", { xmlns = xmlns_mam });
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   240
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   241
	do
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   242
		local first = archive:find(origin.username, { limit = 1 });
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   243
		if not first then
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   244
			origin.send(st.error_reply(stanza, "cancel", "internal-server-error"));
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   245
			return true;
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   246
		end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   247
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   248
		local id, _, when = first();
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   249
		if id then
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   250
			reply:tag("start", { id = id, timestamp = timestamp(when) }):up();
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   251
		end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   252
	end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   253
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   254
	do
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   255
		local last = archive:find(origin.username, { limit = 1, reverse = true });
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   256
		if not last then
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   257
			origin.send(st.error_reply(stanza, "cancel", "internal-server-error"));
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   258
			return true;
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   259
		end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   260
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   261
		local id, _, when = last();
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   262
		if id then
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   263
			reply:tag("end", { id = id, timestamp = timestamp(when) }):up();
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   264
		end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   265
	end
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   266
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   267
	origin.send(reply);
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   268
	return true;
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   269
end);
eaaa8ca742a7 mod_mam: Implement extended MAM metadata query
Kim Alvefur <zash@zash.se>
parents: 11273
diff changeset
   270
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   271
local function has_in_roster(user, who)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   272
	local roster = rm_load_roster(user, host);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   273
	module:log("debug", "%s has %s in roster? %s", user, who, roster[who] and "yes" or "no");
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   274
	return roster[who];
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   275
end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   276
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   277
local function shall_store(user, who)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   278
	-- TODO Cache this?
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   279
	if not um.user_exists(user, host) then
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   280
		module:log("debug", "%s@%s does not exist", user, host)
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   281
		return false;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   282
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   283
	local prefs = get_prefs(user);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   284
	local rule = prefs[who];
10115
0f335815244f plugins: Remove tostring call from logging
Kim Alvefur <zash@zash.se>
parents: 10083
diff changeset
   285
	module:log("debug", "%s's rule for %s is %s", user, who, rule);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   286
	if rule ~= nil then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   287
		return rule;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   288
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   289
	-- Below could be done by a metatable
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   290
	local default = prefs[false];
10115
0f335815244f plugins: Remove tostring call from logging
Kim Alvefur <zash@zash.se>
parents: 10083
diff changeset
   291
	module:log("debug", "%s's default rule is %s", user, default);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   292
	if default == "roster" then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   293
		return has_in_roster(user, who);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   294
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   295
	return default;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   296
end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   297
8210
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   298
local function strip_stanza_id(stanza, user)
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   299
	if stanza:get_child("stanza-id", xmlns_st_id) then
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   300
		stanza = st.clone(stanza);
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   301
		stanza:maptags(function (tag)
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   302
			if tag.name == "stanza-id" and tag.attr.xmlns == xmlns_st_id then
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   303
				local by_user, by_host, res = jid_prepped_split(tag.attr.by);
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   304
				if not res and by_host == host and by_user == user then
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   305
					return nil;
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   306
				end
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   307
			end
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   308
			return tag;
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   309
		end);
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   310
	end
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   311
	return stanza;
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   312
end
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   313
12310
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   314
local function should_store(stanza) --> boolean, reason: string
10740
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   315
	local st_type = stanza.attr.type or "normal";
10755
4db4bd8a7822 mod_mam: Don't store any groupchat messages
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
   316
	-- FIXME pass direction of stanza and use that along with bare/full JID addressing
4db4bd8a7822 mod_mam: Don't store any groupchat messages
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
   317
	-- for more accurate MUC / type=groupchat check
10738
136c41a3d03c mod_mam: Factor out "should we store this" into a function
Kim Alvefur <zash@zash.se>
parents: 10687
diff changeset
   318
10740
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   319
	if st_type == "headline" then
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   320
		-- Headline messages are ephemeral by definition
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   321
		return false, "headline";
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   322
	end
12310
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   323
	if st_type == "error" then
12034
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   324
		-- Errors not sent sent from a local client
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   325
		-- Why would a client send an error anyway?
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   326
		if jid_resource(stanza.attr.to) then
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   327
			-- Store delivery failure notifications so you know if your own messages
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   328
			-- were not delivered.
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   329
			return true, "bounce";
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   330
		else
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   331
			-- Skip errors for messages that come from your account, such as PEP
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   332
			-- notifications.
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   333
			return false, "bounce";
9f8206e99b89 mod_mam: Avoid storing bounces for messages from the bare account (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 11992
diff changeset
   334
		end
10749
79b29f35fac1 mod_mam: Save delivery failures (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10748
diff changeset
   335
	end
10755
4db4bd8a7822 mod_mam: Don't store any groupchat messages
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
   336
	if st_type == "groupchat" then
10740
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   337
		-- MUC messages always go to the full JID, usually archived by the MUC
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   338
		return false, "groupchat";
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   339
	end
10747
3967cf10de1b mod_mam: Respect no-store hint (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10746
diff changeset
   340
	if stanza:get_child("no-store", "urn:xmpp:hints")
3967cf10de1b mod_mam: Respect no-store hint (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10746
diff changeset
   341
	or stanza:get_child("no-permanent-store", "urn:xmpp:hints") then
10750
2e31d67b9a29 mod_mam: Make note of Experimental (or Deferred) XEPs
Kim Alvefur <zash@zash.se>
parents: 10749
diff changeset
   342
		-- XXX Experimental XEP
10741
b2ede421adeb mod_mam: Rework hints handling
Kim Alvefur <zash@zash.se>
parents: 10740
diff changeset
   343
		return false, "hint";
b2ede421adeb mod_mam: Rework hints handling
Kim Alvefur <zash@zash.se>
parents: 10740
diff changeset
   344
	end
b2ede421adeb mod_mam: Rework hints handling
Kim Alvefur <zash@zash.se>
parents: 10740
diff changeset
   345
	if stanza:get_child("store", "urn:xmpp:hints") then
b2ede421adeb mod_mam: Rework hints handling
Kim Alvefur <zash@zash.se>
parents: 10740
diff changeset
   346
		return true, "hint";
b2ede421adeb mod_mam: Rework hints handling
Kim Alvefur <zash@zash.se>
parents: 10740
diff changeset
   347
	end
10740
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   348
	if stanza:get_child("body") then
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   349
		return true, "body";
c5a3576a5335 mod_mam: Invert check for type
Kim Alvefur <zash@zash.se>
parents: 10739
diff changeset
   350
	end
10742
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   351
	if stanza:get_child("subject") then
10746
70b7c8f3d32d mod_mam: Fix typo in comment
Kim Alvefur <zash@zash.se>
parents: 10745
diff changeset
   352
		-- XXX Who would send a message with a subject but without a body?
10742
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   353
		return true, "subject";
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   354
	end
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   355
	if stanza:get_child("encryption", "urn:xmpp:eme:0") then
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   356
		-- Since we can't know what an encrypted message contains, we assume it's important
10750
2e31d67b9a29 mod_mam: Make note of Experimental (or Deferred) XEPs
Kim Alvefur <zash@zash.se>
parents: 10749
diff changeset
   357
		-- XXX Experimental XEP
10742
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   358
		return true, "encrypted";
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   359
	end
10743
50f0a4d83731 mod_mam: Store XEP-0184 receipts and requests
Kim Alvefur <zash@zash.se>
parents: 10742
diff changeset
   360
	if stanza:get_child(nil, "urn:xmpp:receipts") then
50f0a4d83731 mod_mam: Store XEP-0184 receipts and requests
Kim Alvefur <zash@zash.se>
parents: 10742
diff changeset
   361
		-- If it's important enough to ask for a receipt then it's important enough to archive
50f0a4d83731 mod_mam: Store XEP-0184 receipts and requests
Kim Alvefur <zash@zash.se>
parents: 10742
diff changeset
   362
		-- and the same applies to the receipt
50f0a4d83731 mod_mam: Store XEP-0184 receipts and requests
Kim Alvefur <zash@zash.se>
parents: 10742
diff changeset
   363
		return true, "receipt";
50f0a4d83731 mod_mam: Store XEP-0184 receipts and requests
Kim Alvefur <zash@zash.se>
parents: 10742
diff changeset
   364
	end
10748
16002abe61b1 mod_mam: Keep chat markers (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10747
diff changeset
   365
	if stanza:get_child(nil, "urn:xmpp:chat-markers:0") then
10750
2e31d67b9a29 mod_mam: Make note of Experimental (or Deferred) XEPs
Kim Alvefur <zash@zash.se>
parents: 10749
diff changeset
   366
		-- XXX Experimental XEP
10748
16002abe61b1 mod_mam: Keep chat markers (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10747
diff changeset
   367
		return true, "marker";
16002abe61b1 mod_mam: Keep chat markers (thanks Ge0rG)
Kim Alvefur <zash@zash.se>
parents: 10747
diff changeset
   368
	end
10742
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   369
	if stanza:get_child("x", "jabber:x:conference")
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   370
	or stanza:find("{http://jabber.org/protocol/muc#user}x/invite") then
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   371
		return true, "invite";
19ffb2ebf114 mod_mam: Add more positive hints for storage
Kim Alvefur <zash@zash.se>
parents: 10741
diff changeset
   372
	end
12238
1c47162dd965 plugins: Update for namespace bump in XEP-0353 v0.4.0
Kim Alvefur <zash@zash.se>
parents: 12034
diff changeset
   373
	if stanza:get_child(nil, "urn:xmpp:jingle-message:0") or stanza:get_child(nil, "urn:xmpp:jingle-message:1") then
11264
08b397c21805 mod_csi_simple,mod_carbons,mod_mam: Update comment about XEP-0353
Kim Alvefur <zash@zash.se>
parents: 10825
diff changeset
   374
		-- XXX Experimental XEP
10825
30fc1ed5647a mod_mam: Archive XEP-0353: Jingle Message Initiation
Kim Alvefur <zash@zash.se>
parents: 10804
diff changeset
   375
		return true, "jingle call";
30fc1ed5647a mod_mam: Archive XEP-0353: Jingle Message Initiation
Kim Alvefur <zash@zash.se>
parents: 10804
diff changeset
   376
	end
10738
136c41a3d03c mod_mam: Factor out "should we store this" into a function
Kim Alvefur <zash@zash.se>
parents: 10687
diff changeset
   377
10745
27f1fcd85ccd mod_mam: Prefer not archiving if no interesting payloads are found
Kim Alvefur <zash@zash.se>
parents: 10744
diff changeset
   378
	 -- The IM-NG thing to do here would be to return `not st_to_full`
27f1fcd85ccd mod_mam: Prefer not archiving if no interesting payloads are found
Kim Alvefur <zash@zash.se>
parents: 10744
diff changeset
   379
	 -- One day ...
27f1fcd85ccd mod_mam: Prefer not archiving if no interesting payloads are found
Kim Alvefur <zash@zash.se>
parents: 10744
diff changeset
   380
	return false, "default";
10738
136c41a3d03c mod_mam: Factor out "should we store this" into a function
Kim Alvefur <zash@zash.se>
parents: 10687
diff changeset
   381
end
136c41a3d03c mod_mam: Factor out "should we store this" into a function
Kim Alvefur <zash@zash.se>
parents: 10687
diff changeset
   382
12310
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   383
module:hook("archive-should-store", function (event)
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   384
	local should, why = should_store(event.stanza);
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   385
	event.reason = why;
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   386
	return should;
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   387
end, -1)
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   388
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   389
-- Handle messages
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   390
local function message_handler(event, c2s)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   391
	local origin, stanza = event.origin, event.stanza;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   392
	local log = c2s and origin.log or module._log;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   393
	local orig_from = stanza.attr.from;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   394
	local orig_to = stanza.attr.to or orig_from;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   395
	-- Stanza without 'to' are treated as if it was to their own bare jid
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   396
11731
f3aee8a825cc Fix various spelling errors (thanks codespell)
Kim Alvefur <zash@zash.se>
parents: 11341
diff changeset
   397
	-- Whose storage do we put it in?
7847
316f5166eedb mod_mam: Find out which party is the user and which is the 'with' earlier
Kim Alvefur <zash@zash.se>
parents: 7846
diff changeset
   398
	local store_user = c2s and origin.username or jid_split(orig_to);
316f5166eedb mod_mam: Find out which party is the user and which is the 'with' earlier
Kim Alvefur <zash@zash.se>
parents: 7846
diff changeset
   399
	-- And who are they chatting with?
316f5166eedb mod_mam: Find out which party is the user and which is the 'with' earlier
Kim Alvefur <zash@zash.se>
parents: 7846
diff changeset
   400
	local with = jid_bare(c2s and orig_to or orig_from);
316f5166eedb mod_mam: Find out which party is the user and which is the 'with' earlier
Kim Alvefur <zash@zash.se>
parents: 7846
diff changeset
   401
7848
eeb22f912577 mod_mam: Filter out spoofed XEP-0359 tags
Kim Alvefur <zash@zash.se>
parents: 7847
diff changeset
   402
	-- Filter out <stanza-id> that claim to be from us
8210
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   403
	event.stanza = strip_stanza_id(stanza, store_user);
7848
eeb22f912577 mod_mam: Filter out spoofed XEP-0359 tags
Kim Alvefur <zash@zash.se>
parents: 7847
diff changeset
   404
12310
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   405
	local event_payload = { stanza = stanza; session = origin };
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   406
	local should = module:fire_event("archive-should-store", event_payload);
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   407
	local why = event_payload.reason;
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   408
10738
136c41a3d03c mod_mam: Factor out "should we store this" into a function
Kim Alvefur <zash@zash.se>
parents: 10687
diff changeset
   409
	if not should then
12310
81fc7fc77e68 mod_mam: Allow plugging into archive decision
Kim Alvefur <zash@zash.se>
parents: 12238
diff changeset
   410
		log("debug", "Not archiving stanza: %s (%s)", stanza:top_tag(), event_payload.reason);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   411
		return;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   412
	end
7845
9332b43931f5 mod_mam: Add some comments explaining archive expiry
Kim Alvefur <zash@zash.se>
parents: 7844
diff changeset
   413
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   414
	local clone_for_storage;
7852
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   415
	if not strip_tags:empty() then
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   416
		clone_for_storage = st.clone(stanza);
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   417
		clone_for_storage:maptags(function (tag)
7852
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   418
			if strip_tags:contains(tag.attr.xmlns) then
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   419
				return nil;
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   420
			else
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   421
				return tag;
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   422
			end
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   423
		end);
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   424
		if #clone_for_storage.tags == 0 then
8253
9ea5ea53744b mod_mam: Log a message when not archiving because it only had ignored tags
Kim Alvefur <zash@zash.se>
parents: 8234
diff changeset
   425
			log("debug", "Not archiving stanza: %s (empty when stripped)", stanza:top_tag());
7852
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   426
			return;
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   427
		end
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   428
	else
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   429
		clone_for_storage = stanza;
7852
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   430
	end
93a068ef4b2c mod_mam: Allow a set of namespaces to be stripped from stored stanzas, default to chat states (fixes #763)
Kim Alvefur <zash@zash.se>
parents: 7851
diff changeset
   431
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   432
	-- Check with the users preferences
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   433
	if shall_store(store_user, with) then
10739
f2838ffcc499 mod_mam: Log 'why' a stanza is archived
Kim Alvefur <zash@zash.se>
parents: 10738
diff changeset
   434
		log("debug", "Archiving stanza: %s (%s)", stanza:top_tag(), why);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   435
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   436
		-- And stash it
9890
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   437
		local time = time_now();
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   438
		local ok, err = archive:append(store_user, nil, clone_for_storage, time, with);
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   439
		if not ok and err == "quota-limit" then
9898
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   440
			if type(cleanup_after) == "number" then
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   441
				module:log("debug", "User '%s' over quota, cleaning archive", store_user);
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   442
				local cleaned = archive:delete(store_user, {
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   443
					["end"] = (os.time() - cleanup_after);
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   444
				});
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   445
				if cleaned then
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   446
					ok, err = archive:append(store_user, nil, clone_for_storage, time, with);
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   447
				end
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   448
			end
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   449
			if not ok and (archive.caps and archive.caps.truncate) then
8747ccf0008c mod_mam: On quota hit, separately delete by time and by item count
Kim Alvefur <zash@zash.se>
parents: 9890
diff changeset
   450
				module:log("debug", "User '%s' over quota, truncating archive", store_user);
9890
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   451
				local truncated = archive:delete(store_user, {
10804
62794e065e33 MAM: Remove 1% of contents when reaching limits, fix #1545
Kim Alvefur <zash@zash.se>
parents: 10777
diff changeset
   452
					truncate = archive_truncate;
9890
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   453
				});
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   454
				if truncated then
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   455
					ok, err = archive:append(store_user, nil, clone_for_storage, time, with);
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   456
				end
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   457
			end
710a116341cd mod_mam: Trim archive when quota has been exceeded
Kim Alvefur <zash@zash.se>
parents: 9886
diff changeset
   458
		end
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   459
		if ok then
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   460
			local clone_for_other_handlers = st.clone(stanza);
7911
dbdaa8487ecd mod_mam: Fix to treat first return value from archive:append as assigned ID
Kim Alvefur <zash@zash.se>
parents: 7909
diff changeset
   461
			local id = ok;
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   462
			clone_for_other_handlers:tag("stanza-id", { xmlns = xmlns_st_id, by = store_user.."@"..host, id = id }):up();
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   463
			event.stanza = clone_for_other_handlers;
8233
154852646095 mod_mam: Use a FIFO queue for scheduling archive expiry
Kim Alvefur <zash@zash.se>
parents: 8210
diff changeset
   464
			schedule_cleanup(store_user);
8196
bb0118e46c45 mod_mam: Clone stanzas before mutating (thanks waqas) (fixes #961)
Kim Alvefur <zash@zash.se>
parents: 8175
diff changeset
   465
			module:fire_event("archive-message-added", { origin = origin, stanza = clone_for_storage, for_user = store_user, id = id });
10527
86422db90e02 mod_mam: Log error when unable to store stanza (fix #1478)
Kim Alvefur <zash@zash.se>
parents: 10302
diff changeset
   466
		else
86422db90e02 mod_mam: Log error when unable to store stanza (fix #1478)
Kim Alvefur <zash@zash.se>
parents: 10302
diff changeset
   467
			log("error", "Could not archive stanza: %s", err);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   468
		end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   469
	else
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   470
		log("debug", "Not archiving stanza: %s (prefs)", stanza:top_tag());
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   471
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   472
end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   473
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   474
local function c2s_message_handler(event)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   475
	return message_handler(event, true);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   476
end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   477
8210
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   478
-- Filter out <stanza-id> before the message leaves the server to prevent privacy leak.
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   479
local function strip_stanza_id_after_other_events(event)
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   480
	event.stanza = strip_stanza_id(event.stanza, event.origin.username);
7905
92b70a921acb mod_mam: Strip stanza-id tags after carbons
Kim Alvefur <zash@zash.se>
parents: 7904
diff changeset
   481
end
92b70a921acb mod_mam: Strip stanza-id tags after carbons
Kim Alvefur <zash@zash.se>
parents: 7904
diff changeset
   482
8210
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   483
module:hook("pre-message/bare", strip_stanza_id_after_other_events, -1);
8ea0484871e8 mod_mam: Factor out <stanza-id> stripping so it can be reused in two places
Kim Alvefur <zash@zash.se>
parents: 8209
diff changeset
   484
module:hook("pre-message/full", strip_stanza_id_after_other_events, -1);
7905
92b70a921acb mod_mam: Strip stanza-id tags after carbons
Kim Alvefur <zash@zash.se>
parents: 7904
diff changeset
   485
11762
c35b81575d5d mod_mam: Explain behavior with absent mod_offline in a comment
Kim Alvefur <zash@zash.se>
parents: 11761
diff changeset
   486
-- Catch messages not stored by mod_offline and mark them as stored if they
c35b81575d5d mod_mam: Explain behavior with absent mod_offline in a comment
Kim Alvefur <zash@zash.se>
parents: 11761
diff changeset
   487
-- have been archived. This would generally only happen if mod_offline is
c35b81575d5d mod_mam: Explain behavior with absent mod_offline in a comment
Kim Alvefur <zash@zash.se>
parents: 11761
diff changeset
   488
-- disabled.  Otherwise the message would generate a delivery failure report,
c35b81575d5d mod_mam: Explain behavior with absent mod_offline in a comment
Kim Alvefur <zash@zash.se>
parents: 11761
diff changeset
   489
-- which would not be accurate because it has been archived.
11761
8141645e3865 mod_mam: "Handle" messages that have been archived in the absense of mod_offline
Kim Alvefur <zash@zash.se>
parents: 11731
diff changeset
   490
module:hook("message/offline/handle", function(event)
8141645e3865 mod_mam: "Handle" messages that have been archived in the absense of mod_offline
Kim Alvefur <zash@zash.se>
parents: 11731
diff changeset
   491
	local stanza = event.stanza;
11763
9925be5d3b8b mod_mam: Only check for locally generated stanza-ids
Kim Alvefur <zash@zash.se>
parents: 11762
diff changeset
   492
	local user = event.username .. "@" .. host;
11799
41af102c7190 mod_mam: Reduce line count using new util.stanza attr method
Kim Alvefur <zash@zash.se>
parents: 11764
diff changeset
   493
	if stanza:get_child_with_attr("stanza-id", xmlns_st_id, "by", user) then
41af102c7190 mod_mam: Reduce line count using new util.stanza attr method
Kim Alvefur <zash@zash.se>
parents: 11764
diff changeset
   494
		return true;
11761
8141645e3865 mod_mam: "Handle" messages that have been archived in the absense of mod_offline
Kim Alvefur <zash@zash.se>
parents: 11731
diff changeset
   495
	end
8141645e3865 mod_mam: "Handle" messages that have been archived in the absense of mod_offline
Kim Alvefur <zash@zash.se>
parents: 11731
diff changeset
   496
end, -2);
8141645e3865 mod_mam: "Handle" messages that have been archived in the absense of mod_offline
Kim Alvefur <zash@zash.se>
parents: 11731
diff changeset
   497
11764
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   498
-- Don't broadcast offline messages to clients that have queried the archive.
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   499
module:hook("message/offline/broadcast", function (event)
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   500
	if event.origin.mam_requested then
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   501
		return true;
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   502
	end
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   503
end);
d66738eeb875 mod_mam: Suppress offline message broadcast for MAM clients
Kim Alvefur <zash@zash.se>
parents: 11763
diff changeset
   504
8578
5040c8ce32dd Backed out changeset 97a094fdf101, interferes with 6ddddfe05a74
Kim Alvefur <zash@zash.se>
parents: 8541
diff changeset
   505
if cleanup_after ~= "never" then
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   506
	local cleanup_storage = module:open_store("archive_cleanup");
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   507
	local cleanup_map = module:open_store("archive_cleanup", "map");
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   508
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   509
	local day = 86400;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   510
	local multipliers = { d = day, w = day * 7, m = 31 * day, y = 365.2425 * day };
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   511
	local n, m = cleanup_after:lower():match("(%d+)%s*([dwmy]?)");
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   512
	if not n then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   513
		module:log("error", "Could not parse archive_expires_after string %q", cleanup_after);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   514
		return false;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   515
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   516
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   517
	cleanup_after = tonumber(n) * ( multipliers[m] or 1 );
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   518
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   519
	module:log("debug", "archive_expires_after = %d -- in seconds", cleanup_after);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   520
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   521
	if not archive.delete then
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   522
		module:log("error", "archive_expires_after set but mod_%s does not support deleting", archive._provided_by);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   523
		return false;
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   524
	end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   525
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   526
	-- For each day, store a set of users that have new messages. To expire
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   527
	-- messages, we collect the union of sets of users from dates that fall
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   528
	-- outside the cleanup range.
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   529
11972
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   530
	if not (archive.caps and archive.caps.wildcard_delete) then
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   531
		local last_date = require "util.cache".new(module:get_option_number("archive_cleanup_date_cache_size", 1000));
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   532
		function schedule_cleanup(username, date)
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   533
			date = date or datestamp();
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   534
			if last_date:get(username) == date then return end
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   535
			local ok = cleanup_map:set(date, username, true);
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   536
			if ok then
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   537
				last_date:set(username, date);
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   538
			end
10032
79ba2d709e72 mod_mam: Cache last date that archive owner has messages to reduce writes (fixes #1368)
Kim Alvefur <zash@zash.se>
parents: 9883
diff changeset
   539
		end
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   540
	end
11972
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   541
9761
03ed7f10d8da mod_mam: Measure how long it takes to run the message expiry job job
Kim Alvefur <zash@zash.se>
parents: 9756
diff changeset
   542
	local cleanup_time = module:measure("cleanup", "times");
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   543
10686
62ef68f95b6f mod_mam,mod_muc_mam: Allow other work to be performed during archive cleanup (fixes #1504)
Kim Alvefur <zash@zash.se>
parents: 10571
diff changeset
   544
	local async = require "util.async";
11992
18c0ca5fcbb8 mod_mam: Switch to new cron API
Kim Alvefur <zash@zash.se>
parents: 11972
diff changeset
   545
	module:daily("Remove expired messages", function ()
9761
03ed7f10d8da mod_mam: Measure how long it takes to run the message expiry job job
Kim Alvefur <zash@zash.se>
parents: 9756
diff changeset
   546
		local cleanup_done = cleanup_time();
11972
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   547
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   548
		if archive.caps and archive.caps.wildcard_delete then
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   549
			local ok, err = archive:delete(true, { ["end"] = os.time() - cleanup_after })
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   550
			if ok then
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   551
				local sum = tonumber(ok);
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   552
				if sum then
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   553
					module:log("info", "Deleted %d expired messages", sum);
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   554
				else
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   555
					-- driver did not tell
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   556
					module:log("info", "Deleted all expired messages");
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   557
				end
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   558
			else
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   559
				module:log("error", "Could not delete messages: %s", err);
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   560
			end
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   561
			cleanup_done();
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   562
			return;
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   563
		end
6e1af07921d1 mod_mam,mod_muc_mam: Simplify deletion when multi-user-deletion is supported
Kim Alvefur <zash@zash.se>
parents: 11879
diff changeset
   564
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   565
		local users = {};
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   566
		local cut_off = datestamp(os.time() - cleanup_after);
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   567
		for date in cleanup_storage:users() do
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   568
			if date <= cut_off then
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   569
				module:log("debug", "Messages from %q should be expired", date);
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   570
				local messages_this_day = cleanup_storage:get(date);
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   571
				if messages_this_day then
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   572
					for user in pairs(messages_this_day) do
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   573
						users[user] = true;
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   574
					end
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   575
					if date < cut_off then
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   576
						-- Messages from the same day as the cut-off might not have expired yet,
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   577
						-- but all earlier will have, so clear storage for those days.
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   578
						cleanup_storage:set(date, nil);
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   579
					end
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   580
				end
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   581
			end
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   582
		end
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   583
		local sum, num_users = 0, 0;
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   584
		for user in pairs(users) do
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   585
			local ok, err = archive:delete(user, { ["end"] = os.time() - cleanup_after; })
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   586
			if ok then
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   587
				num_users = num_users + 1;
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   588
				sum = sum + (tonumber(ok) or 0);
10528
7c29a6e652d2 mod_mam: Log error when unable to delete old messages (fix #1479) [luacheck]
Kim Alvefur <zash@zash.se>
parents: 10527
diff changeset
   589
			else
10529
9cf7d9761ca2 mod_mam: Schedule cleanup again if unable to delete messages
Kim Alvefur <zash@zash.se>
parents: 10528
diff changeset
   590
				cleanup_map:set(cut_off, user, true);
10528
7c29a6e652d2 mod_mam: Log error when unable to delete old messages (fix #1479) [luacheck]
Kim Alvefur <zash@zash.se>
parents: 10527
diff changeset
   591
				module:log("error", "Could not delete messages for user '%s': %s", user, err);
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   592
			end
10686
62ef68f95b6f mod_mam,mod_muc_mam: Allow other work to be performed during archive cleanup (fixes #1504)
Kim Alvefur <zash@zash.se>
parents: 10571
diff changeset
   593
			local wait, done = async.waiter();
62ef68f95b6f mod_mam,mod_muc_mam: Allow other work to be performed during archive cleanup (fixes #1504)
Kim Alvefur <zash@zash.se>
parents: 10571
diff changeset
   594
			module:add_timer(0.01, done);
62ef68f95b6f mod_mam,mod_muc_mam: Allow other work to be performed during archive cleanup (fixes #1504)
Kim Alvefur <zash@zash.se>
parents: 10571
diff changeset
   595
			wait();
9883
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   596
		end
ddc07fb8dcd4 mod_mam: Perform message expiry based on building an index by date (backport of 39ee70fbb009 from trunk)
Kim Alvefur <zash@zash.se>
parents: 9558
diff changeset
   597
		module:log("info", "Deleted %d expired messages for %d users", sum, num_users);
9761
03ed7f10d8da mod_mam: Measure how long it takes to run the message expiry job job
Kim Alvefur <zash@zash.se>
parents: 9756
diff changeset
   598
		cleanup_done();
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   599
	end);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   600
8135
6ddddfe05a74 mod_mam: Don't ask the storage backend to count all items when expiry is disabled
Kim Alvefur <zash@zash.se>
parents: 8050
diff changeset
   601
else
8579
07ff7b8b702b mod_mam: Log a debug message if archive expiry has been disabled
Kim Alvefur <zash@zash.se>
parents: 8578
diff changeset
   602
	module:log("debug", "Archive expiry disabled");
8135
6ddddfe05a74 mod_mam: Don't ask the storage backend to count all items when expiry is disabled
Kim Alvefur <zash@zash.se>
parents: 8050
diff changeset
   603
	-- Don't ask the backend to count the potentially unbounded number of items,
6ddddfe05a74 mod_mam: Don't ask the storage backend to count all items when expiry is disabled
Kim Alvefur <zash@zash.se>
parents: 8050
diff changeset
   604
	-- it'll get slow.
8580
75d5eee6fcdf mod_mam: Add an option for whether to include 'total' counts by default in queries
Kim Alvefur <zash@zash.se>
parents: 8579
diff changeset
   605
	use_total = module:get_option_boolean("mam_include_total", false);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   606
end
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   607
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   608
-- Stanzas sent by local clients
7843
92b6aa3ea2ce mod_mam: Decrease priority to zero
Kim Alvefur <zash@zash.se>
parents: 7842
diff changeset
   609
module:hook("pre-message/bare", c2s_message_handler, 0);
92b6aa3ea2ce mod_mam: Decrease priority to zero
Kim Alvefur <zash@zash.se>
parents: 7842
diff changeset
   610
module:hook("pre-message/full", c2s_message_handler, 0);
7908
daf83bd94906 mod_mam: Fix typo in comment
Kim Alvefur <zash@zash.se>
parents: 7907
diff changeset
   611
-- Stanzas to local clients
7843
92b6aa3ea2ce mod_mam: Decrease priority to zero
Kim Alvefur <zash@zash.se>
parents: 7842
diff changeset
   612
module:hook("message/bare", message_handler, 0);
92b6aa3ea2ce mod_mam: Decrease priority to zero
Kim Alvefur <zash@zash.se>
parents: 7842
diff changeset
   613
module:hook("message/full", message_handler, 0);
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   614
11285
142fb655b885 mod_mam: Advertise extended MAM when archive storage is capable
Kim Alvefur <zash@zash.se>
parents: 11284
diff changeset
   615
local advertise_extended = archive.caps and archive.caps.full_id_range and archive.caps.ids;
11272
e3f6f0b39e7b mod_mam: Advertise extended MAM 0.7.x behind a feature flag
Kim Alvefur <zash@zash.se>
parents: 11264
diff changeset
   616
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   617
module:hook("account-disco-info", function(event)
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   618
	(event.reply or event.stanza):tag("feature", {var=xmlns_mam}):up();
11272
e3f6f0b39e7b mod_mam: Advertise extended MAM 0.7.x behind a feature flag
Kim Alvefur <zash@zash.se>
parents: 11264
diff changeset
   619
	if advertise_extended then
e3f6f0b39e7b mod_mam: Advertise extended MAM 0.7.x behind a feature flag
Kim Alvefur <zash@zash.se>
parents: 11264
diff changeset
   620
		(event.reply or event.stanza):tag("feature", {var=xmlns_mam_ext}):up();
e3f6f0b39e7b mod_mam: Advertise extended MAM 0.7.x behind a feature flag
Kim Alvefur <zash@zash.se>
parents: 11264
diff changeset
   621
	end
7894
01d2a2af3146 mod_mam: Advertise Stanza ID support (XEP-0359) (thanks iNPUTmice)
Kim Alvefur <zash@zash.se>
parents: 7893
diff changeset
   622
	(event.reply or event.stanza):tag("feature", {var=xmlns_st_id}):up();
7839
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   623
end);
30fac9154fd4 mod_mam: Import from prosody-modules
Kim Alvefur <zash@zash.se>
parents:
diff changeset
   624