Reorganize console.js file

pkg/web/static/js/console.js

@@ -1,26 +1,33 @@
-// Console Output Handler for Fail2ban UI
+// Console output handler (websocket log stream and rendering).
 "use strict";
 
+// =========================================================================
+//  Global Variables
+// =========================================================================
+
 let consoleOutputContainer = null;
 let consoleOutputElement = null;
-let maxConsoleLines = 1000; // Maximum number of lines to keep in console
-let wasConsoleEnabledOnLoad = false; // Track if console was enabled when page loaded
+let maxConsoleLines = 1000;
+let wasConsoleEnabledOnLoad = false;
 
+// =========================================================================
+//  Initialization
+// =========================================================================
+
+// Initialize the console output container and connect to the websocket
 function initConsoleOutput() {
   consoleOutputContainer = document.getElementById('consoleOutputContainer');
   consoleOutputElement = document.getElementById('consoleOutputWindow');
-  
+
   if (!consoleOutputContainer || !consoleOutputElement) {
     return;
   }
-
-  // Register WebSocket callback for console logs
   if (typeof wsManager !== 'undefined' && wsManager) {
     wsManager.onConsoleLog(function(message, timestamp) {
       appendConsoleLog(message, timestamp);
     });
   } else {
-    // Wait for WebSocket manager to be available
+    // Wait for websocket manager to be available
     const wsCheckInterval = setInterval(function() {
       if (typeof wsManager !== 'undefined' && wsManager) {
         wsManager.onConsoleLog(function(message, timestamp) {
@@ -29,35 +36,32 @@ function initConsoleOutput() {
         clearInterval(wsCheckInterval);
       }
     }, 100);
-    
-    // Stop checking after 5 seconds
+    // Timeout after 5 seconds if websocket manager is not available
     setTimeout(function() {
       clearInterval(wsCheckInterval);
     }, 5000);
   }
 }
 
+// Toggle the console output container
 function toggleConsoleOutput(userClicked) {
   const checkbox = document.getElementById('consoleOutput');
   const container = document.getElementById('consoleOutputContainer');
-  
+
   if (!checkbox || !container) {
     return;
   }
-  
+
   if (checkbox.checked) {
+    // Show the console output container
     container.classList.remove('hidden');
-    // Initialize console if not already done
     if (!consoleOutputElement) {
       initConsoleOutput();
     } else {
-      // Re-register WebSocket callback in case it wasn't registered before
       if (typeof wsManager !== 'undefined' && wsManager) {
-        // Remove any existing callbacks and re-register
         if (!wsManager.consoleLogCallbacks) {
           wsManager.consoleLogCallbacks = [];
         }
-        // Check if callback already exists
         let callbackExists = false;
         for (let i = 0; i < wsManager.consoleLogCallbacks.length; i++) {
           if (wsManager.consoleLogCallbacks[i].toString().includes('appendConsoleLog')) {
@@ -72,17 +76,14 @@ function toggleConsoleOutput(userClicked) {
         }
       }
     }
-    
-    // Show save hint only if user just clicked to enable (not on page load)
+
     const consoleEl = document.getElementById('consoleOutputWindow');
+   // Show save hint only if user just clicked to enable (not on page load)
     if (consoleEl && userClicked && !wasConsoleEnabledOnLoad) {
-      // Clear initial placeholder message
       const placeholder = consoleEl.querySelector('.text-gray-500');
       if (placeholder && placeholder.textContent === 'Console output will appear here...') {
         placeholder.remove();
       }
-      
-      // Show save hint message
       const hintDiv = document.createElement('div');
       hintDiv.className = 'text-yellow-400 italic text-center py-4';
       hintDiv.id = 'consoleSaveHint';
@@ -90,59 +91,76 @@ function toggleConsoleOutput(userClicked) {
       hintDiv.textContent = hintText;
       consoleEl.appendChild(hintDiv);
     } else if (consoleEl) {
-      // Just clear initial placeholder if it exists
       const placeholder = consoleEl.querySelector('.text-gray-500');
+      // Remove placeholder if it exists
       if (placeholder && placeholder.textContent === 'Console output will appear here...') {
         placeholder.remove();
       }
     }
   } else {
+    // Hide the console output container
     container.classList.add('hidden');
   }
 }
 
+// Auto-start console if enabled on load
+if (typeof window !== 'undefined') {
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', function() {
+      const checkbox = document.getElementById('consoleOutput');
+      if (checkbox && checkbox.checked) {
+        wasConsoleEnabledOnLoad = true;
+        toggleConsoleOutput(false);
+      }
+      initConsoleOutput();
+    });
+  } else {
+    const checkbox = document.getElementById('consoleOutput');
+    if (checkbox && checkbox.checked) {
+      wasConsoleEnabledOnLoad = true;
+      toggleConsoleOutput(false);
+    }
+    initConsoleOutput();
+  }
+}
+
+// =========================================================================
+//  Log Rendering / Core Functionality
+// =========================================================================
+
 function appendConsoleLog(message, timestamp) {
   if (!consoleOutputElement) {
     consoleOutputElement = document.getElementById('consoleOutputWindow');
   }
-  
   if (!consoleOutputElement) {
     return;
   }
-  
-  // Remove initial placeholder message
+  // Remove placeholder if it exists
   const placeholder = consoleOutputElement.querySelector('.text-gray-500');
   if (placeholder && placeholder.textContent === 'Console output will appear here...') {
     placeholder.remove();
   }
-  
-  // Remove save hint when first log arrives
+  // Remove save hint if it exists
   const saveHint = document.getElementById('consoleSaveHint');
   if (saveHint) {
     saveHint.remove();
   }
-  
-  // Create log line
+  // Create new log line element with timestamp
   const logLine = document.createElement('div');
   logLine.className = 'text-green-400 leading-relaxed';
-  
-  // Format timestamp if provided
   let timeStr = '';
   if (timestamp) {
     try {
       const date = new Date(timestamp);
       timeStr = '<span class="text-gray-500">[' + date.toLocaleTimeString() + ']</span> ';
-    } catch (e) {
-      // Ignore timestamp parsing errors
-    }
+    } catch (e) {}
   }
-  
-  // Escape HTML to prevent XSS (but preserve timestamp HTML)
+
+  // Escape message to prevent XSS
   let escapedMessage = message;
   if (typeof escapeHtml === 'function') {
     escapedMessage = escapeHtml(escapedMessage);
   } else {
-    // Fallback HTML escaping
     escapedMessage = escapedMessage
       .replace(/&/g, '&amp;')
       .replace(/</g, '&lt;')
@@ -151,10 +169,8 @@ function appendConsoleLog(message, timestamp) {
       .replace(/'/g, '&#039;');
   }
   
-  // Color code different log levels using precise patterns to avoid
-  // false positives from SSH flags (e.g. "-o LogLevel=ERROR") or
-  // substrings like "stderr".
-  // Skip coloring for SSH command output that dumps config file content
+  // Set different colors for different log levels using patterns below.
+  // Default is green.
   let logClass = 'text-green-400';
   var isConfigDump = /SSH command output\b/.test(message) && /Fail2Ban-UI Managed Configuration|jail\.local|action_mwlg/.test(message);
   if (!isConfigDump) {
@@ -166,53 +182,26 @@ function appendConsoleLog(message, timestamp) {
       logClass = 'text-blue-400';
     }
   }
-  
   logLine.className = logClass + ' leading-relaxed';
+
+  // Build complete log line with timestamp and message
   logLine.innerHTML = timeStr + escapedMessage;
-  
-  // Add to console
+  // Add log line to console
   consoleOutputElement.appendChild(logLine);
-  
-  // Limit number of lines
+
   const lines = consoleOutputElement.children;
   if (lines.length > maxConsoleLines) {
     consoleOutputElement.removeChild(lines[0]);
   }
-  
-  // Auto-scroll to bottom
   consoleOutputElement.scrollTop = consoleOutputElement.scrollHeight;
 }
 
+// Clear the console
 function clearConsole() {
   if (!consoleOutputElement) {
     consoleOutputElement = document.getElementById('consoleOutputWindow');
   }
-  
   if (consoleOutputElement) {
     consoleOutputElement.textContent = '';
-    // Note: wasConsoleEnabledOnLoad remains true, so hint won't show again after clear
-  }
-}
-
-// Initialize on page load
-if (typeof window !== 'undefined') {
-  if (document.readyState === 'loading') {
-    document.addEventListener('DOMContentLoaded', function() {
-      // Check if console output is already enabled on page load
-      const checkbox = document.getElementById('consoleOutput');
-      if (checkbox && checkbox.checked) {
-        wasConsoleEnabledOnLoad = true; // Mark that it was enabled on load
-        toggleConsoleOutput(false); // false = not a user click
-      }
-      initConsoleOutput();
-    });
-  } else {
-    // Check if console output is already enabled on page load
-    const checkbox = document.getElementById('consoleOutput');
-    if (checkbox && checkbox.checked) {
-      wasConsoleEnabledOnLoad = true; // Mark that it was enabled on load
-      toggleConsoleOutput(false); // false = not a user click
-    }
-    initConsoleOutput();
   }
 }