Merge branch 'ControlSystemStudio:master' into pv-tango

katysaintin · web-flow · commit 16408397776e · 2025-10-22T19:28:12.000+02:00
diff --git a/app/display/representation-javafx/pom.xml b/app/display/representation-javafx/pom.xml
@@ -20,11 +20,6 @@
       <version>1.3</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.apache.commons</groupId>
-      <artifactId>commons-lang3</artifactId>
-      <version>3.5</version>
-    </dependency>
     <dependency>
       <groupId>org.controlsfx</groupId>
       <artifactId>controlsfx</artifactId>
diff --git a/app/logbook/olog/client-es/src/main/java/org/phoebus/olog/es/api/OlogHttpClient.java b/app/logbook/olog/client-es/src/main/java/org/phoebus/olog/es/api/OlogHttpClient.java
@@ -260,9 +260,14 @@ private SearchResult findLogs(MultivaluedMap<String, String> searchParams) throw
                 .build();
         try {
             HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
-            OlogSearchResult searchResult = OlogObjectMappers.logEntryDeserializer.readValue(response.body(), OlogSearchResult.class);
-            return SearchResult.of(new ArrayList<>(searchResult.getLogs()),
-                    searchResult.getHitCount());
+            if(response.statusCode() == 200) {
+                OlogSearchResult searchResult = OlogObjectMappers.logEntryDeserializer.readValue(response.body(), OlogSearchResult.class);
+                return SearchResult.of(new ArrayList<>(searchResult.getLogs()),
+                        searchResult.getHitCount());
+            }
+            else{
+                throw new RuntimeException(response.body());
+            }
         } catch (Exception e) {
             LOGGER.log(Level.WARNING, "failed to retrieve log entries", e);
             throw new RuntimeException(e);
diff --git a/app/logbook/olog/ui/doc/index.rst b/app/logbook/olog/ui/doc/index.rst
@@ -21,6 +21,12 @@ Features
 
 - Log entry viewers offer search capabilities based on meta data and content.
 
+Missing features
+----------------
+In contrast to other markup implementations, HTML tags are **not** supported. Any such tags entered by user will
+be rendered as plain text.
+
+
 Launching the log entry editor
 ------------------------------
 The log entry editor is launched as a non-modal window using one of the following methods:
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/HtmlAwareController.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/HtmlAwareController.java
@@ -29,30 +29,38 @@
 
 public class HtmlAwareController {
 
-    private Parser parser;
-    private HtmlRenderer htmlRenderer;
+    private final Parser parser;
+    private final HtmlRenderer htmlRenderer;
 
+    /**
+     * Constructor to generate html code for HTML preview feature in LogEntryEditor or detailed log entry view.
+     * @param serviceUrl Olog service url
+     */
     public HtmlAwareController(String serviceUrl){
-        List<Extension> extensions =
-                Arrays.asList(TablesExtension.create(), ImageAttributesExtension.create());
-        this.parser = Parser.builder().extensions(extensions).build();
-        htmlRenderer = HtmlRenderer.builder()
-                .attributeProviderFactory(context -> new OlogAttributeProvider(serviceUrl))
-                .extensions(extensions).build();
+       this(new OlogAttributeProvider(serviceUrl));
     }
 
     /**
-     * To create HtmlAwareController object to generate html code for HTML preview feature in LogEntryEditor.
+     * Constructor to generate html code for HTML preview feature in LogEntryEditor or detailed log entry view.
      * @param serviceUrl Olog service url.
      * @param preview Set true when preview button is clicked.
      * @param attachments The current attachments list from AttachmentsEditorController.
      */
     public HtmlAwareController(String serviceUrl, boolean preview, List<Attachment> attachments){
+       this(new OlogAttributeProvider(serviceUrl, preview, attachments));
+    }
+
+    /**
+     * Private constructor to avoid code duplication.
+     * @param ologAttributeProvider The {@link OlogAttributeProvider} particular to the use case.
+     */
+    private HtmlAwareController(OlogAttributeProvider ologAttributeProvider){
         List<Extension> extensions =
                 Arrays.asList(TablesExtension.create(), ImageAttributesExtension.create());
         this.parser = Parser.builder().extensions(extensions).build();
         htmlRenderer = HtmlRenderer.builder()
-                .attributeProviderFactory(context -> new OlogAttributeProvider(serviceUrl, preview, attachments))
+                .escapeHtml(true)
+                .attributeProviderFactory(context -> ologAttributeProvider)
                 .extensions(extensions).build();
     }
 
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryCalenderViewController.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryCalenderViewController.java
@@ -34,6 +34,7 @@
 import org.phoebus.logbook.SearchResult;
 import org.phoebus.logbook.olog.ui.query.OlogQuery;
 import org.phoebus.logbook.olog.ui.query.OlogQueryManager;
+import org.phoebus.ui.dialog.ExceptionDetailsErrorDialog;
 
 import java.net.URL;
 import java.time.LocalDateTime;
@@ -262,7 +263,8 @@ public void search() {
                 },
                 (msg, ex) -> {
                     searchInProgress.set(false);
-                });
+                    ExceptionDetailsErrorDialog.openError(agenda, Messages.SearchFailed, "", ex);
+        });
     }
 
     public String getQuery() {
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTableViewController.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTableViewController.java
@@ -25,6 +25,7 @@
 import javafx.scene.control.Pagination;
 import javafx.scene.control.ProgressIndicator;
 import javafx.scene.control.SelectionMode;
+import javafx.scene.control.SplitPane;
 import javafx.scene.control.TableCell;
 import javafx.scene.control.TableColumn;
 import javafx.scene.control.TableView;
@@ -60,6 +61,7 @@
 import org.phoebus.security.store.SecureStore;
 import org.phoebus.security.tokens.ScopedAuthenticationToken;
 import org.phoebus.ui.dialog.DialogHelper;
+import org.phoebus.ui.dialog.ExceptionDetailsErrorDialog;
 
 import java.io.IOException;
 import java.util.ArrayList;
@@ -88,6 +90,10 @@ public class LogEntryTableViewController extends LogbookSearchController impleme
     @SuppressWarnings("unused")
     private GridPane viewSearchPane;
 
+    @SuppressWarnings("unused")
+    @FXML
+    private SplitPane splitPane;
+
     // elements related to the table view of the log entries
     @FXML
     @SuppressWarnings("unused")
@@ -420,6 +426,7 @@ public void search() {
                 },
                 (msg, ex) -> {
                     searchInProgress.set(false);
+                    ExceptionDetailsErrorDialog.openError(splitPane, Messages.SearchFailed, "", ex);
                 });
     }
 
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java
@@ -55,6 +55,7 @@ public class Messages
             PreviewOpenErrorTitle,
             ReplyToLogEntry,
             RequestTooLarge,
+            SearchFailed,
             SelectFile,
             SelectFolder,
             ShowHideDetails,
diff --git a/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties b/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties
@@ -94,6 +94,7 @@ ScalingFactor=Scaling Factor
 SearchButtonText=Search:
 Search=Search available:
 SearchAvailableItems=Search the list of available items.
+SearchFailed=Search Failed
 SearchToolTip=Edit and press Enter to search
 Selected=Selected
 SelectFolder=Select Folder
diff --git a/app/logbook/olog/ui/src/test/java/org/phoebus/logbook/olog/ui/HtmlAwareControllerTest.java b/app/logbook/olog/ui/src/test/java/org/phoebus/logbook/olog/ui/HtmlAwareControllerTest.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2025 European Spallation Source ERIC.
+ */
+
+package org.phoebus.logbook.olog.ui;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class HtmlAwareControllerTest {
+
+    @Test
+    public void testEscapeHtml(){
+        HtmlAwareController htmlAwareController = new HtmlAwareController("");
+        String escapedHtml = htmlAwareController.toHtml("<br><p>Paragraph</p>");
+        assertEquals("<p>&lt;br&gt;&lt;p&gt;Paragraph&lt;/p&gt;</p>\n", escapedHtml);
+    }
+}
diff --git a/app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/snapshot/SnapshotController.java b/app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/snapshot/SnapshotController.java
@@ -724,6 +724,7 @@ public void initializeViewForNewSnapshot(Node configurationNode) {
             SnapshotData snapshotData = new SnapshotData();
             snapshotData.setSnapshotItems(configurationToSnapshotItems(configPvs));
             this.snapshot = new Snapshot();
+            this.snapshot.setSnapshotNode(Node.builder().nodeType(NodeType.SNAPSHOT).build());
             this.snapshot.setSnapshotData(snapshotData);
             updateUi();
             Platform.runLater(() -> actionResultReadbackColumn.visibleProperty().setValue(false));
@@ -757,13 +758,18 @@ public void takeSnapshot() {
      */
     private void resetMetaData() {
         tabTitleProperty.setValue(Messages.unnamedSnapshot);
-        snapshotNameProperty.setValue(null);
-        snapshotCommentProperty.setValue(null);
         createdDateTextProperty.setValue(null);
         lastModifiedDateTextProperty.setValue(null);
         createdByTextProperty.setValue(null);
     }
 
+    public static Throwable getRootCause(Throwable throwable) {
+        if (throwable.getCause() != null)
+            return getRootCause(throwable.getCause());
+
+        return throwable;
+    }
+
     @SuppressWarnings("unused")
     public void saveSnapshot(ActionEvent actionEvent) {
         disabledUi.set(true);
@@ -795,7 +801,8 @@ public void saveSnapshot(ActionEvent actionEvent) {
                 Platform.runLater(() -> {
                     Alert alert = new Alert(Alert.AlertType.ERROR);
                     alert.setTitle(Messages.errorActionFailed);
-                    alert.setContentText(e.getMessage());
+                    // get root cause of exception because the nested exception names are not very friendly
+                    alert.setContentText(getRootCause(e).getMessage());
                     alert.setHeaderText(Messages.saveSnapshotErrorContent);
                     DialogHelper.positionDialog(alert, borderPane, -150, -150);
                     alert.showAndWait();
@@ -1101,7 +1108,14 @@ private void takeSnapshotReadPVs(Consumer<Optional<Snapshot>> consumer) {
             });
             showTakeSnapshotResult(snapshotItems);
             Snapshot snapshot = new Snapshot();
-            snapshot.setSnapshotNode(Node.builder().nodeType(NodeType.SNAPSHOT).build());
+            snapshot.setSnapshotNode(
+                    Node.builder()
+                        .nodeType(NodeType.SNAPSHOT)
+                        // set name and description to preserve the name / comment fields
+                        .name(snapshotNameProperty.getValue())
+                        .description(snapshotCommentProperty.getValue())
+                        .build()
+            );
             SnapshotData snapshotData = new SnapshotData();
             snapshotData.setSnapshotItems(snapshotItems);
             snapshot.setSnapshotData(snapshotData);
diff --git a/core/formula/doc/index.rst b/core/formula/doc/index.rst
@@ -148,6 +148,9 @@ and toIndex. The indexes must be valid, e.g. fromIndex > 0, fromIndex < toIndex
 **arrayRangeOf(VNumberArray array)** - Returns a Display Range of the given array
 This includes the display min, max
 
+**arrayReversal(VNumberArray array)** - Returns a VNumberArray with the elements in reverse order
+(the first element becomes the last, the last becomes the first).
+
 **arrayStats(VNumberArray array)** - Returns a VStatistic with the statistical information of the given array
 This includes the average, min, max, and element count
 
@@ -163,8 +166,6 @@ The down-sampling is performed using the Largest-Triangle-Three-Buckets (LTTB) a
 
 **arrayCumSum(VNumberArray array)** - Returns a VNumberArray where each element is defined as the cumulative sum of the input array.
 
-String
-------
 **concat(String s...)** - Concatenate a list of strings of a string array.
 
 **strEqual(String s1, String s2)** - Compare value of 2 strings. Return true if s1 equals s2, else false.
diff --git a/core/formula/src/main/java/org/csstudio/apputil/formula/array/ArrayReversalFunction.java b/core/formula/src/main/java/org/csstudio/apputil/formula/array/ArrayReversalFunction.java
@@ -0,0 +1,98 @@
+package org.csstudio.apputil.formula.array;
+
+import org.csstudio.apputil.formula.Formula;
+import org.epics.util.array.ListDouble;
+import org.epics.util.array.ListNumber;
+import org.epics.vtype.Alarm;
+import org.epics.vtype.Display;
+import org.epics.vtype.VNumberArray;
+import org.epics.vtype.VType;
+import org.phoebus.core.vtypes.VTypeHelper;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.logging.Level;
+
+/**
+ * A formula function for reversing the given array.
+ * <p>
+ * The function allows for reversing the order of elements in an array, such that the first element
+ * becomes the last, the second element becomes the second to last, and so on.
+ * </p>
+ *
+ * <b>Arguments:</b>
+ * <ul>
+ *     <li><b>array</b>: The input numeric array to reverse.</li>
+ * </ul>
+ *
+ * <b>Example:</b>
+ * <p>
+ * If given an array [1, 2, 3, 4, 5], the result will be [5, 4, 3, 2, 1].
+ * </p>
+ *
+ * @author Kunal Shroff
+ */
+public class ArrayReversalFunction extends BaseArrayFunction {
+
+    @Override
+    public String getName() {
+        return "arrayReverse";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Reverses the given numeric array so that the first element becomes the last and vice versa.";
+    }
+
+    @Override
+    public List<String> getArguments() {
+        return List.of("array");
+    }
+
+    /**
+     * Reverses the elements of a numeric array.
+     *
+     * @param array The input numeric array (VNumberArray) to reverse.
+     * @return A {@link VNumberArray} containing the reversed elements.
+     */
+    protected VType getArrayData(final VNumberArray array) {
+        return VNumberArray.of(reverse(array.getData()), Alarm.none(), array.getTime(), Display.none());
+    }
+
+    private static ListDouble reverse(final ListNumber data) {
+        return new ListDouble() {
+            @Override
+            public double getDouble(int index) {
+                return data.getDouble(data.size() - 1 - index);
+            }
+
+            @Override
+            public int size() {
+                return data.size();
+            }
+        };
+    }
+
+    /**
+     * Computes the function's result by reversing the provided array.
+     *
+     * @param args The arguments to the function:
+     *             - args[0]: The input array to reverse.
+     * @return A {@link VType} containing the reversed array.
+     * @throws Exception If an invalid number of arguments or incorrect argument types are provided.
+     */
+    @Override
+    public VType compute(final VType... args) throws Exception {
+        if (args.length != 1) {
+            throw new Exception("Function " + getName() +
+                    " requires 1 argument but received " + Arrays.toString(args));
+        }
+        if (!VTypeHelper.isNumericArray(args[0])) {
+            Formula.logger.log(Level.WARNING, "Function " + getName() +
+                    " takes array but received " + Arrays.toString(args));
+            return DEFAULT_NAN_DOUBLE_ARRAY;
+        } else {
+            return getArrayData((VNumberArray) args[0]);
+        }
+    }
+}
diff --git a/core/formula/src/main/resources/META-INF/services/org.csstudio.apputil.formula.spi.FormulaFunction b/core/formula/src/main/resources/META-INF/services/org.csstudio.apputil.formula.spi.FormulaFunction
@@ -59,6 +59,7 @@ org.csstudio.apputil.formula.array.ArrayScalarDivisionFunction
 org.csstudio.apputil.formula.array.ArrayInverseScalarDivisionFunction
 org.csstudio.apputil.formula.array.ArrayOfFunction
 org.csstudio.apputil.formula.array.ArrayRangeOfFunction
+org.csstudio.apputil.formula.array.ArrayReversalFunction
 org.csstudio.apputil.formula.array.ArraySampleWithLTTBFunction
 org.csstudio.apputil.formula.array.ArraySampleWithStrideFunction
 org.csstudio.apputil.formula.array.ArrayStatsFunction
diff --git a/core/formula/src/test/java/org/csstudio/apputil/formula/array/ArrayReversalFunctionTest.java b/core/formula/src/test/java/org/csstudio/apputil/formula/array/ArrayReversalFunctionTest.java
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/persistence/dao/impl/elasticsearch/ElasticsearchDAO.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/persistence/dao/impl/elasticsearch/ElasticsearchDAO.java
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java
