feat: 添加前台打印日志 (#190)

* feat: 前台打印日志

* feat: 添加前台运行日志和localization

Author: Mintanxon

bot/base/localization.py

@@ -0,0 +1,82 @@
+class LocalizationMap:
+    SCENARIO_TYPE_UNKNOWN = '未知'
+    SCENARIO_TYPE_URA = 'URA'
+    SCENARIO_TYPE_AOHARUHAI = '青春杯'
+
+    SUPPORT_CARD_TYPE_UNKNOWN = '未知'
+    SUPPORT_CARD_TYPE_SPEED = '速度'
+    SUPPORT_CARD_TYPE_STAMINA = '耐力'
+    SUPPORT_CARD_TYPE_POWER = '力量'
+    SUPPORT_CARD_TYPE_WILL = '毅力'
+    SUPPORT_CARD_TYPE_INTELLIGENCE = '智力'
+    SUPPORT_CARD_TYPE_FRIEND = '友情'
+    SUPPORT_CARD_TYPE_GROUP = '团队'
+    SUPPORT_CARD_TYPE_NPC = 'NPC'
+
+    SUPPORT_CARD_FAVOR_LEVEL_UNKNOWN = '未知'
+    SUPPORT_CARD_FAVOR_LEVEL_1 = '等级1'
+    SUPPORT_CARD_FAVOR_LEVEL_2 = '等级2'
+    SUPPORT_CARD_FAVOR_LEVEL_3 = '等级3'
+    SUPPORT_CARD_FAVOR_LEVEL_4 = '等级4'
+
+    TRAINING_TYPE_UNKNOWN = '未知'
+    TRAINING_TYPE_SPEED = '速度'
+    TRAINING_TYPE_STAMINA = '耐力'
+    TRAINING_TYPE_POWER = '力量'
+    TRAINING_TYPE_WILL = '毅力'
+    TRAINING_TYPE_INTELLIGENCE = '智力'
+
+    MOTIVATION_LEVEL_UNKNOWN = '未知'
+    MOTIVATION_LEVEL_1 = '等级1'
+    MOTIVATION_LEVEL_2 = '等级2'
+    MOTIVATION_LEVEL_3 = '等级3'
+    MOTIVATION_LEVEL_4 = '等级4'
+    MOTIVATION_LEVEL_5 = '等级5'
+
+    TURN_OPERATION_TYPE_UNKNOWN = '未知'
+    TURN_OPERATION_TYPE_TRAINING = '训练'
+    TURN_OPERATION_TYPE_REST = '休息'
+    TURN_OPERATION_TYPE_MEDIC = '医务室'
+    TURN_OPERATION_TYPE_TRIP = '外出'
+    TURN_OPERATION_TYPE_RACE = '赛事'
+
+    SUPPORT_CARD_UMA_UNKNOWN = '未知'
+    SUPPORT_CARD_UMA_AKIKAWA = '理事长'
+    SUPPORT_CARD_UMA_REPORTER = '记者'
+
+    RACE_TACTIC_TYPE_UNKNOWN = '未知'
+    RACE_TACTIC_TYPE_BACK = '后追'
+    RACE_TACTIC_TYPE_MIDDLE = '居中'
+    RACE_TACTIC_TYPE_FRONT = '跟前'
+    RACE_TACTIC_TYPE_ESCAPE = '领跑'
+
+    TASK_STATUS_INVALID = '任务无效'
+    TASK_STATUS_PENDING = '任务暂停'
+    TASK_STATUS_RUNNING = '任务运行'
+    TASK_STATUS_INTERRUPT = '任务被打断'
+    TASK_STATUS_SUCCESS = '任务完成'
+    TASK_STATUS_FAILED = '任务失败'
+    TASK_STATUS_SCHEDULED = '任务定时'
+    TASK_STATUS_CANCELED = '任务取消'
+
+    support_card = '暂无'
+
+localization_map = {attr: value for attr, value in vars(LocalizationMap).items()
+                    if not callable(value) and not attr.startswith('_')}
+
+def _localization_single(string):
+    for name, value in localization_map.items():
+        string = string.replace(name, value)
+    return string
+
+
+def localization(text):
+    if isinstance(text, str):
+        return _localization_single(text)
+    if not isinstance(text, list):
+        raise TypeError(f'localization failed: illegal type {type(text)}')
+    for i, string in enumerate(text):
+        if not isinstance(string, str):
+            raise TypeError(f'localization failed: illegal type {type(string)}')
+        text[i] = _localization_single(string)
+    return text

bot/base/log.py

@@ -1,7 +1,12 @@
 import logging
+import os
 import sys
+import time
+import threading
+from collections import deque
 from logging import Logger
-
+from bot.base.user_data import base_path
+from bot.base.localization import localization
 import colorlog
 
 log_colors_config = {
@@ -12,6 +17,37 @@
     'CRITICAL': 'bold_red',
 }
 
+current_time = time.strftime("%Y%m%d_%H%M%S", time.localtime())
+log_path = os.path.join(base_path, "log_" + current_time + ".txt")
+
+class TaskLogHandler(logging.Handler):
+    def __init__(self, capacity=1000):
+        super().__init__()
+        self.task_id = None
+        self.buffer = {}
+        self.lock = threading.RLock()
+        self.capacity = capacity
+
+    def emit(self, record):
+        if hasattr(record, "task_id"):
+            self.task_id = record.task_id
+        if self.task_id is not None:
+            if self.task_id not in self.buffer:
+                self.buffer[self.task_id] = deque(maxlen=self.capacity)
+            log_text = localization(self.format(record))
+            with self.lock:
+                self.buffer[self.task_id].append(log_text)
+
+    def get_task_log(self, task_id):
+        with self.lock:
+            logs = list(self.buffer[task_id])
+        return logs
+
+task_log_handler = TaskLogHandler()
+fmt = logging.Formatter('%(asctime)s %(message)s', datefmt='%Y-%m-%d %H:%M')
+task_log_handler.setFormatter(fmt)
+task_log_handler.setLevel(logging.INFO)
+
 
 def get_logger(name) -> Logger:
     logger = logging.getLogger(name)
@@ -26,6 +62,14 @@ def get_logger(name) -> Logger:
         console_handler.setFormatter(fmt)
         console_handler.setLevel(logging.DEBUG)
         logger.addHandler(console_handler)
+
+        fmt = logging.Formatter('%(asctime)s  %(levelname)-8s [%(funcName)34s] %(filename)-20s: %(message)s') 
+        file_handler = logging.FileHandler(log_path)
+        file_handler.setFormatter(fmt)
+        file_handler.setLevel(logging.DEBUG)
+        logger.addHandler(file_handler)
+
+        logger.addHandler(task_log_handler)
     return logger
 
 

bot/base/task.py

@@ -67,7 +67,7 @@ def end_task(self, status, reason) -> None:
 
     @abstractmethod
     def start_task(self) -> None:
-        pass
+        log.info("任务开始", extra={"task_id": self.task_id})
 
     def running(self) -> bool:
         return self.task_status == TaskStatus.TASK_STATUS_RUNNING

bot/base/user_data.py

@@ -1,7 +1,8 @@
 import os
 
 base_path = "userdata"
-
+if not os.path.exists(base_path):
+    os.makedirs(base_path)
 
 def write_file(filename, content):
     filepath = os.path.dirname(base_path + filename)

bot/conn/u2_ctrl.py

@@ -138,7 +138,7 @@ def execute_adb_shell(self, cmd, sync):
 
     def start_app(self, name):
         self.u2client.app_start(name)
-        log.info("starting app <" + name + ">")
+        log.debug("starting app <" + name + ">")
 
     # get_front_activity 获取前台正在运行的应用
     def get_front_activity(self):

bot/server/handler.py

@@ -3,6 +3,7 @@
 from fastapi import FastAPI, Path
 from fastapi.middleware.cors import CORSMiddleware
 
+from bot.base.log import task_log_handler
 from bot.engine import ctrl as bot_ctrl
 from bot.server.protocol.task import *
 from starlette.responses import FileResponse
@@ -33,6 +34,10 @@ def delete_task(req: DeleteTaskRequest):
 def get_task():
     return bot_ctrl.get_task_list()
 
+@server.get("/log/{task_id}")
+def get_task_log(task_id):
+    return task_log_handler.get_task_log(task_id)
+
 
 @server.post("/action/bot/reset-task")
 def reset_task(req: ResetTaskRequest):

module/umamusume/task.py

@@ -38,7 +38,7 @@ def end_task(self, status, reason) -> None:
         super().end_task(status, reason)
 
     def start_task(self) -> None:
-        pass
+        super().start_task()
 
 
 class UmamusumeTaskType(Enum):

module/umamusume/types.py

@@ -52,7 +52,7 @@ def log_training_info(self):
         text = "此训练附带支援卡列表：["
         for c in self.support_card_info_list:
             if c.favor != SupportCardFavorLevel.SUPPORT_CARD_FAVOR_LEVEL_UNKNOWN:
-                text += "[支援卡名称：" + str(c.name) + "支援卡类型：" + str(c.card_type.name) + ", 支援卡羁绊阶段：" + str(c.favor.name) + "] "
+                text += "[支援卡名称：" + str(c.name) + ", 支援卡类型：" + str(c.card_type.name) + ", 支援卡羁绊阶段：" + str(c.favor.name) + "] "
         text += "]"
         log.info(text)
 
@@ -124,9 +124,9 @@ def __init__(self):
         self.turn_learn_skill_done = False
 
     def log_turn_info(self):
-        log.info("当前回合时间 >" + str(self.date))
+        log.info("当前回合时间 " + str(self.date))
         log.info("干劲状态 " + str(self.motivation_level.name))
-        log.info("体力剩余" + str(self.remain_stamina))
+        log.info("体力剩余 " + str(self.remain_stamina))
         log.info("当前属性值 速度：%s, 耐力：%s, 力量：%s, 毅力：%s, 智力：%s, 技能点：%s", self.uma_attribute.speed,
                  self.uma_attribute.stamina, self.uma_attribute.power, self.uma_attribute.will, self.uma_attribute.intelligence, self.uma_attribute.skill_point)
         log.info("速度训练结果：")