Merge 0.10->trunk
[prosody.git] / core / configmanager.lua
index d92120d03493e95175a6c06209c636613779bcf0..16d4b8e2f4a0ecb2841600bc01973c6c83d00b60 100644 (file)
@@ -14,24 +14,32 @@ local format, math_max = string.format, math.max;
 local fire_event = prosody and prosody.events.fire_event or function () end;
 
 local envload = require"util.envload".envload;
-local lfs = require "lfs";
+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);
 
-module "configmanager"
+local encodings = deps.softreq"util.encodings";
+local nameprep = encodings and encodings.stringprep.nameprep or function (host) return host:lower(); end
+
+local _M = {};
+local _ENV = nil;
+
+_M.resolve_relative_path = resolve_relative_path; -- COMPAT
 
 local parsers = {};
 
-local config_mt = { __index = function (t, k) return rawget(t, "*"); end};
+local config_mt = { __index = function (t, _) return rawget(t, "*"); end};
 local config = setmetatable({ ["*"] = { } }, config_mt);
 
 -- When host not found, use global
 local host_mt = { __index = function(_, k) return config["*"][k] end }
 
-function getconfig()
+function _M.getconfig()
        return config;
 end
 
-function get(host, key, _oldkey)
+function _M.get(host, key, _oldkey)
        if key == "core" then
                key = _oldkey; -- COMPAT with code that still uses "core"
        end
@@ -47,11 +55,11 @@ function _M.rawget(host, key, _oldkey)
        end
 end
 
-local function set(config, host, key, value)
+local function set(config_table, host, key, value)
        if host and key then
-               local hostconfig = rawget(config, host);
+               local hostconfig = rawget(config_table, host);
                if not hostconfig then
-                       hostconfig = rawset(config, host, setmetatable({}, host_mt))[host];
+                       hostconfig = rawset(config_table, host, setmetatable({}, host_mt))[host];
                end
                hostconfig[key] = value;
                return true;
@@ -66,55 +74,20 @@ function _M.set(host, key, value, _oldvalue)
        return set(config, host, key, value);
 end
 
--- Helper function to resolve relative paths (needed by config)
-do
-       function resolve_relative_path(parent_path, path)
-               if path then
-                       -- Some normalization
-                       parent_path = parent_path:gsub("%"..path_sep.."+$", "");
-                       path = path:gsub("^%.%"..path_sep.."+", "");
-
-                       local is_relative;
-                       if path_sep == "/" and path:sub(1,1) ~= "/" then
-                               is_relative = true;
-                       elseif path_sep == "\\" and (path:sub(1,1) ~= "/" and (path:sub(2,3) ~= ":\\" and path:sub(2,3) ~= ":/")) then
-                               is_relative = true;
-                       end
-                       if is_relative then
-                               return parent_path..path_sep..path;
-                       end
-               end
-               return path;
-       end
-end
-
--- Helper function to convert a glob to a Lua pattern
-local function glob_to_pattern(glob)
-       return "^"..glob:gsub("[%p*?]", function (c)
-               if c == "*" then
-                       return ".*";
-               elseif c == "?" then
-                       return ".";
-               else
-                       return "%"..c;
-               end
-       end).."$";
-end
+function _M.load(filename, config_format)
+       config_format = config_format or filename:match("%w+$");
 
-function load(filename, format)
-       format = 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 new_config = setmetatable({ ["*"] = { } }, config_mt);
-                       local ok, err = parsers[format].load(f:read("*a"), filename, new_config);
+                       local ok, err = parsers[config_format].load(f:read("*a"), filename, new_config);
                        f:close();
                        if ok then
                                config = new_config;
                                fire_event("config-reloaded", {
                                        filename = filename,
-                                       format = format,
+                                       format = config_format,
                                        config = config
                                });
                        end
@@ -123,88 +96,86 @@ function load(filename, format)
                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 pcall, setmetatable = _G.pcall, _G.setmetatable;
-       local rawget = _G.rawget;
+       local pcall = _G.pcall;
        parsers.lua = {};
-       function parsers.lua.load(data, config_file, config)
+       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 = true }, {
-                               __index = function (t, k)
+                               __index = function (_, k)
                                        return rawget(_G, k);
                                end,
-                               __newindex = function (t, k, v)
-                                       set(config, env.__currenthost or "*", k, v);
+                               __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], "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].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(config, name or "*", "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, name or "*", option_name, option_value);
+                                       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], "defined") and not rawget(config[name], "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(config, name, "component_module", "component");
+                       set(config_table, name, "component_module", "component");
                        -- Don't load the global modules by default
-                       set(config, name, "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, name or "*", option_name, option_value);
+                                       set(config_table, name or "*", option_name, option_value);
                                end
                        end
 
                        return function (module)
                                        if type(module) == "string" then
-                                               set(config, name, "component_module", module);
+                                               set(config_table, name, "component_module", module);
                                                return handle_config_options;
                                        end
                                        return handle_config_options(module);
@@ -213,7 +184,12 @@ do
                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.."]+$", "");
@@ -228,16 +204,17 @@ do
                                                env.Include(path..path_sep..f);
                                        end
                                end
-                       else
-                               local file = resolve_relative_path(config_file:gsub("[^"..path_sep.."]+$", ""), file);
-                               local f, err = io.open(file);
-                               if f then
-                                       local ret, err = parsers.lua.load(f:read("*a"), file, config);
-                                       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;
+                               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 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;