2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local logger = require "util.logger";
10 local log = logger.init("modulemanager");
11 local config = require "core.configmanager";
12 local pluginloader = require "util.pluginloader";
15 local prosody = prosody;
17 local pcall, xpcall = pcall, xpcall;
18 local setmetatable, rawget, setfenv = setmetatable, rawget, setfenv;
19 local pairs, type, tostring = pairs, type, tostring;
21 local debug_traceback = debug.traceback;
22 local unpack, select = unpack, select;
23 pcall = function(f, ...)
24 local n = select("#", ...);
26 return xpcall(function() return f(unpack(params, 1, n)) end, function(e) return tostring(e).."\n"..debug_traceback(); end);
29 local set = require "util.set";
31 local autoload_modules = {"presence", "message", "iq", "offline", "c2s", "s2s"};
32 local component_inheritable_modules = {"tls", "dialback", "iq"};
34 -- We need this to let modules access the real global namespace
37 module "modulemanager"
39 local api = _G.require "core.moduleapi"; -- Module API container
41 -- [host] = { [module] = module_env }
42 local modulemap = { ["*"] = {} };
44 -- Load modules when a host is activated
45 function load_modules_for_host(host)
46 local component = config.get(host, "core", "component_module");
48 local global_modules_enabled = config.get("*", "core", "modules_enabled");
49 local global_modules_disabled = config.get("*", "core", "modules_disabled");
50 local host_modules_enabled = config.get(host, "core", "modules_enabled");
51 local host_modules_disabled = config.get(host, "core", "modules_disabled");
53 if host_modules_enabled == global_modules_enabled then host_modules_enabled = nil; end
54 if host_modules_disabled == global_modules_disabled then host_modules_disabled = nil; end
56 local global_modules = set.new(autoload_modules) + set.new(global_modules_enabled) - set.new(global_modules_disabled);
58 global_modules = set.intersection(set.new(component_inheritable_modules), global_modules);
60 local modules = (global_modules + set.new(host_modules_enabled)) - set.new(host_modules_disabled);
63 if modules:contains("console") then
64 log("error", "The mod_console plugin has been renamed to mod_admin_telnet. Please update your config.");
65 modules:remove("console");
66 modules:add("admin_telnet");
70 load(host, component);
72 for module in modules do
76 prosody.events.add_handler("host-activated", load_modules_for_host);
77 prosody.events.add_handler("host-deactivated", function (host)
78 modulemap[host] = nil;
81 --- Private helpers ---
83 local function do_unload_module(host, name)
84 local mod = get_module(host, name);
85 if not mod then return nil, "module-not-loaded"; end
87 if module_has_method(mod, "unload") then
88 local ok, err = call_module_method(mod, "unload");
89 if (not ok) and err then
90 log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
94 for handler, event in pairs(mod.module.event_handlers) do
95 event.object.remove_handler(event.name, handler);
98 if mod.module.items then -- remove items
99 local events = (host == "*" and prosody.events) or hosts[host].events;
100 for key,t in pairs(mod.module.items) do
104 events.fire_event("item-removed/"..key, {source = mod.module, item = value});
108 mod.module.loaded = false;
109 modulemap[host][name] = nil;
113 local function do_load_module(host, module_name)
114 if not (host and module_name) then
115 return nil, "insufficient-parameters";
116 elseif not hosts[host] and host ~= "*"then
117 return nil, "unknown-host";
120 if not modulemap[host] then
121 modulemap[host] = {};
123 hosts[host].modules = modulemap[host];
127 if modulemap[host][module_name] then
128 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
129 return nil, "module-already-loaded";
130 elseif modulemap["*"][module_name] then
131 local mod = modulemap["*"][module_name];
132 if module_has_method(mod, "add_host") then
133 local _log = logger.init(host..":"..module_name);
134 local host_module_api = setmetatable({
135 host = host, event_handlers = {}, items = {};
136 _log = _log, log = function (self, ...) return _log(...); end;
138 __index = modulemap["*"][module_name].module;
140 local host_module = setmetatable({ module = host_module_api }, { __index = mod });
141 host_module_api.environment = host_module;
142 local ok, result, module_err = call_module_method(mod, "add_host", host_module_api);
143 if not ok or result == false then return nil, ok and module_err or result; end
144 modulemap[host][module_name] = host_module;
147 return nil, "global-module-already-loaded";
151 local mod, err = pluginloader.load_code(module_name);
153 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
157 local _log = logger.init(host..":"..module_name);
158 local api_instance = setmetatable({ name = module_name, host = host, path = err,
159 _log = _log, log = function (self, ...) return _log(...); end, event_handlers = {} }
160 , { __index = api });
162 local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
163 api_instance.environment = pluginenv;
165 setfenv(mod, pluginenv);
167 local ok, err = pcall(mod);
169 -- Call module's "load"
170 if module_has_method(pluginenv, "load") then
171 ok, err = call_module_method(pluginenv, "load");
173 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
177 modulemap[api_instance.host][module_name] = pluginenv;
178 if api_instance.host == "*" then
179 if not api_instance.global then -- COMPAT w/pre-0.9
180 log("warn", "mod_%s: Setting module.host = '*' deprecated, call module:set_global() instead", module_name);
181 api_instance:set_global();
183 if host ~= api_instance.host and module_has_method(pluginenv, "add_host") then
184 -- Now load the module again onto the host it was originally being loaded on
185 ok, err = do_load_module(host, module_name);
190 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
192 return ok and pluginenv, err;
195 local function do_reload_module(host, name)
196 local mod = get_module(host, name);
197 if not mod then return nil, "module-not-loaded"; end
199 local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
201 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
206 if module_has_method(mod, "save") then
207 local ok, ret, err = call_module_method(mod, "save");
211 log("warn", "Error saving module '%s:%s' state: %s", host, name, ret);
212 if not config.get(host, "core", "force_module_reload") then
213 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
214 return nil, "save-state-failed";
216 log("warn", "Continuing with reload (using the force)");
221 do_unload_module(host, name);
222 local ok, err = do_load_module(host, name);
224 mod = get_module(host, name);
225 if module_has_method(mod, "restore") then
226 local ok, err = call_module_method(mod, "restore", saved or {})
227 if (not ok) and err then
228 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
232 return ok and mod, err;
237 -- Load a module and fire module-loaded event
238 function load(host, name)
239 local mod, err = do_load_module(host, name);
241 (hosts[mod.module.host] or prosody).events.fire_event("module-loaded", { module = name, host = host });
246 -- Unload a module and fire module-unloaded
247 function unload(host, name)
248 local ok, err = do_unload_module(host, name);
250 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
255 function reload(host, name)
256 local ok, err = do_reload_module(host, name);
258 (hosts[host] or prosody).events.fire_event("module-reloaded", { module = name, host = host });
259 elseif not is_loaded(host, name) then
260 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
265 function get_module(host, name)
266 return modulemap[host] and modulemap[host][name];
269 function get_modules(host)
270 return modulemap[host];
273 function is_loaded(host, name)
274 return modulemap[host] and modulemap[host][name] and true;
277 function module_has_method(module, method)
278 return type(rawget(module.module, method)) == "function";
281 function call_module_method(module, method, ...)
282 local f = rawget(module.module, method);
283 if type(f) == "function" then
284 return pcall(f, ...);
286 return false, "no-such-method";