core/modulemanager.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9 local logger = require "util.logger";
  10 local log = logger.init("modulemanager");
  11 local config = require "core.configmanager";
  12 local pluginloader = require "util.pluginloader";
  13
  14 local hosts = hosts;
  15 local prosody = prosody;
  16
  17 local loadfile, pcall, xpcall = loadfile, pcall, xpcall;
  18 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
  19 local pairs, ipairs = pairs, ipairs;
  20 local t_insert, t_concat = table.insert, table.concat;
  21 local type = type;
  22 local next = next;
  23 local rawget = rawget;
  24 local error = error;
  25 local tostring, tonumber = tostring, tonumber;
  26
  27 local debug_traceback = debug.traceback;
  28 local unpack, select = unpack, select;
  29 pcall = function(f, ...)
  30         local n = select("#", ...);
  31         local params = {...};
  32         return xpcall(function() return f(unpack(params, 1, n)) end, function(e) return tostring(e).."\n"..debug_traceback(); end);
  33 end
  34
  35 local array, set = require "util.array", require "util.set";
  36
  37 local autoload_modules = {"presence", "message", "iq", "offline", "c2s", "s2s"};
  38 local component_inheritable_modules = {"tls", "dialback", "iq"};
  39
  40 -- We need this to let modules access the real global namespace
  41 local _G = _G;
  42
  43 module "modulemanager"
  44
  45 local api = _G.require "core.moduleapi"; -- Module API container
  46
  47 -- [host] = { [module] = module_env }
  48 local modulemap = { ["*"] = {} };
  49
  50 local NULL = {};
  51
  52 -- Load modules when a host is activated
  53 function load_modules_for_host(host)
  54         local component = config.get(host, "core", "component_module");
  55
  56         local global_modules_enabled = config.get("*", "core", "modules_enabled");
  57         local global_modules_disabled = config.get("*", "core", "modules_disabled");
  58         local host_modules_enabled = config.get(host, "core", "modules_enabled");
  59         local host_modules_disabled = config.get(host, "core", "modules_disabled");
  60
  61         if host_modules_enabled == global_modules_enabled then host_modules_enabled = nil; end
  62         if host_modules_disabled == global_modules_disabled then host_modules_disabled = nil; end
  63
  64         local global_modules = set.new(autoload_modules) + set.new(global_modules_enabled) - set.new(global_modules_disabled);
  65         if component then
  66                 global_modules = set.intersection(set.new(component_inheritable_modules), global_modules);
  67         end
  68         local modules = (global_modules + set.new(host_modules_enabled)) - set.new(host_modules_disabled);
  69
  70         -- COMPAT w/ pre 0.8
  71         if modules:contains("console") then
  72                 log("error", "The mod_console plugin has been renamed to mod_admin_telnet. Please update your config.");
  73                 modules:remove("console");
  74                 modules:add("admin_telnet");
  75         end
  76
  77         if component then
  78                 load(host, component);
  79         end
  80         for module in modules do
  81                 load(host, module);
  82         end
  83 end
  84 prosody.events.add_handler("host-activated", load_modules_for_host);
  85
  86 --- Private helpers ---
  87
  88 local function do_unload_module(host, name)
  89         local mod = get_module(host, name);
  90         if not mod then return nil, "module-not-loaded"; end
  91
  92         if module_has_method(mod, "unload") then
  93                 local ok, err = call_module_method(mod, "unload");
  94                 if (not ok) and err then
  95                         log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
  96                 end
  97         end
  98
  99         for handler, event in pairs(mod.module.event_handlers) do
 100                 event.object.remove_handler(event.name, handler);
 101         end
 102
 103         if mod.module.items then -- remove items
 104                 local events = (host == "*" and prosody.events) or hosts[host].events;
 105                 for key,t in pairs(mod.module.items) do
 106                         for i = #t,1,-1 do
 107                                 local value = t[i];
 108                                 t[i] = nil;
 109                                 events.fire_event("item-removed/"..key, {source = mod.module, item = value});
 110                         end
 111                 end
 112         end
 113         mod.module.loaded = false;
 114         modulemap[host][name] = nil;
 115         return true;
 116 end
 117
 118 local function do_load_module(host, module_name)
 119         if not (host and module_name) then
 120                 return nil, "insufficient-parameters";
 121         elseif not hosts[host] and host ~= "*"then
 122                 return nil, "unknown-host";
 123         end
 124
 125         if not modulemap[host] then
 126                 modulemap[host] = {};
 127                 if host ~= "*" then
 128                         hosts[host].modules = modulemap[host];
 129                 end
 130         end
 131
 132         if modulemap[host][module_name] then
 133                 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
 134                 return nil, "module-already-loaded";
 135         elseif modulemap["*"][module_name] then
 136                 local mod = modulemap["*"][module_name];
 137                 if module_has_method(mod, "add_host") then
 138                         local _log = logger.init(host..":"..module_name);
 139                         local host_module_api = setmetatable({
 140                                 host = host, event_handlers = {}, items = {};
 141                                 _log = _log, log = function (self, ...) return _log(...); end;
 142                         },{
 143                                 __index = modulemap["*"][module_name].module;
 144                         });
 145                         local ok, result, module_err = call_module_method(mod, "add_host", host_module_api);
 146                         if not ok or result == false then return nil, ok and module_err or result; end
 147                         local host_module = setmetatable({ module = host_module_api }, { __index = mod });
 148                         host_module.module.environment = host_module;
 149                         modulemap[host][module_name] = host_module;
 150                         return host_module;
 151                 end
 152                 return nil, "global-module-already-loaded";
 153         end
 154
 155
 156         local mod, err = pluginloader.load_code(module_name);
 157         if not mod then
 158                 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
 159                 return nil, err;
 160         end
 161
 162         local _log = logger.init(host..":"..module_name);
 163         local api_instance = setmetatable({ name = module_name, host = host, path = err,
 164                 _log = _log, log = function (self, ...) return _log(...); end, event_handlers = {} }
 165                 , { __index = api });
 166
 167         local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
 168         api_instance.environment = pluginenv;
 169
 170         setfenv(mod, pluginenv);
 171
 172         local ok, err = pcall(mod);
 173         if ok then
 174                 -- Call module's "load"
 175                 if module_has_method(pluginenv, "load") then
 176                         ok, err = call_module_method(pluginenv, "load");
 177                         if not ok then
 178                                 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
 179                         end
 180                 end
 181
 182                 modulemap[api_instance.host][module_name] = pluginenv;
 183                 if api_instance.host == "*" then
 184                         if not api_instance.global then -- COMPAT w/pre-0.9
 185                                 log("warn", "mod_%s: Setting module.host = '*' deprecated, call module:set_global() instead", module_name);
 186                                 api_instance:set_global();
 187                         end
 188                         if host ~= api_instance.host and module_has_method(pluginenv, "add_host") then
 189                                 -- Now load the module again onto the host it was originally being loaded on
 190                                 ok, err = do_load_module(host, module_name);
 191                         end
 192                 end
 193         end
 194         if not ok then
 195                 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
 196         end
 197         return ok and pluginenv, err;
 198 end
 199
 200 local function do_reload_module(host, name)
 201         local mod = get_module(host, name);
 202         if not mod then return nil, "module-not-loaded"; end
 203
 204         local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
 205         if not _mod then
 206                 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
 207                 return nil, err;
 208         end
 209
 210         local saved;
 211         if module_has_method(mod, "save") then
 212                 local ok, ret, err = call_module_method(mod, "save");
 213                 if ok then
 214                         saved = ret;
 215                 else
 216                         log("warn", "Error saving module '%s:%s' state: %s", host, name, ret);
 217                         if not config.get(host, "core", "force_module_reload") then
 218                                 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
 219                                 return nil, "save-state-failed";
 220                         else
 221                                 log("warn", "Continuing with reload (using the force)");
 222                         end
 223                 end
 224         end
 225
 226         do_unload_module(host, name);
 227         local ok, err = do_load_module(host, name);
 228         if ok then
 229                 mod = get_module(host, name);
 230                 if module_has_method(mod, "restore") then
 231                         local ok, err = call_module_method(mod, "restore", saved or {})
 232                         if (not ok) and err then
 233                                 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
 234                         end
 235                 end
 236         end
 237         return ok and mod, err;
 238 end
 239
 240 --- Public API ---
 241
 242 -- Load a module and fire module-loaded event
 243 function load(host, name)
 244         local mod, err = do_load_module(host, name);
 245         if mod then
 246                 (hosts[mod.module.host] or prosody).events.fire_event("module-loaded", { module = name, host = host });
 247         end
 248         return mod, err;
 249 end
 250
 251 -- Unload a module and fire module-unloaded
 252 function unload(host, name)
 253         local ok, err = do_unload_module(host, name);
 254         if ok then
 255                 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
 256         end
 257         return ok, err;
 258 end
 259
 260 function reload(host, name)
 261         local ok, err = do_reload_module(host, name);
 262         if ok then
 263                 (hosts[host] or prosody).events.fire_event("module-reloaded", { module = name, host = host });
 264         elseif not is_loaded(host, name) then
 265                 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
 266         end
 267         return ok, err;
 268 end
 269
 270 function get_module(host, name)
 271         return modulemap[host] and modulemap[host][name];
 272 end
 273
 274 function get_modules(host)
 275         return modulemap[host];
 276 end
 277
 278 function is_loaded(host, name)
 279         return modulemap[host] and modulemap[host][name] and true;
 280 end
 281
 282 function module_has_method(module, method)
 283         return type(rawget(module.module, method)) == "function";
 284 end
 285
 286 function call_module_method(module, method, ...)
 287         local f = rawget(module.module, method);
 288         if type(f) == "function" then
 289                 return pcall(f, ...);
 290         else
 291                 return false, "no-such-method";
 292         end
 293 end
 294
 295 return _M;