core/modulemanager.lua

   1 -- Prosody IM v0.1
   2 -- Copyright (C) 2008 Matthew Wild
   3 -- Copyright (C) 2008 Waqas Hussain
   4 --
   5 -- This program is free software; you can redistribute it and/or
   6 -- modify it under the terms of the GNU General Public License
   7 -- as published by the Free Software Foundation; either version 2
   8 -- of the License, or (at your option) any later version.
   9 --
  10 -- This program is distributed in the hope that it will be useful,
  11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 -- GNU General Public License for more details.
  14 --
  15 -- You should have received a copy of the GNU General Public License
  16 -- along with this program; if not, write to the Free Software
  17 -- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 --
  19
  20
  21
  22 local plugin_dir = CFG_PLUGINDIR or "./plugins/";
  23
  24 local logger = require "util.logger";
  25 local log = logger.init("modulemanager");
  26 local addDiscoInfoHandler = require "core.discomanager".addDiscoInfoHandler;
  27 local eventmanager = require "core.eventmanager";
  28 local config = require "core.configmanager";
  29 local multitable_new = require "util.multitable".new;
  30
  31
  32 local loadfile, pcall = loadfile, pcall;
  33 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
  34 local pairs, ipairs = pairs, ipairs;
  35 local t_insert = table.insert;
  36 local type = type;
  37
  38 local tostring, print = tostring, print;
  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 = {}; -- Module API container
  46
  47 local modulemap = {};
  48
  49 local m_handler_info = multitable_new();
  50 local m_stanza_handlers = multitable_new();
  51 local handler_info = {};
  52 local stanza_handlers = {};
  53
  54 local modulehelpers = setmetatable({}, { __index = _G });
  55
  56 -- Load modules when a host is activated
  57 function load_modules_for_host(host)
  58         local modules_enabled = config.get(host, "core", "modules_enabled");
  59         if modules_enabled then
  60                 for _, module in pairs(modules_enabled) do
  61                         load(host, module);
  62                 end
  63         end
  64 end
  65 eventmanager.add_event_hook("host-activated", load_modules_for_host);
  66 --
  67
  68 function load(host, module_name, config)
  69         if not (host and module_name) then
  70                 return nil, "insufficient-parameters";
  71         end
  72         local mod, err = loadfile(plugin_dir.."mod_"..module_name..".lua");
  73         if not mod then
  74                 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
  75                 return nil, err;
  76         end
  77
  78         if not modulemap[host] then
  79                 modulemap[host] = {};
  80                 stanza_handlers[host] = {};
  81         elseif modulemap[host][module_name] then
  82                 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
  83                 return nil, "module-already-loaded";
  84         end
  85
  86         local _log = logger.init(host..":"..module_name);
  87         local api_instance = setmetatable({ name = module_name, host = host, config = config,  _log = _log, log = function (self, ...) return _log(...); end }, { __index = api });
  88
  89         local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
  90
  91         setfenv(mod, pluginenv);
  92
  93         local success, ret = pcall(mod);
  94         if not success then
  95                 log("error", "Error initialising module '%s': %s", name or "nil", ret or "nil");
  96                 return nil, ret;
  97         end
  98
  99         modulemap[host][module_name] = mod;
 100
 101         return true;
 102 end
 103
 104 function is_loaded(host, name)
 105         return modulemap[host] and modulemap[host][name] and true;
 106 end
 107
 108 function unload(host, name, ...)
 109         local mod = modulemap[host] and modulemap[host][name];
 110         if not mod then return nil, "module-not-loaded"; end
 111
 112         if type(mod.unload) == "function" then
 113                 local ok, err = pcall(mod.unload, ...)
 114                 if (not ok) and err then
 115                         log("warn", "Non-fatal error unloading module '%s' from '%s': %s", name, host, err);
 116                 end
 117         end
 118
 119 end
 120
 121 function handle_stanza(host, origin, stanza)
 122         local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns, origin.type;
 123         if name == "iq" and xmlns == "jabber:client" then
 124                 xmlns = stanza.tags[1].attr.xmlns;
 125                 log("debug", "Stanza of type %s from %s has xmlns: %s", name, origin_type, xmlns);
 126         end
 127         local handlers = m_stanza_handlers:get(host, origin_type, name, xmlns);
 128         if handlers then
 129                 log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name);
 130                 (handlers[1])(origin, stanza);
 131                 return true;
 132         else
 133                 log("debug", "Stanza unhandled by any modules, xmlns: %s", stanza.attr.xmlns); -- we didn't handle it
 134         end
 135 end
 136
 137 ----- API functions exposed to modules -----------
 138 -- Must all be in api.*
 139
 140 -- Returns the name of the current module
 141 function api:get_name()
 142         return self.name;
 143 end
 144
 145 -- Returns the host that the current module is serving
 146 function api:get_host()
 147         return self.host;
 148 end
 149
 150
 151 local function _add_iq_handler(module, origin_type, xmlns, handler)
 152         local handlers = m_stanza_handlers:get(module.host, origin_type, "iq", xmlns);
 153         if not handlers then
 154                 m_stanza_handlers:add(module.host, origin_type, "iq", xmlns, handler);
 155                 handler_info[handler] = module;
 156                 module:log("debug", "I now handle tag 'iq' [%s] with payload namespace '%s'", origin_type, xmlns);
 157         else
 158                 module:log("warn", "I wanted to handle tag 'iq' [%s] with payload namespace '%s' but mod_%s already handles that", origin_type, xmlns, handler_info[handlers[1]].name);
 159         end
 160 end
 161
 162 function api:add_iq_handler(origin_type, xmlns, handler)
 163         if not (origin_type and handler and xmlns) then return false; end
 164         if type(origin_type) == "table" then
 165                 for _, origin_type in ipairs(origin_type) do
 166                         _add_iq_handler(self, origin_type, xmlns, handler);
 167                 end
 168                 return;
 169         end
 170         _add_iq_handler(self, origin_type, xmlns, handler);
 171 end
 172
 173 function api:add_feature(xmlns)
 174         addDiscoInfoHandler(self.host, function(reply, to, from, node)
 175                 if #node == 0 then
 176                         reply:tag("feature", {var = xmlns}):up();
 177                         return true;
 178                 end
 179         end);
 180 end
 181
 182 function api:add_event_hook (...) return eventmanager.add_event_hook(...); end
 183
 184 local function _add_handler(module, origin_type, tag, xmlns, handler)
 185         local handlers = m_stanza_handlers:get(module.host, origin_type, tag, xmlns);
 186         if not handlers then
 187                 m_stanza_handlers:add(module.host, origin_type, tag, xmlns, handler);
 188                 handler_info[handler] = module;
 189                 module:log("debug", "I now handle tag '%s' [%s] with xmlns '%s'", tag, origin_type, xmlns);
 190         else
 191                 module:log("warning", "I wanted to handle tag '%s' [%s] but mod_%s already handles that", tag, origin_type, handler_info[handlers[1]].module.name);
 192         end
 193 end
 194
 195 function api:add_handler(origin_type, tag, xmlns, handler)
 196         if not (origin_type and tag and xmlns and handler) then return false; end
 197         if type(origin_type) == "table" then
 198                 for _, origin_type in ipairs(origin_type) do
 199                         _add_handler(self, origin_type, tag, xmlns, handler);
 200                 end
 201                 return;
 202         end
 203         _add_handler(self, origin_type, tag, xmlns, handler);
 204 end
 205
 206 --------------------------------------------------------------------
 207
 208 return _M;