[release/3.6] 修复无法加载 WebP 图标的问题 (#4436)

#4171

Author: Glavo

HMCL/src/main/java/org/jackhuang/hmcl/ui/FXUtils.java

@@ -27,6 +27,7 @@
 import javafx.beans.WeakListener;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.Property;
+import javafx.beans.property.SimpleObjectProperty;
 import javafx.beans.value.*;
 import javafx.event.Event;
 import javafx.event.EventDispatcher;
@@ -54,9 +55,8 @@
 import javafx.util.Callback;
 import javafx.util.Duration;
 import javafx.util.StringConverter;
-import org.glavo.png.PNGType;
-import org.glavo.png.PNGWriter;
-import org.glavo.png.javafx.PNGJavaFXUtils;
+import org.jackhuang.hmcl.task.FileDownloadTask;
+import org.jackhuang.hmcl.task.Schedulers;
 import org.jackhuang.hmcl.task.Task;
 import org.jackhuang.hmcl.ui.animation.AnimationUtils;
 import org.jackhuang.hmcl.util.*;
@@ -78,11 +78,16 @@
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
+import java.awt.image.BufferedImage;
 import java.io.*;
 import java.lang.ref.WeakReference;
 import java.net.*;
+import java.nio.ByteBuffer;
+import java.nio.channels.Channels;
+import java.nio.channels.FileChannel;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 import java.util.List;
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
@@ -779,6 +784,21 @@ private static Image loadWebPImage(InputStream input) throws IOException {
         }
     }
 
+    public static Image loadWebPImage(InputStream input,
+                                      int requestedWidth, int requestedHeight,
+                                      boolean preserveRatio, boolean smooth) throws IOException {
+        WebPImageReaderSpi spi = new WebPImageReaderSpi();
+        ImageReader reader = spi.createReaderInstance(null);
+        BufferedImage bufferedImage;
+        try (ImageInputStream imageInput = ImageIO.createImageInputStream(input)) {
+            reader.setInput(imageInput, true, true);
+            bufferedImage = reader.read(0, reader.getDefaultReadParam());
+        } finally {
+            reader.dispose();
+        }
+        return SwingFXUtils.toFXImage(bufferedImage, requestedWidth, requestedHeight, preserveRatio, smooth);
+    }
+
     public static Image loadImage(Path path) throws Exception {
         try (InputStream input = Files.newInputStream(path)) {
             if ("webp".equalsIgnoreCase(FileUtils.getExtension(path)))
@@ -792,6 +812,42 @@ public static Image loadImage(Path path) throws Exception {
         }
     }
 
+    public static Image loadImage(Path path,
+                                  int requestedWidth, int requestedHeight,
+                                  boolean preserveRatio, boolean smooth) throws Exception {
+        try (FileChannel channel = FileChannel.open(path, StandardOpenOption.READ)) {
+            String ext = FileUtils.getExtension(path).toLowerCase(Locale.ROOT);
+            if ("webp".equalsIgnoreCase(ext))
+                return loadWebPImage(Channels.newInputStream(channel),
+                        requestedWidth, requestedHeight, preserveRatio, smooth);
+
+            if (!IMAGE_EXTENSIONS.contains(ext)) {
+                byte[] header = new byte[12];
+                ByteBuffer buffer = ByteBuffer.wrap(header);
+                //noinspection StatementWithEmptyBody
+                while (buffer.hasRemaining() && channel.read(buffer) > 0) {
+                }
+
+                channel.position(0L);
+                if (!buffer.hasRemaining()) {
+                    // WebP File
+                    if (header[0] == 'R' && header[1] == 'I' && header[2] == 'F' && header[3] == 'F' &&
+                            header[8] == 'W' && header[9] == 'E' && header[10] == 'B' && header[11] == 'P') {
+                        return loadWebPImage(Channels.newInputStream(channel),
+                                requestedWidth, requestedHeight, preserveRatio, smooth);
+                    }
+                }
+            }
+
+            Image image = new Image(Channels.newInputStream(channel),
+                    requestedWidth, requestedHeight,
+                    preserveRatio, smooth);
+            if (image.isError())
+                throw image.getException();
+            return image;
+        }
+    }
+
     public static Image loadImage(URL url) throws Exception {
         URLConnection connection = NetworkUtils.createConnection(url);
         if (connection instanceof HttpURLConnection) {
@@ -851,15 +907,37 @@ public static Image newBuiltinImage(String url, double requestedWidth, double re
         }
     }
 
-    /**
-     * Load image from the internet. It will cache the data of images for the further usage.
-     * The cached data will be deleted when HMCL is closed or hidden.
-     *
-     * @param url the url of image. The image resource should be a file on the internet.
-     * @return the image resource within the jar.
-     */
-    public static Image newRemoteImage(String url) {
-        return newRemoteImage(url, 0, 0, false, false, false);
+    public static Task<Image> getRemoteImageTask(String url, int requestedWidth, int requestedHeight, boolean preserveRatio, boolean smooth) {
+        return Task.composeAsync(() -> {
+            Path currentPath = remoteImageCache.get(url);
+            if (currentPath != null) {
+                if (Files.isReadable(currentPath))
+                    return Task.completed(currentPath);
+
+                // The file is unavailable or unreadable.
+                remoteImageCache.remove(url);
+
+                try {
+                    Files.deleteIfExists(currentPath);
+                } catch (IOException e) {
+                    LOG.warning("An exception encountered while deleting broken cached image file.", e);
+                }
+            }
+
+            Path newPath = Files.createTempFile("hmcl-net-resource-cache-", ".cache");
+            return new FileDownloadTask(NetworkUtils.toURL(url), newPath.toFile())
+                    .thenSupplyAsync(() -> {
+                        Path otherPath = remoteImageCache.putIfAbsent(url, newPath);
+                        if (otherPath == null)
+                            return newPath;
+                        else {
+                            // The image has been loaded in another task. Delete the image here in order not to pollute the tmp folder.
+                            Files.delete(newPath);
+                            return otherPath;
+                        }
+
+                    });
+        }).thenApplyAsync(path -> loadImage(path, requestedWidth, requestedHeight, preserveRatio, smooth));
     }
 
     /**
@@ -877,52 +955,17 @@ public static Image newRemoteImage(String url) {
      *                        the specified bounding box
      * @return the image resource within the jar.
      */
-    public static Image newRemoteImage(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading) {
-        Path currentPath = remoteImageCache.get(url);
-        if (currentPath != null) {
-            if (Files.isReadable(currentPath)) {
-                try (InputStream inputStream = Files.newInputStream(currentPath)) {
-                    return new Image(inputStream, requestedWidth, requestedHeight, preserveRatio, smooth);
-                } catch (IOException e) {
-                    LOG.warning("An exception encountered while reading data from cached image file.", e);
-                }
-            }
-
-            // The file is unavailable or unreadable.
-            remoteImageCache.remove(url);
-
-            try {
-                Files.deleteIfExists(currentPath);
-            } catch (IOException e) {
-                LOG.warning("An exception encountered while deleting broken cached image file.", e);
-            }
-        }
-
-        Image image = new Image(url, requestedWidth, requestedHeight, preserveRatio, smooth, backgroundLoading);
-        image.progressProperty().addListener((observable, oldValue, newValue) -> {
-            if (newValue.doubleValue() >= 1.0 && !image.isError() && image.getPixelReader() != null && image.getWidth() > 0.0 && image.getHeight() > 0.0) {
-                Task.runAsync(() -> {
-                    Path newPath = Files.createTempFile("hmcl-net-resource-cache-", ".cache");
-                    try ( // Make sure the file is released from JVM before we put the path into remoteImageCache.
-                          OutputStream outputStream = Files.newOutputStream(newPath);
-                          PNGWriter writer = new PNGWriter(outputStream, PNGType.RGBA, PNGWriter.DEFAULT_COMPRESS_LEVEL)
-                    ) {
-                        writer.write(PNGJavaFXUtils.asArgbImage(image));
-                    } catch (IOException e) {
-                        try {
-                            Files.delete(newPath);
-                        } catch (IOException e2) {
-                            e2.addSuppressed(e);
-                            throw e2;
-                        }
-                        throw e;
-                    }
-                    if (remoteImageCache.putIfAbsent(url, newPath) != null) {
-                        Files.delete(newPath); // The image has been loaded in another task. Delete the image here in order not to pollute the tmp folder.
+    public static ObservableValue<Image> newRemoteImage(String url, int requestedWidth, int requestedHeight, boolean preserveRatio, boolean smooth) {
+        SimpleObjectProperty<Image> image = new SimpleObjectProperty<>();
+        getRemoteImageTask(url, requestedWidth, requestedHeight, preserveRatio, smooth)
+                .whenComplete(Schedulers.javafx(), (result, exception) -> {
+                    if (exception == null) {
+                        image.set(result);
+                    } else {
+                        LOG.warning("An exception encountered while loading remote image: " + url, exception);
                     }
-                }).start();
-            }
-        });
+                })
+                .start();
         return image;
     }
 

HMCL/src/main/java/org/jackhuang/hmcl/ui/HTMLRenderer.java

@@ -22,6 +22,7 @@
 import javafx.scene.image.ImageView;
 import javafx.scene.text.Text;
 import javafx.scene.text.TextFlow;
+import org.jackhuang.hmcl.util.StringUtils;
 import org.jsoup.nodes.Node;
 import org.jsoup.nodes.TextNode;
 
@@ -159,28 +160,19 @@ private void appendAutoLineBreak(String text) {
 
     private void appendImage(Node node) {
         String src = node.absUrl("src");
-        URI imageUri = null;
-        try {
-            if (!src.isEmpty())
-                imageUri = URI.create(src);
-        } catch (Exception ignored) {
-        }
-
         String alt = node.attr("alt");
 
-        if (imageUri != null) {
-            URI uri = URI.create(src);
-
+        if (StringUtils.isNotBlank(src)) {
             String widthAttr = node.attr("width");
             String heightAttr = node.attr("height");
 
-            double width = 0;
-            double height = 0;
+            int width = 0;
+            int height = 0;
 
             if (!widthAttr.isEmpty() && !heightAttr.isEmpty()) {
                 try {
-                    width = Double.parseDouble(widthAttr);
-                    height = Double.parseDouble(heightAttr);
+                    width = (int) Double.parseDouble(widthAttr);
+                    height = (int) Double.parseDouble(heightAttr);
                 } catch (NumberFormatException ignored) {
                 }
 
@@ -190,10 +182,12 @@ private void appendImage(Node node) {
                 }
             }
 
-            Image image = FXUtils.newRemoteImage(uri.toString(), width, height, true, true, false);
-            if (image.isError()) {
-                LOG.warning("Failed to load image: " + uri, image.getException());
-            } else {
+            try {
+                Image image = FXUtils.getRemoteImageTask(src, width, height, true, true)
+                        .run();
+                if (image == null)
+                    throw new AssertionError("Image loading task returned null");
+
                 ImageView imageView = new ImageView(image);
                 if (hyperlink != null) {
                     URI target = resolveLink(hyperlink);
@@ -204,6 +198,8 @@ private void appendImage(Node node) {
                 }
                 children.add(imageView);
                 return;
+            } catch (Throwable e) {
+                LOG.warning("Failed to load image: " + src, e);
             }
         }
 

HMCL/src/main/java/org/jackhuang/hmcl/ui/versions/DownloadListPage.java

@@ -542,7 +542,7 @@ protected void updateControl(RemoteMod dataItem, boolean empty) {
                                 .collect(Collectors.toList()));
 
                         if (StringUtils.isNotBlank(dataItem.getIconUrl())) {
-                            imageView.setImage(FXUtils.newRemoteImage(dataItem.getIconUrl(), 40, 40, true, true, true));
+                            imageView.imageProperty().bind(FXUtils.newRemoteImage(dataItem.getIconUrl(), 40, 40, true, true));
                         }
                     }
                 });

HMCL/src/main/java/org/jackhuang/hmcl/ui/versions/DownloadPage.java

@@ -220,7 +220,7 @@ protected ModDownloadPageSkin(DownloadPage control) {
             {
                 ImageView imageView = new ImageView();
                 if (StringUtils.isNotBlank(getSkinnable().addon.getIconUrl())) {
-                    imageView.setImage(FXUtils.newRemoteImage(getSkinnable().addon.getIconUrl(), 40, 40, true, true, true));
+                    imageView.imageProperty().bind(FXUtils.newRemoteImage(getSkinnable().addon.getIconUrl(), 40, 40, true, true));
                 }
                 descriptionPane.getChildren().add(FXUtils.limitingSize(imageView, 40, 40));
 
@@ -359,7 +359,7 @@ private static final class DependencyModItem extends StackPane {
                         .collect(Collectors.toList()));
 
                 if (StringUtils.isNotBlank(addon.getIconUrl())) {
-                    imageView.setImage(FXUtils.newRemoteImage(addon.getIconUrl(), 40, 40, true, true, true));
+                    imageView.imageProperty().bind(FXUtils.newRemoteImage(addon.getIconUrl(), 40, 40, true, true));
                 }
             } else {
                 content.setTitle(i18n("mods.broken_dependency.title"));

HMCL/src/main/java/org/jackhuang/hmcl/util/SwingFXUtils.java

@@ -120,5 +120,43 @@ public static WritableImage toFXImage(BufferedImage bimg, WritableImage wimg) {
         pw.setPixels(0, 0, bw, bh, pf, data, offset, scan);
         return wimg;
     }
+
+    public static WritableImage toFXImage(BufferedImage bimg, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth) {
+        if (requestedWidth <= 0. || requestedHeight <= 0.) {
+            return toFXImage(bimg, null);
+        }
+
+        int width = (int) requestedWidth;
+        int height = (int) requestedHeight;
+
+        // Calculate actual dimensions if preserveRatio is true
+        if (preserveRatio) {
+            double originalWidth = bimg.getWidth();
+            double originalHeight = bimg.getHeight();
+            double scaleX = requestedWidth / originalWidth;
+            double scaleY = requestedHeight / originalHeight;
+            double scale = Math.min(scaleX, scaleY);
+
+            width = (int) (originalWidth * scale);
+            height = (int) (originalHeight * scale);
+        }
+
+        // Create scaled BufferedImage
+        BufferedImage scaledImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB_PRE);
+        Graphics2D g2d = scaledImage.createGraphics();
+        try {
+            if (smooth) {
+                g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
+                g2d.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
+                g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+            }
+
+            g2d.drawImage(bimg, 0, 0, width, height, null);
+        } finally {
+            g2d.dispose();
+        }
+
+        return toFXImage(scaledImage, null);
+    }
 }