HEIC thumbnails: add ImageMagick to release

Author: asaintsever

Makefile

@@ -9,7 +9,7 @@ IMAGE_FQIN:=asaintsever/tinyworld
 
 .SILENT: ;  	# No need for @
 .ONESHELL: ; 	# Single shell for a target (required to properly use local variables)
-.PHONY: help init clean format test package run-ui run-indexor pre-release gen-portableapp gen-container-image gen-appimage next-version release
+.PHONY: help init clean format test package run-ui run-indexor pre-release gen-portableapp gen-oci-image gen-appimage next-version release
 .DEFAULT_GOAL := help
 
 help: ## Show Help
@@ -42,11 +42,15 @@ run-ui: ## Run TinyWorld UI
 	mvn package -Dmaven.test.skip=true -P UI
 
 pre-release:
+	set -e
 	mkdir -p release/artifacts
+	chmod +x release/get-3rd-party.sh
 	chmod +x release/release-helper.sh
 	chmod +x release/appimage/appdir-gen.sh
 	chmod +x release/appimage/x86_64/appimagetool-x86_64
 	chmod +x release/portable/portableapp-gen.sh
+	echo "Get 3rd-party software ..."
+	release/get-3rd-party.sh
 
 gen-portableapp: package pre-release ## Generate TinyWorld Portable App
 	set -e
@@ -63,19 +67,19 @@ gen-appimage: package pre-release ## Generate TinyWorld AppImage
 	release/appimage/appdir-gen.sh
 	release/appimage/x86_64/appimagetool-x86_64 release/appimage/AppDir release/artifacts/TinyWorld-${RELEASE_VERSION}-x86_64.AppImage
 
-gen-container-image: package pre-release ## Generate TinyWorld Container Image
+gen-oci-image: package pre-release ## Generate TinyWorld OCI Image
 	set -e
-	echo "Build container image ..."
-	release/release-helper.sh release/docker
-	podman build -t ${IMAGE_FQIN}:${RELEASE_VERSION} release/docker
+	echo "Build OCI image ..."
+	release/release-helper.sh release/oci-image
+	release/oci-image/image-gen.sh ${IMAGE_FQIN} ${RELEASE_VERSION}
 
 next-version: ## Set next version
 	set -e
 	read -p "Enter new TinyWorld version: " twNewVer
 	mvn versions:set -DnewVersion=$$twNewVer
 	echo -n $$twNewVer > VERSION
 
-release: test gen-container-image gen-appimage gen-portableapp ## Release
+release: test gen-oci-image gen-appimage gen-portableapp ## Release
 	read -p "Publish image (y/n)? " answer
 	case $$answer in \
 	y|Y ) \

README.md

@@ -13,7 +13,7 @@
 - Geolocalize photos on virtual globe with metadata in annotations
 - Search & filter capabilities to easily navigate your photos (by dates, countries, ...)
 - Offline mode (use local cache for globe data)
-- Available as portable app, AppImage package and container image
+- Available as portable app, AppImage package and OCI image
 
 ## Supported Photo Formats
 
@@ -23,9 +23,8 @@
 
 ## Requirements
 
-- Java 11+ for portable app without JRE
 - Linux or WSL2 for AppImage
-- Docker or Podman for container image
+- Docker or Podman for OCI image
 
 ## Configuration
 
@@ -35,7 +34,7 @@ See [TinyWorld Configuration](cfg/README.md)
 
 ### Using Portable App
 
-Untar/Unzip downloaded portable package (several flavors available: without JRE, with Linux JRE, with Windows JRE) then run provided TinyWorld script:
+Untar/Unzip downloaded portable package (several flavors available: with Linux JRE, with Windows JRE) then run provided TinyWorld script:
 
 ```sh
 # On Linux
@@ -61,7 +60,7 @@ By default, 4Gb of memory is set via Xmx/Xms Java options. You can override this
 JAVA_OPTS="-Xmx2048m -Xms1024m" ./TinyWorld-<release version>-x86_64.AppImage
 ```
 
-### Using Container Image on Linux/WSL2
+### Using OCI Image on Linux/WSL2
 
 ```sh
 <docker|podman> run --rm -e DISPLAY -v "$HOME/.Xauthority:/root/.Xauthority:rw" -v "$HOME/.tinyworld:/root/.tinyworld" -v "$HOME/var/cache:/root/var/cache" --network host asaintsever/tinyworld:<release version>
@@ -92,7 +91,7 @@ In case you experience scaling issue with High DPI (such as globe not filling th
 - Maven 3
 - Java JDK 17
 - zip/unzip *(to generate TinyWorld portable app for Windows)*
-- Podman *(to generate TinyWorld container image)*
+- Podman *(to generate TinyWorld OCI image)*
 - FUSE *(to generate TinyWorld AppImage)*
 
     > *On Ubuntu 22.04+, install required FUSE library using `sudo apt install libfuse2`*
@@ -114,8 +113,8 @@ make gen-portableapp
 # Build TinyWorld AppImage
 make gen-appimage
 
-# Build TinyWorld container image
-make gen-container-image
+# Build TinyWorld OCI image
+make gen-oci-image
 ```
 
 ## Releases

indexor/src/main/java/asaintsever/tinyworld/indexor/Indexor.java

@@ -37,6 +37,7 @@
 import asaintsever.tinyworld.indexor.opensearch.ClusterClient;
 import asaintsever.tinyworld.indexor.opensearch.Document;
 import asaintsever.tinyworld.indexor.opensearch.DocumentAlreadyExistsException;
+import asaintsever.tinyworld.metadata.extractor.Extract;
 import asaintsever.tinyworld.metadata.extractor.PhotoMetadata;
 
 public class Indexor implements Closeable {
@@ -137,6 +138,9 @@ public Indexor(String host, int port, String index, boolean useEmbeddedCluster,
                 throw new RuntimeException(e);
             }
         });
+
+        // Check metadata extractor prerequisites
+        Extract.checkPrerequisites();
     }
 
     public PhotoMetadata getDefaultMetadata() {

metadata-extractor/src/main/java/asaintsever/tinyworld/metadata/extractor/Extract.java

@@ -32,6 +32,7 @@
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -75,6 +76,26 @@ public Result(int ok, int nok, int skip, List<String> errors) {
 
     protected static Logger logger = LoggerFactory.getLogger(Extract.class);
     protected final static List<FileType> supportedFileTypes = List.of(FileType.Jpeg, FileType.Png, FileType.Heif);
+    protected final static String imageMagickCommand = "magick";
+
+    public static boolean checkPrerequisites() {
+        boolean isWindows = File.pathSeparator.equals(";");
+
+        // Check if ImageMagick is available in PATH or not.
+        // ImageMagick is needed only to generate thumbnails from HEIC photos.
+        try {
+            Process improc = Runtime.getRuntime()
+                    .exec((isWindows ? imageMagickCommand + ".exe" : imageMagickCommand) + " -version");
+            Optional<String> impathname = improc.info().command();
+            logger.info("Found ImageMagick at: " + impathname.get());
+        } catch (IOException e) {
+            logger.warn("ImageMagick program not found: " + e.getMessage());
+            logger.warn("Path is: " + System.getenv("PATH"));
+            return false;
+        }
+
+        return true;
+    }
 
     public static Result exploreFS(String rootDir, int depth, IPhotoProcess photoProcess) {
         int nb_processed_ok = 0;

metadata-extractor/src/main/java/asaintsever/tinyworld/metadata/extractor/PhotoObject.java

@@ -158,7 +158,8 @@ public PhotoObject extractMetadata(URI uri, FileType fileType, Metadata metadata
         GpsDirectory gpsDir = metadata.getFirstDirectoryOfType(GpsDirectory.class);
         if (gpsDir != null) {
             this.metadata.setGpsLatLong(gpsDir.getGeoLocation() != null
-                    ? gpsDir.getGeoLocation().getLatitude() + "," + gpsDir.getGeoLocation().getLongitude() : null);
+                    ? gpsDir.getGeoLocation().getLatitude() + "," + gpsDir.getGeoLocation().getLongitude()
+                    : null);
 
             GpsDescriptor gpsDesc = new GpsDescriptor(gpsDir);
             this.metadata.setGpsDatum(gpsDesc.getDescription(GpsDirectory.TAG_MAP_DATUM));
@@ -214,8 +215,7 @@ public PhotoObject extractThumbnail(URI uri, FileType fileType, Metadata metadat
             // Test if HEIF format: Java Image I/O API does not support it
             // Make use of ImageMagick to generate a thumbnail (JPG format)
             if (fileType == FileType.Heif) {
-                ImageCommand cmd = new ImageCommand("magick");
-                // cmd.setSearchPath(""); //In case magick binary is not in path
+                ImageCommand cmd = new ImageCommand(Extract.imageMagickCommand);
                 Stream2BufferedImage s2b = new Stream2BufferedImage();
                 cmd.setOutputConsumer(s2b);
 

metadata-extractor/src/test/java/asaintsever/tinyworld/metadata/extractor/ExtractMetadataFromPhotoTest.java

@@ -37,22 +37,14 @@
 import asaintsever.tinyworld.metadata.extractor.Extract.Result;
 
 public class ExtractMetadataFromPhotoTest {
-    
+
     static boolean isImageMagickInPath;
 
-    
     @BeforeAll
     public static void setup() {
         // Check if ImageMagick is available in PATH or not.
         // ImageMagick is needed only to generate thumbnails from HEIC photos.
-        try {
-            Runtime.getRuntime().exec("magick -version");
-        } catch (IOException e) {
-            isImageMagickInPath = false;
-            return;
-        }
-        
-        isImageMagickInPath = true;
+        isImageMagickInPath = Extract.checkPrerequisites();
     }
 
     @Test

release/appimage/appdir-gen.sh

@@ -16,6 +16,10 @@ cp release/appimage/x86_64/AppRun-x86_64 release/appimage/AppDir/AppRun
 chmod +x release/appimage/AppDir/AppRun
 chmod +x release/appimage/AppDir/usr/bin/tinyworld.sh
 
+# Include 3rd party software
+cp release/tmp/3rd/LICENSE-3RD-PARTY.txt release/appimage/AppDir/usr/bin
+cp release/tmp/3rd/linux/* release/appimage/AppDir/usr/bin
+
 # Add JRE 17
 curl -s -L --create-dirs --output release/tmp/jre_linux.tar.gz https://github.com/asaintsever/tinyworld-utils/releases/download/jre-distro/OpenJDK17U-jre_x64_linux_hotspot_17.0.3_7.tar.gz
 tar -xzf release/tmp/jre_linux.tar.gz -C release/appimage/AppDir/usr/bin

release/get-3rd-party.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -e
+
+# clean
+rm -rf release/tmp/3rd || true
+
+mkdir -p release/tmp/3rd/linux
+mkdir -p release/tmp/3rd/windows
+
+# Generate 3rd-party license
+touch "release/tmp/3rd/LICENSE-3RD-PARTY.txt"
+echo -e "\n\n=====\nLicense for ImageMagick <https://imagemagick.org/>\n=====\n\n" >> "release/tmp/3rd/LICENSE-3RD-PARTY.txt"
+curl -s -L https://raw.githubusercontent.com/asaintsever/tinyworld-utils/main/ImageMagick-LICENSE >> "release/tmp/3rd/LICENSE-3RD-PARTY.txt"
+
+# Get 3rd-party software
+curl -s -L --output release/tmp/3rd/linux/magick https://github.com/asaintsever/tinyworld-utils/releases/download/imagemagick-heic/magick
+chmod +x release/tmp/3rd/linux/magick
+
+curl -s -L --output release/tmp/3rd/windows/magick.exe https://github.com/asaintsever/tinyworld-utils/releases/download/imagemagick-heic/magick.exe

release/docker/.gitignore release/oci-image/.gitignorerelease/docker/.gitignore renamed to release/oci-image/.gitignore

@@ -6,11 +6,16 @@ RUN mkdir -p /opt/tinyworld
 
 WORKDIR /opt/tinyworld
 
-COPY tinyworld.sh .
+ENV PATH=/opt/tinyworld/tools:$PATH
+
+COPY tmp/magick ./tools/magick
+COPY tmp/LICENSE* .
 COPY tmp/deps ./deps
+COPY tinyworld.sh .
 COPY tmp/config ./config
 COPY tmp/*.jar .
 
+RUN chmod +x ./tools/magick
 RUN chmod +x tinyworld.sh
 
 CMD ["./tinyworld.sh"]