Changeset 8128

Timestamp:

Mar 10, 2023, 1:24:13 PM (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

Moved the "View log" page to the extensions administration page.

Location:

branches/3.19-stable/www/admin

Files:

• extensions/details.js (modified) (2 diffs)
• extensions/details.jsp (modified) (3 diffs)
• extensions/index.jsp (modified) (2 diffs)
• extensions/view_log.js (added)
• extensions/view_log.jsp (moved) (moved from branches/3.19-stable/www/admin/services/view_log.jsp) (1 diff)
• services/index.jsp (modified) (2 diffs)
• services/services.js (modified) (3 diffs)

branches/3.19-stable/www/admin/extensions/details.js

@@ -49 +49 @@
     Buttons.addClickHandler('btnToggleExtension', details.toggleExtensionOnClick);
     Buttons.addClickHandler('btnToggleExtensionPoint', details.toggleExtensionPointOnClick);
+    Buttons.addClickHandler('btnViewLog', details.viewLog);
     
     Buttons.addClickHandler('btnEnableFile', details.enableOrDisableFileOnClick);
@@ -67 +68 @@
     url += '&cmd=ScanResults';
     Dialogs.openPopup(url, 'ScanResults', 750, 500);
+  }
+
+  details.viewLog = function(event)
+  {
+    var target = event.currentTarget;
+    var extensionId = Data.get(target, 'extension-id');
+    var url = 'view_log.jsp?ID='+App.getSessionId();
+    url += '&extensionId='+extensionId;
+    Dialogs.openPopup(url, 'ViewLog'+extensionId, 1000, 600);
   }
 

branches/3.19-stable/www/admin/extensions/details.jsp

@@ -47 +47 @@
   import="net.sf.basedb.util.extensions.manager.ProcessResults"
   import="net.sf.basedb.util.extensions.manager.ProcessResults.FileResults"
+  import="net.sf.basedb.util.extensions.logging.ExtensionsLog"
   import="net.sf.basedb.util.extensions.xml.PluginInfo"
   import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
@@ -145 +146 @@
       boolean hasRegistrationError = extFile != null && extFile.hasError();
       boolean allow = writePermission && !hasRegistrationError;
+      
+      String logIcon = "service_log.png";
+      String logSummary = "This extension doesn't have any log";
+      ExtensionsLog log = ExtensionsLog.getLog(extensionId, false);
+      if (log != null)
+      {
+        logSummary = "View the log for this extension; "+
+          log.getNumEntries() +" entries; " + 
+          log.getNumErrors()+" errors; "+
+          log.getNumWarnings()+" warnings";
+        if (log.getNumErrors() > 0)
+        {
+          logIcon = "service_log_error.png";
+        }
+        else if (log.getNumWarnings() > 0)
+        {
+          logIcon = "service_log_warning.png";
+        }
+      }
       %>
       <tbl:button 
@@ -154 +174 @@
         tooltip="Disable/enable this extension"
         disabled="<%=!allow%>"
+      />
+      <tbl:button
+        id="btnViewLog"
+        data-extension-id="<%=extensionId%>"
+        image="<%=logIcon%>" 
+        tooltip="<%=logSummary%>"
+        visible="<%=log != null%>"
+        title="View log&hellip;"
       />
       <tbl:button

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

@@ -33 +33 @@
   import="net.sf.basedb.util.extensions.ExtensionPoint"
   import="net.sf.basedb.util.extensions.Extension"
+  import="net.sf.basedb.util.extensions.logging.ExtensionsLogger"
+  import="net.sf.basedb.util.extensions.logging.ExtensionsLog"
   import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
   import="java.util.List"
@@ -101 +103 @@
     forward = "scan_results.jsp?ID=" + ID;
   }
+  else if ("ClearLog".equals(cmd))
+  {
+    String extensionId = request.getParameter("extensionId");
+    ExtensionsLog serviceLog = ExtensionsLog.getLog(extensionId, false);
+    if (serviceLog != null)
+    {
+      serviceLog.clearLog();
+      serviceLog.createLogger().info("The log was cleared by "+sc.getLoggedInUserName()+" ("+sc.getLoggedInUserLogin()+")");
+    }
+    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId);
+  }
+  else if ("SetLogOptions".equals(cmd))
+  {
+    String extensionId = request.getParameter("extensionId");
+    boolean enableDebug = Values.getBoolean(request.getParameter("enableDebug"));
+    boolean copyToStdout = Values.getBoolean(request.getParameter("copyToStdout"));
+    boolean autoUpdate = Values.getBoolean(request.getParameter("autoUpdate"));
+    ExtensionsLog serviceLog = ExtensionsLog.getLog(extensionId, true);
+    ExtensionsLogger logger = serviceLog.createLogger();
+    if (copyToStdout != serviceLog.isCopyingToStdout())
+    {
+      if (!copyToStdout) logger.info("Stop copy to stdout");
+      serviceLog.setCopyToStdout(copyToStdout);
+      if (copyToStdout) logger.info("Start copy to stdout");
+    }
+    if (enableDebug != serviceLog.isDebugEnabled())
+    {
+      if (!enableDebug) logger.debug("Debug logging was disabled");
+      serviceLog.setDebugEnabled(enableDebug);
+      if (enableDebug) logger.debug("Debug logging was enabled");
+    }
+    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId)+"&autoUpdate="+autoUpdate;
+  }
   else
   {

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

@@ -37 +37 @@
 %>
   <base:page type="popup" title="View log" id="view-page">
-  <base:head scripts="table.js,~services.js" styles="table.css,toolbar.css">
+  <base:head scripts="table.js,~view_log.js" styles="table.css,toolbar.css">
     <style>
     .level

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

@@ -34 +34 @@
   import="net.sf.basedb.util.extensions.Extension"
   import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
-  import="net.sf.basedb.util.extensions.logging.ExtensionsLogger"
-  import="net.sf.basedb.util.extensions.logging.ExtensionsLog"
-  import="net.sf.basedb.util.extensions.logging.LogLevel"
   import="java.util.List"
 %>
@@ -74 +71 @@
     redirect = "services.jsp?ID=" + ID;
   }
-  else if ("SetOptions".equals(cmd))
-  {
-    String extensionId = request.getParameter("extensionId");
-    boolean enableDebug = Values.getBoolean(request.getParameter("enableDebug"));
-    boolean copyToStdout = Values.getBoolean(request.getParameter("copyToStdout"));
-    boolean autoUpdate = Values.getBoolean(request.getParameter("autoUpdate"));
-    ExtensionsLog serviceLog = ExtensionsLog.getLog(extensionId, true);
-    ExtensionsLogger logger = serviceLog.createLogger();
-    if (copyToStdout != serviceLog.isCopyingToStdout())
-    {
-  if (!copyToStdout) logger.info("Stop copy to stdout");
-  serviceLog.setCopyToStdout(copyToStdout);
-  if (copyToStdout) logger.info("Start copy to stdout");
-    }
-    serviceLog.setCopyToStdout(copyToStdout);
-    if (enableDebug != serviceLog.isDebugEnabled())
-    {
-  if (!enableDebug) logger.debug("Debug logging was disabled");
-  serviceLog.setDebugEnabled(enableDebug);
-  if (enableDebug) logger.debug("Debug logging was enabled");
-    }
-    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId)+"&autoUpdate="+autoUpdate;
-  }
-  else if ("ClearLog".equals(cmd))
-  {
-    String extensionId = request.getParameter("extensionId");
-    ExtensionsLog serviceLog = ExtensionsLog.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

@@ -27 +27 @@
 {
   var services = {};
-  
-  services.initPage = function()
-  {
-    var pageId = Doc.getPageId();   
-    if (pageId == 'view-page')
-    {
-      // Close button
-      Buttons.addClickHandler('close', App.closeWindow);
-      
-      Buttons.addClickHandler('btnClearLog', services.clearLog);
-      Events.addEventHandler('enableDebug', 'change', services.setOptions);
-      Events.addEventHandler('copyToStdout', 'change', services.setOptions);
-      
-      // Auto-update timer
-      setInterval(services.autoUpdate, 2000);
-    }
-    else if (pageId == 'list-page')
-    {
-      // Nothing here yet
-    }
-  }
   
   services.initElements = function(element, autoInit)
@@ -93 +72 @@
   {
     var extensionId = Data.get(event.currentTarget, 'extension-id');
-    var url = 'view_log.jsp?ID='+App.getSessionId();
+    var url = '../extensions/view_log.jsp?ID='+App.getSessionId();
     url += '&extensionId='+extensionId;
     Dialogs.openPopup(url, 'ViewLog'+extensionId, 1000, 600);
-  }
-  
-  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.setOptions = function()
-  {
-    var extensionId = Data.get('page-data', 'extension-id');
-    var url = 'index.jsp?ID='+App.getSessionId();
-    url += '&cmd=SetOptions';
-    url += '&extensionId='+extensionId;
-    url += '&enableDebug='+(Doc.element('enableDebug').checked?1:0);
-    url += '&copyToStdout='+(Doc.element('copyToStdout').checked?1:0);
-    url += '&autoUpdate='+(Doc.element('autoUpdate').checked?1:0);;
-    location.replace(url);
-  }
-  
-  services.autoUpdate = function()
-  {
-    if (Doc.element('autoUpdate').checked)
-    {
-      var extensionId = Data.get('page-data', 'extension-id');
-      var url = 'view_log.jsp?ID='+App.getSessionId();
-      url += '&extensionId='+extensionId;
-      url += '&autoUpdate=1';
-      location.replace(url);
-    }
   }
   
@@ -135 +81 @@
 
 Doc.addElementInitializer(Services.initElements);
-Doc.onLoad(Services.initPage);