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