portmanager: Add luacheck annotations
[prosody.git] / core / modulemanager.lua
index bf1e1924acbb59b49010604b1cb4cc1991a0cb09..e629b00571c49dee40e96183f443aca2f2e67693 100644 (file)
@@ -1,7 +1,7 @@
 -- Prosody IM
 -- Copyright (C) 2008-2010 Matthew Wild
 -- Copyright (C) 2008-2010 Waqas Hussain
--- 
+--
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
 --
@@ -10,70 +10,63 @@ local logger = require "util.logger";
 local log = logger.init("modulemanager");
 local config = require "core.configmanager";
 local pluginloader = require "util.pluginloader";
+local set = require "util.set";
+
+local new_multitable = require "util.multitable".new;
 
 local hosts = hosts;
 local prosody = prosody;
 
-local loadfile, pcall, xpcall = loadfile, pcall, xpcall;
-local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
-local pairs, ipairs = pairs, ipairs;
-local t_insert, t_concat = table.insert, table.concat;
-local type = type;
-local next = next;
-local rawget = rawget;
-local error = error;
-local tostring, tonumber = tostring, tonumber;
+local xpcall = xpcall;
+local setmetatable, rawget = setmetatable, rawget;
+local ipairs, pairs, type, tostring, t_insert = ipairs, pairs, type, tostring, table.insert;
 
 local debug_traceback = debug.traceback;
 local unpack, select = unpack, select;
-pcall = function(f, ...)
+local pcall = function(f, ...)
        local n = select("#", ...);
        local params = {...};
        return xpcall(function() return f(unpack(params, 1, n)) end, function(e) return tostring(e).."\n"..debug_traceback(); end);
 end
 
-local array, set = require "util.array", require "util.set";
-
-local autoload_modules = {"presence", "message", "iq", "offline", "c2s", "s2s"};
-local component_inheritable_modules = {"tls", "dialback", "iq"};
+local autoload_modules = {prosody.platform, "presence", "message", "iq", "offline", "c2s", "s2s", "s2s_auth_certs"};
+local component_inheritable_modules = {"tls", "saslauth", "dialback", "iq", "s2s"};
 
 -- We need this to let modules access the real global namespace
 local _G = _G;
 
 module "modulemanager"
 
-local api = _G.require "core.moduleapi"; -- Module API container
+local api = _G.require "core.moduleapi".init(_M); -- Module API container
 
 -- [host] = { [module] = module_env }
 local modulemap = { ["*"] = {} };
 
-local NULL = {};
-
 -- Load modules when a host is activated
 function load_modules_for_host(host)
-       local component = config.get(host, "core", "component_module");
-       
-       local global_modules_enabled = config.get("*", "core", "modules_enabled");
-       local global_modules_disabled = config.get("*", "core", "modules_disabled");
-       local host_modules_enabled = config.get(host, "core", "modules_enabled");
-       local host_modules_disabled = config.get(host, "core", "modules_disabled");
-       
+       local component = config.get(host, "component_module");
+
+       local global_modules_enabled = config.get("*", "modules_enabled");
+       local global_modules_disabled = config.get("*", "modules_disabled");
+       local host_modules_enabled = config.get(host, "modules_enabled");
+       local host_modules_disabled = config.get(host, "modules_disabled");
+
        if host_modules_enabled == global_modules_enabled then host_modules_enabled = nil; end
        if host_modules_disabled == global_modules_disabled then host_modules_disabled = nil; end
-       
+
        local global_modules = set.new(autoload_modules) + set.new(global_modules_enabled) - set.new(global_modules_disabled);
        if component then
                global_modules = set.intersection(set.new(component_inheritable_modules), global_modules);
        end
        local modules = (global_modules + set.new(host_modules_enabled)) - set.new(host_modules_disabled);
-       
+
        -- COMPAT w/ pre 0.8
        if modules:contains("console") then
                log("error", "The mod_console plugin has been renamed to mod_admin_telnet. Please update your config.");
                modules:remove("console");
                modules:add("admin_telnet");
        end
-       
+
        if component then
                load(host, component);
        end
@@ -82,24 +75,27 @@ function load_modules_for_host(host)
        end
 end
 prosody.events.add_handler("host-activated", load_modules_for_host);
+prosody.events.add_handler("host-deactivated", function (host)
+       modulemap[host] = nil;
+end);
 
 --- Private helpers ---
 
 local function do_unload_module(host, name)
        local mod = get_module(host, name);
        if not mod then return nil, "module-not-loaded"; end
-       
+
        if module_has_method(mod, "unload") then
                local ok, err = call_module_method(mod, "unload");
                if (not ok) and err then
                        log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
                end
        end
-       
-       for handler, event in pairs(mod.module.event_handlers) do
-               event.object.remove_handler(event.name, handler);
+
+       for object, event, handler in mod.module.event_handlers:iter(nil, nil, nil) do
+               object.remove_handler(event, handler);
        end
-       
+
        if mod.module.items then -- remove items
                local events = (host == "*" and prosody.events) or hosts[host].events;
                for key,t in pairs(mod.module.items) do
@@ -115,60 +111,64 @@ local function do_unload_module(host, name)
        return true;
 end
 
-local function do_load_module(host, module_name)
+local function do_load_module(host, module_name, state)
        if not (host and module_name) then
                return nil, "insufficient-parameters";
        elseif not hosts[host] and host ~= "*"then
                return nil, "unknown-host";
        end
-       
+
        if not modulemap[host] then
-               modulemap[host] = {};
-               if host ~= "*" then
-                       hosts[host].modules = modulemap[host];
-               end
+               modulemap[host] = hosts[host].modules;
        end
-       
+
        if modulemap[host][module_name] then
-               log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
+               log("debug", "%s is already loaded for %s, so not loading again", module_name, host);
                return nil, "module-already-loaded";
        elseif modulemap["*"][module_name] then
                local mod = modulemap["*"][module_name];
                if module_has_method(mod, "add_host") then
                        local _log = logger.init(host..":"..module_name);
                        local host_module_api = setmetatable({
-                               host = host, event_handlers = {}, items = {};
-                               _log = _log, log = function (self, ...) return _log(...); end;
+                               host = host, event_handlers = new_multitable(), items = {};
+                               _log = _log, log = function (self, ...) return _log(...); end; --luacheck: ignore 212/self
                        },{
                                __index = modulemap["*"][module_name].module;
                        });
-                       local ok, result, module_err = call_module_method(mod, "add_host", host_module_api);
-                       if not ok or result == false then return nil, ok and module_err or result; end
                        local host_module = setmetatable({ module = host_module_api }, { __index = mod });
-                       host_module.module.environment = host_module;
+                       host_module_api.environment = host_module;
                        modulemap[host][module_name] = host_module;
+                       local ok, result, module_err = call_module_method(mod, "add_host", host_module_api);
+                       if not ok or result == false then
+                               modulemap[host][module_name] = nil;
+                               return nil, ok and module_err or result;
+                       end
                        return host_module;
                end
                return nil, "global-module-already-loaded";
        end
-       
 
-       local mod, err = pluginloader.load_code(module_name);
-       if not mod then
-               log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
-               return nil, err;
-       end
+
 
        local _log = logger.init(host..":"..module_name);
-       local api_instance = setmetatable({ name = module_name, host = host, path = err,
-               _log = _log, log = function (self, ...) return _log(...); end, event_handlers = {} }
+       local api_instance = setmetatable({ name = module_name, host = host,
+               _log = _log, log = function (self, ...) return _log(...); end, --luacheck: ignore 212/self
+               event_handlers = new_multitable(), reloading = not not state,
+               saved_state = state~=true and state or nil }
                , { __index = api });
 
        local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
        api_instance.environment = pluginenv;
-       
-       setfenv(mod, pluginenv);
-       
+
+       local mod, err = pluginloader.load_code(module_name, nil, pluginenv);
+       if not mod then
+               log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
+               return nil, err;
+       end
+
+       api_instance.path = err;
+
+       modulemap[host][module_name] = pluginenv;
        local ok, err = pcall(mod);
        if ok then
                -- Call module's "load"
@@ -178,13 +178,17 @@ local function do_load_module(host, module_name)
                                log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
                        end
                end
+               api_instance.reloading, api_instance.saved_state = nil, nil;
 
-               modulemap[api_instance.host][module_name] = pluginenv;
                if api_instance.host == "*" then
                        if not api_instance.global then -- COMPAT w/pre-0.9
-                               log("warn", "mod_%s: Setting module.host = '*' deprecated, call module:set_global() instead", module_name);
+                               if host ~= "*" then
+                                       log("warn", "mod_%s: Setting module.host = '*' deprecated, call module:set_global() instead", module_name);
+                               end
                                api_instance:set_global();
                        end
+                       modulemap[host][module_name] = nil;
+                       modulemap[api_instance.host][module_name] = pluginenv;
                        if host ~= api_instance.host and module_has_method(pluginenv, "add_host") then
                                -- Now load the module again onto the host it was originally being loaded on
                                ok, err = do_load_module(host, module_name);
@@ -192,6 +196,7 @@ local function do_load_module(host, module_name)
                end
        end
        if not ok then
+               modulemap[api_instance.host][module_name] = nil;
                log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
        end
        return ok and pluginenv, err;
@@ -214,7 +219,7 @@ local function do_reload_module(host, name)
                        saved = ret;
                else
                        log("warn", "Error saving module '%s:%s' state: %s", host, name, ret);
-                       if not config.get(host, "core", "force_module_reload") then
+                       if not config.get(host, "force_module_reload") then
                                log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
                                return nil, "save-state-failed";
                        else
@@ -223,8 +228,9 @@ local function do_reload_module(host, name)
                end
        end
 
+       mod.module.reloading = true;
        do_unload_module(host, name);
-       local ok, err = do_load_module(host, name);
+       local ok, err = do_load_module(host, name, saved or true);
        if ok then
                mod = get_module(host, name);
                if module_has_method(mod, "restore") then
@@ -243,7 +249,7 @@ end
 function load(host, name)
        local mod, err = do_load_module(host, name);
        if mod then
-               (hosts[mod.module.host] or prosody).events.fire_event("module-loaded", { module = name, host = host });
+               (hosts[mod.module.host] or prosody).events.fire_event("module-loaded", { module = name, host = mod.module.host });
        end
        return mod, err;
 end
@@ -258,19 +264,38 @@ function unload(host, name)
 end
 
 function reload(host, name)
-       local ok, err = do_reload_module(host, name);
-       if ok then
+       local mod, err = do_reload_module(host, name);
+       if mod then
+               modulemap[host][name].module.reloading = true;
                (hosts[host] or prosody).events.fire_event("module-reloaded", { module = name, host = host });
+               mod.module.reloading = nil;
        elseif not is_loaded(host, name) then
                (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
        end
-       return ok, err;
+       return mod, err;
 end
 
 function get_module(host, name)
        return modulemap[host] and modulemap[host][name];
 end
 
+function get_items(key, host)
+       local result = {};
+       local modules = modulemap[host];
+       if not key or not host or not modules then return nil; end
+
+       for _, module in pairs(modules) do
+               local mod = module.module;
+               if mod.items and mod.items[key] then
+                       for _, value in ipairs(mod.items[key]) do
+                               t_insert(result, value);
+                       end
+               end
+       end
+
+       return result;
+end
+
 function get_modules(host)
        return modulemap[host];
 end