aboutsummaryrefslogtreecommitdiff
path: root/Minecraft.Server/Console/ServerCliEngine.cpp
diff options
context:
space:
mode:
authorkuwa <kuwa.com3@gmail.com>2026-03-15 16:32:50 +0900
committerGitHub <noreply@github.com>2026-03-15 02:32:50 -0500
commitf483074cd2ff2cc9e9c3ef1df4430d4a65d1fb2a (patch)
tree9cd094e38b2259ea913fecb7d6fde16046277182 /Minecraft.Server/Console/ServerCliEngine.cpp
parent4d200a589dd3d0a8424eaef6c0d6fd454d16e411 (diff)
Dedicated Server Software - Minecraft.Server.exe (#498)
* add: Dedicated Server implementation - Introduced `ServerMain.cpp` for the dedicated server logic, handling command-line arguments, server initialization, and network management. - Created `postbuild_server.ps1` script for post-build tasks, including copying necessary resources and DLLs for the dedicated server. - Added `CopyServerAssets.cmake` to manage the copying of server assets during the build process, ensuring required files are available for the dedicated server. - Defined project filters in `Minecraft.Server.vcxproj.filters` for better organization of server-related files. * add: refactor world loader & add server properties - Introduced ServerLogger for logging startup steps and world I/O operations. - Implemented ServerProperties for loading and saving server configuration from `server.properties`. - Added WorldManager to handle world loading and creation based on server properties. - Updated ServerMain to integrate server properties loading and world management. - Enhanced project files to include new source and header files for the server components. * update: implement enhanced logging functionality with configurable log levels * update: update keyboard and mouse input initialization 1dc8a005ed111463c22c17b487e5ec8a3e2d30f3 * fix: change virtual screen resolution to 1920x1080(HD) Since 31881af56936aeef38ff322b975fd0 , `skinHud.swf` for 720 is not included in `MediaWindows64.arc`, the app crashes unless the virtual screen is set to HD. * fix: dedicated server build settings for miniaudio migration and missing sources - remove stale Windows64 Miles (mss64) link/copy references from server build - add Common/Filesystem/Filesystem.cpp to Minecraft.Server.vcxproj - add Windows64/PostProcesser.cpp to Minecraft.Server.vcxproj - fix unresolved externals (PostProcesser::*, FileExists) in dedicated server build * update: changed the virtual screen to 720p Since the crash caused by the 720p `skinHud.swf` not being included in `MediaWindows64.arc` has been resolved, switching back to 720p to reduce resource usage. * add: add Docker support for Dedicated Server add with entrypoint and build scripts * fix: add initial save for newly created worlds in dedicated server on the server side, I fixed the behavior introduced after commit aadb511, where newly created worlds are intentionally not saved to disk immediately. * update: add basically all configuration options that are implemented in the classes to `server.properties` * update: add LAN advertising configuration for server.properties LAN-Discovery, which isn’t needed in server mode and could potentially be a security risk, has also been disabled(only server mode). * add: add implementing interactive command line using linenoise - Integrated linenoise library for line editing and completion in the server console. - Updated ServerLogger to handle external writes safely during logging. - Modified ServerMain to initialize and manage the ServerCli for command input. - The implementation is separate from everything else, so it doesn't affect anything else. - The command input section and execution section are separated into threads. * update: enhance command line completion with predictive hints Like most command line tools, it highlights predictions in gray. * add: implement `StringUtils` for string manipulation and refactor usages Unified the scattered utility functions. * fix: send DisconnectPacket on shutdown and fix Win64 recv-thread teardown race Before this change, server/host shutdown closed sockets directly in ServerConnection::stop(), which bypassed the normal disconnect flow. As a result, clients could be dropped without receiving a proper DisconnectPacket during stop/kill/world-close paths. Also, WinsockNetLayer::Shutdown() could destroy synchronization objects while host-side recv threads were still exiting, causing a crash in RecvThreadProc (access violation on world close in host mode). * fix: return client to menus when Win64 host connection drops - Add client-side host disconnect handling in CPlatformNetworkManagerStub::DoWork() for _WINDOWS64. - When in QNET_STATE_GAME_PLAY as a non-host and WinsockNetLayer::IsConnected() becomes false, trigger g_NetworkManager.HandleDisconnect(false) to enter the normal disconnect/UI flow. - Use m_bLeaveGameOnTick as a one-shot guard to prevent repeated disconnect handling while the link remains down. - Reset m_bLeaveGameOnTick on LeaveGame(), HostGame(), and JoinGame() to avoid stale state across sessions. * update: converted Japanese comments to English * add: create `Minecraft.Server` developer guide in English and Japanese * update: add note about issue * add: add `nlohmann/json` json lib * add: add FileUtils Moved file operations to `utils`. * add: Dedicated Server BAN access manager with persistent player and IP bans - add Access frontend that publishes thread-safe ban manager snapshots for dedicated server use - add BanManager storage for banned-players.json and banned-ips.json with load/save/update flows - add persistent player and IP ban checks during dedicated server connection handling - add UTF-8 BOM-safe JSON parsing and shared file helpers backed by nlohmann/json - add Unicode-safe ban file read/write and safer atomic replacement behavior on Windows - add active-ban snapshot APIs and expiry-aware filtering for expires metadata - add RAII-based dedicated access shutdown handling during server startup and teardown * update: changed file read/write operations to use `FileUtils`. - As a side effect, saving has become faster! * fix: Re-added the source that had somehow disappeared. * add: significantly improved the dedicated server logging system - add ServerLogManager to Minecraft.Server as the single entry point for dedicated-server log output - forward CMinecraftApp logger output to the server logger when running with g_Win64DedicatedServer - add named network logs for incoming, accepted, rejected, and disconnected connections - cache connection metadata by smallId so player name and remote IP remain available for disconnect logs - keep Minecraft.Client changes minimal by using lightweight hook points and handling log orchestration on the server side * fix: added the updated library source * add: add `ban` and `pardon` commands for Player and IP * fix: fix stop command shutdown process add dedicated server shutdown request handling * fix: fixed the save logic during server shutdown Removed redundant repeated saves and eliminated the risks of async writes. * update: added new sever files to Docker entrypoint * fix: replace shutdown flag with atomic variable for thread safety * update: update Dedicated Server developer guide English is machine translated. Please forgive me. * update: check for the existence of `GameHDD` and create * add: add Whitelist to Dedicated Server * refactor: clean up and refactor the code - unify duplicated implementations that were copied repeatedly - update outdated patterns to more modern ones * fix: include UI header (new update fix) * fix: fix the detection range for excessive logging `getHighestNonEmptyY()` returning `-1` occurs normally when the chunk is entirely air. The caller (`Minecraft.World/LevelChunk.cpp:2400`) normalizes `-1` to `0`. * update: add world size config to dedicated server properties * update: update README add explanation of `server.properties` & launch arguments * update: add nightly release workflow for dedicated server and client builds to Actions * fix: update name for workflow * add random seed generation * add: add Docker nightly workflow for Dedicated Server publish to GitHub Container Registry * fix: ghost player when clients disconnect out of order #4 * fix: fix 7zip option * fix: fix Docker workflow for Dedicated Server artifact handling * add: add no build Dedicated Server startup scripts and Docker Compose * update: add README for Docker Dedicated Server setup with no local build * refactor: refactor command path structure As the number of commands has increased and become harder to navigate, each command has been organized into separate folders. * update: support stream(file stdin) input mode for server CLI Support for the stream (file stdin) required when attaching a tty to a Docker container on Linux. * add: add new CLI Console Commands for Dedicated Server Most of these commands are executed using the command dispatcher implemented on the `Minecraft.World` side. When registering them with the dispatcher, the sender uses a permission-enabled configuration that treats the CLI as a player. - default game. - enchant - experience. - give - kill(currently, getting a permission error for some reason) - time - weather. - update tp & gamemode command * fix: change player map icon to random select * update: increase the player limit * add: restore the basic anti-cheat implementation and add spawn protection Added the following anti-cheat measures and add spawn protection to `server.properties`. - instant break - speed - reach * fix: fix Docker image tag --------- Co-authored-by: sylvessa <225480449+sylvessa@users.noreply.github.com>
Diffstat (limited to 'Minecraft.Server/Console/ServerCliEngine.cpp')
-rw-r--r--Minecraft.Server/Console/ServerCliEngine.cpp395
1 files changed, 395 insertions, 0 deletions
diff --git a/Minecraft.Server/Console/ServerCliEngine.cpp b/Minecraft.Server/Console/ServerCliEngine.cpp
new file mode 100644
index 00000000..82bbdcc8
--- /dev/null
+++ b/Minecraft.Server/Console/ServerCliEngine.cpp
@@ -0,0 +1,395 @@
+#include "stdafx.h"
+
+#include "ServerCliEngine.h"
+
+#include "ServerCliParser.h"
+#include "ServerCliRegistry.h"
+#include "commands\IServerCliCommand.h"
+#include "commands\ban\CliCommandBan.h"
+#include "commands\ban-ip\CliCommandBanIp.h"
+#include "commands\ban-list\CliCommandBanList.h"
+#include "commands\defaultgamemode\CliCommandDefaultGamemode.h"
+#include "commands\enchant\CliCommandEnchant.h"
+#include "commands\experience\CliCommandExperience.h"
+#include "commands\gamemode\CliCommandGamemode.h"
+#include "commands\give\CliCommandGive.h"
+#include "commands\help\CliCommandHelp.h"
+#include "commands\kill\CliCommandKill.h"
+#include "commands\list\CliCommandList.h"
+#include "commands\pardon\CliCommandPardon.h"
+#include "commands\pardon-ip\CliCommandPardonIp.h"
+#include "commands\stop\CliCommandStop.h"
+#include "commands\time\CliCommandTime.h"
+#include "commands\tp\CliCommandTp.h"
+#include "commands\weather\CliCommandWeather.h"
+#include "commands\whitelist\CliCommandWhitelist.h"
+#include "..\Common\StringUtils.h"
+#include "..\ServerShutdown.h"
+#include "..\ServerLogger.h"
+#include "..\..\Minecraft.Client\MinecraftServer.h"
+#include "..\..\Minecraft.Client\PlayerList.h"
+#include "..\..\Minecraft.Client\ServerPlayer.h"
+#include "..\..\Minecraft.World\CommandDispatcher.h"
+#include "..\..\Minecraft.World\CommandSender.h"
+#include "..\..\Minecraft.World\LevelSettings.h"
+#include "..\..\Minecraft.World\StringHelpers.h"
+
+#include <stdlib.h>
+#include <unordered_set>
+
+namespace ServerRuntime
+{
+
+ /**
+ * Create an authorized Sender to make the CLI appear as a user.
+ * The return value can also be used to display logs.
+ */
+ namespace
+ {
+ class ServerCliConsoleCommandSender : public CommandSender
+ {
+ public:
+ explicit ServerCliConsoleCommandSender(const ServerCliEngine *engine)
+ : m_engine(engine)
+ {
+ }
+
+ void sendMessage(const wstring &message, ChatPacket::EChatPacketMessage type, int customData, const wstring &additionalMessage) override
+ {
+ (void)type;
+ (void)customData;
+ (void)additionalMessage;
+ if (m_engine == nullptr)
+ {
+ return;
+ }
+
+ m_engine->LogInfo(StringUtils::WideToUtf8(message));
+ }
+
+ bool hasPermission(EGameCommand command) override
+ {
+ (void)command;
+ return true;
+ }
+
+ private:
+ const ServerCliEngine *m_engine;
+ };
+ }
+
+ ServerCliEngine::ServerCliEngine()
+ : m_registry(new ServerCliRegistry())
+ , m_consoleSender(std::make_shared<ServerCliConsoleCommandSender>(this))
+ {
+ RegisterDefaultCommands();
+ }
+
+ ServerCliEngine::~ServerCliEngine()
+ {
+ }
+
+ void ServerCliEngine::RegisterDefaultCommands()
+ {
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandHelp()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandStop()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandList()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandBan()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandBanIp()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandPardon()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandPardonIp()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandBanList()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandWhitelist()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandTp()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandTime()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandWeather()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandGive()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandEnchant()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandKill()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandGamemode()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandDefaultGamemode()));
+ m_registry->Register(std::unique_ptr<IServerCliCommand>(new CliCommandExperience()));
+ }
+
+ void ServerCliEngine::EnqueueCommandLine(const std::string &line)
+ {
+ std::lock_guard<std::mutex> lock(m_queueMutex);
+ m_pendingLines.push(line);
+ }
+
+ void ServerCliEngine::Poll()
+ {
+ for (;;)
+ {
+ std::string line;
+ {
+ // Keep the lock scope minimal: dequeue only, execute outside.
+ std::lock_guard<std::mutex> lock(m_queueMutex);
+ if (m_pendingLines.empty())
+ {
+ break;
+ }
+ line = m_pendingLines.front();
+ m_pendingLines.pop();
+ }
+
+ ExecuteCommandLine(line);
+ }
+ }
+
+ bool ServerCliEngine::ExecuteCommandLine(const std::string &line)
+ {
+ // Normalize user input before parsing (trim + optional leading slash).
+ std::wstring wide = trimString(StringUtils::Utf8ToWide(line));
+ if (wide.empty())
+ {
+ return true;
+ }
+
+ std::string normalizedLine = StringUtils::WideToUtf8(wide);
+ if (!normalizedLine.empty() && normalizedLine[0] == '/')
+ {
+ normalizedLine = normalizedLine.substr(1);
+ }
+
+ ServerCliParsedLine parsed = ServerCliParser::Parse(normalizedLine);
+ if (parsed.tokens.empty())
+ {
+ return true;
+ }
+
+ IServerCliCommand *command = m_registry->FindMutable(parsed.tokens[0]);
+ if (command == NULL)
+ {
+ LogWarn("Unknown command: " + parsed.tokens[0]);
+ return false;
+ }
+
+ return command->Execute(parsed, this);
+ }
+
+ void ServerCliEngine::BuildCompletions(const std::string &line, std::vector<std::string> *out) const
+ {
+ if (out == NULL)
+ {
+ return;
+ }
+
+ out->clear();
+ ServerCliCompletionContext context = ServerCliParser::BuildCompletionContext(line);
+ bool slashPrefixedCommand = false;
+ std::string commandToken;
+ if (!context.parsed.tokens.empty())
+ {
+ // Completion accepts both "tp" and "/tp" style command heads.
+ commandToken = context.parsed.tokens[0];
+ if (!commandToken.empty() && commandToken[0] == '/')
+ {
+ commandToken = commandToken.substr(1);
+ slashPrefixedCommand = true;
+ }
+ }
+
+ if (context.currentTokenIndex == 0)
+ {
+ std::string prefix = context.prefix;
+ if (!prefix.empty() && prefix[0] == '/')
+ {
+ prefix = prefix.substr(1);
+ slashPrefixedCommand = true;
+ }
+
+ std::string linePrefix = context.linePrefix;
+ if (slashPrefixedCommand && linePrefix.empty())
+ {
+ // Preserve leading slash when user started with "/".
+ linePrefix = "/";
+ }
+
+ m_registry->SuggestCommandNames(prefix, linePrefix, out);
+ }
+ else
+ {
+ const IServerCliCommand *command = m_registry->Find(commandToken);
+ if (command != NULL)
+ {
+ command->Complete(context, this, out);
+ }
+ }
+
+ std::unordered_set<std::string> seen;
+ std::vector<std::string> unique;
+ for (size_t i = 0; i < out->size(); ++i)
+ {
+ // Remove duplicates while keeping first-seen ordering.
+ if (seen.insert((*out)[i]).second)
+ {
+ unique.push_back((*out)[i]);
+ }
+ }
+ out->swap(unique);
+ }
+
+ void ServerCliEngine::LogInfo(const std::string &message) const
+ {
+ LogInfof("console", "%s", message.c_str());
+ }
+
+ void ServerCliEngine::LogWarn(const std::string &message) const
+ {
+ LogWarnf("console", "%s", message.c_str());
+ }
+
+ void ServerCliEngine::LogError(const std::string &message) const
+ {
+ LogErrorf("console", "%s", message.c_str());
+ }
+
+ void ServerCliEngine::RequestShutdown() const
+ {
+ RequestDedicatedServerShutdown();
+ }
+
+ std::vector<std::string> ServerCliEngine::GetOnlinePlayerNamesUtf8() const
+ {
+ std::vector<std::string> result;
+ MinecraftServer *server = MinecraftServer::getInstance();
+ if (server == NULL)
+ {
+ return result;
+ }
+
+ PlayerList *players = server->getPlayers();
+ if (players == NULL)
+ {
+ return result;
+ }
+
+ for (size_t i = 0; i < players->players.size(); ++i)
+ {
+ std::shared_ptr<ServerPlayer> player = players->players[i];
+ if (player != NULL)
+ {
+ result.push_back(StringUtils::WideToUtf8(player->getName()));
+ }
+ }
+
+ return result;
+ }
+
+ std::shared_ptr<ServerPlayer> ServerCliEngine::FindPlayerByNameUtf8(const std::string &name) const
+ {
+ MinecraftServer *server = MinecraftServer::getInstance();
+ if (server == NULL)
+ {
+ return nullptr;
+ }
+
+ PlayerList *players = server->getPlayers();
+ if (players == NULL)
+ {
+ return nullptr;
+ }
+
+ std::wstring target = StringUtils::Utf8ToWide(name);
+ for (size_t i = 0; i < players->players.size(); ++i)
+ {
+ std::shared_ptr<ServerPlayer> player = players->players[i];
+ if (player != NULL && equalsIgnoreCase(player->getName(), target))
+ {
+ return player;
+ }
+ }
+
+ return nullptr;
+ }
+
+ void ServerCliEngine::SuggestPlayers(const std::string &prefix, const std::string &linePrefix, std::vector<std::string> *out) const
+ {
+ std::vector<std::string> players = GetOnlinePlayerNamesUtf8();
+ std::string loweredPrefix = StringUtils::ToLowerAscii(prefix);
+ for (size_t i = 0; i < players.size(); ++i)
+ {
+ std::string loweredName = StringUtils::ToLowerAscii(players[i]);
+ if (loweredName.compare(0, loweredPrefix.size(), loweredPrefix) == 0)
+ {
+ out->push_back(linePrefix + players[i]);
+ }
+ }
+ }
+
+ void ServerCliEngine::SuggestGamemodes(const std::string &prefix, const std::string &linePrefix, std::vector<std::string> *out) const
+ {
+ static const char *kModes[] = { "survival", "creative", "s", "c", "0", "1" };
+ std::string loweredPrefix = StringUtils::ToLowerAscii(prefix);
+ for (size_t i = 0; i < sizeof(kModes) / sizeof(kModes[0]); ++i)
+ {
+ std::string candidate = kModes[i];
+ std::string loweredCandidate = StringUtils::ToLowerAscii(candidate);
+ if (loweredCandidate.compare(0, loweredPrefix.size(), loweredPrefix) == 0)
+ {
+ out->push_back(linePrefix + candidate);
+ }
+ }
+ }
+
+ GameType *ServerCliEngine::ParseGamemode(const std::string &token) const
+ {
+ std::string lowered = StringUtils::ToLowerAscii(token);
+ if (lowered == "survival" || lowered == "s" || lowered == "0")
+ {
+ return GameType::SURVIVAL;
+ }
+ if (lowered == "creative" || lowered == "c" || lowered == "1")
+ {
+ return GameType::CREATIVE;
+ }
+
+ char *end = NULL;
+ long id = strtol(lowered.c_str(), &end, 10);
+ if (end != NULL && *end == 0)
+ {
+ // Numeric fallback supports extended ids handled by level settings.
+ return LevelSettings::validateGameType((int)id);
+ }
+
+ return NULL;
+ }
+
+ bool ServerCliEngine::DispatchWorldCommand(EGameCommand command, byteArray commandData, const std::shared_ptr<CommandSender> &sender) const
+ {
+ MinecraftServer *server = MinecraftServer::getInstance();
+ if (server == NULL)
+ {
+ LogWarn("MinecraftServer instance is not available.");
+ return false;
+ }
+
+ CommandDispatcher *dispatcher = server->getCommandDispatcher();
+ if (dispatcher == NULL)
+ {
+ LogWarn("Command dispatcher is not available.");
+ return false;
+ }
+
+ std::shared_ptr<CommandSender> commandSender = sender;
+ if (commandSender == nullptr)
+ {
+ // fall back to console sender if caller did not provide one
+ commandSender = m_consoleSender;
+ }
+ if (commandSender == nullptr)
+ {
+ LogWarn("No command sender is available.");
+ return false;
+ }
+
+ dispatcher->performCommand(commandSender, command, commandData);
+ return true;
+ }
+
+ const ServerCliRegistry &ServerCliEngine::Registry() const
+ {
+ return *m_registry;
+ }
+}