Add thumbs creation for pdf if enabled in Imagick. (#3329)

Author: ildyria

app/Actions/Diagnostics/Errors.php

@@ -20,6 +20,7 @@
 use App\Actions\Diagnostics\Pipes\Checks\ForeignKeyListInfo;
 use App\Actions\Diagnostics\Pipes\Checks\GDSupportCheck;
 use App\Actions\Diagnostics\Pipes\Checks\ImageOptCheck;
+use App\Actions\Diagnostics\Pipes\Checks\ImagickPdfCheck;
 use App\Actions\Diagnostics\Pipes\Checks\IniSettingsCheck;
 use App\Actions\Diagnostics\Pipes\Checks\MigrationCheck;
 use App\Actions\Diagnostics\Pipes\Checks\OpCacheCheck;
@@ -61,6 +62,7 @@ class Errors
 		CachePasswordCheck::class,
 		CacheTemporaryUrlCheck::class,
 		SupporterCheck::class,
+		ImagickPdfCheck::class,
 	];
 
 	/**

app/Actions/Diagnostics/Pipes/Checks/ImagickPdfCheck.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Actions\Diagnostics\Pipes\Checks;
+
+use App\Contracts\DiagnosticPipe;
+use App\DTO\DiagnosticData;
+use App\Models\Configs;
+use Illuminate\Support\Facades\Schema;
+use Safe\Exceptions\FilesystemException;
+use Safe\Exceptions\PcreException;
+use function Safe\file_get_contents;
+use function Safe\preg_match;
+
+/**
+ * Verify that if Imagick is installed, it is allowed to work with pdf files.
+ */
+class ImagickPdfCheck implements DiagnosticPipe
+{
+	/**
+	 * {@inheritDoc}
+	 */
+	public function handle(array &$data, \Closure $next): array
+	{
+		if (!Schema::hasTable('configs')) {
+			// @codeCoverageIgnoreStart
+			return $next($data);
+			// @codeCoverageIgnoreEnd
+		}
+
+		if (!Configs::hasImagick()) {
+			$data[] = DiagnosticData::info('Imagick is not enabled. Thumbs will not be created for pdf files.', self::class);
+
+			return $next($data);
+		}
+
+		try {
+			$imagic_policy = file_get_contents('/etc/ImageMagick-6/policy.xml');
+			if (1 === preg_match('/<policy domain="coder" rights="none" pattern="PDF"/', $imagic_policy)) {
+				$data[] = DiagnosticData::warn('Imagick is not allowed to create thumbs for pdf files.', self::class,
+					['Verify that the /etc/ImageMagick-6/policy.xml file contains the line <policy domain="coder" rights="read|write" pattern="PDF"/> .']);
+			}
+		} catch (FilesystemException) {
+			$data[] = DiagnosticData::warn('Could not determine whether Imagick is allowed to work with pdf files.', self::class, [
+				'Make sure to have the policy.xml file in `/etc/ImageMagick-6/policy.xml`.',
+				'Verify that the file contains the line <policy domain="coder" rights="read|write" pattern="PDF"/> .',
+			]);
+		} catch (PcreException) {
+			// Just ignore.
+		}
+
+		return $next($data);
+	}
+}

app/Image/Files/BaseMediaFile.php

@@ -272,6 +272,12 @@ protected static function getSanitizedAcceptedRawFileExtensions(): array
 	{
 		if (count(self::$cachedAcceptedRawFileExtensions) === 0) {
 			$tmp = explode('|', strtolower(Configs::getValueAsString('raw_formats')));
+
+			// We imagick is enabeld, then we can allow PDF files.
+			if (Configs::hasImagick()) {
+				$tmp[] = '.pdf';
+			}
+
 			// Explode may return `false` on error
 			// Our supported file extensions always take precedence over any
 			// custom configured extension

app/Image/Handlers/ImagickHandler.php

@@ -14,6 +14,7 @@
 use App\DTO\ImageDimension;
 use App\Exceptions\ImageProcessingException;
 use App\Exceptions\MediaFileOperationException;
+use App\Image\Files\BaseMediaFile;
 use App\Image\Files\InMemoryBuffer;
 use Imagick;
 
@@ -63,6 +64,12 @@ public function load(MediaFile $file): void
 
 			$this->im_image = new \Imagick();
 			$this->im_image->readImageFile($input_stream);
+
+			// If the file is a PDF and the user has chosen to support PDF files then try to create an image from the first page
+			if ($file->getExtension() === '.pdf' && BaseMediaFile::isSupportedOrAcceptedFileExtension($file->getExtension())) {
+				$this->im_image->setIteratorIndex(0);
+			}
+
 			$this->autoRotate();
 		} catch (\ImagickException $e) {
 			throw new MediaFileOperationException('Failed to load image', $e);