MUC: Split out handling of normal (un)available presence into its own method
[prosody.git] / core / configmanager.lua
index 54fb0a9ae82fdb61d22f4d1600f27855f84a3d46..16d4b8e2f4a0ecb2841600bc01973c6c83d00b60 100644 (file)
 -- Prosody IM
 -- Copyright (C) 2008-2010 Matthew Wild
 -- Copyright (C) 2008-2010 Waqas Hussain
--- 
+--
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
 --
 
+local _G = _G;
+local setmetatable, rawget, rawset, io, error, dofile, type, pairs, table =
+      setmetatable, rawget, rawset, io, error, dofile, type, pairs, table;
+local format, math_max = string.format, math.max;
 
+local fire_event = prosody and prosody.events.fire_event or function () end;
 
-local _G = _G;
-local  setmetatable, loadfile, pcall, rawget, rawset, io, error, dofile, type, pairs, table, format =
-               setmetatable, loadfile, pcall, rawget, rawset, io, error, dofile, type, pairs, table, string.format;
+local envload = require"util.envload".envload;
+local deps = require"util.dependencies";
+local resolve_relative_path = require"util.paths".resolve_relative_path;
+local glob_to_pattern = require"util.paths".glob_to_pattern;
+local path_sep = package.config:sub(1,1);
 
+local encodings = deps.softreq"util.encodings";
+local nameprep = encodings and encodings.stringprep.nameprep or function (host) return host:lower(); end
 
-local eventmanager = require "core.eventmanager";
+local _M = {};
+local _ENV = nil;
 
-module "configmanager"
+_M.resolve_relative_path = resolve_relative_path; -- COMPAT
 
 local parsers = {};
 
-local config = { ["*"] = { core = {} } };
-
-local global_config = config["*"];
+local config_mt = { __index = function (t, _) return rawget(t, "*"); end};
+local config = setmetatable({ ["*"] = { } }, config_mt);
 
 -- When host not found, use global
-setmetatable(config, { __index = function () return global_config; end});
-local host_mt = { __index = global_config };
-
--- When key not found in section, check key in global's section
-function section_mt(section_name)
-       return { __index =      function (t, k)
-                                                                       local section = rawget(global_config, section_name);
-                                                                       if not section then return nil; end
-                                                                       return section[k];
-                                                       end };
-end
+local host_mt = { __index = function(_, k) return config["*"][k] end }
 
-function getconfig()
+function _M.getconfig()
        return config;
 end
 
-function get(host, section, key)
-       local sec = config[host][section];
-       if sec then
-               return sec[key];
+function _M.get(host, key, _oldkey)
+       if key == "core" then
+               key = _oldkey; -- COMPAT with code that still uses "core"
+       end
+       return config[host][key];
+end
+function _M.rawget(host, key, _oldkey)
+       if key == "core" then
+               key = _oldkey; -- COMPAT with code that still uses "core"
+       end
+       local hostconfig = rawget(config, host);
+       if hostconfig then
+               return rawget(hostconfig, key);
        end
-       return nil;
 end
 
-function set(host, section, key, value)
-       if host and section and key then
-               local hostconfig = rawget(config, host);
+local function set(config_table, host, key, value)
+       if host and key then
+               local hostconfig = rawget(config_table, host);
                if not hostconfig then
-                       hostconfig = rawset(config, host, setmetatable({}, host_mt))[host];
-               end
-               if not rawget(hostconfig, section) then
-                       hostconfig[section] = setmetatable({}, section_mt(section));
+                       hostconfig = rawset(config_table, host, setmetatable({}, host_mt))[host];
                end
-               hostconfig[section][key] = value;
+               hostconfig[key] = value;
                return true;
        end
        return false;
 end
 
-function load(filename, format)
-       format = format or filename:match("%w+$");
+function _M.set(host, key, value, _oldvalue)
+       if key == "core" then
+               key, value = value, _oldvalue; --COMPAT with code that still uses "core"
+       end
+       return set(config, host, key, value);
+end
+
+function _M.load(filename, config_format)
+       config_format = config_format or filename:match("%w+$");
 
-       if parsers[format] and parsers[format].load then
+       if parsers[config_format] and parsers[config_format].load then
                local f, err = io.open(filename);
                if f then
-                       local ok, err = parsers[format].load(f:read("*a"), filename);
+                       local new_config = setmetatable({ ["*"] = { } }, config_mt);
+                       local ok, err = parsers[config_format].load(f:read("*a"), filename, new_config);
                        f:close();
                        if ok then
-                               eventmanager.fire_event("config-reloaded", { filename = filename, format = format });
+                               config = new_config;
+                               fire_event("config-reloaded", {
+                                       filename = filename,
+                                       format = config_format,
+                                       config = config
+                               });
                        end
                        return ok, "parser", err;
                end
                return f, "file", err;
        end
 
-       if not format then
+       if not config_format then
                return nil, "file", "no parser specified";
        else
-               return nil, "file", "no parser for "..(format);
+               return nil, "file", "no parser for "..(config_format);
        end
 end
 
-function save(filename, format)
-end
-
-function addparser(format, parser)
-       if format and parser then
-               parsers[format] = parser;
+function _M.addparser(config_format, parser)
+       if config_format and parser then
+               parsers[config_format] = parser;
        end
 end
 
 -- _M needed to avoid name clash with local 'parsers'
 function _M.parsers()
        local p = {};
-       for format in pairs(parsers) do
-               table.insert(p, format);
+       for config_format in pairs(parsers) do
+               table.insert(p, config_format);
        end
        return p;
 end
 
 -- Built-in Lua parser
 do
-       local loadstring, pcall, setmetatable = _G.loadstring, _G.pcall, _G.setmetatable;
-       local setfenv, rawget, tostring = _G.setfenv, _G.rawget, _G.tostring;
+       local pcall = _G.pcall;
        parsers.lua = {};
-       function parsers.lua.load(data, filename)
+       function parsers.lua.load(data, config_file, config_table)
                local env;
                -- The ' = true' are needed so as not to set off __newindex when we assign the functions below
-               env = setmetatable({ Host = true, host = true, VirtualHost = true, Component = true, component = true,
-                                                       Include = true, include = true, RunScript = dofile }, { __index = function (t, k)
-                                                                                               return rawget(_G, k) or
-                                                                                                               function (settings_table)
-                                                                                                                       config[__currenthost or "*"][k] = settings_table;
-                                                                                                               end;
-                                                                               end,
-                                                               __newindex = function (t, k, v)
-                                                                                       set(env.__currenthost or "*", "core", k, v);
-                                                                               end});
-               
+               env = setmetatable({
+                       Host = true, host = true, VirtualHost = true,
+                       Component = true, component = true,
+                       Include = true, include = true, RunScript = true }, {
+                               __index = function (_, k)
+                                       return rawget(_G, k);
+                               end,
+                               __newindex = function (_, k, v)
+                                       set(config_table, env.__currenthost or "*", k, v);
+                               end
+               });
+
                rawset(env, "__currenthost", "*") -- Default is global
                function env.VirtualHost(name)
-                       if rawget(config, name) and rawget(config[name].core, "component_module") then
+                       name = nameprep(name);
+                       if rawget(config_table, name) and rawget(config_table[name], "component_module") then
                                error(format("Host %q clashes with previously defined %s Component %q, for services use a sub-domain like conference.%s",
-                                       name, config[name].core.component_module:gsub("^%a+$", { component = "external", muc = "MUC"}), name, name), 0);
+                                       name, config_table[name].component_module:gsub("^%a+$", { component = "external", muc = "MUC"}), name, name), 0);
                        end
                        rawset(env, "__currenthost", name);
                        -- Needs at least one setting to logically exist :)
-                       set(name or "*", "core", "defined", true);
+                       set(config_table, name or "*", "defined", true);
+                       return function (config_options)
+                               rawset(env, "__currenthost", "*"); -- Return to global scope
+                               for option_name, option_value in pairs(config_options) do
+                                       set(config_table, name or "*", option_name, option_value);
+                               end
+                       end;
                end
                env.Host, env.host = env.VirtualHost, env.VirtualHost;
-               
+
                function env.Component(name)
-                       if rawget(config, name) and rawget(config[name].core, "defined") and not rawget(config[name].core, "component_module") then
+                       name = nameprep(name);
+                       if rawget(config_table, name) and rawget(config_table[name], "defined") and not rawget(config_table[name], "component_module") then
                                error(format("Component %q clashes with previously defined Host %q, for services use a sub-domain like conference.%s",
                                        name, name, name), 0);
                        end
-                       set(name, "core", "component_module", "component");
+                       set(config_table, name, "component_module", "component");
                        -- Don't load the global modules by default
-                       set(name, "core", "load_global_modules", false);
+                       set(config_table, name, "load_global_modules", false);
                        rawset(env, "__currenthost", name);
-       
+                       local function handle_config_options(config_options)
+                               rawset(env, "__currenthost", "*"); -- Return to global scope
+                               for option_name, option_value in pairs(config_options) do
+                                       set(config_table, name or "*", option_name, option_value);
+                               end
+                       end
+
                        return function (module)
                                        if type(module) == "string" then
-                                               set(name, "core", "component_module", module);
+                                               set(config_table, name, "component_module", module);
+                                               return handle_config_options;
                                        end
+                                       return handle_config_options(module);
                                end
                end
                env.component = env.Component;
-               
+
                function env.Include(file)
+                       -- Check whether this is a wildcard Include
+                       if file:match("[*?]") then
+                               local lfs = deps.softreq "lfs";
+                               if not lfs then
+                                       error(format("Error expanding wildcard pattern in Include %q - LuaFileSystem not available", file));
+                               end
+                               local path_pos, glob = file:match("()([^"..path_sep.."]+)$");
+                               local path = file:sub(1, math_max(path_pos-2,0));
+                               local config_path = config_file:gsub("[^"..path_sep.."]+$", "");
+                               if #path > 0 then
+                                       path = resolve_relative_path(config_path, path);
+                               else
+                                       path = config_path;
+                               end
+                               local patt = glob_to_pattern(glob);
+                               for f in lfs.dir(path) do
+                                       if f:sub(1,1) ~= "." and f:match(patt) then
+                                               env.Include(path..path_sep..f);
+                                       end
+                               end
+                               return;
+                       end
+                       -- Not a wildcard, so resolve (potentially) relative path and run through config parser
+                       file = resolve_relative_path(config_file:gsub("[^"..path_sep.."]+$", ""), file);
                        local f, err = io.open(file);
                        if f then
-                               local data = f:read("*a");
-                               local ok, err = parsers.lua.load(data, file);
-                               if not ok then error(err:gsub("%[string.-%]", file), 0); end
+                               local ret, err = parsers.lua.load(f:read("*a"), file, config_table);
+                               if not ret then error(err:gsub("%[string.-%]", file), 0); end
                        end
                        if not f then error("Error loading included "..file..": "..err, 0); end
                        return f, err;
                end
                env.include = env.Include;
-               
-               local chunk, err = loadstring(data, "@"..filename);
-               
+
+               function env.RunScript(file)
+                       return dofile(resolve_relative_path(config_file:gsub("[^"..path_sep.."]+$", ""), file));
+               end
+
+               local chunk, err = envload(data, "@"..config_file, env);
+
                if not chunk then
                        return nil, err;
                end
-               
-               setfenv(chunk, env);
-               
+
                local ok, err = pcall(chunk);
-               
+
                if not ok then
                        return nil, err;
                end
-               
+
                return true;
        end
-       
+
 end
 
 return _M;