-- Prosody IM

-- Copyright (C) 2008-2012 Matthew Wild

-- Copyright (C) 2008-2012 Waqas Hussain

--

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

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

--

local array = require "prosody.util.array";

local set = require "prosody.util.set";

local it = require "prosody.util.iterators";

local logger = require "prosody.util.logger";

local timer = require "prosody.util.timer";

local resolve_relative_path = require"prosody.util.paths".resolve_relative_path;

local st = require "prosody.util.stanza";

local cache = require "prosody.util.cache";

local errors = require "prosody.util.error";

local promise = require "prosody.util.promise";

local time_now = require "prosody.util.time".now;

local format = require "prosody.util.format".format;

local jid_node = require "prosody.util.jid".node;

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

local jid_resource = require "prosody.util.jid".resource;

local human_io = require "prosody.util.human.io";

local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;

local error, setmetatable, type = error, setmetatable, type;

local ipairs, pairs, select = ipairs, pairs, select;

local tonumber, tostring = tonumber, tostring;

local require = require;

local pack = table.pack;

local unpack = table.unpack;

local prosody = prosody;

local hosts = prosody.hosts;

-- FIXME: This assert() is to try and catch an obscure bug (2013-04-05)

local core_post_stanza = assert(prosody.core_post_stanza,

	"prosody.core_post_stanza is nil, please report this as a bug");

-- Registry of shared module data

local shared_data = setmetatable({}, { __mode = "v" });

local NULL = {};

local api = {};

-- Returns the name of the current module

function api:get_name()

	return self.name;

end

-- Returns the host that the current module is serving

function api:get_host()

	return self.host;

end

function api:get_host_type()

	return (self.host == "*" and "global") or hosts[self.host].type or "local";

end

function api:set_global()

	self.host = "*";

	-- Update the logger

	local _log = logger.init("mod_"..self.name);

	self.log = function (self, ...) return _log(...); end; --luacheck: ignore self

	self._log = _log;

	self.global = true;

end

function api:add_feature(xmlns)

	self:add_item("feature", xmlns);

end

function api:add_identity(category, identity_type, name)

	self:add_item("identity", {category = category, type = identity_type, name = name});

end

function api:add_extension(data)

	self:add_item("extension", data);

end

function api:fire_event(...)

	return (hosts[self.host] or prosody).events.fire_event(...);

end

function api:hook_object_event(object, event, handler, priority)

	self.event_handlers:set(object, event, handler, true);

	return object.add_handler(event, handler, priority);

end

function api:unhook_object_event(object, event, handler)

	self.event_handlers:set(object, event, handler, nil);

	return object.remove_handler(event, handler);

end

function api:hook(event, handler, priority)

	return self:hook_object_event((hosts[self.host] or prosody).events, event, handler, priority);

end

function api:hook_global(event, handler, priority)

	return self:hook_object_event(prosody.events, event, handler, priority);

end

function api:hook_tag(xmlns, name, handler, priority)

	if not handler and type(name) == "function" then

		-- If only 2 options then they specified no xmlns

		xmlns, name, handler, priority = nil, xmlns, name, handler;

	elseif not (handler and name) then

		self:log("warn", "Error: Insufficient parameters to module:hook_tag()");

		return;

	end

	return self:hook("stanza/"..(xmlns and (xmlns..":") or "")..name,

		function (data) return handler(data.origin, data.stanza, data); end, priority);

end

api.hook_stanza = api.hook_tag; -- COMPAT w/pre-0.9

function api:unhook(event, handler)

	return self:unhook_object_event((hosts[self.host] or prosody).events, event, handler);

end

function api:wrap_object_event(events_object, event, handler)

	return self:hook_object_event(assert(events_object.wrappers, "no wrappers"), event, handler);

end

function api:wrap_event(event, handler)

	return self:wrap_object_event((hosts[self.host] or prosody).events, event, handler);

end

function api:wrap_global(event, handler)

	return self:hook_object_event(prosody.events, event, handler);

end

function api:require(lib)

	local modulemanager = require"prosody.core.modulemanager";

	local f, n = modulemanager.loader:load_code_ext(self.name, lib, "lib.lua", self.environment);

	if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message

	return f();

end

function api:depends(name)

	local modulemanager = require"prosody.core.modulemanager";

	if self:get_option_inherited_set("modules_disabled", {}):contains(name) then

		error("Dependency on disabled module mod_"..name);

	end

	if not self.dependencies then

		self.dependencies = {};

		self:hook("module-reloaded", function (event)

			if self.dependencies[event.module] and not self.reloading then

				self:log("info", "Auto-reloading due to reload of %s:%s", event.host, event.module);

				modulemanager.reload(self.host, self.name);

				return;

			end

		end);

		self:hook("module-unloaded", function (event)

			if self.dependencies[event.module] then

				self:log("info", "Auto-unloading due to unload of %s:%s", event.host, event.module);

				modulemanager.unload(self.host, self.name);

			end

		end);

	end

	local mod = modulemanager.get_module(self.host, name) or modulemanager.get_module("*", name);

	if mod and mod.module.host == "*" and self.host ~= "*"

	and modulemanager.module_has_method(mod, "add_host") then

		mod = nil; -- Target is a shared module, so we still want to load it on our host

	end

	if not mod then

		local err;

		mod, err = modulemanager.load(self.host, name);

		if not mod then

			return error(("Unable to load required module, mod_%s: %s"):format(name, ((err or "unknown error"):gsub("%-", " ")) ));

		end

	end

	self.dependencies[name] = true;

	if not mod.module.reverse_dependencies then

		mod.module.reverse_dependencies = {};

	end

	mod.module.reverse_dependencies[self.name] = true;

	return mod;

end

local function get_shared_table_from_path(module, tables, path)

	if path:sub(1,1) ~= "/" then -- Prepend default components

		local default_path_components = { module.host, module.name };

		local n_components = select(2, path:gsub("/", "%1"));

		path = (n_components<#default_path_components and "/" or "")

			..t_concat(default_path_components, "/", 1, #default_path_components-n_components).."/"..path;

	end

	local shared = tables[path];

	if not shared then

		shared = {};

		if path:match("%-cache$") then

			setmetatable(shared, { __mode = "kv" });

		end

		tables[path] = shared;

	end

	return shared;

end

-- Returns a shared table at the specified virtual path

-- Intentionally does not allow the table to be _set_, it

-- is auto-created if it does not exist.

function api:shared(path)

	if not self.shared_data then self.shared_data = {}; end

	local shared = get_shared_table_from_path(self, shared_data, path);

	self.shared_data[path] = shared;

	return shared;

end

function api:get_option(name, default_value)

	local config = require "prosody.core.configmanager";

	local value = config.get(self.host, name);

	if value == nil then

		value = default_value;

	end

	return value;

end

function api:get_option_scalar(name, default_value)

	local value = self:get_option(name, default_value);

	if type(value) == "table" then

		if #value > 1 then

			self:log("error", "Config option '%s' does not take a list, using just the first item", name);

		end

		value = value[1];

	end

	return value;

end

function api:get_option_string(name, default_value)

	local value = self:get_option_scalar(name, default_value);

	if value == nil then

		return nil;

	end

	return tostring(value);

end

function api:get_option_number(name, default_value, min, max)

	local value = self:get_option_scalar(name, default_value);

	local ret = tonumber(value);

	if value ~= nil and ret == nil then

		self:log("error", "Config option '%s' not understood, expecting a number", name);

	end

	if ret == default_value then

		-- skip interval checks for default or nil

		return ret;

	end

	if min and ret < min then

		self:log("warn", "Config option '%s' out of bounds %g < %g", name, ret, min);

		return min;

	end

	if max and ret > max then

		self:log("warn", "Config option '%s' out of bounds %g > %g", name, ret, max);

		return max;

	end

	return ret;

end

function api:get_option_period(name, default_value)

	local value = self:get_option_scalar(name, default_value);

	if type(value) == "number" then

		if value < 0 then

			self:log("debug", "Treating negative period as infinity");

			return math.huge;

		end

		-- assume seconds

		return value;

	elseif value == "never" or value == false then

		-- usually for disabling some periodic thing

		return math.huge;

	elseif type(value) == "string" then

		local ret = human_io.parse_duration(value);

		if value ~= nil and ret == nil then

			self:log("error", "Config option '%s' not understood, expecting a period (e.g. \"2 days\")", name);

		end

		return ret;

	elseif value ~= nil then

		self:log("error", "Config option '%s' expects a number or a period description string (e.g. \"3 hours\"), not %s", name, type(value));

	end

end

function api:get_option_boolean(name, ...)

	local value = self:get_option_scalar(name, ...);

	if value == nil then

		return nil;

	end

	local ret = value == true or value == "true" or value == 1 or nil;

	if ret == nil then

		ret = (value == false or value == "false" or value == 0);

		if ret then

			ret = false;

		else

			ret = nil;

		end

	end

	if ret == nil then

		self:log("error", "Config option '%s' not understood, expecting true/false", name);

	end

	return ret;

end

function api:get_option_array(name, ...)

	local value = self:get_option(name, ...);

	if value == nil then

		return nil;

	end

	if type(value) ~= "table" then

		return array{ value }; -- Assume any non-list is a single-item list

	end

	return array():append(value); -- Clone

end

function api:get_option_set(name, ...)

	local value = self:get_option_array(name, ...);

	if value == nil then

		return nil;

	end

	return set.new(value);

end

function api:get_option_inherited_set(name, ...)

	local value = self:get_option_set(name, ...);

	local global_value = self:context("*"):get_option_set(name, ...);

	if not value then

		return global_value;

	elseif not global_value then

		return value;

	end

	value:include(global_value);

	return value;

end

function api:get_option_path(name, default, parent)

	if parent == nil then

		parent = self:get_directory();

	elseif prosody.paths[parent] then

		parent = prosody.paths[parent];

	end

	local value = self:get_option_string(name, default);

	if value == nil then

		return nil;

	end

	return resolve_relative_path(parent, value);

end

function api:get_option_enum(name, default, ...)

	local value = self:get_option_scalar(name, default);

	if value == nil then return nil; end

	local options = set.new{default, ...};