feat(log): add append mode and timestamp options for serial log recording

Author: FASTSHIFT

Tools/WebServer/app/routes/logs.py

@@ -160,16 +160,20 @@ def api_log_file_start():
 
     data = request.json or {}
     path = data.get("path", "")
+    append = data.get("append", True)
+    timestamp = data.get("timestamp", True)
 
     if not path:
         return jsonify({"success": False, "error": "No path provided"})
 
     device = state.device
-    success, error = log_recorder.start(path)
+    success, error = log_recorder.start(path, append=append, timestamp=timestamp)
 
     if success:
         device.log_file_enabled = True
         device.log_file_path = path
+        device.log_file_append = append
+        device.log_file_timestamp = timestamp
         state.save_config()
 
     return jsonify({"success": success, "error": error})
@@ -203,6 +207,8 @@ def api_log_file_status():
             "path": log_recorder.path,
             "config_enabled": device.log_file_enabled,
             "config_path": device.log_file_path,
+            "config_append": device.log_file_append,
+            "config_timestamp": device.log_file_timestamp,
         }
     )
 

Tools/WebServer/core/config_schema.py

@@ -342,6 +342,24 @@ def to_dict(self) -> dict:
         tooltip="Record serial communication logs to file",
         order=20,
     ),
+    ConfigItem(
+        key="log_file_append",
+        label="Append Mode",
+        group=ConfigGroup.LOGGING,
+        config_type=ConfigType.BOOLEAN,
+        default=True,
+        tooltip="Append to existing log file instead of truncating",
+        order=25,
+    ),
+    ConfigItem(
+        key="log_file_timestamp",
+        label="Record Timestamp",
+        group=ConfigGroup.LOGGING,
+        config_type=ConfigType.BOOLEAN,
+        default=True,
+        tooltip="Add timestamp prefix to each log line",
+        order=26,
+    ),
     ConfigItem(
         key="serial_echo_enabled",
         label="Serial TX Echo",

Tools/WebServer/main.py

@@ -235,7 +235,11 @@ def restore_state():
         from services.log_recorder import log_recorder
 
         logger.info(f"Restoring log file recording: {device.log_file_path}")
-        success, error = log_recorder.start(device.log_file_path)
+        success, error = log_recorder.start(
+            device.log_file_path,
+            append=device.log_file_append,
+            timestamp=device.log_file_timestamp,
+        )
         if success:
             logger.info("Log file recording restored")
         else:

Tools/WebServer/services/log_recorder.py

@@ -25,8 +25,11 @@ def __init__(self):
         self._file = None
         self._enabled = False
         self._path = ""
+        self._timestamp = True
 
-    def start(self, path: str) -> tuple[bool, str]:
+    def start(
+        self, path: str, append: bool = True, timestamp: bool = True
+    ) -> tuple[bool, str]:
         """Start recording logs to file."""
         with self._lock:
             if self._enabled:
@@ -41,11 +44,15 @@ def start(self, path: str) -> tuple[bool, str]:
                 if dir_path and not os.path.exists(dir_path):
                     os.makedirs(dir_path, exist_ok=True)
 
-                self._file = open(path, "a", encoding="utf-8")
+                mode = "a" if append else "w"
+                self._file = open(path, mode, encoding="utf-8")
                 self._enabled = True
                 self._path = path
+                self._timestamp = timestamp
 
-                logger.info(f"Log recording started: {path}")
+                logger.info(
+                    f"Log recording started: {path} (append={append}, timestamp={timestamp})"
+                )
                 return True, ""
             except Exception as e:
                 self._enabled = False
@@ -83,14 +90,16 @@ def write(self, message: str):
                 return
 
             try:
-                timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f")[:-3]
                 # Handle multi-line messages
                 lines = message.split("\n")
                 for i, line in enumerate(lines):
                     if (
                         line or i == 0
                     ):  # Write first line even if empty, skip other empty lines
-                        if i == 0:
+                        if i == 0 and self._timestamp:
+                            timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f")[
+                                :-3
+                            ]
                             self._file.write(f"[{timestamp}] {line}\n")
                         else:
                             self._file.write(f"{line}\n")

Tools/WebServer/static/js/features/config.js

@@ -440,6 +440,10 @@ async function onLogFileEnabledChange() {
       if (pathInput) pathInput.value = path;
     }
 
+    const append = document.getElementById('logFileAppend')?.checked ?? true;
+    const timestamp =
+      document.getElementById('logFileTimestamp')?.checked ?? true;
+
     try {
       // Check current status first
       const statusRes = await fetch('/api/log_file/status');
@@ -457,7 +461,7 @@ async function onLogFileEnabledChange() {
       const res = await fetch('/api/log_file/start', {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ path }),
+        body: JSON.stringify({ path, append, timestamp }),
       });
       const data = await res.json();
 

Tools/WebServer/static/js/locales/en.js

@@ -40,6 +40,8 @@ window.i18nResources['en'] = {
         wakeup_shell_cnt: 'Wakeup Count',
         log_file_path: 'Log Path',
         log_file_enabled: 'Record Serial Logs',
+        log_file_append: 'Append Mode',
+        log_file_timestamp: 'Record Timestamp',
         serial_echo_enabled: 'Serial TX Echo',
         external_gdb_port: 'External GDB Port',
         ghidra_path: 'Ghidra Path',
@@ -471,6 +473,8 @@ window.i18nResources['en'] = {
         'Number of newlines to send before entering fl mode to wake up shell.',
       log_file_path: 'Path to save serial logs',
       log_file_enabled: 'Record serial communication logs to file',
+      log_file_append: 'Append to existing log file instead of truncating',
+      log_file_timestamp: 'Add timestamp prefix to each log line',
       serial_echo_enabled: 'Echo TX commands to SERIAL panel (for debugging)',
       ghidra_path:
         'Path to Ghidra installation directory (containing support/analyzeHeadless)',

Tools/WebServer/static/js/locales/zh-CN.js

@@ -40,6 +40,8 @@ window.i18nResources['zh-CN'] = {
         wakeup_shell_cnt: '唤醒次数',
         log_file_path: '日志路径',
         log_file_enabled: '记录串口日志',
+        log_file_append: '追加模式',
+        log_file_timestamp: '记录时间戳',
         serial_echo_enabled: '串口发送回显',
         external_gdb_port: '外部 GDB 端口',
         ghidra_path: 'Ghidra 路径',
@@ -458,6 +460,8 @@ window.i18nResources['zh-CN'] = {
       wakeup_shell_cnt: '进入 fl 模式前发送换行符的次数，用于唤醒 shell。',
       log_file_path: '串口日志保存路径',
       log_file_enabled: '将串口通信日志记录到文件',
+      log_file_append: '追加到已有日志文件，关闭则截断文件重新写入',
+      log_file_timestamp: '在每行日志前添加时间戳',
       serial_echo_enabled: '在串口面板回显发送的命令（用于调试）',
       ghidra_path: 'Ghidra 安装目录路径（包含 support/analyzeHeadless）',
       enable_decompile: '创建补丁模板时启用反编译（需要 Ghidra）',

Tools/WebServer/static/js/locales/zh-TW.js

@@ -40,6 +40,8 @@ window.i18nResources['zh-TW'] = {
         wakeup_shell_cnt: '喚醒次數',
         log_file_path: '日誌路徑',
         log_file_enabled: '記錄串列埠日誌',
+        log_file_append: '追加模式',
+        log_file_timestamp: '記錄時間戳',
         serial_echo_enabled: '串列埠傳送回顯',
         external_gdb_port: '外部 GDB 連接埠',
         ghidra_path: 'Ghidra 路徑',
@@ -459,6 +461,8 @@ window.i18nResources['zh-TW'] = {
       wakeup_shell_cnt: '進入 fl 模式前傳送換行符的次數，用於喚醒 shell。',
       log_file_path: '串列埠日誌儲存路徑',
       log_file_enabled: '將串列埠通訊日誌記錄到檔案',
+      log_file_append: '追加到已有日誌檔案，關閉則截斷檔案重新寫入',
+      log_file_timestamp: '在每行日誌前新增時間戳',
       serial_echo_enabled: '在串列埠面板回顯傳送的命令（用於除錯）',
       ghidra_path: 'Ghidra 安裝目錄路徑（包含 support/analyzeHeadless）',
       enable_decompile: '建立補丁範本時啟用反編譯（需要 Ghidra）',

Tools/WebServer/tests/test_main.py

@@ -301,7 +301,11 @@ def test_restore_state_log_recorder_success(self, mock_recorder):
 
         main.restore_state()
 
-        mock_recorder.start.assert_called_once_with("/tmp/test.log")
+        mock_recorder.start.assert_called_once_with(
+            "/tmp/test.log",
+            append=state.device.log_file_append,
+            timestamp=state.device.log_file_timestamp,
+        )
 
     @patch("services.log_recorder.log_recorder")
     def test_restore_state_log_recorder_failure(self, mock_recorder):