Merge pull request #34 from xieyuen/dev/kill_server

KillServer v1.0.0

Author: xieyuen

src/KillServer/README.md

@@ -5,26 +5,22 @@
 > [!WARNING]
 > 此插件使用 [dowhen](http://github.com/gaogaotiantian/dowhen/) 模块实现, 可能不够稳定
 
+> [!TIP]
+> BUG Report: [GitHub issues](https://github.com/xieyuen/MCDR-Plugins/issues/new)
+
 ## 介绍
 
-对于下面的两种情况(实际可能还有更多适用的情况):
+对于下面的情况(实际可能还有更多适用的情况):
 
 1. Fabric 服务器卡死不关闭
-   - [MCDReforged/MCDReforged#150](https://github.com/MCDReforged/MCDReforged/issues/150)
-   - [EngineHub/WorldEdit#2459](https://github.com/EngineHub/WorldEdit/issues/2459)
+    - [MCDReforged/MCDReforged#150](https://github.com/MCDReforged/MCDReforged/issues/150)
+    - [EngineHub/WorldEdit#2459](https://github.com/EngineHub/WorldEdit/issues/2459)
 2. `pause` 命令诱发用户Ctrl+C操作，导致 MCDR 关闭与存档恢复冲突，最终致使存档损坏
-   - [TISUnion/PrimeBackup#85](https://github.com/TISUnion/PrimeBackup/issues/85)
-
+    - [TISUnion/PrimeBackup#85](https://github.com/TISUnion/PrimeBackup/issues/85)
+    - [MCDReforged/MCDReforged#394](https://github.com/MCDReforged/MCDReforged/issues/394)
 
 本插件提供监听服务器关闭并且在这些情况下强制关闭服务器的功能, 给小白腐竹们提供一个简单且无脑的解决方案
 
-## 配置
-
-|      配置项       |   类型    |  默认值   | 含义                 | 注释      |
-|:--------------:|:-------:|:------:|:-------------------|:--------|
-|    `enable`    | `bool`  | `True` | 是否启用插件             | 不影响事件分发 |
-| `waiting_time` | `float` |  `60`  | 等待服务器关闭的时间, 超时强制关闭 | 单位为秒    |
-
 ## 使用方法
 
 直接安装到 MCDR 的插件文件夹下即可, 可以从 [GitHub](https://github/xieyuen/MCDR-Plugins)
@@ -42,40 +38,68 @@
 > 你都用 MCDR 了竟然还不知道原生 `/stop` 会让 MCDR 关闭吗?<br>
 > 你都用 MCDR 了竟然还用不支持运行时回档的备份模组而不是 PrimeBackup、QuickBackupM 吗?
 
+## 配置
+
+|      配置项       |   类型    |   默认值   | 含义                                                              | 注释      |
+|:--------------:|:-------:|:-------:|:----------------------------------------------------------------|:--------|
+|    `enable`    | `bool`  | `True`  | 是否启用插件                                                          | 不影响事件分发 |
+| `waiting_time` | `float` |  `60`   | 等待服务器关闭的时间, 超时强制关闭                                              | 单位为秒    |
+|  `mcdr_only`   | `bool`  | `False` | 是否只监听 [`PluginStoppingServerEvent`](#PluginStoppingServerEvent) |         |
+
 ## 新的事件
 
 KillServer 创建了三个字面量事件 [`ServerStoppingEvent`](#serverstoppingevent),
 [`PluginStoppingServerEvent`](#pluginstoppingserverevent)
-和 [`WorldSavedEvent`](#worldsavedevent)
+和 [`WorldSavedEvent`](#worldsavedevent) 用以监听服务器控制事件
+
+你可以通过下面的方式在自己的插件中使用这些事件
 
 ```python
 from kill_server import ServerStoppingEvent, PluginStoppingServerEvent, WorldSavedEvent
+from mcdreforged import event_listener, PluginServerInterface
+
+
+# import
+@event_listener(ServerStoppingEvent)
+def on_server_stopping(server: PluginServerInterface):
+    pass
+
+
+# or id
+@event_listener("kill_server.server_stopping")  # also 
+def on_server_stopping(server: PluginServerInterface):
+    pass
 ```
 
+> [!TIP]
+> 如果你只是需要各个事件而不需要强制关闭功能的话可以把配置中的 `enable` 项设定为 `false`,
+> 该配置只会影响强制关闭功能而不会停止事件分发
+
 ### ServerStoppingEvent
 
-KillServer 创建了一个字面量事件 `ServerStoppingEvent = LiteralEvent("kill_server.server_stopping")`
-用以监听服务器关闭, 这个事件会在服务器关闭时 (例如 `/stop` 被调用时) 分发
+字面量事件 `ServerStoppingEvent = LiteralEvent("kill_server.server_stopping")`
+用以监听服务器关闭, 这个事件会在服务器开始关闭时 (例如 `/stop` 被调用时) 触发
 
 - **事件 ID**: `kill_server.server_stopping`
 - **回调参数**: `PluginServerInterface`
 
 ### PluginStoppingServerEvent
 
-KillServer 创建了一个字面量事件 `PluginStoppingServerEvent = LiteralEvent("kill_server.plugin_stopping_server")`
-用以监听 ***由插件或调用 MCDR 命令*** 导致的服务器关闭, 这个事件会在服务器关闭时 (例如 `!!MCDR server stop` 被调用时) 分发
+事件 `PluginStoppingServerEvent = LiteralEvent("kill_server.plugin_stopping_server")`
+用以监听 ***由插件调用 `ServerInterface.stop()` 或调用 MCDR 命令*** 导致的服务器开始关闭,
+这个事件会在服务器关闭时 (例如 `!!MCDR server stop` 被调用时) 触发
+
+> [!IMPORTANT]
+> 1. 该事件同时会引发 [`ServerStoppingEvent`](#serverstoppingevent)
+> 2. `ServerInterface.kill()` 不会触发该事件, 因为服务器此时不是正常开始关闭而是进程组被 kill
 
 - **事件 ID**: `kill_server.plugin_stopping_server`
 - **回调参数**: `PluginServerInterface`
 
 ### WorldSavedEvent
 
 KillServer 创建了一个字面量事件 `WorldSavedEvent = LiteralEvent("kill_server.world_saved")`
-用以监听服务器是否将世界保存好, 这个事件会在服务器保存世界完成时 (例如 `/save` 被调用之后) 分发
+用以监听服务器是否将世界保存好, 这个事件会在服务器保存世界完成时 (例如 `/save` 被调用之后) 触发
 
 - **事件 ID**: `kill_server.world_saved`
 - **回调参数**: `PluginServerInterface`
-
-> [!TIP]
-> 如果你只是需要各个事件而不需要强制关闭功能的话可以把配置中的 `enable` 项设定为 `false`,
-> 该配置只会影响强制关闭功能而不会停止事件分发

src/KillServer/kill_server/__init__.py

@@ -15,42 +15,81 @@
 PluginStoppingServerEvent = LiteralEvent("kill_server.plugin_stopping_server")
 WorldSavedEvent = LiteralEvent("kill_server.world_saved")
 
+__all__ = ["ServerStoppingEvent", "PluginStoppingServerEvent", "WorldSavedEvent"]
+
+is_world_saved: bool = False
+
+
+def on_server_startup(_server: PluginServerInterface):
+    global is_world_saved
+    is_world_saved = False
+
+
+@event_listener(WorldSavedEvent)
+def on_world_saved(_server: PluginServerInterface):
+    global is_world_saved
+    is_world_saved = True
+
 
-@event_listener(ServerStoppingEvent)
 @new_thread("KillServer")
-def force_kill_server():
+def force_kill_server(server: PluginServerInterface):
     """强制关闭服务器"""
-    if not config.enable:
-        return
-
-    psi.logger.info("检测到服务器关闭命令执行, 等待服务器自动关闭")
+    server.logger.info("检测到服务器关闭命令执行, 等待服务器自动关闭")
 
     time.sleep(config.waiting_time)
-    if not psi.is_server_running():
+    if not server.is_server_running():
         return
-    psi.logger.info("等待服务器关闭超时, 正在强制关闭服务器")
+    server.logger.info("等待服务器关闭超时, 正在强制关闭服务器")
     # TODO: 检查世界是否保存
-    psi.kill()
+    if not is_world_saved:
+        server.logger.warning("世界仍未保存完成, 建议增加等待时间")
+    server.kill()
 
 
 def dispatch(event: PluginEvent):
     psi.dispatch_event(event, ())
 
 
-def on_load(server: PluginServerInterface, prev_module):
+def on_load(server: PluginServerInterface, _prev_module):
     global psi, config, handler
     psi = server
     config = server.load_config_simple(target_class=Config)
 
-    if prev_module is not None:
-        prev_module.handler.remove()
+    if not config.enable:
+        server.logger.info("强制关闭功能已关闭")
+    elif config.mcdr_only:
+        server.logger.info("配置 mcdr_only 已启用")
+        server.register_event_listener(PluginStoppingServerEvent, force_kill_server)
+    else:
+        server.register_event_listener(ServerStoppingEvent, force_kill_server)
 
     # noinspection PyTypeChecker
     handler = when(server.stop, "return").do(lambda: dispatch(PluginStoppingServerEvent))
 
 
-def on_info(_server: PluginServerInterface, info: Info):
+def on_unload(_server: PluginServerInterface):
+    handler.remove()
+
+
+def on_info(server: PluginServerInterface, info: Info):
     if re.fullmatch(r"Stopping the server", info.content):
         dispatch(ServerStoppingEvent)
+        return
     if re.fullmatch(r".*All dimensions are saved", info.content):
         dispatch(WorldSavedEvent)
+        return
+    if any(
+            i == "请按任意键继续. . . "
+            for i in (info.raw_content, info.content)
+    ):
+        msgs = [
+            "检测到 pause 命令的输出",
+            "请检查 MCDR 配置文件内的 start_command 配置项和(如果存在)启动脚本内有没有 pause 命令",
+            "如果存在, 请尽快删除",
+            "pause 引起的一些 issue:",
+            "https://github.com/MCDReforged/MCDReforged/issues/394",
+            "https://github.com/TISUnion/PrimeBackup/issues/85",
+        ]
+        for msg in msgs:
+            server.logger.critical(msg)
+        return

src/KillServer/kill_server/config.py

@@ -12,6 +12,9 @@ class Config(Serializable):
     waiting_time: float = 60
     """等待时间, 超时之后才强制关闭服务器, 单位为秒"""
 
+    mcdr_only: bool = False
+    """是否只监听由 MCDR 或插件调用 ``ServerInterface.stop()`` 引起的关闭"""
+
     def validate_attribute(self, attr_name: str, attr_value: Any, **kwargs):
         if attr_name == "waiting_time":
             if attr_value <= 0:

src/KillServer/mcdreforged.plugin.json

@@ -1,6 +1,6 @@
 {
     "id": "kill_server",
-    "version": "0.1.2",
+    "version": "1.0.0",
     "name": "KillServer",
     "description": {
         "en_us": "Force to kill mc server",