Mon, 22 Mar 2010 14:35:02 +0000
mod_groups: Fixes to make compatible with roster versioning - set version to 'true' to indicate that the roster is not being versioned
-- Prosody IM -- Copyright (C) 2008-2009 Matthew Wild -- Copyright (C) 2008-2009 Waqas Hussain -- -- This project is MIT/X11 licensed. Please see the -- COPYING file in the source package for more information. -- local plugin_dir = CFG_PLUGINDIR or "./plugins/"; local logger = require "util.logger"; local log = logger.init("modulemanager"); local eventmanager = require "core.eventmanager"; local config = require "core.configmanager"; local multitable_new = require "util.multitable".new; local st = require "util.stanza"; local pluginloader = require "util.pluginloader"; local hosts = hosts; local prosody = prosody; local loadfile, pcall = loadfile, pcall; local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv; local pairs, ipairs = pairs, ipairs; local t_insert, t_concat = table.insert, table.concat; local type = type; local next = next; local rawget = rawget; local error = error; local tostring, tonumber = tostring, tonumber; local array, set = require "util.array", require "util.set"; local autoload_modules = {"presence", "message", "iq"}; -- We need this to let modules access the real global namespace local _G = _G; module "modulemanager" api = {}; local api = api; -- Module API container local modulemap = { ["*"] = {} }; local stanza_handlers = multitable_new(); local handler_info = {}; local modulehelpers = setmetatable({}, { __index = _G }); local handler_table = multitable_new(); local hooked = multitable_new(); local hooks = multitable_new(); local event_hooks = multitable_new(); local NULL = {}; -- Load modules when a host is activated function load_modules_for_host(host) local disabled_set = {}; local modules_disabled = config.get(host, "core", "modules_disabled"); if modules_disabled then for _, module in ipairs(modules_disabled) do disabled_set[module] = true; end end -- Load auto-loaded modules for this host if hosts[host].type == "local" then for _, module in ipairs(autoload_modules) do if not disabled_set[module] then load(host, module); end end end -- Load modules from global section if config.get(host, "core", "load_global_modules") ~= false then local modules_enabled = config.get("*", "core", "modules_enabled"); if modules_enabled then for _, module in ipairs(modules_enabled) do if not disabled_set[module] and not is_loaded(host, module) then load(host, module); end end end end -- Load modules from just this host local modules_enabled = config.get(host, "core", "modules_enabled"); if modules_enabled and modules_enabled ~= config.get("*", "core", "modules_enabled") then for _, module in pairs(modules_enabled) do if not is_loaded(host, module) then load(host, module); end end end end eventmanager.add_event_hook("host-activated", load_modules_for_host); eventmanager.add_event_hook("component-activated", load_modules_for_host); -- function load(host, module_name, config) if not (host and module_name) then return nil, "insufficient-parameters"; end if not modulemap[host] then modulemap[host] = {}; end if modulemap[host][module_name] then log("warn", "%s is already loaded for %s, so not loading again", module_name, host); return nil, "module-already-loaded"; elseif modulemap["*"][module_name] then return nil, "global-module-already-loaded"; end local mod, err = pluginloader.load_code(module_name); if not mod then log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil"); return nil, err; end local _log = logger.init(host..":"..module_name); local api_instance = setmetatable({ name = module_name, host = host, config = config, _log = _log, log = function (self, ...) return _log(...); end }, { __index = api }); local pluginenv = setmetatable({ module = api_instance }, { __index = _G }); api_instance.environment = pluginenv; setfenv(mod, pluginenv); if not hosts[host] then local create_component = _G.require "core.componentmanager".create_component; hosts[host] = create_component(host); hosts[host].connected = false; log("debug", "Created new component: %s", host); end hosts[host].modules = modulemap[host]; modulemap[host][module_name] = pluginenv; local success, err = pcall(mod); if success then if module_has_method(pluginenv, "load") then success, err = call_module_method(pluginenv, "load"); if not success then log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil"); end end -- Use modified host, if the module set one if api_instance.host == "*" and host ~= "*" then modulemap[host][module_name] = nil; modulemap["*"][module_name] = pluginenv; api_instance:set_global(); end else log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil"); end if success then (hosts[api_instance.host] or prosody).events.fire_event("module-loaded", { module = module_name, host = host }); return true; else -- load failed, unloading unload(api_instance.host, module_name); return nil, err; end end function get_module(host, name) return modulemap[host] and modulemap[host][name]; end function is_loaded(host, name) return modulemap[host] and modulemap[host][name] and true; end function unload(host, name, ...) local mod = get_module(host, name); if not mod then return nil, "module-not-loaded"; end if module_has_method(mod, "unload") then local ok, err = call_module_method(mod, "unload"); if (not ok) and err then log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err); end end local params = handler_table:get(host, name); -- , {module.host, origin_type, tag, xmlns} for _, param in pairs(params or NULL) do local handlers = stanza_handlers:get(param[1], param[2], param[3], param[4]); if handlers then handler_info[handlers[1]] = nil; stanza_handlers:remove(param[1], param[2], param[3], param[4]); end end event_hooks:remove(host, name); -- unhook event handlers hooked by module:hook for event, handlers in pairs(hooks:get(host, name) or NULL) do for handler in pairs(handlers or NULL) do (hosts[host] or prosody).events.remove_handler(event, handler); end end hooks:remove(host, name); if mod.module.items then -- remove items for key,t in pairs(mod.module.items) do for i = #t,1,-1 do local value = t[i]; t[i] = nil; hosts[host].events.fire_event("item-removed/"..key, {source = self, item = value}); end end end modulemap[host][name] = nil; (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host }); return true; end function reload(host, name, ...) local mod = get_module(host, name); if not mod then return nil, "module-not-loaded"; end local _mod, err = pluginloader.load_code(name); -- checking for syntax errors if not _mod then log("error", "Unable to load module '%s': %s", name or "nil", err or "nil"); return nil, err; end local saved; if module_has_method(mod, "save") then local ok, ret, err = call_module_method(mod, "save"); if ok then saved = ret; else log("warn", "Error saving module '%s:%s' state: %s", host, module, ret); if not config.get(host, "core", "force_module_reload") then log("warn", "Aborting reload due to error, set force_module_reload to ignore this"); return nil, "save-state-failed"; else log("warn", "Continuing with reload (using the force)"); end end end unload(host, name, ...); local ok, err = load(host, name, ...); if ok then mod = get_module(host, name); if module_has_method(mod, "restore") then local ok, err = call_module_method(mod, "restore", saved or {}) if (not ok) and err then log("warn", "Error restoring module '%s' from '%s': %s", name, host, err); end end return true; end return ok, err; end function handle_stanza(host, origin, stanza) local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns or "jabber:client", origin.type; if name == "iq" and xmlns == "jabber:client" then if stanza.attr.type == "get" or stanza.attr.type == "set" then xmlns = stanza.tags[1].attr.xmlns or "jabber:client"; log("debug", "Stanza of type %s from %s has xmlns: %s", name, origin_type, xmlns); else log("debug", "Discarding %s from %s of type: %s", name, origin_type, stanza.attr.type); return true; end end local handlers = stanza_handlers:get(host, origin_type, name, xmlns); if not handlers then handlers = stanza_handlers:get("*", origin_type, name, xmlns); end if handlers then log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name); (handlers[1])(origin, stanza); return true; else if stanza.attr.xmlns == "jabber:client" then log("debug", "Unhandled %s stanza: %s; xmlns=%s", origin.type, stanza.name, xmlns); -- we didn't handle it if stanza.attr.type ~= "error" and stanza.attr.type ~= "result" then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); end elseif not((name == "features" or name == "error") and xmlns == "http://etherx.jabber.org/streams") then -- FIXME remove check once we handle S2S features log("warn", "Unhandled %s stream element: %s; xmlns=%s: %s", origin.type, stanza.name, xmlns, tostring(stanza)); -- we didn't handle it origin:close("unsupported-stanza-type"); end end end function module_has_method(module, method) return type(module.module[method]) == "function"; end function call_module_method(module, method, ...) if module_has_method(module, method) then local f = module.module[method]; return pcall(f, ...); else return false, "no-such-method"; end end ----- API functions exposed to modules ----------- -- Must all be in api.* -- Returns the name of the current module function api:get_name() return self.name; end -- Returns the host that the current module is serving function api:get_host() return self.host; end function api:get_host_type() return hosts[self.host].type; end function api:set_global() self.host = "*"; -- Update the logger local _log = logger.init("mod_"..self.name); self.log = function (self, ...) return _log(...); end; self._log = _log; end local function _add_handler(module, origin_type, tag, xmlns, handler) local handlers = stanza_handlers:get(module.host, origin_type, tag, xmlns); local msg = (tag == "iq") and "namespace" or "payload namespace"; if not handlers then stanza_handlers:add(module.host, origin_type, tag, xmlns, handler); handler_info[handler] = module; handler_table:add(module.host, module.name, {module.host, origin_type, tag, xmlns}); --module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns); else 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); end end function api:add_handler(origin_type, tag, xmlns, handler) if not (origin_type and tag and xmlns and handler) then return false; end if type(origin_type) == "table" then for _, origin_type in ipairs(origin_type) do _add_handler(self, origin_type, tag, xmlns, handler); end else _add_handler(self, origin_type, tag, xmlns, handler); end end function api:add_iq_handler(origin_type, xmlns, handler) self:add_handler(origin_type, "iq", xmlns, handler); end function api:add_feature(xmlns) self:add_item("feature", xmlns); end function api:add_identity(category, type, name) self:add_item("identity", {category = category, type = type, name = name}); end local event_hook = function(host, mod_name, event_name, ...) if type((...)) == "table" and (...).host and (...).host ~= host then return; end for handler in pairs(event_hooks:get(host, mod_name, event_name) or NULL) do handler(...); end end; function api:add_event_hook(name, handler) if not hooked:get(self.host, self.name, name) then eventmanager.add_event_hook(name, function(...) event_hook(self.host, self.name, name, ...); end); hooked:set(self.host, self.name, name, true); end event_hooks:set(self.host, self.name, name, handler, true); end function api:fire_event(...) return (hosts[self.host] or prosody).events.fire_event(...); end function api:hook(event, handler, priority) hooks:set(self.host, self.name, event, handler, true); (hosts[self.host] or prosody).events.add_handler(event, handler, priority); end function api:hook_stanza(xmlns, name, handler, priority) if not handler and type(name) == "function" then -- If only 2 options then they specified no xmlns xmlns, name, handler, priority = nil, xmlns, name, handler; elseif not (handler and name) then self:log("warn", "Error: Insufficient parameters to module:hook_stanza()"); return; end return api.hook(self, "stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority); end function api:require(lib) local f, n = pluginloader.load_code(self.name, lib..".lib.lua"); if not f then f, n = pluginloader.load_code(lib, lib..".lib.lua"); end if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message setfenv(f, self.environment); return f(); end function api:get_option(name, default_value) local value = config.get(self.host, self.name, name); if value == nil then value = config.get(self.host, "core", name); if value == nil then value = default_value; end end return value; end function api:get_option_string(name, default_value) local value = self:get_option(name, default_value); if type(value) == "table" then if #value > 1 then self:log("error", "Config option '%s' does not take a list, using just the first item", name); end value = value[1]; end if value == nil then return nil; end return tostring(value); end function api:get_option_number(name, ...) local value = self:get_option(name, ...); if type(value) == "table" then if #value > 1 then self:log("error", "Config option '%s' does not take a list, using just the first item", name); end value = value[1]; end local ret = tonumber(value); if value ~= nil and ret == nil then self:log("error", "Config option '%s' not understood, expecting a number", name); end return ret; end function api:get_option_boolean(name, ...) local value = self:get_option(name, ...); if type(value) == "table" then if #value > 1 then self:log("error", "Config option '%s' does not take a list, using just the first item", name); end value = value[1]; end if value == nil then return nil; end local ret = value == true or value == "true" or value == 1 or nil; if ret == nil then ret = (value == false or value == "false" or value == 0); if ret then ret = false; else ret = nil; end end if ret == nil then self:log("error", "Config option '%s' not understood, expecting true/false", name); end return ret; end function api:get_option_array(name, ...) local value = self:get_option(name, ...); if value == nil then return nil; end if type(value) ~= "table" then return array{ value }; -- Assume any non-list is a single-item list end return array():append(value); -- Clone end function api:get_option_set(name, ...) local value = self:get_option_array(name, ...); if value == nil then return nil; end return set.new(value); end local t_remove = _G.table.remove; local module_items = multitable_new(); function api:add_item(key, value) self.items = self.items or {}; self.items[key] = self.items[key] or {}; t_insert(self.items[key], value); self:fire_event("item-added/"..key, {source = self, item = value}); end function api:remove_item(key, value) local t = self.items and self.items[key] or NULL; for i = #t,1,-1 do if t[i] == value then t_remove(self.items[key], i); self:fire_event("item-removed/"..key, {source = self, item = value}); return value; end end end function api:get_host_items(key) local result = {}; for mod_name, module in pairs(modulemap[self.host]) do module = module.module; if module.items then for _, item in ipairs(module.items[key] or NULL) do t_insert(result, item); end end end for mod_name, module in pairs(modulemap["*"]) do module = module.module; if module.items then for _, item in ipairs(module.items[key] or NULL) do t_insert(result, item); end end end return result; end return _M;