From 9eedb15c6fc760e45316a02cf372b00bb6547f09 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Sat, 22 Feb 2025 00:00:41 +0100 Subject: [PATCH 1/3] core.configmanager: Remove dependency on 'prosody' global for Credential Minimizing dependencies on global state is nice, as it makes using configmanager outside of Prosody easier. --- core/configmanager.lua | 16 +++++++++++++--- util/startup.lua | 9 ++++++++- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/core/configmanager.lua b/core/configmanager.lua index 023545d7a..effe33a13 100644 --- a/core/configmanager.lua +++ b/core/configmanager.lua @@ -36,6 +36,8 @@ local config_mt = { __index = function (t, _) return rawget(t, "*"); end}; local config = setmetatable({ ["*"] = { } }, config_mt); local delayed_warnings = {}; local files = {}; +local credentials_directory = nil; +local credential_fallback_fatal = true; -- When host not found, use global local host_mt = { __index = function(_, k) return config["*"][k] end } @@ -371,9 +373,9 @@ do env.FileLine = filereader(config_path, "*l"); env.FileLines = linereader(config_path); - if _G.prosody.paths.credentials then - env.Credential = filereader(_G.prosody.paths.credentials, "*a"); - elseif _G.prosody.process_type == "prosody" then + if credentials_directory then + env.Credential = filereader(credentials_directory, "*a"); + elseif credential_fallback_fatal then env.Credential = function() error("Credential() requires the $CREDENTIALS_DIRECTORY environment variable to be set", 2) end else env.Credential = function() @@ -405,4 +407,12 @@ do end +function _M.set_credentials_directory(directory) + credentials_directory = directory; +end + +function _M.set_credential_fallback_mode(mode) + credential_fallback_fatal = mode == "error"; +end + return _M; diff --git a/util/startup.lua b/util/startup.lua index 34c2f733c..15f07fdfd 100644 --- a/util/startup.lua +++ b/util/startup.lua @@ -89,6 +89,14 @@ function startup.read_config() end end prosody.config_file = filename + local credentials_directory = os.getenv("CREDENTIALS_DIRECTORY"); + if credentials_directory then + config.set_credentials_directory(credentials_directory); + elseif prosody.process_type == "prosody" then + config.set_credential_fallback_mode("error"); + else + config.set_credential_fallback_mode("warn"); + end local ok, level, err = config.load(filename); if not ok then print("\n"); @@ -271,7 +279,6 @@ function startup.init_global_state() config = CFG_CONFIGDIR or "."; plugins = CFG_PLUGINDIR or "plugins"; data = "data"; - credentials = os.getenv("CREDENTIALS_DIRECTORY"); }; prosody.arg = _G.arg; From 5e41daac799c7195fd5885da254cbba13025cca6 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Sat, 22 Feb 2025 00:08:18 +0100 Subject: [PATCH 2/3] core.configmanager: Fix reporting delayed warnings from global section A Credential in the global section would be stored at delayed_warnings["*/secret"], but get("example.com","secret") would look for delayed_warnings["example.com/secret"] Storing the warnings in the config itself has the unfortunate side-effect that the config now contains util.error objects, which may be awkward if something bypasses get(). Should rawget() also do this filtering? getconfig() too? Currently this only affects prosodyctl, so maybe it won't be much of a problem. --- core/configmanager.lua | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/core/configmanager.lua b/core/configmanager.lua index effe33a13..526409e87 100644 --- a/core/configmanager.lua +++ b/core/configmanager.lua @@ -34,7 +34,6 @@ local parser = nil; local config_mt = { __index = function (t, _) return rawget(t, "*"); end}; local config = setmetatable({ ["*"] = { } }, config_mt); -local delayed_warnings = {}; local files = {}; local credentials_directory = nil; local credential_fallback_fatal = true; @@ -47,11 +46,12 @@ function _M.getconfig() end function _M.get(host, key) - if host and key and delayed_warnings[host.."/"..key] then - local warning = delayed_warnings[host.."/"..key]; - log("warn", "%s", warning.text); + local v = config[host][key]; + if v and errors.is_error(v) then + log("warn", "%s", v.text); + return nil; end - return config[host][key]; + return v; end function _M.rawget(host, key) local hostconfig = rawget(config, host); @@ -252,10 +252,6 @@ do t_insert(warnings, ("%s:%d: Duplicate option '%s'"):format(config_file, get_line_number(config_file), k)); end set_options[option_path] = true; - if errors.is_error(v) then - delayed_warnings[option_path] = v; - return; - end set(config_table, env.__currenthost or "*", k, v); end }); @@ -385,7 +381,6 @@ do :format(config_file, get_line_number(config_file)); }); end - end local chunk, err = envload(data, "@"..config_file, env); From 6b1e05614238b1ceb0fb640ee4241697e10db638 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Sat, 22 Feb 2025 00:04:51 +0100 Subject: [PATCH 3/3] core.configmanager: Pass name and line number in context Delays the string interpolation until the warning is logged, which may slightly lower memory usage. Allows retrieving the filename and line number easily. --- core/configmanager.lua | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/core/configmanager.lua b/core/configmanager.lua index 526409e87..6c6b670b9 100644 --- a/core/configmanager.lua +++ b/core/configmanager.lua @@ -48,7 +48,7 @@ end function _M.get(host, key) local v = config[host][key]; if v and errors.is_error(v) then - log("warn", "%s", v.text); + log("warn", "%s:%d: %s", v.context.filename, v.context.fileline, v.text); return nil; end return v; @@ -376,10 +376,9 @@ do else env.Credential = function() return errors.new({ - type = "continue", - text = ("%s:%d: Credential() requires the $CREDENTIALS_DIRECTORY environment variable to be set") - :format(config_file, get_line_number(config_file)); - }); + type = "continue"; + text = "Credential() requires the $CREDENTIALS_DIRECTORY environment variable to be set"; + }, { filename = config_file; fileline = get_line_number(config_file) }); end end