Merge pull request #2316 from ControlSystemStudio/CSSTUDIO-1582

Save & restore logging

Author: shroffk

app/logbook/elog/pom.xml

@@ -16,6 +16,11 @@
       <artifactId>core-logbook</artifactId>
       <version>4.6.10-SNAPSHOT</version>
     </dependency>
+      <dependency>
+          <groupId>org.phoebus</groupId>
+          <artifactId>core-security</artifactId>
+          <version>4.6.10-SNAPSHOT</version>
+      </dependency>
     <dependency>
         <groupId>net.dongliu</groupId>
         <artifactId>requests</artifactId>

app/logbook/olog/client-es/src/main/java/org/phoebus/olog/es/api/OlogClient.java

@@ -58,7 +58,7 @@ public class OlogClient implements LogClient {
 
     private static final String OLOG_CLIENT_INFO_HEADER = "X-Olog-Client-Info";
     private static final String CLIENT_INFO =
-            "CS Studio " + org.phoebus.ui.application.Messages.AppVersion + " on " + System.getProperty("os.name");
+            "CS Studio " + Messages.AppVersion + " on " + System.getProperty("os.name");
 
     /**
      * Builder Class to help create a olog client.

app/logbook/olog/client/pom.xml

@@ -24,6 +24,11 @@
             <artifactId>core-security</artifactId>
             <version>4.6.10-SNAPSHOT</version>
         </dependency>
+        <dependency>
+            <groupId>org.phoebus</groupId>
+            <artifactId>core-util</artifactId>
+            <version>4.6.10-SNAPSHOT</version>
+        </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/SendLogbookAction.java

@@ -8,7 +8,6 @@
 package org.phoebus.logbook.olog.ui.menu;
 
 import javafx.application.Platform;
-import javafx.scene.Node;
 import javafx.scene.control.MenuItem;
 import javafx.scene.image.Image;
 import org.phoebus.framework.jobs.JobManager;
@@ -43,19 +42,6 @@ public class SendLogbookAction extends MenuItem {
     /**
      * Constructor.
      *
-     * @param parent    JavaFX parent that context menu is called from.
-     * @param title     Initial title or <code>null</code>
-     * @param body      Initial body text or <code>null</code>
-     * @param get_image Supplier for image to attach, or <code>null</code>
-     */
-    public SendLogbookAction(final String title, final String body, final Supplier<Image> get_image) {
-        this(title, body == null ? null : () -> body, get_image);
-    }
-
-    /**
-     * Constructor.
-     *
-     * @param parent    JavaFX parent that context menu is called from.
      * @param title     Initial title or <code>null</code>
      * @param get_body  Supplier for initial body text or <code>null</code>
      * @param get_image Supplier for image to attach, or <code>null</code>

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/SendToLogBookApp.java

@@ -8,9 +8,12 @@
 package org.phoebus.logbook.olog.ui.menu;
 
 import javafx.scene.image.Image;
+import org.phoebus.framework.adapter.AdapterService;
+import org.phoebus.framework.selection.Selection;
+import org.phoebus.framework.selection.SelectionService;
 import org.phoebus.framework.spi.AppDescriptor;
 import org.phoebus.framework.spi.AppInstance;
-import org.phoebus.logbook.olog.ui.LogbookAvailabilityChecker;
+import org.phoebus.logbook.LogEntry;
 import org.phoebus.logbook.olog.ui.write.LogEntryEditorStage;
 import org.phoebus.olog.es.api.model.OlogLog;
 import org.phoebus.ui.javafx.ImageCache;
@@ -37,10 +40,15 @@ public String getName() {
 
     @Override
     public AppInstance create() {
-        if (!LogbookAvailabilityChecker.isLogbookAvailable()) {
-            return null;
+        Selection selection = SelectionService.getInstance().getSelection();
+        LogEntry ologLog;
+        if(selection.getSelections().isEmpty()){
+            ologLog = new OlogLog();
         }
-        new LogEntryEditorStage(new OlogLog()).show();
+        else{
+            ologLog = AdapterService.adapt(selection.getSelections().get(0), LogEntry.class).get();
+        }
+        new LogEntryEditorStage(ologLog).show();
         return null;
     }
 

app/save-and-restore/app/doc/index.rst

@@ -65,6 +65,14 @@ Once a selection of nodes have been copied or moved successfully, the target fol
 **NOTE**: Copying a large number of nodes and/or nodes with deep sub-trees is discouraged as this is an expensive operation.
 Moving nodes on the other hand is lightweight as only references in the tree structure are updated.
 
+Logging
+-------
+
+If a logbook implementation is available in the application, the optional logging module can be used to launch a log entry
+editor for the purpose of logging when a new snapshot has been saved, or when a snapshot has been restored.
+Properties of the snapshot (name, date etc) are automatically set on the log entry rendered by the editor. If
+a restore action has failed to write one or multiple PVs, a list of these PVs is also added to the log entry.
+
 Script Support
 --------------
 

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/Messages.java

@@ -55,6 +55,9 @@ public class Messages {
     public static String jmasarServiceUnavailable;
     public static String labelMultiplier;
     public static String labelThreshold;
+    public static String loggingFailedTitle;
+    public static String loggingFailed;
+    public static String loggingFailedCauseUnknown;
     public static String menuItemDeleteSelectedPVs;
     public static String openResourceFailedTitle;
     public static String openResourceFailedHeader;