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