Merge pull request #3457 from ControlSystemStudio/CSSTUDIO-2906

Add check for HEIC file attachments

Author: shroffk

app/logbook/olog/ui/doc/index.rst

@@ -77,6 +77,10 @@ Here user may attach any number of files of arbitrary types:
 can be configured to use a different limit, but users should keep in mind that download of large attachments to
 the log viewer may incur delays in terms of UI updates.
 
+**NOTE**: Since iOS 11 the default camera image format is HEIC/HEIF (High-Efficiency Image Format). This type of
+image file is not supported. Consequently upload of HEIC files is blocked by the application. Moreover, HEIC files converted to JPEG
+in native Mac OS applications (e.g. Preview) may also fail to render and are also blocked from upload.
+
 Embedded images
 ---------------
 Images may be embedded in the body text using markup. The user should consult the quick reference (Markup Help button)

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java

@@ -59,6 +59,7 @@ public class Messages
             SelectFolder,
             ShowHideDetails,
             SizeLimitsText,
+            UnsupportedFileType,
             UpdateLogEntry;
 
     static

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/write/AttachmentsEditorController.java

@@ -47,10 +47,12 @@
 import org.phoebus.ui.docking.DockPane;
 import org.phoebus.ui.javafx.ImageCache;
 import org.phoebus.ui.javafx.Screenshot;
+import org.phoebus.util.MimeTypeDetector;
 
 import javax.activation.MimetypesFileTypeMap;
 import javax.imageio.ImageIO;
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -291,11 +293,18 @@ public void setTextArea(TextArea textArea) {
         this.textArea = textArea;
     }
 
+    /**
+     * Add
+     * @param files
+     */
     private void addFiles(List<File> files) {
         Platform.runLater(() -> sizesErrorMessage.set(null));
         if (!checkFileSizes(files)) {
             return;
         }
+        if(!checkForHeicFiles(files)){
+            return;
+        }
         MimetypesFileTypeMap fileTypeMap = new MimetypesFileTypeMap();
         for (File file : files) {
             OlogAttachment ologAttachment = new OlogAttachment();
@@ -403,4 +412,43 @@ private void showTotalSizeExceedsLimit() {
     public void clearAttachments(){
         getAttachments().clear();
     }
+
+    /**
+     * Checks if any of the attached files uses extension heic or heics, which are unsupported. If a heic file
+     * is detected, an error dialog is shown.
+     * @param files List of {@link File}s to check.
+     * @return <code>true</code> if all is well, i.e. no heic files deyected, otherwise <code>false</code>.
+     */
+    private boolean checkForHeicFiles(List<File> files){
+        File file = detectHeicFiles(files);
+        if(file != null){
+            Alert alert = new Alert(AlertType.ERROR);
+            alert.setHeaderText(MessageFormat.format(Messages.UnsupportedFileType, file.getAbsolutePath()));
+            DialogHelper.positionDialog(alert, textArea, -200, -100);
+            alert.show();
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Probes files for heic content, which is not supported.
+     * @param files List of {@link File}s to check.
+     * @return The first {@link File} in the list determined to have heic. If no such file
+     * is detected, <code>null</code> is returned.
+     */
+    private File detectHeicFiles(List<File> files){
+        for(File file : files){
+            try {
+                String mimeType = MimeTypeDetector.determineMimeType(new FileInputStream(file));
+                if(mimeType != null && mimeType.toLowerCase().contains("image/heic")){
+                    return file;
+                }
+            } catch (IOException e) {
+                logger.log(Level.WARNING, "Cannot check file " +
+                        file.getAbsolutePath() + " for heic file content", e);
+            }
+        }
+        return null;
+    }
 }

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/write/EmbedImageDialogController.java

@@ -45,6 +45,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
+import java.util.List;
 import java.util.ResourceBundle;
 import java.util.UUID;
 import java.util.logging.Level;
@@ -55,49 +56,60 @@
  */
 public class EmbedImageDialogController implements Initializable{
 
+    @SuppressWarnings("unused")
     @FXML
     private DialogPane dialogPane;
+    @SuppressWarnings("unused")
     @FXML
     private Label fileLabel;
+    @SuppressWarnings("unused")
     @FXML
     private Label widthLabel;
+    @SuppressWarnings("unused")
     @FXML
     private Label heightLabel;
+    @SuppressWarnings("unused")
     @FXML
     private Button browseButton;
+    @SuppressWarnings("unused")
     @FXML
     private Button clipboardButton;
+    @SuppressWarnings("unused")
     @FXML
     private TextField fileName;
+    @SuppressWarnings("unused")
     @FXML
     private TextField width;
+    @SuppressWarnings("unused")
     @FXML
     private TextField height;
+    @SuppressWarnings("unused")
     @FXML
     private Label scaleLabel;
+    @SuppressWarnings("unused")
     @FXML
     private TextField scale;
 
     /**
      * This is set when image is selected from file or clipboard. It is not bound to
      * a UI component.
      */
-    private IntegerProperty widthProperty = new SimpleIntegerProperty();
+    private final IntegerProperty widthProperty = new SimpleIntegerProperty();
     /**
      * This is the computed width value rendered in the UI component.
      */
-    private IntegerProperty scaledWidthProperty = new SimpleIntegerProperty();
+    private final IntegerProperty scaledWidthProperty = new SimpleIntegerProperty();
     /**
      * This is set when image is selected from file or clipboard. It is not bound to
      * a UI component.
      */
-    private IntegerProperty heightProperty = new SimpleIntegerProperty();
+    private final IntegerProperty heightProperty = new SimpleIntegerProperty();
     /**
      * This is the computed width value rendered in the UI component.
      */
-    private IntegerProperty scaledHeightProperty = new SimpleIntegerProperty();
-    private SimpleStringProperty filenameProperty = new SimpleStringProperty();
-    private DoubleProperty scaleProperty = new SimpleDoubleProperty(1.0);
+    private final IntegerProperty scaledHeightProperty = new SimpleIntegerProperty();
+    private final SimpleStringProperty filenameProperty = new SimpleStringProperty();
+    private final DoubleProperty scaleProperty = new SimpleDoubleProperty(1.0);
 
     private String id;
 
@@ -127,13 +139,14 @@ public void initialize(URL url, ResourceBundle resourceBundle){
         dialogPane.lookupButton(ButtonType.OK).disableProperty().bind(okButtonBinding);
     }
 
+    @SuppressWarnings("unused")
     @FXML
     public void browse(){
         FileChooser fileChooser = new FileChooser();
         fileChooser.setTitle(Messages.SelectFile);
         fileChooser.getExtensionFilters().addAll(
-                new FileChooser.ExtensionFilter("Image files (jpg, png, gif)", "*.jpg", "*.png", "*.gif"),
-                new FileChooser.ExtensionFilter("All files", "*.*")
+                new FileChooser.ExtensionFilter("Image files (jpg, jpeg, png, gif)", "*.jpg", "*.jpeg", "*.png", "*.gif")
+
         );
 
         File file = fileChooser.showOpenDialog(dialogPane.getScene().getWindow());
@@ -152,6 +165,7 @@ public void browse(){
         }
     }
 
+    @SuppressWarnings("unused")
     @FXML
     public void pasteClipboard(){
         image = Clipboard.getSystemClipboard().getImage();

app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties

@@ -56,7 +56,7 @@ Help=Help
 HitsPerPage=Hits per page:
 ImageWidth=Width
 ImageHeight=Height
-JumpToLogEntry=Jump to Log Entry: 
+JumpToLogEntry=Jump to Log Entry:
 Level=Level
 Logbook=Logbook
 Logbooks=Logbooks:
@@ -118,6 +118,7 @@ Text=Text:
 Time=Time:
 Title=Title:
 UnableToDownloadArchived=
+UnsupportedFileType=Unsupported content found in file {0}
 Username=User Name:
 UpdateLogEntry=Edit
 HtmlPreview=Preview

core/util/pom.xml

@@ -13,6 +13,12 @@
       <artifactId>javax.ws.rs-api</artifactId>
       <version>2.1</version>
     </dependency>
+    <!-- https://mvnrepository.com/artifact/org.apache.tika/tika-core -->
+    <dependency>
+      <groupId>org.apache.tika</groupId>
+      <artifactId>tika-core</artifactId>
+      <version>3.2.0</version>
+    </dependency>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter</artifactId>

core/util/src/main/java/org/phoebus/util/MimeTypeDetector.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2025 European Spallation Source ERIC.
+ */
+
+package org.phoebus.util;
+
+import org.apache.tika.Tika;
+import org.apache.tika.metadata.Metadata;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+public class MimeTypeDetector {
+
+    /**
+     * Attempts to determine the file type based on its content. Cleverness delegated to Apache Tika.
+     * <p>
+     * Note that the {@link InputStream} will be closed by this method.
+     * </p>
+     *
+     * @param inputStream A non-null {@link InputStream} that will be closed by this method.
+     * @return A MIME type string, e.g. image/jpeg
+     * @throws IOException If there is a problem reading the stream or if the provided {@link InputStream} is
+     *                     <code>null</code>.
+     */
+    public static String determineMimeType(InputStream inputStream) throws IOException {
+        if (inputStream == null) {
+            throw new IOException("InputStream must not be null");
+        }
+        try {
+            return new Tika().detect(inputStream, new Metadata());
+        } catch (IOException e) {
+            Logger.getLogger(MimeTypeDetector.class.getName())
+                    .log(Level.WARNING, "Unable to read input stream", e);
+            throw e;
+        } finally {
+            try {
+                inputStream.close();
+            } catch (IOException e) {
+                Logger.getLogger(MimeTypeDetector.class.getName())
+                        .log(Level.WARNING, "Failed to close input stream", e);
+            }
+        }
+    }
+}

core/util/src/test/java/org/phoebus/util/MimeTypeDetectorTest.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2025 European Spallation Source ERIC.
+ */
+
+package org.phoebus.util;
+
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+public class MimeTypeDetectorTest {
+
+    @Test
+    public void testHeic() throws Exception {
+        assertEquals("image/heic",
+                MimeTypeDetector
+                        .determineMimeType(MimeTypeDetector.class.getResourceAsStream("ios_original.HEIC")));
+
+        assertEquals("image/heic",
+                MimeTypeDetector
+                        .determineMimeType(MimeTypeDetector.class.getResourceAsStream("ios_heic_converted.JPEG")));
+    }
+
+    @Test
+    public void testJpeg() throws Exception {
+        assertEquals("image/jpeg",
+                MimeTypeDetector
+                        .determineMimeType(MimeTypeDetector.class.getResourceAsStream("proper_jpeg.jpeg")));
+    }
+
+    @Test
+    public void testPdf() throws Exception {
+        assertEquals("application/pdf",
+                MimeTypeDetector
+                        .determineMimeType(MimeTypeDetector.class.getResourceAsStream("mimetest.pdf")));
+    }
+
+    @Test
+    public void testNullInputStream() {
+        assertThrows(IOException.class, () ->
+                MimeTypeDetector
+                        .determineMimeType(MimeTypeDetector.class.getResourceAsStream("does_no_exist")));
+    }
+}