feat: implement maintain mode (opentibiabr#1791)

Introduces functionality to enable maintenance mode, restricting user access and displaying a customizable message during server maintenance or update periods.
marcusvcj · Nov 8, 2023 · 0249c80 · 0249c80
1 parent 2137f6f
commit 0249c80
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 6 deletions.
diff --git a/config.lua.dist b/config.lua.dist
@@ -12,6 +12,15 @@ coreDirectory = "data"
 -- NOTE: Will only display logs with level higher or equal the one set.
 logLevel = "info"
 
+--- Toggles the server's maintenance mode.
+-- When enabled, it restricts user access and indicates maintenance operations.
+-- @field [parent=#global] #boolean toggleMaintainMode false by default, set to true to enable maintenance mode.
+toggleMaintainMode = false
+--- Message displayed during maintenance mode.
+-- Should inform the expected downtime or resumption details succinctly.
+-- @field [parent=#global] #string maintainModeMessage an empty string by default, set a custom message if needed.
+maintainModeMessage = ""
+
 -- Combat settings
 -- NOTE: valid values for worldType are: "pvp", "no-pvp" and "pvp-enforced"
 worldType = "pvp"

diff --git a/src/canary_server.cpp b/src/canary_server.cpp
@@ -89,8 +89,14 @@ int CanaryServer::run() {
 
 				g_game().start(&serviceManager);
 				g_game().setGameState(GAME_STATE_NORMAL);
-
-				g_webhook().sendMessage("Server is now online", "Server has successfully started.", WEBHOOK_COLOR_ONLINE);
+				if (g_configManager().getBoolean(TOGGLE_MAINTAIN_MODE)) {
+					g_game().setGameState(GAME_STATE_CLOSED);
+					g_logger().warn("Initialized in maintain mode!");
+					g_webhook().sendMessage("Server is now online", "The server is now online. Access is currently restricted to administrators only.", WEBHOOK_COLOR_ONLINE);
+				} else {
+					g_game().setGameState(GAME_STATE_NORMAL);
+					g_webhook().sendMessage("Server is now online", "Server has successfully started.", WEBHOOK_COLOR_ONLINE);
+				}
 
 				loaderStatus = LoaderStatus::LOADED;
 			} catch (FailedToInitializeCanary &err) {

diff --git a/src/config/config_definitions.hpp b/src/config/config_definitions.hpp
@@ -82,16 +82,14 @@ enum booleanConfig_t {
 	RESET_SESSIONS_ON_STARTUP,
 	TOGGLE_WHEELSYSTEM,
 	TOGGLE_ATTACK_SPEED_ONFIST,
-
 	VIP_SYSTEM_ENABLED,
 	VIP_AUTOLOOT_VIP_ONLY,
 	VIP_STAY_ONLINE,
-
 	REWARD_CHEST_COLLECT_ENABLED,
 	TOGGLE_MOUNT_IN_PZ,
 	TOGGLE_HOUSE_TRANSFER_ON_SERVER_RESTART,
-
 	TOGGLE_RECEIVE_REWARD,
+	TOGGLE_MAINTAIN_MODE,
 
 	LAST_BOOLEAN_CONFIG
 };
@@ -128,6 +126,7 @@ enum stringConfig_t {
 	FORGE_FIENDISH_INTERVAL_TIME,
 	TIBIADROME_CONCOCTION_TICK_TYPE,
 	M_CONST,
+	MAINTAIN_MODE_MESSAGE,
 
 	LAST_STRING_CONFIG
 };

diff --git a/src/config/configmanager.cpp b/src/config/configmanager.cpp
@@ -99,6 +99,8 @@ bool ConfigManager::load() {
 		boolean[BIND_ONLY_GLOBAL_ADDRESS] = getGlobalBoolean(L, "bindOnlyGlobalAddress", false);
 		boolean[OPTIMIZE_DATABASE] = getGlobalBoolean(L, "startupDatabaseOptimization", true);
 		boolean[TOGGLE_MAP_CUSTOM] = getGlobalBoolean(L, "toggleMapCustom", true);
+		boolean[TOGGLE_MAINTAIN_MODE] = getGlobalBoolean(L, "toggleMaintainMode", false);
+		string[MAINTAIN_MODE_MESSAGE] = getGlobalString(L, "maintainModeMessage", "");
 
 		string[IP] = getGlobalString(L, "ip", "127.0.0.1");
 		string[MAP_NAME] = getGlobalString(L, "mapName", "canary");

diff --git a/src/server/network/protocol/protocolgame.cpp b/src/server/network/protocol/protocolgame.cpp
@@ -498,7 +498,12 @@ void ProtocolGame::login(const std::string &name, uint32_t accountId, OperatingS
 
 		if (g_game().getGameState() == GAME_STATE_CLOSED && !player->hasFlag(PlayerFlags_t::CanAlwaysLogin)) {
 			g_game().removePlayerUniqueLogin(player);
-			disconnectClient("Server is currently closed.\nPlease try again later.");
+			auto maintainMessage = g_configManager().getString(MAINTAIN_MODE_MESSAGE);
+			if (!maintainMessage.empty()) {
+				disconnectClient(maintainMessage);
+			} else {
+				disconnectClient("Server is currently closed.\nPlease try again later.");
+			}
 			return;
 		}