-- Prosody IM

-- Copyright (C) 2008-2017 Matthew Wild

-- Copyright (C) 2008-2017 Waqas Hussain

-- Copyright (C) 2011-2017 Kim Alvefur

--

-- This project is MIT/X11 licensed. Please see the

-- COPYING file in the source package for more information.

--

-- XEP-0313: Message Archive Management for Prosody

--

local xmlns_mam     = "urn:xmpp:mam:2";

local xmlns_delay   = "urn:xmpp:delay";

local xmlns_forward = "urn:xmpp:forward:0";

local xmlns_st_id   = "urn:xmpp:sid:0";

local um = require "core.usermanager";

local st = require "util.stanza";

local rsm = require "util.rsm";

local get_prefs = module:require"mamprefs".get;

local set_prefs = module:require"mamprefs".set;

local prefs_to_stanza = module:require"mamprefsxml".tostanza;

local prefs_from_stanza = module:require"mamprefsxml".fromstanza;

local jid_bare = require "util.jid".bare;

local jid_split = require "util.jid".split;

local jid_prepped_split = require "util.jid".prepped_split;

local dataform = require "util.dataforms".new;

local get_form_type = require "util.dataforms".get_type;

local host = module.host;

local rm_load_roster = require "core.rostermanager".load_roster;

local is_stanza = st.is_stanza;

local tostring = tostring;

local time_now = os.time;

local m_min = math.min;

local timestamp, timestamp_parse, datestamp = import( "util.datetime", "datetime", "parse", "date");

local default_max_items, max_max_items = 20, module:get_option_number("max_archive_query_results", 50);

local strip_tags = module:get_option_set("dont_archive_namespaces", { "http://jabber.org/protocol/chatstates" });

local archive_store = module:get_option_string("archive_store", "archive");

local archive = module:open_store(archive_store, "archive");

local cleanup_after = module:get_option_string("archive_expires_after", "1w");

local cleanup_interval = module:get_option_number("archive_cleanup_interval", 4 * 60 * 60);

local archive_item_limit = module:get_option_number("storage_archive_item_limit", archive.caps and archive.caps.quota or 1000);

if not archive.find then

	error("mod_"..(archive._provided_by or archive.name and "storage_"..archive.name).." does not support archiving\n"

		.."See https://prosody.im/doc/storage and https://prosody.im/doc/archiving for more information");

end

local use_total = module:get_option_boolean("mam_include_total", true);

function schedule_cleanup()

	-- replaced by non-noop later if cleanup is enabled

end

-- Handle prefs.

module:hook("iq/self/"..xmlns_mam..":prefs", function(event)

	local origin, stanza = event.origin, event.stanza;

	local user = origin.username;

	if stanza.attr.type == "set" then

		local new_prefs = stanza:get_child("prefs", xmlns_mam);

		local prefs = prefs_from_stanza(new_prefs);

		local ok, err = set_prefs(user, prefs);

		if not ok then

			origin.send(st.error_reply(stanza, "cancel", "internal-server-error", "Error storing preferences: "..tostring(err)));

			return true;

		end

	end

	local prefs = prefs_to_stanza(get_prefs(user, true));

	local reply = st.reply(stanza):add_child(prefs);

	origin.send(reply);

	return true;

end);

local query_form = dataform {

	{ name = "FORM_TYPE"; type = "hidden"; value = xmlns_mam; };

	{ name = "with"; type = "jid-single"; };

	{ name = "start"; type = "text-single" };

	{ name = "end"; type = "text-single"; };

};

-- Serve form

module:hook("iq-get/self/"..xmlns_mam..":query", function(event)

	local origin, stanza = event.origin, event.stanza;

	get_prefs(origin.username, true);

	origin.send(st.reply(stanza):query(xmlns_mam):add_child(query_form:form()));

	return true;

end);

-- Handle archive queries

module:hook("iq-set/self/"..xmlns_mam..":query", function(event)

	local origin, stanza = event.origin, event.stanza;

	local query = stanza.tags[1];

	local qid = query.attr.queryid;

	origin.mam_requested = true;

	get_prefs(origin.username, true);

	-- Search query parameters

	local qwith, qstart, qend;

	local form = query:get_child("x", "jabber:x:data");

	if form then

		local form_type, err = get_form_type(form);

		if not form_type then

			origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid dataform: "..err));

			return true;

		elseif form_type ~= xmlns_mam then

			origin.send(st.error_reply(stanza, "modify", "bad-request", "Unexpected FORM_TYPE, expected '"..xmlns_mam.."'"));

			return true;

		end

		form, err = query_form:data(form);

		if err then

			origin.send(st.error_reply(stanza, "modify", "bad-request", select(2, next(err))));

			return true;

		end

		qwith, qstart, qend = form["with"], form["start"], form["end"];

		qwith = qwith and jid_bare(qwith); -- dataforms does jidprep

	end

	if qstart or qend then -- Validate timestamps

		local vstart, vend = (qstart and timestamp_parse(qstart)), (qend and timestamp_parse(qend));

		if (qstart and not vstart) or (qend and not vend) then

			origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid timestamp"))

			return true;

		end

		qstart, qend = vstart, vend;

	end

	module:log("debug", "Archive query by %s id=%s with=%s when=%s...%s",

		origin.username,

		qid or stanza.attr.id,

		qwith or "*",

		qstart and timestamp(qstart) or "",

		qend and timestamp(qend) or "");

	-- RSM stuff

	local qset = rsm.get(query);

	local qmax = m_min(qset and qset.max or default_max_items, max_max_items);

	local reverse = qset and qset.before or false;

	local before, after = qset and qset.before, qset and qset.after;

	if type(before) ~= "string" then before = nil; end

	if qset then

		module:log("debug", "Archive query id=%s rsm=%q", qid or stanza.attr.id, qset);

	end

	-- Load all the data!

	local data, err = archive:find(origin.username, {

		start = qstart; ["end"] = qend; -- Time range

		with = qwith;

		limit = qmax == 0 and 0 or qmax + 1;

		before = before; after = after;

		reverse = reverse;

		total = use_total or qmax == 0;

	});

	if not data then

		module:log("debug", "Archive query id=%s failed: %s", qid or stanza.attr.id, err);

		if err == "item-not-found" then

			origin.send(st.error_reply(stanza, "modify", "item-not-found"));

		else

			origin.send(st.error_reply(stanza, "cancel", "internal-server-error"));

		end

		return true;

	end

	local total = tonumber(err);

	local msg_reply_attr = { to = stanza.attr.from, from = stanza.attr.to };

	local results = {};

	-- Wrap it in stuff and deliver

	local first, last;

	local count = 0;

	local complete = "true";

	for id, item, when in data do

		count = count + 1;

		if count > qmax then

			-- We requested qmax+1 items. If that many items are retrieved then

			-- there are more results to page through, so:

			complete = nil;

			break;

		end

		local fwd_st = st.message(msg_reply_attr)

			:tag("result", { xmlns = xmlns_mam, queryid = qid, id = id })

				:tag("forwarded", { xmlns = xmlns_forward })

					:tag("delay", { xmlns = xmlns_delay, stamp = timestamp(when) }):up();

		if not is_stanza(item) then

			item = st.deserialize(item);

		end

		item.attr.xmlns = "jabber:client";

		fwd_st:add_child(item);

		if not first then first = id; end

		last = id;

		if reverse then

			results[count] = fwd_st;

		else

			origin.send(fwd_st);

		end

	end

	if reverse then

		for i = #results, 1, -1 do

			origin.send(results[i]);

		end

		first, last = last, first;

	end

	origin.send(st.reply(stanza)

		:tag("fin", { xmlns = xmlns_mam, queryid = qid, complete = complete })

			:add_child(rsm.generate {

				first = first, last = last, count = total }));

	-- That's all folks!

	module:log("debug", "Archive query id=%s completed, %d items returned", qid or stanza.attr.id, complete and count or count - 1);

	return true;

end);

local function has_in_roster(user, who)

	local roster = rm_load_roster(user, host);

	module:log("debug", "%s has %s in roster? %s", user, who, roster[who] and "yes" or "no");

	return roster[who];

end

local function shall_store(user, who)

	-- TODO Cache this?

	if not um.user_exists(user, host) then

		module:log("debug", "%s@%s does not exist", user, host)

		return false;

	end

	local prefs = get_prefs(user);

	local rule = prefs[who];

	module:log("debug", "%s's rule for %s is %s", user, who, rule);

	if rule ~= nil then

		return rule;

	end

	-- Below could be done by a metatable

	local default = prefs[false];

	module:log("debug", "%s's default rule is %s", user, default);

	if default == "roster" then

		return has_in_roster(user, who);

	end

	return default;

end

local function strip_stanza_id(stanza, user)

	if stanza:get_child("stanza-id", xmlns_st_id) then

		stanza = st.clone(stanza);

		stanza:maptags(function (tag)

			if tag.name == "stanza-id" and tag.attr.xmlns == xmlns_st_id then

				local by_user, by_host, res = jid_prepped_split(tag.attr.by);

				if not res and by_host == host and by_user == user then

					return nil;

				end

			end

			return tag;

		end);

	end

	return stanza;

end

local function should_store(stanza) --> boolean, reason: string

	local st_type = stanza.attr.type or "normal";

	local st_to_full = (stanza.attr.to or ""):find("/");

	if st_type == "error" then

		st_to_full = (stanza.attr.from or ""):find("/");

	end

	if st_type == "headline" then

		-- Headline messages are ephemeral by definition

		return false, "headline";

	end

	if st_type == "error" then

		return true, "bounce";

	end

		-- MUC messages always go to the full JID, usually archived by the MUC

		return false, "groupchat";

	end

	if stanza:get_child("no-store", "urn:xmpp:hints")

	or stanza:get_child("no-permanent-store", "urn:xmpp:hints") then

		-- XXX Experimental XEP

		return false, "hint";

	end

	if stanza:get_child("store", "urn:xmpp:hints") then

		return true, "hint";

	end

	if stanza:get_child("body") then

		return true, "body";

	end

	if stanza:get_child("subject") then

		-- XXX Who would send a message with a subject but without a body?

		return true, "subject";

	end

	if stanza:get_child("encryption", "urn:xmpp:eme:0") then

		-- Since we can't know what an encrypted message contains, we assume it's important

		-- XXX Experimental XEP

		return true, "encrypted";

	end

	if stanza:get_child(nil, "urn:xmpp:receipts") then

		-- If it's important enough to ask for a receipt then it's important enough to archive

		-- and the same applies to the receipt

		return true, "receipt";

	end

	if stanza:get_child(nil, "urn:xmpp:chat-markers:0") then

		-- XXX Experimental XEP

		return true, "marker";

	end

	if stanza:get_child("x", "jabber:x:conference")

	or stanza:find("{http://jabber.org/protocol/muc#user}x/invite") then

		return true, "invite";

	end

	 -- The IM-NG thing to do here would be to return `not st_to_full`

	 -- One day ...

	return false, "default";

end

-- Handle messages

local function message_handler(event, c2s)

	local origin, stanza = event.origin, event.stanza;

	local log = c2s and origin.log or module._log;

	local orig_from = stanza.attr.from;

	local orig_to = stanza.attr.to or orig_from;

	-- Stanza without 'to' are treated as if it was to their own bare jid

	-- Whos storage do we put it in?

	local store_user = c2s and origin.username or jid_split(orig_to);

	-- And who are they chatting with?

	local with = jid_bare(c2s and orig_to or orig_from);

	-- Filter out <stanza-id> that claim to be from us

	event.stanza = strip_stanza_id(stanza, store_user);

	local should, why = should_store(stanza);

	if not should then

		log("debug", "Not archiving stanza: %s (%s)", stanza:top_tag(), why);

		return;

	end

	local clone_for_storage;

	if not strip_tags:empty() then

		clone_for_storage = st.clone(stanza);

		clone_for_storage:maptags(function (tag)

			if strip_tags:contains(tag.attr.xmlns) then

				return nil;

			else

				return tag;

			end

		end);

		if #clone_for_storage.tags == 0 then

			log("debug", "Not archiving stanza: %s (empty when stripped)", stanza:top_tag());

			return;

		end

	else

		clone_for_storage = stanza;

	end

	-- Check with the users preferences

	if shall_store(store_user, with) then

		log("debug", "Archiving stanza: %s (%s)", stanza:top_tag(), why);