Skip to content

Add sanity checks for config options #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add sanity checks for config options #1097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions Server/Components/LegacyNetwork/legacy_network_impl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,6 +816,89 @@ void RakNetLegacyNetwork::start()

IConfig& config = core->getConfig();
int maxPlayers = *config.getInt("max_players");
int maxBots = *config.getInt("max_bots");

// Sanity checks for config options
if (maxBots >= maxPlayers)
{
core->logLn(LogLevel::Warning, "The 'max_bots' option is greater than or equal to 'max_players' option. Players may not be able to join.");
}

if (!*config.getBool("enable_query") && *config.getBool("announce"))
{
core->logLn(LogLevel::Warning, "Query is disabled but announce is enabled. The server will not be visible in the master list.");
}

// Check for negative values that should not be negative
int playerTimeout = *config.getInt("network.player_timeout");
if (playerTimeout < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.player_timeout' (%d) has been corrected to positive.", playerTimeout);
config.setInt("network.player_timeout", -playerTimeout);
}

int minConnectionTime = *config.getInt("network.minimum_connection_time");
if (minConnectionTime < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.minimum_connection_time' (%d) has been corrected to positive.", minConnectionTime);
config.setInt("network.minimum_connection_time", -minConnectionTime);
}

int messagesLimit = *config.getInt("network.messages_limit");
if (messagesLimit < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.messages_limit' (%d) has been corrected to positive.", messagesLimit);
config.setInt("network.messages_limit", -messagesLimit);
}

int messageHoleLimit = *config.getInt("network.message_hole_limit");
if (messageHoleLimit < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.message_hole_limit' (%d) has been corrected to positive.", messageHoleLimit);
config.setInt("network.message_hole_limit", -messageHoleLimit);
}

int acksLimit = *config.getInt("network.acks_limit");
if (acksLimit < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.acks_limit' (%d) has been corrected to positive.", acksLimit);
config.setInt("network.acks_limit", -acksLimit);
}

int limitsBanTime = *config.getInt("network.limits_ban_time");
if (limitsBanTime < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.limits_ban_time' (%d) has been corrected to positive.", limitsBanTime);
config.setInt("network.limits_ban_time", -limitsBanTime);
}

int gameWeather = *config.getInt("game.weather");
if (gameWeather < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'game.weather' (%d) has been corrected to positive.", gameWeather);
config.setInt("game.weather", -gameWeather);
}

int gameTime = *config.getInt("game.time");
if (gameTime < 0)
{
int correctedTime = (-gameTime) % 24;
core->logLn(LogLevel::Warning, "Negative value for 'game.time' (%d) has been corrected to %d.", gameTime, correctedTime);
config.setInt("game.time", correctedTime);
}
else if (gameTime >= 24)
{
int correctedTime = gameTime % 24;
core->logLn(LogLevel::Warning, "Value for 'game.time' (%d) exceeds 24 hours, has been corrected to %d.", gameTime, correctedTime);
config.setInt("game.time", correctedTime);
}

int cookieReseedTime = *config.getInt("network.cookie_reseed_time");
if (cookieReseedTime < 0)
{
core->logLn(LogLevel::Warning, "Negative value for 'network.cookie_reseed_time' (%d) has been corrected to positive.", cookieReseedTime);
config.setInt("network.cookie_reseed_time", -cookieReseedTime);
}

int port = *config.getInt("network.port");
int sleep = static_cast<int>(*config.getFloat("sleep"));
Expand Down
6 changes: 5 additions & 1 deletion Server/Components/Pawn/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,11 @@ class PawnComponent final : public IPawnComponent, public CoreEventHandler, publ
ghc::filesystem::path scriptfilesPath = ghc::filesystem::absolute("scriptfiles");
if (!ghc::filesystem::exists(scriptfilesPath) || !ghc::filesystem::is_directory(scriptfilesPath))
{
ghc::filesystem::create_directory(scriptfilesPath);
core->logLn(LogLevel::Warning, "Cannot access 'scriptfiles' directory. Attempting to create one.");
if (!ghc::filesystem::create_directory(scriptfilesPath))
{
core->logLn(LogLevel::Error, "Cannot create 'scriptfiles' directory. Some scripts may not work correctly.");
}
}

#if defined(GHC_USE_WCHAR_T)
Expand Down