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 multitable_new = require "util.multitable".new;
  13 local st = require "util.stanza";
  14 local pluginloader = require "util.pluginloader";
  15
  16 local hosts = hosts;
  17 local prosody = prosody;
  18 local prosody_events = prosody.events;
  19
  20 local loadfile, pcall, xpcall = loadfile, pcall, xpcall;
  21 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
  22 local pairs, ipairs = pairs, ipairs;
  23 local t_insert, t_concat = table.insert, table.concat;
  24 local type = type;
  25 local next = next;
  26 local rawget = rawget;
  27 local error = error;
  28 local tostring, tonumber = tostring, tonumber;
  29
  30 local debug_traceback = debug.traceback;
  31 local unpack, select = unpack, select;
  32 pcall = function(f, ...)
  33         local n = select("#", ...);
  34         local params = {...};
  35         return xpcall(function() return f(unpack(params, 1, n)) end, function(e) return tostring(e).."\n"..debug_traceback(); end);
  36 end
  37
  38 local array, set = require "util.array", require "util.set";
  39
  40 local autoload_modules = {"presence", "message", "iq", "offline"};
  41 local component_inheritable_modules = {"tls", "dialback", "iq"};
  42
  43 -- We need this to let modules access the real global namespace
  44 local _G = _G;
  45
  46 module "modulemanager"
  47
  48 api = {};
  49 local api = api; -- Module API container
  50
  51 local modulemap = { ["*"] = {} };
  52
  53 local modulehelpers = setmetatable({}, { __index = _G });
  54
  55 local hooks = multitable_new();
  56
  57 local NULL = {};
  58
  59 -- Load modules when a host is activated
  60 function load_modules_for_host(host)
  61         local component = config.get(host, "core", "component_module");
  62
  63         local global_modules_enabled = config.get("*", "core", "modules_enabled");
  64         local global_modules_disabled = config.get("*", "core", "modules_disabled");
  65         local host_modules_enabled = config.get(host, "core", "modules_enabled");
  66         local host_modules_disabled = config.get(host, "core", "modules_disabled");
  67
  68         if host_modules_enabled == global_modules_enabled then host_modules_enabled = nil; end
  69         if host_modules_disabled == global_modules_disabled then host_modules_disabled = nil; end
  70
  71         local host_modules = set.new(host_modules_enabled) - set.new(host_modules_disabled);
  72         local global_modules = set.new(autoload_modules) + set.new(global_modules_enabled) - set.new(global_modules_disabled);
  73         if component then
  74                 global_modules = set.intersection(set.new(component_inheritable_modules), global_modules);
  75         end
  76         local modules = global_modules + host_modules;
  77
  78         -- COMPAT w/ pre 0.8
  79         if modules:contains("console") then
  80                 log("error", "The mod_console plugin has been renamed to mod_admin_telnet. Please update your config.");
  81                 modules:remove("console");
  82                 modules:add("admin_telnet");
  83         end
  84
  85         if component then
  86                 load(host, component);
  87         end
  88         for module in modules do
  89                 load(host, module);
  90         end
  91 end
  92 prosody_events.add_handler("host-activated", load_modules_for_host);
  93 --
  94
  95 function load(host, module_name, config)
  96         if not (host and module_name) then
  97                 return nil, "insufficient-parameters";
  98         elseif not hosts[host] then
  99                 return nil, "unknown-host";
 100         end
 101
 102         if not modulemap[host] then
 103                 modulemap[host] = {};
 104         end
 105
 106         if modulemap[host][module_name] then
 107                 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
 108                 return nil, "module-already-loaded";
 109         elseif modulemap["*"][module_name] then
 110                 return nil, "global-module-already-loaded";
 111         end
 112
 113
 114         local mod, err = pluginloader.load_code(module_name);
 115         if not mod then
 116                 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
 117                 return nil, err;
 118         end
 119
 120         local _log = logger.init(host..":"..module_name);
 121         local api_instance = setmetatable({ name = module_name, host = host, config = config,  _log = _log, log = function (self, ...) return _log(...); end }, { __index = api });
 122
 123         local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
 124         api_instance.environment = pluginenv;
 125
 126         setfenv(mod, pluginenv);
 127         hosts[host].modules = modulemap[host];
 128         modulemap[host][module_name] = pluginenv;
 129
 130         local success, err = pcall(mod);
 131         if success then
 132                 if module_has_method(pluginenv, "load") then
 133                         success, err = call_module_method(pluginenv, "load");
 134                         if not success then
 135                                 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
 136                         end
 137                 end
 138
 139                 -- Use modified host, if the module set one
 140                 if api_instance.host == "*" and host ~= "*" then
 141                         modulemap[host][module_name] = nil;
 142                         modulemap["*"][module_name] = pluginenv;
 143                         api_instance:set_global();
 144                 end
 145         else
 146                 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
 147         end
 148         if success then
 149                 (hosts[api_instance.host] or prosody).events.fire_event("module-loaded", { module = module_name, host = host });
 150                 return true;
 151         else -- load failed, unloading
 152                 unload(api_instance.host, module_name);
 153                 return nil, err;
 154         end
 155 end
 156
 157 function get_module(host, name)
 158         return modulemap[host] and modulemap[host][name];
 159 end
 160
 161 function is_loaded(host, name)
 162         return modulemap[host] and modulemap[host][name] and true;
 163 end
 164
 165 function unload(host, name, ...)
 166         local mod = get_module(host, name);
 167         if not mod then return nil, "module-not-loaded"; end
 168
 169         if module_has_method(mod, "unload") then
 170                 local ok, err = call_module_method(mod, "unload");
 171                 if (not ok) and err then
 172                         log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
 173                 end
 174         end
 175         -- unhook event handlers hooked by module:hook
 176         for event, handlers in pairs(hooks:get(host, name) or NULL) do
 177                 for handler in pairs(handlers or NULL) do
 178                         (hosts[host] or prosody).events.remove_handler(event, handler);
 179                 end
 180         end
 181         hooks:remove(host, name);
 182         if mod.module.items then -- remove items
 183                 for key,t in pairs(mod.module.items) do
 184                         for i = #t,1,-1 do
 185                                 local value = t[i];
 186                                 t[i] = nil;
 187                                 hosts[host].events.fire_event("item-removed/"..key, {source = self, item = value});
 188                         end
 189                 end
 190         end
 191         modulemap[host][name] = nil;
 192         (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
 193         return true;
 194 end
 195
 196 function reload(host, name, ...)
 197         local mod = get_module(host, name);
 198         if not mod then return nil, "module-not-loaded"; end
 199
 200         local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
 201         if not _mod then
 202                 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
 203                 return nil, err;
 204         end
 205
 206         local saved;
 207
 208         if module_has_method(mod, "save") then
 209                 local ok, ret, err = call_module_method(mod, "save");
 210                 if ok then
 211                         saved = ret;
 212                 else
 213                         log("warn", "Error saving module '%s:%s' state: %s", host, module, ret);
 214                         if not config.get(host, "core", "force_module_reload") then
 215                                 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
 216                                 return nil, "save-state-failed";
 217                         else
 218                                 log("warn", "Continuing with reload (using the force)");
 219                         end
 220                 end
 221         end
 222
 223         unload(host, name, ...);
 224         local ok, err = load(host, name, ...);
 225         if ok then
 226                 mod = get_module(host, name);
 227                 if module_has_method(mod, "restore") then
 228                         local ok, err = call_module_method(mod, "restore", saved or {})
 229                         if (not ok) and err then
 230                                 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
 231                         end
 232                 end
 233                 return true;
 234         end
 235         return ok, err;
 236 end
 237
 238 function module_has_method(module, method)
 239         return type(module.module[method]) == "function";
 240 end
 241
 242 function call_module_method(module, method, ...)
 243         if module_has_method(module, method) then
 244                 local f = module.module[method];
 245                 return pcall(f, ...);
 246         else
 247                 return false, "no-such-method";
 248         end
 249 end
 250
 251 ----- API functions exposed to modules -----------
 252 -- Must all be in api.*
 253
 254 -- Returns the name of the current module
 255 function api:get_name()
 256         return self.name;
 257 end
 258
 259 -- Returns the host that the current module is serving
 260 function api:get_host()
 261         return self.host;
 262 end
 263
 264 function api:get_host_type()
 265         return hosts[self.host].type;
 266 end
 267
 268 function api:set_global()
 269         self.host = "*";
 270         -- Update the logger
 271         local _log = logger.init("mod_"..self.name);
 272         self.log = function (self, ...) return _log(...); end;
 273         self._log = _log;
 274 end
 275
 276 function api:add_feature(xmlns)
 277         self:add_item("feature", xmlns);
 278 end
 279 function api:add_identity(category, type, name)
 280         self:add_item("identity", {category = category, type = type, name = name});
 281 end
 282
 283 function api:fire_event(...)
 284         return (hosts[self.host] or prosody).events.fire_event(...);
 285 end
 286
 287 function api:hook(event, handler, priority)
 288         hooks:set(self.host, self.name, event, handler, true);
 289         (hosts[self.host] or prosody).events.add_handler(event, handler, priority);
 290 end
 291
 292 function api:hook_stanza(xmlns, name, handler, priority)
 293         if not handler and type(name) == "function" then
 294                 -- If only 2 options then they specified no xmlns
 295                 xmlns, name, handler, priority = nil, xmlns, name, handler;
 296         elseif not (handler and name) then
 297                 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
 298                 return;
 299         end
 300         return api.hook(self, "stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
 301 end
 302
 303 function api:require(lib)
 304         local f, n = pluginloader.load_code(self.name, lib..".lib.lua");
 305         if not f then
 306                 f, n = pluginloader.load_code(lib, lib..".lib.lua");
 307         end
 308         if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
 309         setfenv(f, self.environment);
 310         return f();
 311 end
 312
 313 function api:get_option(name, default_value)
 314         local value = config.get(self.host, self.name, name);
 315         if value == nil then
 316                 value = config.get(self.host, "core", name);
 317                 if value == nil then
 318                         value = default_value;
 319                 end
 320         end
 321         return value;
 322 end
 323
 324 function api:get_option_string(name, default_value)
 325         local value = self:get_option(name, default_value);
 326         if type(value) == "table" then
 327                 if #value > 1 then
 328                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
 329                 end
 330                 value = value[1];
 331         end
 332         if value == nil then
 333                 return nil;
 334         end
 335         return tostring(value);
 336 end
 337
 338 function api:get_option_number(name, ...)
 339         local value = self:get_option(name, ...);
 340         if type(value) == "table" then
 341                 if #value > 1 then
 342                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
 343                 end
 344                 value = value[1];
 345         end
 346         local ret = tonumber(value);
 347         if value ~= nil and ret == nil then
 348                 self:log("error", "Config option '%s' not understood, expecting a number", name);
 349         end
 350         return ret;
 351 end
 352
 353 function api:get_option_boolean(name, ...)
 354         local value = self:get_option(name, ...);
 355         if type(value) == "table" then
 356                 if #value > 1 then
 357                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
 358                 end
 359                 value = value[1];
 360         end
 361         if value == nil then
 362                 return nil;
 363         end
 364         local ret = value == true or value == "true" or value == 1 or nil;
 365         if ret == nil then
 366                 ret = (value == false or value == "false" or value == 0);
 367                 if ret then
 368                         ret = false;
 369                 else
 370                         ret = nil;
 371                 end
 372         end
 373         if ret == nil then
 374                 self:log("error", "Config option '%s' not understood, expecting true/false", name);
 375         end
 376         return ret;
 377 end
 378
 379 function api:get_option_array(name, ...)
 380         local value = self:get_option(name, ...);
 381
 382         if value == nil then
 383                 return nil;
 384         end
 385
 386         if type(value) ~= "table" then
 387                 return array{ value }; -- Assume any non-list is a single-item list
 388         end
 389
 390         return array():append(value); -- Clone
 391 end
 392
 393 function api:get_option_set(name, ...)
 394         local value = self:get_option_array(name, ...);
 395
 396         if value == nil then
 397                 return nil;
 398         end
 399
 400         return set.new(value);
 401 end
 402
 403 local t_remove = _G.table.remove;
 404 local module_items = multitable_new();
 405 function api:add_item(key, value)
 406         self.items = self.items or {};
 407         self.items[key] = self.items[key] or {};
 408         t_insert(self.items[key], value);
 409         self:fire_event("item-added/"..key, {source = self, item = value});
 410 end
 411 function api:remove_item(key, value)
 412         local t = self.items and self.items[key] or NULL;
 413         for i = #t,1,-1 do
 414                 if t[i] == value then
 415                         t_remove(self.items[key], i);
 416                         self:fire_event("item-removed/"..key, {source = self, item = value});
 417                         return value;
 418                 end
 419         end
 420 end
 421
 422 function api:get_host_items(key)
 423         local result = {};
 424         for mod_name, module in pairs(modulemap[self.host]) do
 425                 module = module.module;
 426                 if module.items then
 427                         for _, item in ipairs(module.items[key] or NULL) do
 428                                 t_insert(result, item);
 429                         end
 430                 end
 431         end
 432         for mod_name, module in pairs(modulemap["*"]) do
 433                 module = module.module;
 434                 if module.items then
 435                         for _, item in ipairs(module.items[key] or NULL) do
 436                                 t_insert(result, item);
 437                         end
 438                 end
 439         end
 440         return result;
 441 end
 442
 443 return _M;