fix bug: schedule task name and thread name conflict, print thread name in !!hooks list tasks

Author: OptiJava

README.md

@@ -86,18 +86,39 @@ Apply和加载有区别，Apply是指：**插件创建Task、挂载Task的操作
 
 首先要编写脚本，示例：
 ``````
-tasks:  
+tasks:  # 普通任务
   - name: motd  # 声明task的名字，别有空格
     task_type: shell_command  # 任务类型
     command: date   # 要执行的指令
     command_file: {hooks_config_path}/scripts/script.txt（脚本内容路径，如果此路径有效，插件将从command_file中读取command并执行，执行的指令即文件的所有内容（文件扩展名随意写，插件并非直接执行此文件，而是将文件内容读到内存处理后再执行）。command_file和command只用写一个，command_file如果写了command项就会被忽略）。{hooks_config_path}会被替换为hooks插件的配置文件目录，即server.get_data_folder()
     hooks:   # 要挂载到的hook，必须是数组
       - on_server_started
       - on_mcdr_started
+ schedule_tasks:  # 定时任务声明
+  - name: ababababa  # 名字
+    task_type: server_command  # 任务类型
+    command: say 6  # 指令
+    command_file: {hooks_config_path}/scripts/script.txt（脚本内容路径，如果此路径有效，插件将从command_file中读取command并执行，执行的指令即文件的所有内容（文件扩展名随意写，插件并非直接执行此文件，而是将文件内容读到内存处理后再执行）。command_file和command只用写一个，command_file如果写了command项就会被忽略）。{hooks_config_path}会被替换为hooks插件的配置文件目录，即server.get_data_folder()
+    hooks:
+      - on_user_info  # 定时任务也可以被挂载哟~ 
 ``````
 
 将其命名为`<脚本名字>.yaml`，并且放到`config/hooks/scripts`文件夹或子文件夹中
 
+### 定时任务（`schedule_task`）
+
+定时任务就是隔一段时间执行一次的任务
+
+每一个定时任务都会被放到一个单独的线程调度，线程名`hooks - schedule_task_daemon(<任务名>)`，可以使用`!!MCDR status`查看
+
+#### 指令
+
+`!!hooks schedule <name> <exec_interval> <task_type> <command>`
+- `<name>`任务名字，定时任务本质上和任务一样，只不过多了执行间隔的属性
+- `<exec_interval>`执行间隔，单位秒，必须是整数
+- `<task_type>`任务类型
+- `<command>`指令
+
 ### 其他指令
 
 `!!hooks list mount`

hooks/__init__.py

@@ -48,12 +48,12 @@ class TaskType(Enum):
 
 class Task:
     def __init__(self, name, task_type, created_by, command):
-        self.name = name
+        self.task_name = name
         self.task_type = task_type
         self.created_by = created_by
         self.command = command
 
-    name: str = 'undefined'
+    task_name: str = 'undefined'
 
     task_type: TaskType = TaskType.undefined
 
@@ -63,20 +63,20 @@ def __init__(self, name, task_type, created_by, command):
 
     @new_thread('hooks - execute')
     def execute_task(self, server: PluginServerInterface, hook: str, var_dict: dict = None, obj_dict: dict = None):
-        server.logger.debug(f'Executing task: {self.name}, task_type: {self.task_type}, command: {self.command}')
+        server.logger.debug(f'Executing task: {self.task_name}, task_type: {self.task_type}, command: {self.command}')
         server.logger.debug(f'objects_dict: {str(var_dict)}')
 
         start_time = time.time()
 
         if self.command is None:
             server.logger.error(
-                f'Task state is not correct! Task: {self.name} Hooks: {hook} TaskType: {self.task_type} '
+                f'Task state is not correct! Task: {self.task_name} Hooks: {hook} TaskType: {self.task_type} '
                 f'command: {self.command}')
             return
 
         if self.task_type == TaskType.undefined:
             server.logger.error(
-                f'Task state is not correct! Task: {self.name} Hooks: {hook} TaskType: {self.task_type} '
+                f'Task state is not correct! Task: {self.task_name} Hooks: {hook} TaskType: {self.task_type} '
                 f'command: {self.command}')
             return
 
@@ -126,7 +126,7 @@ def execute_task(self, server: PluginServerInterface, hook: str, var_dict: dict
                 else:
                     exec(self.command, globals(), locals())
 
-        server.logger.debug(f'Task finished, name: {self.name}, task_type: {self.task_type}, command: {self.command}, '
+        server.logger.debug(f'Task finished, name: {self.task_name}, task_type: {self.task_type}, command: {self.command}, '
                             f'costs {time.time() - start_time} seconds.')
 
 
@@ -142,6 +142,9 @@ def stop_all_schedule_daemon_threads():
 class AThread(threading.Thread):
     def init_thread(self):
         super().__init__(daemon=True)
+        
+    def set_thread_name(self, name: str):
+        self.name = name
 
 
 class ScheduleTask(Task, AThread):
@@ -151,6 +154,7 @@ def __init__(self, name, task_type, created_by, command, server_inst, exec_inter
         self.exec_interval = exec_interval
         self.stop_event = threading.Event()
         super().init_thread()
+        super(Task, self).set_thread_name(f'hooks - schedule_task_daemon({name})')
         temp_config.schedule_daemon_threads.append(self)
 
     def break_thread(self):
@@ -159,7 +163,7 @@ def break_thread(self):
     def run(self):
         if self.exec_interval <= 0:
             self.server_inst.logger.warning(
-                f'Schedule task {self.name} has illegal exec_interval: {self.exec_interval}')
+                f'Schedule task {self.task_name} has illegal exec_interval: {self.exec_interval}')
             return
 
         while True:
@@ -326,7 +330,6 @@ def create_task(task_type: str, command: str, name: str, src: CommandSource, ser
                             server_inst=server, exec_interval=exec_interval)
         temp_config.task[name] = var1
         var1.start()
-        var1.name = f'hooks - schedule_task_daemon({name})'
 
     server.logger.info(f'Successfully created task {name}')
     src.reply(RTextMCDRTranslation('hooks.create.success', name))
@@ -365,7 +368,7 @@ def list_task(src: CommandSource):
     for t in temp_config.task.values():
         rtext_list.append(RTextList(
             RText('\n  '),
-            RText(t.name, color=RColor.red).h(t.task_type.name),
+            RText(t.task_name, color=RColor.red).h(t.task_type.name),
             RText(f'  created by: "{t.created_by}"', color=RColor.green)
         ))
     src.reply(RTextMCDRTranslation('hooks.list.task', rtext_list))