Let global modules add disco features for all hosts
[prosody.git] / core / modulemanager.lua
index 4d654ae005217f75f4a846a7364d463c5ac57b31..76ea0bc07df5460e7cca9e2ebbbfb58b197748e7 100644 (file)
@@ -1,20 +1,9 @@
--- Prosody IM v0.2
--- Copyright (C) 2008 Matthew Wild
--- Copyright (C) 2008 Waqas Hussain
+-- Prosody IM v0.3
+-- Copyright (C) 2008-2009 Matthew Wild
+-- Copyright (C) 2008-2009 Waqas Hussain
 -- 
--- This program is free software; you can redistribute it and/or
--- modify it under the terms of the GNU General Public License
--- as published by the Free Software Foundation; either version 2
--- of the License, or (at your option) any later version.
--- 
--- This program is distributed in the hope that it will be useful,
--- but WITHOUT ANY WARRANTY; without even the implied warranty of
--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--- GNU General Public License for more details.
--- 
--- You should have received a copy of the GNU General Public License
--- along with this program; if not, write to the Free Software
--- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
 --
 
 
@@ -27,12 +16,14 @@ local addDiscoInfoHandler = require "core.discomanager".addDiscoInfoHandler;
 local eventmanager = require "core.eventmanager";
 local config = require "core.configmanager";
 local multitable_new = require "util.multitable".new;
+local register_actions = require "core.actions".register;
 
+local hosts = hosts;
 
 local loadfile, pcall = loadfile, pcall;
 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
 local pairs, ipairs = pairs, ipairs;
-local t_insert = table.insert;
+local t_insert, t_concat = table.insert, table.concat;
 local type = type;
 local next = next;
 local rawget = rawget;
@@ -55,6 +46,9 @@ local modulehelpers = setmetatable({}, { __index = _G });
 
 local features_table = multitable_new();
 local handler_table = multitable_new();
+local hooked = multitable_new();
+local event_hooks = multitable_new();
+
 local NULL = {};
 
 -- Load modules when a host is activated
@@ -65,11 +59,11 @@ function load_modules_for_host(host)
        local disabled_set = {};
        if modules_enabled then
                if modules_disabled then
-                       for _, module in pairs(modules_disabled) do
+                       for _, module in ipairs(modules_disabled) do
                                disabled_set[module] = true;
                        end
                end
-               for _, module in pairs(modules_enabled) do
+               for _, module in ipairs(modules_enabled) do
                        if not disabled_set[module] then
                                load(host, module);
                        end
@@ -96,7 +90,9 @@ function load(host, module_name, config)
        
        if not modulemap[host] then
                modulemap[host] = {};
-       elseif modulemap[host][module_name] then
+       end
+       
+       if modulemap[host][module_name] then
                log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
                return nil, "module-already-loaded";
        elseif modulemap["*"][module_name] then
@@ -104,7 +100,7 @@ function load(host, module_name, config)
        end
        
 
-       local mod, err = loadfile(plugin_dir.."mod_"..module_name..".lua");
+       local mod, err = loadfile(get_module_filename(module_name));
        if not mod then
                log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
                return nil, err;
@@ -116,6 +112,7 @@ function load(host, module_name, config)
        local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
        
        setfenv(mod, pluginenv);
+       if not hosts[host] then hosts[host] = { type = "component", host = host, connected = false, s2sout = {} }; end
        
        local success, ret = pcall(mod);
        if not success then
@@ -129,31 +126,80 @@ function load(host, module_name, config)
        return true;
 end
 
+function get_module(host, name)
+       return modulemap[host] and modulemap[host][name];
+end
+
 function is_loaded(host, name)
        return modulemap[host] and modulemap[host][name] and true;
 end
 
 function unload(host, name, ...)
-       local mod = modulemap[host] and modulemap[host][name];
+       local mod = get_module(host, name); 
        if not mod then return nil, "module-not-loaded"; end
        
-       if type(rawget(mod, "unload")) == "function" then
-               local ok, err = pcall(rawget(mod, "unload"), ...)
+       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' from '%s': %s", name, host, err);
+                       log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
                end
        end
        modulemap[host][name] = nil;
        features_table:remove(host, name);
        local params = handler_table:get(host, name); -- , {module.host, origin_type, tag, xmlns}
-       for _, param in pairs(params) do
+       for _, param in pairs(params or NULL) do
                local handlers = stanza_handlers:get(param[1], param[2], param[3], param[4]);
-               handler_info[handlers[1]] = nil;
-               stanza_handlers:remove(param[1], param[2], param[3], param[4]);
+               if handlers then
+                       handler_info[handlers[1]] = nil;
+                       stanza_handlers:remove(param[1], param[2], param[3], param[4]);
+               end
        end
+       event_hooks:remove(host, name);
        return true;
 end
 
+function reload(host, name, ...)
+       local mod = get_module(host, name);
+       if not mod then return nil, "module-not-loaded"; end
+
+       local _mod, err = loadfile(get_module_filename(name)); -- checking for syntax errors
+       if not _mod then
+               log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
+               return nil, err;
+       end
+
+       local saved;
+
+       if module_has_method(mod, "save") then
+               local ok, ret, err = call_module_method(mod, "save");
+               if ok then
+                       saved = ret;
+               else
+                       log("warn", "Error saving module '%s:%s' state: %s", host, module, ret);
+                       if not config.get(host, "core", "force_module_reload") then
+                               log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
+                               return nil, "save-state-failed";
+                       else
+                               log("warn", "Continuing with reload (using the force)");
+                       end
+               end
+       end
+
+       unload(host, name, ...);
+       local ok, err = load(host, name, ...);
+       if ok then
+               mod = get_module(host, name);
+               if module_has_method(mod, "restore") then
+                       local ok, err = call_module_method(mod, "restore", saved or {})
+                       if (not ok) and err then
+                               log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
+                       end
+               end
+               return true;
+       end
+       return ok, err;
+end
+
 function handle_stanza(host, origin, stanza)
        local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns, origin.type;
        if name == "iq" and xmlns == "jabber:client" then
@@ -166,6 +212,7 @@ function handle_stanza(host, origin, stanza)
                end
        end
        local handlers = stanza_handlers:get(host, origin_type, name, xmlns);
+       if not handlers then handlers = stanza_handlers:get("*", origin_type, name, xmlns); end
        if handlers then
                log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name);
                (handlers[1])(origin, stanza);
@@ -175,6 +222,25 @@ function handle_stanza(host, origin, stanza)
        end
 end
 
+function module_has_method(module, method)
+       return type(module.module[method]) == "function";
+end
+
+function call_module_method(module, method, ...)
+       if module_has_method(module, method) then       
+               local f = module.module[method];
+               return pcall(f, ...);
+       else
+               return false, "no-such-method";
+       end
+end
+
+local _modulepath = { plugin_dir, "mod_", nil, ".lua"};
+function get_module_filename(name)
+       _modulepath[3] = name;
+       return t_concat(_modulepath);
+end
+
 ----- API functions exposed to modules -----------
 -- Must all be in api.* 
 
@@ -188,6 +254,14 @@ function api:get_host()
        return self.host;
 end
 
+function api:get_host_type()
+       return hosts[self.host].type;
+end
+
+function api:set_global()
+       self.host = "*";
+end
+
 local function _add_handler(module, origin_type, tag, xmlns, handler)
        local handlers = stanza_handlers:get(module.host, origin_type, tag, xmlns);
        local msg = (tag == "iq") and "namespace" or "payload namespace";
@@ -195,7 +269,7 @@ local function _add_handler(module, origin_type, tag, xmlns, handler)
                stanza_handlers:add(module.host, origin_type, tag, xmlns, handler);
                handler_info[handler] = module;
                handler_table:add(module.host, module.name, {module.host, origin_type, tag, xmlns});
-               module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns);
+               --module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns);
        else
                module:log("warn", "I wanted to handle tag '%s' [%s] with %s '%s' but mod_%s already handles that", tag, origin_type, msg, xmlns, handler_info[handlers[1]].module.name);
        end
@@ -226,6 +300,14 @@ addDiscoInfoHandler("*host", function(reply, to, from, node)
                                end
                        end
                end
+               for module, features in pairs(features_table:get("*") or NULL) do -- for each module
+                       for feature in pairs(features) do
+                               if not done[feature] then
+                                       reply:tag("feature", {var = feature}):up(); -- TODO cache
+                                       done[feature] = true;
+                               end
+                       end
+               end
                return next(done) ~= nil;
        end
 end);
@@ -234,8 +316,33 @@ function api:add_feature(xmlns)
        features_table:set(self.host, self.name, xmlns, true);
 end
 
-function api:add_event_hook (...) return eventmanager.add_event_hook(...); end
+local event_hook = function(host, mod_name, event_name, ...)
+       if type((...)) == "table" and (...).host and (...).host ~= host then return; end
+       for handler in pairs(event_hooks:get(host, mod_name, event_name) or NULL) do
+               handler(...);
+       end
+end;
+function api:add_event_hook(name, handler)
+       if not hooked:get(self.host, self.name, name) then
+               eventmanager.add_event_hook(name, function(...) event_hook(self.host, self.name, name, ...); end);
+               hooked:set(self.host, self.name, name, true);
+       end
+       event_hooks:set(self.host, self.name, name, handler, true);
+end
 
 --------------------------------------------------------------------
 
+local actions = {};
+
+function actions.load(params)
+       --return true, "Module loaded ("..params.module.." on "..params.host..")";
+       return load(params.host, params.module);
+end
+
+function actions.unload(params)
+       return unload(params.host, params.module);
+end
+
+register_actions("/modules", actions);
+
 return _M;