feat: add /restart command (#372)

* feat: add /restart command for server restarts

The command writes an expirable timestamp marker file before triggering
shutdown. The Python CLI wrapper detects the marker and relaunches the
server process, ignoring stale markers older than 60 seconds.

* fix: restrict /restart command to console only

Author: wu-vincent

endstone/cli/__init__.py

@@ -98,9 +98,25 @@ def main(ctx: click.Context, server_folder: str, no_confirm: bool, remote: str,
         raise NotImplementedError(f"{system} is not supported.")
 
     bootstrap = cls(server_folder=server_folder, no_confirm=no_confirm, remote=remote, interactive=interactive)
-    exit_code = bootstrap.run()
-    if exit_code != 0:
-        logger.error(f"Server exited with non-zero code {exit_code}.")
-        time.sleep(2)
-
-    sys.exit(exit_code)
+    restart_marker = bootstrap.server_path / ".endstone_restart"
+
+    while True:
+        exit_code = bootstrap.run()
+
+        if restart_marker.exists():
+            try:
+                timestamp = float(restart_marker.read_text().strip())
+                elapsed = time.time() - timestamp
+                if elapsed < 60:
+                    restart_marker.unlink()
+                    logger.info("Server is restarting...")
+                    continue
+            except (ValueError, OSError):
+                pass
+            restart_marker.unlink(missing_ok=True)
+
+        if exit_code != 0:
+            logger.error(f"Server exited with non-zero code {exit_code}.")
+            time.sleep(2)
+
+        sys.exit(exit_code)

src/endstone/core/CMakeLists.txt

@@ -61,6 +61,7 @@ add_library(endstone_core
         command/defaults/pardon_ip_command.cpp
         command/defaults/plugins_command.cpp
         command/defaults/reload_command.cpp
+        command/defaults/restart_command.cpp
         command/defaults/seed_command.cpp
         command/defaults/status_command.cpp
         command/defaults/version_command.cpp

src/endstone/core/command/command_map.cpp

@@ -32,6 +32,7 @@
 #include "endstone/core/command/defaults/pardon_ip_command.h"
 #include "endstone/core/command/defaults/plugins_command.h"
 #include "endstone/core/command/defaults/reload_command.h"
+#include "endstone/core/command/defaults/restart_command.h"
 #include "endstone/core/command/defaults/seed_command.h"
 #include "endstone/core/command/defaults/status_command.h"
 #include "endstone/core/command/defaults/version_command.h"
@@ -148,6 +149,7 @@ void EndstoneCommandMap::setDefaultCommands()
     registerCommand(std::make_unique<PardonIpCommand>());
     registerCommand(std::make_unique<PluginsCommand>());
     registerCommand(std::make_unique<ReloadCommand>());
+    registerCommand(std::make_unique<RestartCommand>());
     registerCommand(std::make_unique<SeedCommand>());
     registerCommand(std::make_unique<StatusCommand>());
     registerCommand(std::make_unique<VersionCommand>());

src/endstone/core/command/defaults/restart_command.cpp

@@ -0,0 +1,57 @@
+// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "endstone/core/command/defaults/restart_command.h"
+
+#include <chrono>
+#include <filesystem>
+#include <fstream>
+
+#include <entt/entt.hpp>
+
+#include "endstone/color_format.h"
+#include "endstone/core/server.h"
+
+namespace endstone::core {
+
+RestartCommand::RestartCommand() : EndstoneCommand("restart")
+{
+    setDescription("Restarts the server.");
+    setUsages("/restart");
+    setPermissions("endstone.command.restart");
+}
+
+bool RestartCommand::execute(CommandSender &sender, const std::vector<std::string> &args) const
+{
+    if (!testPermission(sender)) {
+        return true;
+    }
+
+    auto &server = entt::locator<EndstoneServer>::value();
+    server.broadcast(ColorFormat::Yellow + "Server is restarting...", Server::BroadcastChannelAdmin);
+
+    // Write a restart marker file with the current timestamp
+    auto marker_path = std::filesystem::current_path() / ".endstone_restart";
+    std::ofstream marker(marker_path);
+    if (marker.is_open()) {
+        auto now = std::chrono::system_clock::now();
+        auto epoch = std::chrono::duration_cast<std::chrono::seconds>(now.time_since_epoch()).count();
+        marker << epoch;
+    }
+
+    server.shutdown();
+    return true;
+}
+
+}  // namespace endstone::core

src/endstone/core/command/defaults/restart_command.h

@@ -0,0 +1,27 @@
+// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#include "endstone/core/command/endstone_command.h"
+
+namespace endstone::core {
+
+class RestartCommand : public EndstoneCommand {
+public:
+    RestartCommand();
+    bool execute(CommandSender &sender, const std::vector<std::string> &args) const override;
+};
+
+}  // namespace endstone::core

src/endstone/core/permissions/default_permissions.cpp

@@ -105,6 +105,8 @@ Permission &CommandPermissions::registerPermissions(Permission &parent)
     registerPermission(PREFIX + "reload", "reload",
                        "Allows the user to reload the configuration and plugins of the server",
                        PermissionDefault::Operator, commands);
+    registerPermission(PREFIX + "restart", "restart", "Allows the user to restart the server",
+                       PermissionDefault::Console, commands);
     registerPermission(PREFIX + "seed", "seed", "Allows the user to view the seed of the level.",
                        PermissionDefault::Operator, commands);
     registerPermission(PREFIX + "status", "status", "Allows the user to view the status of the server",