Added support for WebP scaling

Signed-off-by: Arnau Mora Gras <[email protected]>

Author: ArnyminerZ

build.gradle.kts

@@ -69,6 +69,9 @@ dependencies {
     // Crowdin localization
     implementation(libs.crowdin)
 
+    // WebP image support
+    implementation(libs.imageio.webp)
+
 
     testImplementation(libs.kotlin.test)
 

gradle/libs.versions.toml

@@ -2,6 +2,7 @@
 crowdin = "1.14.1"
 exposed = "0.47.0"
 foojay-resolver = "0.8.0"
+imageio-webp = "0.1.6"
 json = "20240205"
 kotlin = "1.9.22"
 kotlinx-kover = "0.7.6"
@@ -13,6 +14,7 @@ sqlite = "3.44.0.0"
 
 [libraries]
 crowdin = { module = "com.github.crowdin:crowdin-api-client-java", version.ref = "crowdin" }
+imageio-webp = { module = "org.sejda.imageio:webp-imageio", version.ref = "imageio-webp" }
 json = { module = "org.json:json", version.ref = "json" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }

package/version.txt

@@ -1 +1 @@
-1.0.32
+1.0.33

src/main/kotlin/server/endpoints/files/DownloadFileEndpoint.kt

@@ -41,7 +41,7 @@ object DownloadFileEndpoint : EndpointBase("/download/{uuid}") {
             call.response.header("Content-Type", contentType)
         }
 
-        if (listOf("png", "jpeg", "jpg").any { file.extension.equals(it, true) }) {
+        if (ImageUtils.supportedExtensions.any { file.extension.equals(it, true) }) {
             // File is image, resizing is supported
             if (width != null || height != null) {
                 // Respond the image resized

src/main/kotlin/utils/ImageUtils.kt

@@ -17,6 +17,8 @@ object ImageUtils {
     private const val TRUNCATED_BYTE_A: Byte = (0xff).toByte()
     private const val TRUNCATED_BYTE_B: Byte = (0xd9).toByte()
 
+    val supportedExtensions = listOf("png", "jpeg", "jpg", "webp")
+
     /**
      * Verifies the integrity of an image file.
      *
@@ -66,7 +68,7 @@ object ImageUtils {
         var truncated: Boolean? = null
     }
 
-    suspend fun scale(imageFile: File, width: Int?, height: Int?, outputStream: OutputStream) {
+    suspend fun scale(imageFile: File, width: Int?, height: Int?, outputStream: OutputStream, format: String = "webp") {
         withContext(Dispatchers.IO) {
             check(width != null || height != null) { "Must provide either width, height or both, but not none." }
 
@@ -93,7 +95,7 @@ object ImageUtils {
             val imageBuff = BufferedImage(imageWidth, imageHeight, BufferedImage.TYPE_INT_RGB)
             imageBuff.graphics.drawImage(scaledImage, 0, 0, Color(0, 0, 0), null)
 
-            ImageIO.write(imageBuff, "jpg", outputStream)
+            ImageIO.write(imageBuff, format, outputStream)
         }
     }
 }

src/test/kotlin/server/DataProvider.kt

@@ -36,6 +36,7 @@ object DataProvider {
         skipDisplayName: Boolean = false,
         skipWebUrl: Boolean = false,
         skipImage: Boolean = false,
+        imageFile: String = "/images/alcoi.jpg",
         assertion: suspend HttpResponse.() -> Int? = {
             var areaId: Int? = null
             assertSuccess(HttpStatusCode.Created) { data ->
@@ -46,7 +47,7 @@ object DataProvider {
             areaId
         }
     ): Int? {
-        val image = this::class.java.getResourceAsStream("/images/alcoi.jpg")!!.use {
+        val image = this::class.java.getResourceAsStream(imageFile)!!.use {
             it.readBytes()
         }
 

src/test/kotlin/server/endpoints/files/TestFileDownloading.kt

@@ -18,8 +18,11 @@ import server.DataProvider
 import server.base.ApplicationTestBase
 
 class TestFileDownloading : ApplicationTestBase() {
-    private suspend inline fun ApplicationTestBuilder.provideImageFile(block: (imageUUID: String) -> Unit) {
-        val areaId = DataProvider.provideSampleArea()
+    private suspend inline fun ApplicationTestBuilder.provideImageFile(
+        imageFile: String = "/images/alcoi.jpg",
+        block: (imageUUID: String) -> Unit
+    ) {
+        val areaId = DataProvider.provideSampleArea(imageFile = imageFile)
 
         var image: String? = null
 
@@ -95,4 +98,27 @@ class TestFileDownloading : ApplicationTestBase() {
             }
         }
     }
+
+    @Test
+    fun `test downloading resized files (webp)`() = test {
+        provideImageFile("/images/alcoi.webp") { image ->
+            val tempFile = File.createTempFile("eaic", null)
+            val response = get("/download/$image?height=200")
+            assertTrue(
+                response.status.isSuccess(),
+                "Got a non-successful response from server. Status: ${response.status}"
+            )
+
+            val channel = response.bodyAsChannel()
+            channel.copyAndClose(tempFile.writeChannel())
+
+            try {
+                val img: BufferedImage? = ImageIO.read(tempFile)
+                assertNotNull(img)
+                assertEquals(200, img.height)
+            } finally {
+                tempFile.delete()
+            }
+        }
+    }
 }

src/test/kotlin/utils/ImageUtilsTest.kt

@@ -4,6 +4,7 @@ import io.ktor.test.dispatcher.testSuspend
 import java.awt.image.BufferedImage
 import java.io.ByteArrayOutputStream
 import java.io.File
+import java.nio.file.Files
 import javax.imageio.ImageIO
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -19,23 +20,35 @@ class ImageUtilsTest {
         }
     }
 
-    private fun testResize(width: Int? = null, height: Int? = null) = testSuspend {
+    private fun testResize(
+        resource: String,
+        width: Int? = null,
+        height: Int? = null,
+        format: String = "webp"
+    ) = testSuspend {
+        val name = resource.substringAfterLast('/')
+        val nameWithoutExtension = name.substringBeforeLast('.')
         // Create temp files
-        val file = File.createTempFile("test_scaling_original-", "-alcoi.jpg")
-        val fileScaled = File.createTempFile("test_scaling_resized-", "-alcoi.avif")
+        val file = File.createTempFile("test_scaling_original-", "-$name")
+        val fileScaled = File.createTempFile("test_scaling_resized-", "-$nameWithoutExtension.$format")
         // Store the original image size
         val (originalWidth, originalHeight) = 1578 to 720
         val originalRatio = originalWidth.toDouble() / originalHeight
         try {
             // Create the resource as File
-            this::class.java.getResourceAsStream("/images/alcoi.jpg")!!.use { input ->
+            this::class.java.getResourceAsStream(resource)!!.use { input ->
                 file.outputStream().use { output -> input.copyTo(output) }
             }
             fileScaled.outputStream().use { output ->
                 ImageUtils.scale(file, width, height, output)
             }
             println("Scaled file: ${fileScaled.absolutePath}")
+
             assertTrue(fileScaled.exists())
+
+            val mimeType = Files.probeContentType(fileScaled.toPath())
+            assertEquals("image/$format", mimeType)
+
             val img: BufferedImage? = ImageIO.read(fileScaled)
             assertNotNull(img)
             val (scaledWidth, scaledHeight) = img.width to img.height
@@ -54,8 +67,11 @@ class ImageUtilsTest {
 
 
     @Test
-    fun `test image scaling - change width`() = testResize(width = 100)
+    fun `test image scaling - change width`() = testResize("/images/alcoi.jpg", width = 100)
+
+    @Test
+    fun `test image scaling - change height`() = testResize("/images/alcoi.jpg", height = 100)
 
     @Test
-    fun `test image scaling - change height`() = testResize(height = 100)
+    fun `test image scaling (webp)`() = testResize("/images/alcoi.webp", width = 100)
 }