add setting: debug

Author: OptiJava

hooks/__init__.py

@@ -11,6 +11,7 @@
 import hooks.schedule_tasks as schedule_tasks
 import hooks.tasks as tasks
 import hooks.utils as utils
+import hooks.logger.logger as logger
 from hooks.utils import process_arg_server
 
 scripts_folder: str = ''
@@ -21,8 +22,6 @@ def trigger_hooks(hook: mount.Hooks, server: PluginServerInterface, objects_dict
         return
 
     try:
-        server.logger.debug(f'Triggered hooks {hook.value}')
-        server.logger.debug(f'objects_dict: {str(objects_dict)}')
         if len(cfg.temp_config.hooks.get(hook.value)) != 0:
             _trigger_hooks(hook, server, objects_dict)
     except Exception as e:
@@ -31,6 +30,8 @@ def trigger_hooks(hook: mount.Hooks, server: PluginServerInterface, objects_dict
 
 @new_thread('hooks - trigger')
 def _trigger_hooks(hook: mount.Hooks, server: PluginServerInterface, objects_dict: dict[str, Any] = None):
+    logger.debug(f'Triggering hooks {hook.value}', server)
+    
     # 初始化最终变量字典
     finally_var_dict = dict()
 
@@ -112,7 +113,7 @@ def list_scripts(src: CommandSource):
 
 
 def reload_config(src: CommandSource, server: PluginServerInterface):
-    schedule_tasks.stop_all_schedule_daemon_threads()
+    schedule_tasks.stop_all_schedule_daemon_threads(server)
 
     cfg.temp_config = cfg.TempConfig()
     cfg.config = server.load_config_simple(target_class=cfg.Configuration)
@@ -168,6 +169,8 @@ def run_command(command: str, task_type: str, server: PluginServerInterface, src
 
 
 def _parse_and_apply_scripts(script: str, server: PluginServerInterface):
+    logger.debug(f'Prepare for apply script: {script}', server)
+    
     try:
         # 读取
         with open(cfg.temp_config.scripts_list.get(script), 'r') as f:
@@ -250,12 +253,15 @@ def _parse_and_apply_scripts(script: str, server: PluginServerInterface):
                     for hook in schedule.get('hooks'):
                         # 挂载
                         mount.mount_task(hook, schedule.get('name'), server.get_plugin_command_source(), server)
+        logger.debug(f'{script} apply successfully.', server)
     except Exception as e:
         server.logger.exception(f'Unexpected exception when parse or apply scripts {os.path.basename(script)}! Please '
                                 f'check your scripts.', e)
 
 
 def load_scripts(server: PluginServerInterface):
+    logger.debug('Loading scripts...', server)
+    
     if not os.path.isdir(scripts_folder):
         # 创建脚本目录
         os.makedirs(scripts_folder)
@@ -433,7 +439,7 @@ def on_load(server: PluginServerInterface, old_module):
 
 
 def on_unload(server: PluginServerInterface):
-    schedule_tasks.stop_all_schedule_daemon_threads()
+    schedule_tasks.stop_all_schedule_daemon_threads(server)
 
     trigger_hooks(mount.Hooks.on_plugin_unloaded, server, {'server': process_arg_server(server)})
 

hooks/config.py

@@ -8,6 +8,8 @@ def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
     automatically: bool = True
+    
+    debug: bool = False
 
 
 class TempConfig:

hooks/logger/__init__.py

@@ -0,0 +1,8 @@
+from mcdreforged.api.types import PluginServerInterface
+
+import hooks.config as cfg
+
+
+def debug(msg: str, server: PluginServerInterface):
+    if cfg.config.debug:
+        server.logger.info('debug: ' + msg)

hooks/logger/logger.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
-from mcdreforged.api.all import *
+from mcdreforged.api.all import CommandSource, PluginServerInterface, RTextMCDRTranslation
 
 from hooks import config as cfg
 

hooks/mount.py

@@ -3,6 +3,7 @@
 
 import hooks.tasks as tasks
 from hooks import config as cfg
+import hooks.logger.logger as logger
 
 
 class AThread(threading.Thread):
@@ -35,13 +36,16 @@ def run(self):
         while True:
             for _ in range(self.exec_interval):
                 if self.stop_event.is_set():
+                    logger.debug(f'Schedule task {self.task_name} stopped.', self.server_inst)
                     return
                 sleep(1.0)
+            logger.debug(f'Schedule task {self.task_name} triggered. exec_interval: {self.exec_interval}', self.server_inst)
             if cfg.config.automatically:
                 self.execute_task(self.server_inst, 'schedule')
 
 
-def stop_all_schedule_daemon_threads():
+def stop_all_schedule_daemon_threads(server):
+    logger.debug('Stopping all schedule task daemon thread...', server)
     if len(cfg.temp_config.schedule_daemon_threads) == 0:
         return
 

hooks/schedule_tasks.py

@@ -3,9 +3,10 @@
 from enum import Enum
 from io import StringIO
 
-from mcdreforged.api.all import *
+from mcdreforged.api.all import CommandSource, PluginServerInterface, RTextMCDRTranslation, new_thread
 
 from hooks import config as cfg, mount as mount, schedule_tasks as schedule_tasks
+import hooks.logger.logger as logger
 
 
 class TaskType(Enum):
@@ -35,8 +36,7 @@ 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.task_name}, task_type: {self.task_type}, command: {self.command}')
-        server.logger.debug(f'objects_dict: {str(var_dict)}')
+        logger.debug(f'Executing task: {self.task_name}, task_type: {self.task_type}', server)
 
         start_time = time.time()
 
@@ -98,8 +98,8 @@ def execute_task(self, server: PluginServerInterface, hook: str, var_dict: dict
                 else:
                     exec(self.command, {}, locals())
 
-        server.logger.debug(f'Task finished, name: {self.task_name}, task_type: {self.task_type}, '
-                            f'command: {self.command}, costs {time.time() - start_time} seconds.')
+        logger.debug(f'Task finished, name: {self.task_name}, task_type: {self.task_type}, '
+                     f'costs {time.time() - start_time} seconds.', server)
 
 
 def create_task(task_type: str, command: str, name: str, src: CommandSource, server: PluginServerInterface,