Merge pull request #140 from thawn/copilot/add-logs-panel-to-frontend

Add server logs panel to configuration page with dynamic log level control

Author: thawn

src/config.html

@@ -7,7 +7,8 @@
 					  'open_browser' : testCheckBox('#open_browser'),
 					  'audio_format' : $('#audio_format').val(),
 					  'pen_language' : $('#pen_language').val(),
-					  'library_path' : $('#library_path').val()
+					  'library_path' : $('#library_path').val(),
+					  'log_level' : $('#log_level').val()
 					  };
 	$.post('/config',
 		   'action=update&data=' + encodeURIComponent(JSON.stringify(configVars)))
@@ -59,6 +60,45 @@
 	window.location.href = '/download_oid_images';
 }
 
+var loadLogs = function(){
+	$.get('/logs?lines=100')
+		.done(function(data) {
+			if (data.success) {
+				var logsText = data.logs.join('\n');
+				$('#log-display').text(logsText);
+				// Auto-scroll to bottom
+				var logDisplay = document.getElementById('log-display');
+				logDisplay.scrollTop = logDisplay.scrollHeight;
+			}
+		})
+		.fail(function() {
+			$('#log-display').text('Failed to load logs');
+		});
+}
+
+var changeLogLevel = function(){
+	var level = $('#log_level').val();
+	$.ajax({
+		url: '/logs/level',
+		type: 'POST',
+		contentType: 'application/json',
+		data: JSON.stringify({level: level})
+	})
+	.done(function(data) {
+		if (data.success) {
+			notify($('#log_level'), '', 'Log level changed to ' + level, 'bg-success', 2000);
+			// Refresh logs after a short delay to show the change
+			setTimeout(loadLogs, 500);
+		}
+	})
+	.fail(function() {
+		notify($('#log_level'), '', 'Failed to change log level', 'bg-danger', 4000);
+	});
+}
+
+// Auto-refresh logs every 3 seconds
+var logRefreshInterval;
+
 $(function(){
     loadConfig();
 	$('[data-toggle="tooltip"]').tooltip();
@@ -68,6 +108,18 @@
 	$('#download-oid-images').click(function(){
 		downloadOidImages();
 	});
+	$('#log_level').change(function(){
+		changeLogLevel();
+	});
+	$('#refresh-logs').click(function(){
+		loadLogs();
+	});
+
+	// Initial log load
+	loadLogs();
+
+	// Auto-refresh logs every 3 seconds
+	logRefreshInterval = setInterval(loadLogs, 3000);
 });
 
 </script>
@@ -115,6 +167,17 @@ <h4 class="panel-title">ttmp32gme configuration:</h4>
 				<option value="ITALIAN">ITALIAN</option>
 			</select>
 		</div>
+		<div class="form-group">
+			<label for="log_level">Log Level:</label>
+			<select id="log_level" class="custom-select form-control" data-toggle="tooltip"
+				title="Set the logging level for the application. Changes take effect immediately.">
+				<option value="DEBUG">DEBUG</option>
+				<option value="INFO">INFO</option>
+				<option value="WARNING">WARNING</option>
+				<option value="ERROR">ERROR</option>
+				<option value="CRITICAL">CRITICAL</option>
+			</select>
+		</div>
 		<button type="button" id="submit" class="btn btn-primary" data-toggle="popover" disabled>Save
 			Configuration</button>
 	</div>
@@ -131,3 +194,21 @@ <h4 class="panel-title">Download OID Images:</h4>
 		</button>
 	</div>
 </div>
+<div class="panel panel-default">
+	<div class="panel-heading">
+		<h4 class="panel-title">Server Logs:</h4>
+	</div>
+	<div class="panel-body">
+		<p>View recent server logs. Logs are automatically refreshed every 3 seconds. Change the log level above to control verbosity.</p>
+		<button type="button" id="refresh-logs" class="btn btn-info btn-sm" data-toggle="tooltip"
+			title="Manually refresh the log display">
+			<span class="glyphicon glyphicon-refresh" aria-hidden="true"></span> Refresh Now
+		</button>
+		<div style="margin-top: 10px;">
+			<textarea id="log-display" class="form-control" readonly
+				style="font-family: monospace; font-size: 12px; height: 400px; overflow-y: scroll; background-color: #f5f5f5; color: #333;">
+Loading logs...
+			</textarea>
+		</div>
+	</div>
+</div>

src/ttmp32gme/db_handler.py

@@ -118,6 +118,9 @@ class ConfigUpdateModel(BaseModel):
     audio_format: Optional[str] = Field(None, pattern="^(mp3|ogg)$")
     pen_language: Optional[str] = Field(None, max_length=50)
     library_path: Optional[str] = Field(None, max_length=500)
+    log_level: Optional[str] = Field(
+        None, pattern="^(DEBUG|INFO|WARNING|ERROR|CRITICAL)$"
+    )
 
     # Allow other config fields
     model_config = {"extra": "allow"}
@@ -379,6 +382,7 @@ def initialize(self):
                 INSERT OR IGNORE INTO config VALUES('print_preset','list');
                 INSERT OR IGNORE INTO config VALUES('pen_language','GERMAN');
                 INSERT OR IGNORE INTO config VALUES('library_path','');
+                INSERT OR IGNORE INTO config VALUES('log_level','WARNING');
             """
             )
             cursor.executescript(
@@ -1470,6 +1474,10 @@ def _fix_text_encoding(
                 ),
                 "UPDATE config SET value='2.0.1' WHERE param='version';",
             ],
+            "2.0.2": [
+                "UPDATE config SET value='2.0.2' WHERE param='version';",
+                "INSERT OR IGNORE INTO config (param, value) VALUES ('log_level', 'WARNING');",
+            ],
         }
         version_str = self.get_config_value("version")
         if version_str is None:

src/ttmp32gme/log_handler.py

@@ -0,0 +1,37 @@
+"""Log handler for capturing logs in memory for frontend display."""
+
+import logging
+from collections import deque
+from threading import Lock
+from typing import List
+
+
+class MemoryLogHandler(logging.Handler):
+    """Custom log handler that stores recent log records in memory."""
+
+    def __init__(self, max_records: int = 1000):
+        super().__init__()
+        self.max_records = max_records
+        self.records: deque[str] = deque(maxlen=max_records)
+        self._lock: Lock = Lock()
+
+    def emit(self, record: logging.LogRecord) -> None:
+        """Store log record in memory."""
+        try:
+            msg = self.format(record)
+            with self._lock:
+                self.records.append(msg)
+        except Exception:
+            self.handleError(record)
+
+    def get_logs(self, num_lines: int = 100) -> List[str]:
+        """Get recent log entries.
+
+        Args:
+            num_lines: Number of recent log lines to return
+
+        Returns:
+            List of formatted log messages
+        """
+        with self._lock:
+            return list(self.records)[-num_lines:]

src/ttmp32gme/ttmp32gme.py

@@ -36,6 +36,7 @@
     DBHandler,
     LibraryActionModel,
 )
+from ttmp32gme.log_handler import MemoryLogHandler
 from ttmp32gme.print_handler import create_pdf, create_print_layout, format_print_button
 from ttmp32gme.tttool_handler import copy_gme, delete_gme_tiptoi, make_gme
 
@@ -45,6 +46,13 @@
 )
 logger = logging.getLogger(__name__)
 
+# Add memory handler to capture logs for frontend
+memory_handler = MemoryLogHandler(max_records=1000)
+memory_handler.setFormatter(
+    logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+)
+logging.getLogger().addHandler(memory_handler)
+
 # Create Flask app
 # Configure paths for both development and PyInstaller
 if getattr(sys, "frozen", False):
@@ -166,6 +174,13 @@ def save_config(config_params: Dict[str, Any]) -> tuple[Dict[str, Any], str]:
 
                 shutil.rmtree(new_path, ignore_errors=True)
 
+    # Handle log level changes
+    if "log_level" in config_params:
+        level_str = config_params["log_level"]
+        level = getattr(logging, level_str, logging.WARNING)
+        logging.getLogger().setLevel(level)
+        logger.info(f"Log level changed to {level_str}")
+
     # Validate DPI and pixel size
     if "tt_dpi" in config_params and "tt_pixel-size" in config_params:
         dpi = int(config_params["tt_dpi"])
@@ -560,6 +575,7 @@ def config_post():
                         "audio_format": new_config["audio_format"],
                         "pen_language": new_config["pen_language"],
                         "library_path": new_config["library_path"],
+                        "log_level": new_config.get("log_level", "WARNING"),
                     },
                 }
             )
@@ -577,6 +593,7 @@ def config_post():
                     "audio_format": config["audio_format"],
                     "pen_language": config["pen_language"],
                     "library_path": config["library_path"],
+                    "log_level": config.get("log_level", "WARNING"),
                 },
             }
         )
@@ -600,6 +617,40 @@ def help_page():
     )
 
 
+@app.route("/logs")
+def get_logs():
+    """Get recent log entries."""
+    num_lines = request.args.get("lines", default=100, type=int)
+    logs = memory_handler.get_logs(num_lines)
+    return jsonify({"success": True, "logs": logs})
+
+
+@app.route("/logs/level", methods=["POST"])
+def set_log_level():
+    """Set the log level dynamically."""
+    if not request.json:
+        return jsonify({"success": False, "error": "Invalid request"}), 400
+
+    level_str = request.json.get("level", "WARNING")
+
+    # Validate log level
+    valid_levels = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+    if level_str not in valid_levels:
+        return jsonify({"success": False, "error": "Invalid log level"}), 400
+
+    # Set the log level
+    level = getattr(logging, level_str)
+    logging.getLogger().setLevel(level)
+    logger.info(f"Log level changed to {level_str}")
+
+    # Save to config
+    db = get_db()
+    db.insert_or_replace_config("log_level", level_str)
+    config["log_level"] = level_str
+
+    return jsonify({"success": True, "level": level_str})
+
+
 @app.route("/images/<path:filename>")
 def serve_dynamic_image(filename: str):
     """Serve dynamically generated images (OID codes, covers, etc.)."""
@@ -747,6 +798,13 @@ def main():
         logger.info("Update successful.")
         config = fetch_config()
 
+    # Apply log level from config if not overridden by command line
+    if args.verbose == 0:  # Only apply config if -v/-vv not used
+        log_level_str = config.get("log_level", "WARNING")
+        log_level = getattr(logging, log_level_str, logging.WARNING)
+        logging.getLogger().setLevel(log_level)
+        logger.info(f"Log level set to {log_level_str} from config")
+
     # Override config with command-line args
     if args.port:
         config["port"] = args.port

tests/unit/test_log_handler.py

@@ -0,0 +1,82 @@
+"""Unit tests for MemoryLogHandler."""
+
+import logging
+import sys
+from pathlib import Path
+
+# Add src to path to import ttmp32gme
+sys.path.insert(0, str(Path(__file__).parent.parent.parent / "src"))
+
+
+def test_memory_log_handler_stores_logs():
+    """Test that MemoryLogHandler stores log records."""
+    from ttmp32gme.ttmp32gme import MemoryLogHandler
+
+    handler = MemoryLogHandler(max_records=10)
+    handler.setFormatter(
+        logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    )
+
+    logger = logging.getLogger("test_handler")
+    logger.addHandler(handler)
+    logger.setLevel(logging.DEBUG)
+
+    # Log some messages
+    logger.debug("Debug message")
+    logger.info("Info message")
+    logger.warning("Warning message")
+
+    # Get logs
+    logs = handler.get_logs()
+
+    assert len(logs) == 3
+    assert "Debug message" in logs[0]
+    assert "Info message" in logs[1]
+    assert "Warning message" in logs[2]
+
+
+def test_memory_log_handler_respects_max_records():
+    """Test that MemoryLogHandler respects max_records limit."""
+    from ttmp32gme.ttmp32gme import MemoryLogHandler
+
+    handler = MemoryLogHandler(max_records=5)
+    handler.setFormatter(logging.Formatter("%(message)s"))
+
+    logger = logging.getLogger("test_max_records")
+    logger.addHandler(handler)
+    logger.setLevel(logging.DEBUG)
+
+    # Log more than max_records
+    for i in range(10):
+        logger.info(f"Message {i}")
+
+    # Get logs
+    logs = handler.get_logs()
+
+    # Should only have last 5 messages
+    assert len(logs) == 5
+    assert "Message 5" in logs[0]
+    assert "Message 9" in logs[4]
+
+
+def test_memory_log_handler_get_logs_with_limit():
+    """Test that get_logs respects num_lines parameter."""
+    from ttmp32gme.ttmp32gme import MemoryLogHandler
+
+    handler = MemoryLogHandler(max_records=100)
+    handler.setFormatter(logging.Formatter("%(message)s"))
+
+    logger = logging.getLogger("test_limit")
+    logger.addHandler(handler)
+    logger.setLevel(logging.DEBUG)
+
+    # Log 20 messages
+    for i in range(20):
+        logger.info(f"Message {i}")
+
+    # Get only last 5 logs
+    logs = handler.get_logs(num_lines=5)
+
+    assert len(logs) == 5
+    assert "Message 15" in logs[0]
+    assert "Message 19" in logs[4]