feat: ability to upload and work with HEIF images by convert them to JPEG

app/Actions/Photo/Convert/HeifToJpeg.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Convert;
+
+use App\Contracts\Image\ConvertMediaFileInterface;
+use App\Image\Files\NativeLocalFile;
+use App\Image\Files\TemporaryJobFile;
+use Http\Client\Exception;
+use Maestroerror\HeicToJpg;
+use Safe\Exceptions\FilesystemException;
+use function Safe\unlink;
+
+class HeifToJpeg implements ConvertMediaFileInterface
+{
+	/**
+	 * @throws \Exception
+	 */
+	public function handle(NativeLocalFile $tmp_file): TemporaryJobFile
+	{
+		try {
+			$path = $tmp_file->getRealPath();
+			$pathinfo = pathinfo($path);
+			$file_name = $pathinfo['filename'];
+			$new_path = $pathinfo['dirname'] . '/' . $file_name . '.jpg';
+
+			// Convert to Jpeg
+			$imagick_converted = $this->convertToJpeg($path);
+
+			// Store converted image
+			$this->storeNewImage($imagick_converted, $new_path);
+
+			// Delete old file
+			$this->deleteOldFile($path);
+
+			return new TemporaryJobFile($new_path);
+		} catch (\Exception $e) {
+			throw new \Exception('Failed to convert HEIC/HEIF to JPEG. ' . $e->getMessage());
+		}
+	}
+
+	/**
+	 * @throws \Exception
+	 */
+	public function storeNewImage(\Imagick|HeicToJpg $image_instance, string $store_to_path): void
+	{
+		try {
+			if ($image_instance instanceof \Imagick) {
+				$image_instance->writeImage($store_to_path);
+			} elseif ($image_instance instanceof HeicToJpg) {
+				$image_instance->saveAs($store_to_path);
+			}
+		} catch (\ImagickException|\Exception $e) {
+			throw new \Exception('Failed to store converted image');
+		}
+	}
+
+	/**
+	 * @throws \Exception
+	 */
+	public function deleteOldFile(string $path): void
+	{
+		try {
+			unlink($path);
+		} catch (FilesystemException $e) {
+			throw new \Exception('Failed to delete old file');
+		}
+	}
+
+	/**
+	 * Try ImageMagick, if fails try php-heic-to-jpg package because ImageMagick fails to convert newer IPhone images.
+	 *
+	 * @throws \Exception
+	 */
+	private function convertToJpeg(string $path): \Imagick|HeicToJpg
+	{
+		try {
+			$img = new \Imagick($path);
+
+			if ($img->getNumberImages() > 1) {
+				$img->setIteratorIndex(0);
+			}
+
+			$img->setImageFormat('jpeg');
+			$img->setImageCompression(\Imagick::COMPRESSION_JPEG);
+			$img->setImageCompressionQuality(92);
+
+			$img->autoOrient();
+
+			return $img;
+		} catch (\ImagickException $e) {
+			try {
+				return HeicToJpg::convert($path);
+			} catch (Exception $exception) {
+				throw new \Exception('Failed to convert HEIC/HEIF to JPEG. ' . $e->getMessage() . ' ' . $exception->getMessage());
+			}
+		}
+	}
+}

app/Actions/Photo/Convert/ImageTypeFactory.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Convert;
+
+use App\Contracts\Image\ConvertMediaFileInterface;
+use App\Enum\ConvertableImageType;
+
+class ImageTypeFactory
+{
+	public ?string $conversionClass = null;
+
+	public function __construct(string $extension)
+	{
+		$this->conversionClass = match (true) {
+			ConvertableImageType::isHeifImageType($extension) => 'HeifToJpeg',
+			// TODO: Add more convertion types/classes
+			default => null,
+		};
+	}
+
+	public function make(): ConvertMediaFileInterface
+	{
+		if ($this->conversionClass === null) {
+			throw new \RuntimeException('No conversion class available for this file type');
+		}
+
+		$class = 'App\Actions\Photo\Convert\\' . $this->conversionClass;
+
+		if (!class_exists($class)) {
+			throw new \RuntimeException("Converter class {$class} does not exist");
+		}
+
+		$instance = new $class();
+
+		if (!$instance instanceof ConvertMediaFileInterface) {
+			throw new \RuntimeException("Converter class {$class} must implement ConvertMediaFileInterface");
+		}
+
+		return $instance;
+	}
+}

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,41 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Actions\Photo\Pipes\Init;
+
+use App\Actions\Photo\Convert\ImageTypeFactory;
+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 \Exception
+	 */
+	public function handle(InitDTO $state, \Closure $next): InitDTO
+	{
+		$ext = ltrim($state->source_file->getOriginalExtension(), '.');
+
+		$factory = new ImageTypeFactory($ext);
+
+		if ($factory->conversionClass === null) {
+			return $next($state);
+		}
+
+		try {
+			$state->source_file = $factory->make()->handle($state->source_file);
+		} catch (\Exception $exception) {
+			throw new CannotConvertMediaFileException($exception->getMessage(), $exception);
+		}
+
+		return $next($state);
+	}
+}

app/Contracts/Image/ConvertMediaFileInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Contracts\Image;
+
+use App\Image\Files\NativeLocalFile;
+use App\Image\Files\TemporaryJobFile;
+use Maestroerror\HeicToJpg;
+
+interface ConvertMediaFileInterface
+{
+	public function handle(NativeLocalFile $tmp_file): TemporaryJobFile;
+
+	public function storeNewImage(\Imagick|HeicToJpg $image_instance, string $store_to_path);
+
+	public function deleteOldFile(string $path);
+}

app/Enum/ConvertableImageType.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 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/Enum/ImageType.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Enum;
+
+enum ImageType: int
+{
+	case JPEG = IMAGETYPE_JPEG;
+	case JPEG2000 = IMAGETYPE_JPEG2000;
+	case PNG = IMAGETYPE_PNG;
+	case GIF = IMAGETYPE_GIF;
+	case WEBP = IMAGETYPE_WEBP;
+}
+

app/Exceptions/CannotConvertMediaFileException.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 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);
+	}
+}

composer.json

@@ -68,6 +68,7 @@
         "lychee-org/nestedset": "^11.0.0",
         "lychee-org/php-exif": "^1.0.4",
         "maennchen/zipstream-php": "^2.1 || ^3.1",
+        "maestroerror/php-heic-to-jpg": "^1.0.5",
         "mavinoo/laravel-batch": "^2.4",
         "moneyphp/money": "^4.7",
         "omnipay/dummy": "^3.0",

database/migrations/2025_12_22_105523_change_title_to_text_on_photos_table.php

@@ -0,0 +1,46 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Facades\DB;
+
+return new class() extends Migration {
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::table('photos', function (Blueprint $table) {
+			// Drop the existing index
+			if (Schema::hasIndex('photos', 'photos_album_id_is_starred_title_index')) {
+				$table->dropIndex('photos_album_id_is_starred_title_index');
+			}
+
+			// Change to text
+			$table->text('title')->nullable()->change();
+
+			// Recreate the index with a key length for the TEXT column
+			$table->index(['old_album_id', 'is_starred', DB::raw('title(100)')], 'photos_album_id_is_starred_title_index');
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::table('photos', function (Blueprint $table) {
+			// Drop the existing index
+			if (Schema::hasIndex('photos', 'photos_album_id_is_starred_title_index')) {
+				$table->dropIndex('photos_album_id_is_starred_title_index');
+			}
+
+			// Change to varchar
+			$table->string('title', 100)->nullable()->change();
+
+			$table->index(['odl_album_id', 'is_starred', 'title'], 'photos_album_id_is_starred_title_index');
+		});
+	}
+};