Files
azerothcore-wotlk/src/common/Configuration/Config.cpp
UltraNix c568bdcc42 feat(Modules): load modules configs before Log initialization (#6104)
in order to properly load modules appenders and loggers
2021-06-04 23:57:10 +02:00

438 lines
12 KiB
C++

/*
* Copyright (C) 2016+ AzerothCore <www.azerothcore.org>, released under GNU GPL v2 license, you may redistribute it and/or modify it under version 2 of the License, or (at your option), any later version.
* Copyright (C) 2021+ WarheadCore <https://github.com/WarheadCore>
*/
#include "Config.h"
#include "Log.h"
#include "StringConvert.h"
#include "StringFormat.h"
#include "Util.h"
#include <mutex>
#include <fstream>
#include <unordered_map>
namespace
{
std::string _filename;
std::vector<std::string> _additonalFiles;
std::vector<std::string> _args;
std::unordered_map<std::string /*name*/, std::string /*value*/> _configOptions;
std::mutex _configLock;
// Check system configs like *server.conf*
bool IsAppConfig(std::string_view fileName)
{
size_t found = fileName.find_first_of("authserver.conf");
if (found != std::string::npos)
{
return true;
}
found = fileName.find_first_of("worldserver.conf");
if (found != std::string::npos)
{
return true;
}
return false;
}
template<typename Format, typename... Args>
inline void PrintError(std::string_view filename, Format&& fmt, Args&& ... args)
{
std::string message = Acore::StringFormat(std::forward<Format>(fmt), std::forward<Args>(args)...);
if (IsAppConfig(filename))
{
printf("%s\n", message.c_str());
}
else
{
LOG_ERROR("server.loading", "%s", message.c_str());
}
}
void AddKey(std::string const& optionName, std::string const& optionKey, bool replace = true)
{
auto const& itr = _configOptions.find(optionName);
if (itr != _configOptions.end())
{
if (!replace)
{
LOG_ERROR("server", "> Config: Option '%s' is exist! Option key - '%s'", optionName.c_str(), itr->second.c_str());
return;
}
_configOptions.erase(optionName);
}
_configOptions.emplace(optionName, optionKey);
}
void ParseFile(std::string const& file)
{
std::ifstream in(file);
if (in.fail())
{
throw ConfigException(Acore::StringFormat("Config::LoadFile: Failed open file '%s'", file.c_str()));
}
uint32 count = 0;
uint32 lineNumber = 0;
std::unordered_map<std::string /*name*/, std::string /*value*/> fileConfigs;
auto IsDuplicateOption = [&](std::string const& confOption)
{
auto const& itr = fileConfigs.find(confOption);
if (itr != fileConfigs.end())
{
PrintError(file, "> Config::LoadFile: Dublicate key name '%s' in config file '%s'", std::string(confOption).c_str(), file.c_str());
return true;
}
return false;
};
while (in.good())
{
lineNumber++;
std::string line;
std::getline(in, line);
// read line error
if (!in.good() && !in.eof())
{
throw ConfigException(Acore::StringFormat("> Config::LoadFile: Failure to read line number %u in file '%s'", lineNumber, file.c_str()));
}
// remove whitespace in line
line = Acore::String::Trim(line, in.getloc());
if (line.empty())
{
continue;
}
// comments
if (line[0] == '#' || line[0] == '[')
{
continue;
}
size_t found = line.find_first_of('#');
if (found != std::string::npos)
{
line = line.substr(0, found);
}
auto const equal_pos = line.find('=');
if (equal_pos == std::string::npos || equal_pos == line.length())
{
PrintError(file, "> Config::LoadFile: Failure to read line number %u in file '%s'. Skip this line", lineNumber, file.c_str());
continue;
}
auto entry = Acore::String::Trim(line.substr(0, equal_pos), in.getloc());
auto value = Acore::String::Trim(line.substr(equal_pos + 1, std::string::npos), in.getloc());
value.erase(std::remove(value.begin(), value.end(), '"'), value.end());
// Skip if 2+ same options in one config file
if (IsDuplicateOption(entry))
{
continue;
}
// Add to temp container
fileConfigs.emplace(entry, value);
count++;
}
// No lines read
if (!count)
throw ConfigException(Acore::StringFormat("Config::LoadFile: Empty file '%s'", file.c_str()));
// Add correct keys if file load without errors
for (auto const& [entry, key] : fileConfigs)
{
AddKey(entry, key);
}
}
bool LoadFile(std::string const& file)
{
try
{
ParseFile(file);
return true;
}
catch (const std::exception& e)
{
PrintError(file, "> %s", e.what());
}
return false;
}
}
bool ConfigMgr::LoadInitial(std::string const& file)
{
std::lock_guard<std::mutex> lock(_configLock);
_configOptions.clear();
return LoadFile(file);
}
bool ConfigMgr::LoadAdditionalFile(std::string file)
{
std::lock_guard<std::mutex> lock(_configLock);
return LoadFile(file);
}
ConfigMgr* ConfigMgr::instance()
{
static ConfigMgr instance;
return &instance;
}
bool ConfigMgr::Reload()
{
if (!LoadAppConfigs())
return false;
return LoadModulesConfigs();
}
template<class T>
T ConfigMgr::GetValueDefault(std::string const& name, T const& def, bool showLogs /*= true*/) const
{
auto const& itr = _configOptions.find(name);
if (itr == _configOptions.end())
{
if (showLogs)
{
LOG_ERROR("server", "> Config: Missing name %s in config, add \"%s = %s\"",
name.c_str(), name.c_str(), Acore::ToString(def).c_str());
}
return def;
}
auto value = Acore::StringTo<T>(itr->second);
if (!value)
{
if (showLogs)
{
LOG_ERROR("server", "> Config: Bad value defined for name '%s', going to use '%s' instead",
name.c_str(), Acore::ToString(def).c_str());
}
return def;
}
return *value;
}
template<>
std::string ConfigMgr::GetValueDefault<std::string>(std::string const& name, std::string const& def, bool showLogs /*= true*/) const
{
auto const& itr = _configOptions.find(name);
if (itr == _configOptions.end())
{
if (showLogs)
{
LOG_ERROR("server", "> Config: Missing name %s in config, add \"%s = %s\"",
name.c_str(), name.c_str(), def.c_str());
}
return def;
}
return itr->second;
}
template<class T>
T ConfigMgr::GetOption(std::string const& name, T const& def, bool showLogs /*= true*/) const
{
return GetValueDefault<T>(name, def, showLogs);
}
template<>
bool ConfigMgr::GetOption<bool>(std::string const& name, bool const& def, bool showLogs /*= true*/) const
{
std::string val = GetValueDefault(name, std::string(def ? "1" : "0"), showLogs);
auto boolVal = Acore::StringTo<bool>(val);
if (!boolVal)
{
if (showLogs)
{
LOG_ERROR("server", "> Config: Bad value defined for name '%s', going to use '%s' instead",
name.c_str(), def ? "true" : "false");
}
return def;
}
return *boolVal;
}
std::vector<std::string> ConfigMgr::GetKeysByString(std::string const& name)
{
std::lock_guard<std::mutex> lock(_configLock);
std::vector<std::string> keys;
for (auto const& [optionName, key] : _configOptions)
if (!optionName.compare(0, name.length(), name))
keys.emplace_back(optionName);
return keys;
}
std::string const& ConfigMgr::GetFilename()
{
std::lock_guard<std::mutex> lock(_configLock);
return _filename;
}
std::vector<std::string> const& ConfigMgr::GetArguments() const
{
return _args;
}
std::string const ConfigMgr::GetConfigPath()
{
std::lock_guard<std::mutex> lock(_configLock);
#if AC_PLATFORM == AC_PLATFORM_WINDOWS
return "configs/";
#else
return std::string(_CONF_DIR) + "/";
#endif
}
void ConfigMgr::Configure(std::string const& initFileName, std::vector<std::string> args, std::string const& modulesConfigList /*= ""*/)
{
_filename = initFileName;
_args = std::move(args);
// Add modules config if exist
if (!modulesConfigList.empty())
{
Tokenizer configFileList(modulesConfigList, ',');
for (auto const& itr : configFileList)
_additonalFiles.emplace_back(std::string(itr));
}
}
bool ConfigMgr::LoadAppConfigs()
{
// #1 - Load init config file .conf.dist
if (!LoadInitial(_filename + ".dist"))
return false;
// #2 - Load .conf file
if (!LoadAdditionalFile(_filename))
return false;
return true;
}
bool ConfigMgr::LoadModulesConfigs()
{
if (_additonalFiles.empty())
return true;
// Start loading module configs
std::string const& moduleConfigPath = GetConfigPath() + "modules/";
bool isExistDefaultConfig = true;
bool isExistDistConfig = true;
for (auto const& distFileName : _additonalFiles)
{
std::string defaultFileName = distFileName;
if (!defaultFileName.empty())
defaultFileName.erase(defaultFileName.end() - 5, defaultFileName.end());
// Load .conf.dist config
if (!LoadAdditionalFile(moduleConfigPath + distFileName))
isExistDistConfig = false;
// Load .conf config
if (!LoadAdditionalFile(moduleConfigPath + defaultFileName))
isExistDefaultConfig = false;
if (isExistDefaultConfig && isExistDistConfig)
_moduleConfigFiles.emplace_back(defaultFileName);
else if (!isExistDefaultConfig && isExistDistConfig)
_moduleConfigFiles.emplace_back(distFileName);
}
// If module configs not exist - no load
return !_moduleConfigFiles.empty();
}
void ConfigMgr::PrintLoadedModulesConfigs()
{
// Print modules configurations
LOG_INFO("server", " ");
LOG_INFO("server", "Using modules configuration:");
for (auto const& itr : _moduleConfigFiles)
LOG_INFO("server", "> %s", itr.c_str());
LOG_INFO("server", " ");
}
/*
* Deprecated geters. This geters will be deleted
*/
// @deprecated DO NOT USE - use GetOption<std::string> instead.
std::string ConfigMgr::GetStringDefault(std::string const& name, const std::string& def, bool showLogs /*= true*/)
{
return GetOption<std::string>(name, def, showLogs);
}
// @deprecated DO NOT USE - use GetOption<bool> instead.
bool ConfigMgr::GetBoolDefault(std::string const& name, bool def, bool showLogs /*= true*/)
{
return GetOption<bool>(name, def, showLogs);
}
// @deprecated DO NOT USE - use GetOption<int32> instead.
int ConfigMgr::GetIntDefault(std::string const& name, int def, bool showLogs /*= true*/)
{
return GetOption<int32>(name, def, showLogs);
}
// @deprecated DO NOT USE - use GetOption<float> instead.
float ConfigMgr::GetFloatDefault(std::string const& name, float def, bool showLogs /*= true*/)
{
return GetOption<float>(name, def, showLogs);
}
/*
* End deprecated geters
*/
#define TEMPLATE_CONFIG_OPTION(__typename) \
template __typename ConfigMgr::GetOption<__typename>(std::string const& name, __typename const& def, bool showLogs /*= true*/) const;
TEMPLATE_CONFIG_OPTION(std::string)
TEMPLATE_CONFIG_OPTION(uint8)
TEMPLATE_CONFIG_OPTION(int8)
TEMPLATE_CONFIG_OPTION(uint16)
TEMPLATE_CONFIG_OPTION(int16)
TEMPLATE_CONFIG_OPTION(uint32)
TEMPLATE_CONFIG_OPTION(int32)
TEMPLATE_CONFIG_OPTION(uint64)
TEMPLATE_CONFIG_OPTION(int64)
TEMPLATE_CONFIG_OPTION(float)
#undef TEMPLATE_CONFIG_OPTION