core/modulemanager.lua

   1 -- Prosody IM v0.3
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 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
  10
  11 local plugin_dir = CFG_PLUGINDIR or "./plugins/";
  12
  13 local logger = require "util.logger";
  14 local log = logger.init("modulemanager");
  15 local addDiscoInfoHandler = require "core.discomanager".addDiscoInfoHandler;
  16 local eventmanager = require "core.eventmanager";
  17 local config = require "core.configmanager";
  18 local multitable_new = require "util.multitable".new;
  19 local register_actions = require "core.actions".register;
  20
  21 local hosts = hosts;
  22
  23 local loadfile, pcall = loadfile, pcall;
  24 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
  25 local pairs, ipairs = pairs, ipairs;
  26 local t_insert, t_concat = table.insert, table.concat;
  27 local type = type;
  28 local next = next;
  29 local rawget = rawget;
  30
  31 local tostring, print = tostring, print;
  32
  33 -- We need this to let modules access the real global namespace
  34 local _G = _G;
  35
  36 module "modulemanager"
  37
  38 local api = {}; -- Module API container
  39
  40 local modulemap = { ["*"] = {} };
  41
  42 local stanza_handlers = multitable_new();
  43 local handler_info = {};
  44
  45 local modulehelpers = setmetatable({}, { __index = _G });
  46
  47 local features_table = multitable_new();
  48 local handler_table = multitable_new();
  49 local hooked = multitable_new();
  50 local event_hooks = multitable_new();
  51
  52 local NULL = {};
  53
  54 -- Load modules when a host is activated
  55 function load_modules_for_host(host)
  56         -- Load modules from global section
  57         local modules_enabled = config.get("*", "core", "modules_enabled");
  58         local modules_disabled = config.get(host, "core", "modules_disabled");
  59         local disabled_set = {};
  60         if modules_enabled then
  61                 if modules_disabled then
  62                         for _, module in ipairs(modules_disabled) do
  63                                 disabled_set[module] = true;
  64                         end
  65                 end
  66                 for _, module in ipairs(modules_enabled) do
  67                         if not disabled_set[module] then
  68                                 load(host, module);
  69                         end
  70                 end
  71         end
  72
  73         -- Load modules from just this host
  74         local modules_enabled = config.get(host, "core", "modules_enabled");
  75         if modules_enabled then
  76                 for _, module in pairs(modules_enabled) do
  77                         if not is_loaded(host, module) then
  78                                 load(host, module);
  79                         end
  80                 end
  81         end
  82 end
  83 eventmanager.add_event_hook("host-activated", load_modules_for_host);
  84 --
  85
  86 function load(host, module_name, config)
  87         if not (host and module_name) then
  88                 return nil, "insufficient-parameters";
  89         end
  90
  91         if not modulemap[host] then
  92                 modulemap[host] = {};
  93         end
  94
  95         if modulemap[host][module_name] then
  96                 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
  97                 return nil, "module-already-loaded";
  98         elseif modulemap["*"][module_name] then
  99                 return nil, "global-module-already-loaded";
 100         end
 101
 102
 103         local mod, err = loadfile(get_module_filename(module_name));
 104         if not mod then
 105                 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
 106                 return nil, err;
 107         end
 108
 109         local _log = logger.init(host..":"..module_name);
 110         local api_instance = setmetatable({ name = module_name, host = host, config = config,  _log = _log, log = function (self, ...) return _log(...); end }, { __index = api });
 111
 112         local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
 113
 114         setfenv(mod, pluginenv);
 115         if not hosts[host] then hosts[host] = { type = "component", host = host, connected = false, s2sout = {} }; end
 116
 117         local success, ret = pcall(mod);
 118         if not success then
 119                 log("error", "Error initialising module '%s': %s", name or "nil", ret or "nil");
 120                 return nil, ret;
 121         end
 122
 123         -- Use modified host, if the module set one
 124         modulemap[api_instance.host][module_name] = pluginenv;
 125
 126         return true;
 127 end
 128
 129 function get_module(host, name)
 130         return modulemap[host] and modulemap[host][name];
 131 end
 132
 133 function is_loaded(host, name)
 134         return modulemap[host] and modulemap[host][name] and true;
 135 end
 136
 137 function unload(host, name, ...)
 138         local mod = get_module(host, name);
 139         if not mod then return nil, "module-not-loaded"; end
 140
 141         if module_has_method(mod, "unload") then
 142                 local ok, err = call_module_method(mod, "unload");
 143                 if (not ok) and err then
 144                         log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
 145                 end
 146         end
 147         modulemap[host][name] = nil;
 148         features_table:remove(host, name);
 149         local params = handler_table:get(host, name); -- , {module.host, origin_type, tag, xmlns}
 150         for _, param in pairs(params or NULL) do
 151                 local handlers = stanza_handlers:get(param[1], param[2], param[3], param[4]);
 152                 if handlers then
 153                         handler_info[handlers[1]] = nil;
 154                         stanza_handlers:remove(param[1], param[2], param[3], param[4]);
 155                 end
 156         end
 157         event_hooks:remove(host, name);
 158         return true;
 159 end
 160
 161 function reload(host, name, ...)
 162         local mod = get_module(host, name);
 163         if not mod then return nil, "module-not-loaded"; end
 164
 165         local _mod, err = loadfile(get_module_filename(name)); -- checking for syntax errors
 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         local saved;
 172
 173         if module_has_method(mod, "save") then
 174                 local ok, ret, err = call_module_method(mod, "save");
 175                 if ok then
 176                         saved = ret;
 177                 else
 178                         log("warn", "Error saving module '%s:%s' state: %s", host, module, ret);
 179                         if not config.get(host, "core", "force_module_reload") then
 180                                 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
 181                                 return nil, "save-state-failed";
 182                         else
 183                                 log("warn", "Continuing with reload (using the force)");
 184                         end
 185                 end
 186         end
 187
 188         unload(host, name, ...);
 189         local ok, err = load(host, name, ...);
 190         if ok then
 191                 mod = get_module(host, name);
 192                 if module_has_method(mod, "restore") then
 193                         local ok, err = call_module_method(mod, "restore", saved or {})
 194                         if (not ok) and err then
 195                                 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
 196                         end
 197                 end
 198                 return true;
 199         end
 200         return ok, err;
 201 end
 202
 203 function handle_stanza(host, origin, stanza)
 204         local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns, origin.type;
 205         if name == "iq" and xmlns == "jabber:client" then
 206                 if stanza.attr.type == "get" or stanza.attr.type == "set" then
 207                         xmlns = stanza.tags[1].attr.xmlns;
 208                         log("debug", "Stanza of type %s from %s has xmlns: %s", name, origin_type, xmlns);
 209                 else
 210                         log("debug", "Discarding %s from %s of type: %s", name, origin_type, stanza.attr.type);
 211                         return true;
 212                 end
 213         end
 214         local handlers = stanza_handlers:get(host, origin_type, name, xmlns);
 215         if not handlers then handlers = stanza_handlers:get("*", origin_type, name, xmlns); end
 216         if handlers then
 217                 log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name);
 218                 (handlers[1])(origin, stanza);
 219                 return true;
 220         else
 221                 log("debug", "Stanza unhandled by any modules, xmlns: %s", stanza.attr.xmlns); -- we didn't handle it
 222         end
 223 end
 224
 225 function module_has_method(module, method)
 226         return type(module.module[method]) == "function";
 227 end
 228
 229 function call_module_method(module, method, ...)
 230         if module_has_method(module, method) then
 231                 local f = module.module[method];
 232                 return pcall(f, ...);
 233         else
 234                 return false, "no-such-method";
 235         end
 236 end
 237
 238 local _modulepath = { plugin_dir, "mod_", nil, ".lua"};
 239 function get_module_filename(name)
 240         _modulepath[3] = name;
 241         return t_concat(_modulepath);
 242 end
 243
 244 ----- API functions exposed to modules -----------
 245 -- Must all be in api.*
 246
 247 -- Returns the name of the current module
 248 function api:get_name()
 249         return self.name;
 250 end
 251
 252 -- Returns the host that the current module is serving
 253 function api:get_host()
 254         return self.host;
 255 end
 256
 257 function api:get_host_type()
 258         return hosts[self.host].type;
 259 end
 260
 261 function api:set_global()
 262         self.host = "*";
 263 end
 264
 265 local function _add_handler(module, origin_type, tag, xmlns, handler)
 266         local handlers = stanza_handlers:get(module.host, origin_type, tag, xmlns);
 267         local msg = (tag == "iq") and "namespace" or "payload namespace";
 268         if not handlers then
 269                 stanza_handlers:add(module.host, origin_type, tag, xmlns, handler);
 270                 handler_info[handler] = module;
 271                 handler_table:add(module.host, module.name, {module.host, origin_type, tag, xmlns});
 272                 --module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns);
 273         else
 274                 module:log("warn", "I wanted to handle tag '%s' [%s] with %s '%s' but mod_%s already handles that", tag, origin_type, msg, xmlns, handler_info[handlers[1]].module.name);
 275         end
 276 end
 277
 278 function api:add_handler(origin_type, tag, xmlns, handler)
 279         if not (origin_type and tag and xmlns and handler) then return false; end
 280         if type(origin_type) == "table" then
 281                 for _, origin_type in ipairs(origin_type) do
 282                         _add_handler(self, origin_type, tag, xmlns, handler);
 283                 end
 284         else
 285                 _add_handler(self, origin_type, tag, xmlns, handler);
 286         end
 287 end
 288 function api:add_iq_handler(origin_type, xmlns, handler)
 289         self:add_handler(origin_type, "iq", xmlns, handler);
 290 end
 291
 292 addDiscoInfoHandler("*host", function(reply, to, from, node)
 293         if #node == 0 then
 294                 local done = {};
 295                 for module, features in pairs(features_table:get(to) or NULL) do -- for each module
 296                         for feature in pairs(features) do
 297                                 if not done[feature] then
 298                                         reply:tag("feature", {var = feature}):up(); -- TODO cache
 299                                         done[feature] = true;
 300                                 end
 301                         end
 302                 end
 303                 for module, features in pairs(features_table:get("*") or NULL) do -- for each module
 304                         for feature in pairs(features) do
 305                                 if not done[feature] then
 306                                         reply:tag("feature", {var = feature}):up(); -- TODO cache
 307                                         done[feature] = true;
 308                                 end
 309                         end
 310                 end
 311                 return next(done) ~= nil;
 312         end
 313 end);
 314
 315 function api:add_feature(xmlns)
 316         features_table:set(self.host, self.name, xmlns, true);
 317 end
 318
 319 local event_hook = function(host, mod_name, event_name, ...)
 320         if type((...)) == "table" and (...).host and (...).host ~= host then return; end
 321         for handler in pairs(event_hooks:get(host, mod_name, event_name) or NULL) do
 322                 handler(...);
 323         end
 324 end;
 325 function api:add_event_hook(name, handler)
 326         if not hooked:get(self.host, self.name, name) then
 327                 eventmanager.add_event_hook(name, function(...) event_hook(self.host, self.name, name, ...); end);
 328                 hooked:set(self.host, self.name, name, true);
 329         end
 330         event_hooks:set(self.host, self.name, name, handler, true);
 331 end
 332
 333 --------------------------------------------------------------------
 334
 335 local actions = {};
 336
 337 function actions.load(params)
 338         --return true, "Module loaded ("..params.module.." on "..params.host..")";
 339         return load(params.host, params.module);
 340 end
 341
 342 function actions.unload(params)
 343         return unload(params.host, params.module);
 344 end
 345
 346 register_actions("/modules", actions);
 347
 348 return _M;