Changeset 8120

Timestamp:

Mar 7, 2023, 10:40:50 AM (7 months ago)

Author:

Nicklas Nordborg

Message:

References #2295: Add API for services to send log messages that can be displayed by the web client

Added a function for clearing the log.

Location:

branches/3.19-stable

Files:

• src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java (modified) (5 diffs)
• www/admin/services/index.jsp (modified) (1 diff)
• www/admin/services/services.js (modified) (2 diffs)
• www/admin/services/view_log.jsp (modified) (2 diffs)

branches/3.19-stable/src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java

@@ -28 +28 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentLinkedDeque;
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 import org.apache.commons.collections4.iterators.UnmodifiableIterator;
@@ -75 +78 @@
   private final String extensionId;
   private final Deque<LogEntry> logEntries;
+  private final ReadWriteLock lock;
   
   private int maxEntries;
@@ -88 +92 @@
     this.logEntries = new ConcurrentLinkedDeque<>();
     this.maxEntries = 200;
+    this.lock = new ReentrantReadWriteLock();
   }
   
@@ -144 +149 @@
   {
     return numErrors;
+  }
+  
+  /**
+    Clear the log.
+  */
+  public void clearLog()
+  {
+    // We need the write lock here since we are changing multiple properties
+    Lock l = lock.writeLock();
+    try
+    {
+      l.lock();
+      logEntries.clear();
+      numEntries = 0;
+      numWarnings = 0;
+      numErrors = 0;
+    }
+    finally
+    {
+      l.unlock();
+    }
   }
   
@@ -160 +186 @@
   void add(LogEntry entry)
   {
-    if (entry.level == LogLevel.DEBUG && !isDebugEnabled) return; // 
-    logEntries.addFirst(entry);
-    if (entry.level == LogLevel.WARNING) numWarnings++;
-    if (entry.level == LogLevel.ERROR) numErrors++;
-
-    if (numEntries++ > maxEntries)
-    {
-      // Remove one entry
-      numEntries--;
-      LogEntry last = logEntries.removeLast();
-      if (last.level == LogLevel.WARNING) numWarnings--;
-      if (last.level == LogLevel.ERROR) numErrors--;
+    // A read lock should be enough since we are using a ConcurrentLinkedDeque that supports multiple threads
+    Lock l = lock.readLock();
+    try
+    {
+      l.lock();
+      if (entry.level == LogLevel.DEBUG && !isDebugEnabled) return; // 
+      logEntries.addFirst(entry);
+      if (entry.level == LogLevel.WARNING) numWarnings++;
+      if (entry.level == LogLevel.ERROR) numErrors++;
+  
+      if (numEntries++ > maxEntries)
+      {
+        // Remove one entry
+        numEntries--;
+        LogEntry last = logEntries.removeLast();
+        if (last.level == LogLevel.WARNING) numWarnings--;
+        if (last.level == LogLevel.ERROR) numErrors--;
+      }
+    }
+    finally
+    {
+      l.unlock();
     }
   }

branches/3.19-stable/www/admin/services/index.jsp

@@ -88 +88 @@
     redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId);
   }
+  else if ("ClearLog".equals(cmd))
+  {
+    String extensionId = request.getParameter("extensionId");
+    ServiceLog serviceLog = ServiceLog.getLog(extensionId, false);
+    if (serviceLog != null)
+    {
+      serviceLog.clearLog();
+      serviceLog.createLogger().log(LogLevel.INFO, "The log was cleared by "+sc.getLoggedInUserName()+" ("+sc.getLoggedInUserLogin()+")");
+    }
+    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId);
+  }
   else
   {

branches/3.19-stable/www/admin/services/services.js

@@ -36 +36 @@
       Buttons.addClickHandler('close', App.closeWindow);
       
+      Buttons.addClickHandler('btnClearLog', services.clearLog);
       Events.addEventHandler('enableDebug', 'change', services.toggleDebugLog);
       
@@ -86 +87 @@
   }
   
+  services.clearLog = function()
+  {
+    var extensionId = Data.get('page-data', 'extension-id');
+    var url = 'index.jsp?ID='+App.getSessionId();
+    url += '&cmd=ClearLog';
+    url += '&extensionId='+extensionId;
+    location.replace(url);
+  }
+  
   services.toggleDebugLog = function()
   {

branches/3.19-stable/www/admin/services/view_log.jsp

@@ -38 +38 @@
   %>
   <base:page type="popup" title="View log" id="view-page">
-  <base:head scripts="table.js,~services.js" styles="table.css">
+  <base:head scripts="table.js,~services.js" styles="table.css,toolbar.css">
     <style>
     .level
@@ -85 +85 @@
         title="Message" 
       />
-      <div class="panelgroup bg-filled-50 bottomborder" style="height: 1.9em; padding: 0.25em; 1em;">
-        <tbl:panel>
+      <div class="panelgroup bg-filled-50 bottomborder" style="height: 1.9em;">
+        <tbl:toolbar>
+          <tbl:button
+            id="btnClearLog"
+            title="Clear the log"
+            image="delete.png"
+          />
+          <tbl:label style="padding-right: 1em;">
           <label><input type="checkbox" name="enableDebug" 
             id="enableDebug" <%=serviceLog.isDebugEnabled()?"checked":""%>
             >Enable debug logging</label>
+          </tbl:label>
+          <tbl:label style="padding-right: 1em;">
           <label><input type="checkbox" name="autoUpdate"
             id="autoUpdate" <%=autoUpdate?"checked":"" %>
             >Auto update</label>
-        </tbl:panel>
+          </tbl:label>
+        </tbl:toolbar>
       </div>
       <tbl:data style="top: 1.9em; margin-top: 0px;">