feat: ability to upload and work with HEIF images by convert them to JPEG (#3946)

Co-authored-by: nbalkandzhiyski <nikolay.balkandzhiyski@gmail.com>

Author: nbalkandzhiyski

app/Actions/Photo/Convert/HeifToJpeg.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Convert;
+
+use App\Contracts\PhotoCreate\PhotoConverter;
+use App\Exceptions\CannotConvertMediaFileException;
+use App\Image\Files\NativeLocalFile;
+use App\Image\Files\TemporaryJobFile;
+use App\Repositories\ConfigManager;
+
+class HeifToJpeg implements PhotoConverter
+{
+	public function __construct(
+		private ConfigManager $config_manager,
+	) {
+	}
+
+	/**
+	 * @throws \Exception
+	 */
+	public function handle(NativeLocalFile $tmp_file): TemporaryJobFile
+	{
+		if ($this->config_manager->hasImagick() === false) {
+			throw new CannotConvertMediaFileException('Imagick is not available.');
+		}
+
+		$path = $tmp_file->getRealPath();
+		$pathinfo = pathinfo($path);
+		$file_name = $pathinfo['filename'];
+		$new_path = $pathinfo['dirname'] . '/' . $file_name . '.jpg';
+
+		// Convert to Jpeg
+		try {
+			$imagick_converted = new \Imagick($path);
+
+			if ($imagick_converted->getNumberImages() > 1) {
+				$imagick_converted->setIteratorIndex(0);
+			}
+
+			$imagick_converted->setImageFormat('jpeg');
+			$imagick_converted->setImageCompression(\Imagick::COMPRESSION_JPEG);
+			$imagick_converted->setImageCompressionQuality(92);
+
+			$imagick_converted->autoOrient();
+			$imagick_converted->writeImage($new_path);
+		} catch (\ImagickException $e) {
+			throw new CannotConvertMediaFileException('Failed to convert HEIC/HEIF to JPEG.', $e);
+		}
+
+		// Delete old file
+		$tmp_file->delete();
+
+		return new TemporaryJobFile($new_path);
+	}
+}

app/Actions/Photo/Convert/PhotoConverterFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Convert;
+
+use App\Contracts\PhotoCreate\PhotoConverter;
+use App\Enum\ConvertableImageType;
+
+class PhotoConverterFactory
+{
+	public function make(string $extension): ?PhotoConverter
+	{
+		return match (true) {
+			ConvertableImageType::isHeifImageType($extension) => resolve(HeifToJpeg::class),
+			default => null,
+		};
+	}
+}

app/Actions/Photo/Create.php

@@ -80,6 +80,7 @@ public function add(NativeLocalFile $source_file, ?AbstractAlbum $album, ?int $f
 		);
 
 		$pre_pipes = [
+			Init\ConvertUnsupportedMedia::class,
 			Init\AssertSupportedMedia::class,
 			Init\FetchLastModifiedTime::class,
 			Init\MayLoadFileMetadata::class,

app/Actions/Photo/Pipes/Init/ConvertUnsupportedMedia.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Pipes\Init;
+
+use App\Actions\Photo\Convert\PhotoConverterFactory;
+use App\Contracts\PhotoCreate\InitPipe;
+use App\DTO\PhotoCreate\InitDTO;
+use App\Exceptions\CannotConvertMediaFileException;
+
+class ConvertUnsupportedMedia implements InitPipe
+{
+	/**
+	 * Tries to convert the file to a supported format.
+	 *
+	 * @throws CannotConvertMediaFileException
+	 */
+	public function handle(InitDTO $state, \Closure $next): InitDTO
+	{
+		$ext = ltrim($state->source_file->getOriginalExtension(), '.');
+
+		$factory = new PhotoConverterFactory();
+		$converter = $factory->make($ext);
+		if ($converter === null) {
+			return $next($state);
+		}
+
+		$state->source_file = $converter->handle($state->source_file);
+
+		return $next($state);
+	}
+}

app/Contracts/PhotoCreate/PhotoConverter.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Contracts\PhotoCreate;
+
+use App\Image\Files\NativeLocalFile;
+use App\Image\Files\TemporaryJobFile;
+
+interface PhotoConverter
+{
+	public function handle(NativeLocalFile $tmp_file): TemporaryJobFile;
+}

app/Enum/ConvertableImageType.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Enum;
+
+enum ConvertableImageType: string
+{
+	case HEIC = 'heic';
+	case HEIF = 'heif';
+
+	public static function isHeifImageType(string $extension): bool
+	{
+		$extension = str($extension)->lower()->toString();
+
+		return in_array($extension, [
+			self::HEIC->value,
+			self::HEIF->value,
+		], true);
+	}
+}

app/Exceptions/CannotConvertMediaFileException.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2026 LycheeOrg.
+ */
+
+namespace App\Exceptions;
+
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * CannotConvertMediaFileException.
+ *
+ * Indicates that a media file cannot be converted to another format.
+ */
+class CannotConvertMediaFileException extends BaseLycheeException
+{
+	public const string DEFAULT_MESSAGE = 'Cannot convert media file to another format';
+
+	public function __construct(string $msg = self::DEFAULT_MESSAGE, ?\Throwable $previous = null)
+	{
+		parent::__construct(Response::HTTP_UNPROCESSABLE_ENTITY, $msg, $previous);
+	}
+}

app/Services/Image/FileExtensionService.php

@@ -20,6 +20,7 @@ class FileExtensionService
 		IMAGETYPE_PNG,
 		IMAGETYPE_WEBP,
 		IMAGETYPE_AVIF,
+		20, // IMAGETYPE_HEIF;
 	];
 
 	public const SUPPORTED_IMAGE_FILE_EXTENSIONS = [
@@ -29,6 +30,8 @@ class FileExtensionService
 		'.gif',
 		'.webp',
 		'.avif',
+		'.heic',
+		'.heif',
 	];
 
 	public const SUPPORTED_VIDEO_FILE_EXTENSIONS = [
@@ -48,6 +51,8 @@ class FileExtensionService
 		'image/png',
 		'image/webp',
 		'image/avif',
+		'image/heif',
+		'image/heic',
 	];
 
 	public const SUPPORTED_VIDEO_MIME_TYPES = [
@@ -70,6 +75,8 @@ class FileExtensionService
 		'image/png' => '.png',
 		'image/webp' => '.webp',
 		'image/avif' => '.avif',
+		'image/heif' => '.heif',
+		'image/heic' => '.heic',
 		'video/mp4' => '.mp4',
 		'video/mpeg' => '.mpg',
 		'image/x-tga' => '.mpg',