nextcloud / server

lib/private/PreviewManager.php

Indentation +441 added lines, -441 removed lines

@@ -28,445 +28,445 @@
 use function array_key_exists;
 
 class PreviewManager implements IPreview {
-	protected IConfig $config;
-	protected IRootFolder $rootFolder;
-	protected IAppData $appData;
-	protected IEventDispatcher $eventDispatcher;
-	private ?Generator $generator = null;
-	private GeneratorHelper $helper;
-	protected bool $providerListDirty = false;
-	protected bool $registeredCoreProviders = false;
-	protected array $providers = [];
-
-	/** @var array mime type => support status */
-	protected array $mimeTypeSupportMap = [];
-	protected ?array $defaultProviders = null;
-	protected ?string $userId;
-	private Coordinator $bootstrapCoordinator;
-
-	/**
-	 * Hash map (without value) of loaded bootstrap providers
-	 * @psalm-var array<string, null>
-	 */
-	private array $loadedBootstrapProviders = [];
-	private ContainerInterface $container;
-	private IBinaryFinder $binaryFinder;
-	private IMagickSupport $imagickSupport;
-	private bool $enablePreviews;
-
-	public function __construct(
-		IConfig $config,
-		IRootFolder $rootFolder,
-		IAppData $appData,
-		IEventDispatcher $eventDispatcher,
-		GeneratorHelper $helper,
-		?string $userId,
-		Coordinator $bootstrapCoordinator,
-		ContainerInterface $container,
-		IBinaryFinder $binaryFinder,
-		IMagickSupport $imagickSupport,
-	) {
-		$this->config = $config;
-		$this->rootFolder = $rootFolder;
-		$this->appData = $appData;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->helper = $helper;
-		$this->userId = $userId;
-		$this->bootstrapCoordinator = $bootstrapCoordinator;
-		$this->container = $container;
-		$this->binaryFinder = $binaryFinder;
-		$this->imagickSupport = $imagickSupport;
-		$this->enablePreviews = $config->getSystemValueBool('enable_previews', true);
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be
-	 * called in case preview providers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
-	 *
-	 * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
-	 * @param \Closure $callable
-	 * @return void
-	 */
-	public function registerProvider($mimeTypeRegex, \Closure $callable): void {
-		if (!$this->enablePreviews) {
-			return;
-		}
-
-		if (!isset($this->providers[$mimeTypeRegex])) {
-			$this->providers[$mimeTypeRegex] = [];
-		}
-		$this->providers[$mimeTypeRegex][] = $callable;
-		$this->providerListDirty = true;
-	}
-
-	/**
-	 * Get all providers
-	 */
-	public function getProviders(): array {
-		if (!$this->enablePreviews) {
-			return [];
-		}
-
-		$this->registerCoreProviders();
-		$this->registerBootstrapProviders();
-		if ($this->providerListDirty) {
-			$keys = array_map('strlen', array_keys($this->providers));
-			array_multisort($keys, SORT_DESC, $this->providers);
-			$this->providerListDirty = false;
-		}
-
-		return $this->providers;
-	}
-
-	/**
-	 * Does the manager have any providers
-	 */
-	public function hasProviders(): bool {
-		$this->registerCoreProviders();
-		return !empty($this->providers);
-	}
-
-	private function getGenerator(): Generator {
-		if ($this->generator === null) {
-			$this->generator = new Generator(
-				$this->config,
-				$this,
-				$this->appData,
-				new GeneratorHelper(
-					$this->rootFolder,
-					$this->config
-				),
-				$this->eventDispatcher,
-				$this->container->get(LoggerInterface::class),
-			);
-		}
-		return $this->generator;
-	}
-
-	/**
-	 * Returns a preview of a file
-	 *
-	 * The cache is searched first and if nothing usable was found then a preview is
-	 * generated by one of the providers
-	 *
-	 * @param File $file
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param string $mimeType
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
-	 */
-	public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
-		$this->throwIfPreviewsDisabled();
-		$previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all');
-		$sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency);
-		try {
-			$preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType);
-		} finally {
-			Generator::unguardWithSemaphore($sem);
-		}
-
-		return $preview;
-	}
-
-	/**
-	 * Generates previews of a file
-	 *
-	 * @param File $file
-	 * @param array $specifications
-	 * @param string $mimeType
-	 * @return ISimpleFile the last preview that was generated
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 * @since 19.0.0
-	 */
-	public function generatePreviews(File $file, array $specifications, $mimeType = null) {
-		$this->throwIfPreviewsDisabled();
-		return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
-	}
-
-	/**
-	 * returns true if the passed mime type is supported
-	 *
-	 * @param string $mimeType
-	 * @return boolean
-	 */
-	public function isMimeSupported($mimeType = '*') {
-		if (!$this->enablePreviews) {
-			return false;
-		}
-
-		if (isset($this->mimeTypeSupportMap[$mimeType])) {
-			return $this->mimeTypeSupportMap[$mimeType];
-		}
-
-		$this->registerCoreProviders();
-		$this->registerBootstrapProviders();
-		$providerMimeTypes = array_keys($this->providers);
-		foreach ($providerMimeTypes as $supportedMimeType) {
-			if (preg_match($supportedMimeType, $mimeType)) {
-				$this->mimeTypeSupportMap[$mimeType] = true;
-				return true;
-			}
-		}
-		$this->mimeTypeSupportMap[$mimeType] = false;
-		return false;
-	}
-
-	/**
-	 * Check if a preview can be generated for a file
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file): bool {
-		if (!$this->enablePreviews) {
-			return false;
-		}
-
-		$this->registerCoreProviders();
-		if (!$this->isMimeSupported($file->getMimetype())) {
-			return false;
-		}
-
-		$mount = $file->getMountPoint();
-		if ($mount and !$mount->getOption('previews', true)) {
-			return false;
-		}
-
-		foreach ($this->providers as $supportedMimeType => $providers) {
-			if (preg_match($supportedMimeType, $file->getMimetype())) {
-				foreach ($providers as $providerClosure) {
-					$provider = $this->helper->getProvider($providerClosure);
-					if (!($provider instanceof IProviderV2)) {
-						continue;
-					}
-
-					if ($provider->isAvailable($file)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * List of enabled default providers
-	 *
-	 * The following providers are enabled by default:
-	 *  - OC\Preview\PNG
-	 *  - OC\Preview\JPEG
-	 *  - OC\Preview\GIF
-	 *  - OC\Preview\BMP
-	 *  - OC\Preview\XBitmap
-	 *  - OC\Preview\MarkDown
-	 *  - OC\Preview\MP3
-	 *  - OC\Preview\TXT
-	 *
-	 * The following providers are disabled by default due to performance or privacy concerns:
-	 *  - OC\Preview\Font
-	 *  - OC\Preview\HEIC
-	 *  - OC\Preview\Illustrator
-	 *  - OC\Preview\Movie
-	 *  - OC\Preview\MSOfficeDoc
-	 *  - OC\Preview\MSOffice2003
-	 *  - OC\Preview\MSOffice2007
-	 *  - OC\Preview\OpenDocument
-	 *  - OC\Preview\PDF
-	 *  - OC\Preview\Photoshop
-	 *  - OC\Preview\Postscript
-	 *  - OC\Preview\StarOffice
-	 *  - OC\Preview\SVG
-	 *  - OC\Preview\TIFF
-	 *
-	 * @return array
-	 */
-	protected function getEnabledDefaultProvider() {
-		if ($this->defaultProviders !== null) {
-			return $this->defaultProviders;
-		}
-
-		$imageProviders = [
-			Preview\PNG::class,
-			Preview\JPEG::class,
-			Preview\GIF::class,
-			Preview\BMP::class,
-			Preview\XBitmap::class,
-			Preview\Krita::class,
-			Preview\WebP::class,
-		];
-
-		$this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
-			Preview\MarkDown::class,
-			Preview\MP3::class,
-			Preview\TXT::class,
-			Preview\OpenDocument::class,
-		], $imageProviders));
-
-		if (in_array(Preview\Image::class, $this->defaultProviders)) {
-			$this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
-		}
-		$this->defaultProviders = array_unique($this->defaultProviders);
-		return $this->defaultProviders;
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 *
-	 * @param string $class
-	 * @param string $mimeType
-	 */
-	protected function registerCoreProvider($class, $mimeType, $options = []) {
-		if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-			$this->registerProvider($mimeType, function () use ($class, $options) {
-				return new $class($options);
-			});
-		}
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 */
-	protected function registerCoreProviders() {
-		if ($this->registeredCoreProviders) {
-			return;
-		}
-		$this->registeredCoreProviders = true;
-
-		$this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
-		$this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
-		$this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
-		$this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
-		$this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
-		$this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
-		$this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
-		$this->registerCoreProvider(Preview\WebP::class, '/image\/webp/');
-		$this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/');
-		$this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg$/');
-		$this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
-		$this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
-		$this->registerCoreProvider(Preview\ImaginaryPDF::class, Preview\ImaginaryPDF::supportedMimeTypes());
-
-		// SVG and Bitmap require imagick
-		if ($this->imagickSupport->hasExtension()) {
-			$imagickProviders = [
-				'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
-				'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
-				'PDF' => ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
-				'AI' => ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
-				'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
-				'EPS' => ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
-				'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
-				'HEIC' => ['mimetype' => '/image\/(x-)?hei(f|c)/', 'class' => Preview\HEIC::class],
-				'TGA' => ['mimetype' => '/image\/(x-)?t(ar)?ga/', 'class' => Preview\TGA::class],
-				'SGI' => ['mimetype' => '/image\/(x-)?sgi/', 'class' => Preview\SGI::class],
-			];
-
-			foreach ($imagickProviders as $queryFormat => $provider) {
-				$class = $provider['class'];
-				if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-					continue;
-				}
-
-				if ($this->imagickSupport->supportsFormat($queryFormat)) {
-					$this->registerCoreProvider($class, $provider['mimetype']);
-				}
-			}
-		}
-
-		$this->registerCoreProvidersOffice();
-
-		// Video requires avconv or ffmpeg
-		if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
-			$movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null);
-			if (!is_string($movieBinary)) {
-				$movieBinary = $this->binaryFinder->findBinaryPath('avconv');
-				if (!is_string($movieBinary)) {
-					$movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg');
-				}
-			}
-
-
-			if (is_string($movieBinary)) {
-				$this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ['movieBinary' => $movieBinary]);
-			}
-		}
-	}
-
-	private function registerCoreProvidersOffice(): void {
-		$officeProviders = [
-			['mimetype' => '/application\/msword/', 'class' => Preview\MSOfficeDoc::class],
-			['mimetype' => '/application\/vnd.ms-.*/', 'class' => Preview\MSOffice2003::class],
-			['mimetype' => '/application\/vnd.openxmlformats-officedocument.*/', 'class' => Preview\MSOffice2007::class],
-			['mimetype' => '/application\/vnd.oasis.opendocument.*/', 'class' => Preview\OpenDocument::class],
-			['mimetype' => '/application\/vnd.sun.xml.*/', 'class' => Preview\StarOffice::class],
-			['mimetype' => '/image\/emf/', 'class' => Preview\EMF::class],
-		];
-
-		$findBinary = true;
-		$officeBinary = false;
-
-		foreach ($officeProviders as $provider) {
-			$class = $provider['class'];
-			if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-				continue;
-			}
-
-			if ($findBinary) {
-				// Office requires openoffice or libreoffice
-				$officeBinary = $this->config->getSystemValue('preview_libreoffice_path', false);
-				if ($officeBinary === false) {
-					$officeBinary = $this->binaryFinder->findBinaryPath('libreoffice');
-				}
-				if ($officeBinary === false) {
-					$officeBinary = $this->binaryFinder->findBinaryPath('openoffice');
-				}
-				$findBinary = false;
-			}
-
-			if ($officeBinary) {
-				$this->registerCoreProvider($class, $provider['mimetype'], ['officeBinary' => $officeBinary]);
-			}
-		}
-	}
-
-	private function registerBootstrapProviders(): void {
-		$context = $this->bootstrapCoordinator->getRegistrationContext();
-
-		if ($context === null) {
-			// Just ignore for now
-			return;
-		}
-
-		$providers = $context->getPreviewProviders();
-		foreach ($providers as $provider) {
-			$key = $provider->getMimeTypeRegex() . '-' . $provider->getService();
-			if (array_key_exists($key, $this->loadedBootstrapProviders)) {
-				// Do not load the provider more than once
-				continue;
-			}
-			$this->loadedBootstrapProviders[$key] = null;
-
-			$this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) {
-				try {
-					return $this->container->get($provider->getService());
-				} catch (QueryException $e) {
-					return null;
-				}
-			});
-		}
-	}
-
-	/**
-	 * @throws NotFoundException if preview generation is disabled
-	 */
-	private function throwIfPreviewsDisabled(): void {
-		if (!$this->enablePreviews) {
-			throw new NotFoundException('Previews disabled');
-		}
-	}
+    protected IConfig $config;
+    protected IRootFolder $rootFolder;
+    protected IAppData $appData;
+    protected IEventDispatcher $eventDispatcher;
+    private ?Generator $generator = null;
+    private GeneratorHelper $helper;
+    protected bool $providerListDirty = false;
+    protected bool $registeredCoreProviders = false;
+    protected array $providers = [];
+
+    /** @var array mime type => support status */
+    protected array $mimeTypeSupportMap = [];
+    protected ?array $defaultProviders = null;
+    protected ?string $userId;
+    private Coordinator $bootstrapCoordinator;
+
+    /**
+     * Hash map (without value) of loaded bootstrap providers
+     * @psalm-var array<string, null>
+     */
+    private array $loadedBootstrapProviders = [];
+    private ContainerInterface $container;
+    private IBinaryFinder $binaryFinder;
+    private IMagickSupport $imagickSupport;
+    private bool $enablePreviews;
+
+    public function __construct(
+        IConfig $config,
+        IRootFolder $rootFolder,
+        IAppData $appData,
+        IEventDispatcher $eventDispatcher,
+        GeneratorHelper $helper,
+        ?string $userId,
+        Coordinator $bootstrapCoordinator,
+        ContainerInterface $container,
+        IBinaryFinder $binaryFinder,
+        IMagickSupport $imagickSupport,
+    ) {
+        $this->config = $config;
+        $this->rootFolder = $rootFolder;
+        $this->appData = $appData;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->helper = $helper;
+        $this->userId = $userId;
+        $this->bootstrapCoordinator = $bootstrapCoordinator;
+        $this->container = $container;
+        $this->binaryFinder = $binaryFinder;
+        $this->imagickSupport = $imagickSupport;
+        $this->enablePreviews = $config->getSystemValueBool('enable_previews', true);
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be
+     * called in case preview providers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
+     *
+     * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
+     * @param \Closure $callable
+     * @return void
+     */
+    public function registerProvider($mimeTypeRegex, \Closure $callable): void {
+        if (!$this->enablePreviews) {
+            return;
+        }
+
+        if (!isset($this->providers[$mimeTypeRegex])) {
+            $this->providers[$mimeTypeRegex] = [];
+        }
+        $this->providers[$mimeTypeRegex][] = $callable;
+        $this->providerListDirty = true;
+    }
+
+    /**
+     * Get all providers
+     */
+    public function getProviders(): array {
+        if (!$this->enablePreviews) {
+            return [];
+        }
+
+        $this->registerCoreProviders();
+        $this->registerBootstrapProviders();
+        if ($this->providerListDirty) {
+            $keys = array_map('strlen', array_keys($this->providers));
+            array_multisort($keys, SORT_DESC, $this->providers);
+            $this->providerListDirty = false;
+        }
+
+        return $this->providers;
+    }
+
+    /**
+     * Does the manager have any providers
+     */
+    public function hasProviders(): bool {
+        $this->registerCoreProviders();
+        return !empty($this->providers);
+    }
+
+    private function getGenerator(): Generator {
+        if ($this->generator === null) {
+            $this->generator = new Generator(
+                $this->config,
+                $this,
+                $this->appData,
+                new GeneratorHelper(
+                    $this->rootFolder,
+                    $this->config
+                ),
+                $this->eventDispatcher,
+                $this->container->get(LoggerInterface::class),
+            );
+        }
+        return $this->generator;
+    }
+
+    /**
+     * Returns a preview of a file
+     *
+     * The cache is searched first and if nothing usable was found then a preview is
+     * generated by one of the providers
+     *
+     * @param File $file
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param string $mimeType
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
+     */
+    public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
+        $this->throwIfPreviewsDisabled();
+        $previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all');
+        $sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency);
+        try {
+            $preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType);
+        } finally {
+            Generator::unguardWithSemaphore($sem);
+        }
+
+        return $preview;
+    }
+
+    /**
+     * Generates previews of a file
+     *
+     * @param File $file
+     * @param array $specifications
+     * @param string $mimeType
+     * @return ISimpleFile the last preview that was generated
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     * @since 19.0.0
+     */
+    public function generatePreviews(File $file, array $specifications, $mimeType = null) {
+        $this->throwIfPreviewsDisabled();
+        return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
+    }
+
+    /**
+     * returns true if the passed mime type is supported
+     *
+     * @param string $mimeType
+     * @return boolean
+     */
+    public function isMimeSupported($mimeType = '*') {
+        if (!$this->enablePreviews) {
+            return false;
+        }
+
+        if (isset($this->mimeTypeSupportMap[$mimeType])) {
+            return $this->mimeTypeSupportMap[$mimeType];
+        }
+
+        $this->registerCoreProviders();
+        $this->registerBootstrapProviders();
+        $providerMimeTypes = array_keys($this->providers);
+        foreach ($providerMimeTypes as $supportedMimeType) {
+            if (preg_match($supportedMimeType, $mimeType)) {
+                $this->mimeTypeSupportMap[$mimeType] = true;
+                return true;
+            }
+        }
+        $this->mimeTypeSupportMap[$mimeType] = false;
+        return false;
+    }
+
+    /**
+     * Check if a preview can be generated for a file
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file): bool {
+        if (!$this->enablePreviews) {
+            return false;
+        }
+
+        $this->registerCoreProviders();
+        if (!$this->isMimeSupported($file->getMimetype())) {
+            return false;
+        }
+
+        $mount = $file->getMountPoint();
+        if ($mount and !$mount->getOption('previews', true)) {
+            return false;
+        }
+
+        foreach ($this->providers as $supportedMimeType => $providers) {
+            if (preg_match($supportedMimeType, $file->getMimetype())) {
+                foreach ($providers as $providerClosure) {
+                    $provider = $this->helper->getProvider($providerClosure);
+                    if (!($provider instanceof IProviderV2)) {
+                        continue;
+                    }
+
+                    if ($provider->isAvailable($file)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * List of enabled default providers
+     *
+     * The following providers are enabled by default:
+     *  - OC\Preview\PNG
+     *  - OC\Preview\JPEG
+     *  - OC\Preview\GIF
+     *  - OC\Preview\BMP
+     *  - OC\Preview\XBitmap
+     *  - OC\Preview\MarkDown
+     *  - OC\Preview\MP3
+     *  - OC\Preview\TXT
+     *
+     * The following providers are disabled by default due to performance or privacy concerns:
+     *  - OC\Preview\Font
+     *  - OC\Preview\HEIC
+     *  - OC\Preview\Illustrator
+     *  - OC\Preview\Movie
+     *  - OC\Preview\MSOfficeDoc
+     *  - OC\Preview\MSOffice2003
+     *  - OC\Preview\MSOffice2007
+     *  - OC\Preview\OpenDocument
+     *  - OC\Preview\PDF
+     *  - OC\Preview\Photoshop
+     *  - OC\Preview\Postscript
+     *  - OC\Preview\StarOffice
+     *  - OC\Preview\SVG
+     *  - OC\Preview\TIFF
+     *
+     * @return array
+     */
+    protected function getEnabledDefaultProvider() {
+        if ($this->defaultProviders !== null) {
+            return $this->defaultProviders;
+        }
+
+        $imageProviders = [
+            Preview\PNG::class,
+            Preview\JPEG::class,
+            Preview\GIF::class,
+            Preview\BMP::class,
+            Preview\XBitmap::class,
+            Preview\Krita::class,
+            Preview\WebP::class,
+        ];
+
+        $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
+            Preview\MarkDown::class,
+            Preview\MP3::class,
+            Preview\TXT::class,
+            Preview\OpenDocument::class,
+        ], $imageProviders));
+
+        if (in_array(Preview\Image::class, $this->defaultProviders)) {
+            $this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
+        }
+        $this->defaultProviders = array_unique($this->defaultProviders);
+        return $this->defaultProviders;
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     *
+     * @param string $class
+     * @param string $mimeType
+     */
+    protected function registerCoreProvider($class, $mimeType, $options = []) {
+        if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+            $this->registerProvider($mimeType, function () use ($class, $options) {
+                return new $class($options);
+            });
+        }
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     */
+    protected function registerCoreProviders() {
+        if ($this->registeredCoreProviders) {
+            return;
+        }
+        $this->registeredCoreProviders = true;
+
+        $this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
+        $this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
+        $this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
+        $this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
+        $this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
+        $this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
+        $this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
+        $this->registerCoreProvider(Preview\WebP::class, '/image\/webp/');
+        $this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/');
+        $this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg$/');
+        $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
+        $this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
+        $this->registerCoreProvider(Preview\ImaginaryPDF::class, Preview\ImaginaryPDF::supportedMimeTypes());
+
+        // SVG and Bitmap require imagick
+        if ($this->imagickSupport->hasExtension()) {
+            $imagickProviders = [
+                'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
+                'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
+                'PDF' => ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
+                'AI' => ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
+                'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
+                'EPS' => ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
+                'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
+                'HEIC' => ['mimetype' => '/image\/(x-)?hei(f|c)/', 'class' => Preview\HEIC::class],
+                'TGA' => ['mimetype' => '/image\/(x-)?t(ar)?ga/', 'class' => Preview\TGA::class],
+                'SGI' => ['mimetype' => '/image\/(x-)?sgi/', 'class' => Preview\SGI::class],
+            ];
+
+            foreach ($imagickProviders as $queryFormat => $provider) {
+                $class = $provider['class'];
+                if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+                    continue;
+                }
+
+                if ($this->imagickSupport->supportsFormat($queryFormat)) {
+                    $this->registerCoreProvider($class, $provider['mimetype']);
+                }
+            }
+        }
+
+        $this->registerCoreProvidersOffice();
+
+        // Video requires avconv or ffmpeg
+        if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
+            $movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null);
+            if (!is_string($movieBinary)) {
+                $movieBinary = $this->binaryFinder->findBinaryPath('avconv');
+                if (!is_string($movieBinary)) {
+                    $movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg');
+                }
+            }
+
+
+            if (is_string($movieBinary)) {
+                $this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ['movieBinary' => $movieBinary]);
+            }
+        }
+    }
+
+    private function registerCoreProvidersOffice(): void {
+        $officeProviders = [
+            ['mimetype' => '/application\/msword/', 'class' => Preview\MSOfficeDoc::class],
+            ['mimetype' => '/application\/vnd.ms-.*/', 'class' => Preview\MSOffice2003::class],
+            ['mimetype' => '/application\/vnd.openxmlformats-officedocument.*/', 'class' => Preview\MSOffice2007::class],
+            ['mimetype' => '/application\/vnd.oasis.opendocument.*/', 'class' => Preview\OpenDocument::class],
+            ['mimetype' => '/application\/vnd.sun.xml.*/', 'class' => Preview\StarOffice::class],
+            ['mimetype' => '/image\/emf/', 'class' => Preview\EMF::class],
+        ];
+
+        $findBinary = true;
+        $officeBinary = false;
+
+        foreach ($officeProviders as $provider) {
+            $class = $provider['class'];
+            if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+                continue;
+            }
+
+            if ($findBinary) {
+                // Office requires openoffice or libreoffice
+                $officeBinary = $this->config->getSystemValue('preview_libreoffice_path', false);
+                if ($officeBinary === false) {
+                    $officeBinary = $this->binaryFinder->findBinaryPath('libreoffice');
+                }
+                if ($officeBinary === false) {
+                    $officeBinary = $this->binaryFinder->findBinaryPath('openoffice');
+                }
+                $findBinary = false;
+            }
+
+            if ($officeBinary) {
+                $this->registerCoreProvider($class, $provider['mimetype'], ['officeBinary' => $officeBinary]);
+            }
+        }
+    }
+
+    private function registerBootstrapProviders(): void {
+        $context = $this->bootstrapCoordinator->getRegistrationContext();
+
+        if ($context === null) {
+            // Just ignore for now
+            return;
+        }
+
+        $providers = $context->getPreviewProviders();
+        foreach ($providers as $provider) {
+            $key = $provider->getMimeTypeRegex() . '-' . $provider->getService();
+            if (array_key_exists($key, $this->loadedBootstrapProviders)) {
+                // Do not load the provider more than once
+                continue;
+            }
+            $this->loadedBootstrapProviders[$key] = null;
+
+            $this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) {
+                try {
+                    return $this->container->get($provider->getService());
+                } catch (QueryException $e) {
+                    return null;
+                }
+            });
+        }
+    }
+
+    /**
+     * @throws NotFoundException if preview generation is disabled
+     */
+    private function throwIfPreviewsDisabled(): void {
+        if (!$this->enablePreviews) {
+            throw new NotFoundException('Previews disabled');
+        }
+    }
 }

lib/private/Preview/Generator.php

Indentation +572 added lines, -572 removed lines

@@ -24,592 +24,592 @@
 use Psr\Log\LoggerInterface;
 
 class Generator {
-	public const SEMAPHORE_ID_ALL = 0x0a11;
-	public const SEMAPHORE_ID_NEW = 0x07ea;
-
-	public function __construct(
-		private IConfig $config,
-		private IPreview $previewManager,
-		private IAppData $appData,
-		private GeneratorHelper $helper,
-		private IEventDispatcher $eventDispatcher,
-		private LoggerInterface $logger,
-	) {
-	}
-
-	/**
-	 * Returns a preview of a file
-	 *
-	 * The cache is searched first and if nothing usable was found then a preview is
-	 * generated by one of the providers
-	 *
-	 * @param File $file
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param string|null $mimeType
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
-		$specification = [
-			'width' => $width,
-			'height' => $height,
-			'crop' => $crop,
-			'mode' => $mode,
-		];
-
-		$this->eventDispatcher->dispatchTyped(new BeforePreviewFetchedEvent(
-			$file,
-			$width,
-			$height,
-			$crop,
-			$mode,
-			$mimeType,
-		));
-
-		$this->logger->debug('Requesting preview for {path} with width={width}, height={height}, crop={crop}, mode={mode}, mimeType={mimeType}', [
-			'path' => $file->getPath(),
-			'width' => $width,
-			'height' => $height,
-			'crop' => $crop,
-			'mode' => $mode,
-			'mimeType' => $mimeType,
-		]);
+    public const SEMAPHORE_ID_ALL = 0x0a11;
+    public const SEMAPHORE_ID_NEW = 0x07ea;
+
+    public function __construct(
+        private IConfig $config,
+        private IPreview $previewManager,
+        private IAppData $appData,
+        private GeneratorHelper $helper,
+        private IEventDispatcher $eventDispatcher,
+        private LoggerInterface $logger,
+    ) {
+    }
+
+    /**
+     * Returns a preview of a file
+     *
+     * The cache is searched first and if nothing usable was found then a preview is
+     * generated by one of the providers
+     *
+     * @param File $file
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param string|null $mimeType
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
+        $specification = [
+            'width' => $width,
+            'height' => $height,
+            'crop' => $crop,
+            'mode' => $mode,
+        ];
+
+        $this->eventDispatcher->dispatchTyped(new BeforePreviewFetchedEvent(
+            $file,
+            $width,
+            $height,
+            $crop,
+            $mode,
+            $mimeType,
+        ));
+
+        $this->logger->debug('Requesting preview for {path} with width={width}, height={height}, crop={crop}, mode={mode}, mimeType={mimeType}', [
+            'path' => $file->getPath(),
+            'width' => $width,
+            'height' => $height,
+            'crop' => $crop,
+            'mode' => $mode,
+            'mimeType' => $mimeType,
+        ]);
 		
 
-		// since we only ask for one preview, and the generate method return the last one it created, it returns the one we want
-		return $this->generatePreviews($file, [$specification], $mimeType);
-	}
-
-	/**
-	 * Generates previews of a file
-	 *
-	 * @param File $file
-	 * @param non-empty-array $specifications
-	 * @param string $mimeType
-	 * @return ISimpleFile the last preview that was generated
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	public function generatePreviews(File $file, array $specifications, $mimeType = null) {
-		//Make sure that we can read the file
-		if (!$file->isReadable()) {
-			$this->logger->warning('Cannot read file: {path}, skipping preview generation.', ['path' => $file->getPath()]);
-			throw new NotFoundException('Cannot read file');
-		}
-
-		if ($mimeType === null) {
-			$mimeType = $file->getMimeType();
-		}
-
-		$previewFolder = $this->getPreviewFolder($file);
-		// List every existing preview first instead of trying to find them one by one
-		$previewFiles = $previewFolder->getDirectoryListing();
-
-		$previewVersion = '';
-		if ($file instanceof IVersionedPreviewFile) {
-			$previewVersion = $file->getPreviewVersion() . '-';
-		}
-
-		// Get the max preview and infer the max preview sizes from that
-		$maxPreview = $this->getMaxPreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion);
-		$maxPreviewImage = null; // only load the image when we need it
-		if ($maxPreview->getSize() === 0) {
-			$maxPreview->delete();
-			$this->logger->error("Max preview generated for file {$file->getPath()} has size 0, deleting and throwing exception.");
-			throw new NotFoundException('Max preview size 0, invalid!');
-		}
-
-		[$maxWidth, $maxHeight] = $this->getPreviewSize($maxPreview, $previewVersion);
-
-		if ($maxWidth <= 0 || $maxHeight <= 0) {
-			throw new NotFoundException('The maximum preview sizes are zero or less pixels');
-		}
-
-		$preview = null;
-
-		foreach ($specifications as $specification) {
-			$width = $specification['width'] ?? -1;
-			$height = $specification['height'] ?? -1;
-			$crop = $specification['crop'] ?? false;
-			$mode = $specification['mode'] ?? IPreview::MODE_FILL;
-
-			// If both width and height are -1 we just want the max preview
-			if ($width === -1 && $height === -1) {
-				$width = $maxWidth;
-				$height = $maxHeight;
-			}
-
-			// Calculate the preview size
-			[$width, $height] = $this->calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight);
-
-			// No need to generate a preview that is just the max preview
-			if ($width === $maxWidth && $height === $maxHeight) {
-				// ensure correct return value if this was the last one
-				$preview = $maxPreview;
-				continue;
-			}
-
-			// Try to get a cached preview. Else generate (and store) one
-			try {
-				try {
-					$preview = $this->getCachedPreview($previewFiles, $width, $height, $crop, $maxPreview->getMimeType(), $previewVersion);
-				} catch (NotFoundException $e) {
-					if (!$this->previewManager->isMimeSupported($mimeType)) {
-						throw new NotFoundException();
-					}
-
-					if ($maxPreviewImage === null) {
-						$maxPreviewImage = $this->helper->getImage($maxPreview);
-					}
-
-					$this->logger->warning('Cached preview not found for file {path}, generating a new preview.', ['path' => $file->getPath()]);
-					$preview = $this->generatePreview($previewFolder, $maxPreviewImage, $width, $height, $crop, $maxWidth, $maxHeight, $previewVersion);
-					// New file, augment our array
-					$previewFiles[] = $preview;
-				}
-			} catch (\InvalidArgumentException $e) {
-				throw new NotFoundException('', 0, $e);
-			}
-
-			if ($preview->getSize() === 0) {
-				$preview->delete();
-				throw new NotFoundException('Cached preview size 0, invalid!');
-			}
-		}
-		assert($preview !== null);
-
-		// Free memory being used by the embedded image resource.  Without this the image is kept in memory indefinitely.
-		// Garbage Collection does NOT free this memory.  We have to do it ourselves.
-		if ($maxPreviewImage instanceof \OCP\Image) {
-			$maxPreviewImage->destroy();
-		}
-
-		return $preview;
-	}
-
-	/**
-	 * Acquire a semaphore of the specified id and concurrency, blocking if necessary.
-	 * Return an identifier of the semaphore on success, which can be used to release it via
-	 * {@see Generator::unguardWithSemaphore()}.
-	 *
-	 * @param int $semId
-	 * @param int $concurrency
-	 * @return false|\SysvSemaphore the semaphore on success or false on failure
-	 */
-	public static function guardWithSemaphore(int $semId, int $concurrency) {
-		if (!extension_loaded('sysvsem')) {
-			return false;
-		}
-		$sem = sem_get($semId, $concurrency);
-		if ($sem === false) {
-			return false;
-		}
-		if (!sem_acquire($sem)) {
-			return false;
-		}
-		return $sem;
-	}
-
-	/**
-	 * Releases the semaphore acquired from {@see Generator::guardWithSemaphore()}.
-	 *
-	 * @param false|\SysvSemaphore $semId the semaphore identifier returned by guardWithSemaphore
-	 * @return bool
-	 */
-	public static function unguardWithSemaphore(false|\SysvSemaphore $semId): bool {
-		if ($semId === false || !($semId instanceof \SysvSemaphore)) {
-			return false;
-		}
-		return sem_release($semId);
-	}
-
-	/**
-	 * Get the number of concurrent threads supported by the host.
-	 *
-	 * @return int number of concurrent threads, or 0 if it cannot be determined
-	 */
-	public static function getHardwareConcurrency(): int {
-		static $width;
-
-		if (!isset($width)) {
-			if (function_exists('ini_get')) {
-				$openBasedir = ini_get('open_basedir');
-				if (empty($openBasedir) || strpos($openBasedir, '/proc/cpuinfo') !== false) {
-					$width = is_readable('/proc/cpuinfo') ? substr_count(file_get_contents('/proc/cpuinfo'), 'processor') : 0;
-				} else {
-					$width = 0;
-				}
-			} else {
-				$width = 0;
-			}
-		}
-		return $width;
-	}
-
-	/**
-	 * Get number of concurrent preview generations from system config
-	 *
-	 * Two config entries, `preview_concurrency_new` and `preview_concurrency_all`,
-	 * are available. If not set, the default values are determined with the hardware concurrency
-	 * of the host. In case the hardware concurrency cannot be determined, or the user sets an
-	 * invalid value, fallback values are:
-	 * For new images whose previews do not exist and need to be generated, 4;
-	 * For all preview generation requests, 8.
-	 * Value of `preview_concurrency_all` should be greater than or equal to that of
-	 * `preview_concurrency_new`, otherwise, the latter is returned.
-	 *
-	 * @param string $type either `preview_concurrency_new` or `preview_concurrency_all`
-	 * @return int number of concurrent preview generations, or -1 if $type is invalid
-	 */
-	public function getNumConcurrentPreviews(string $type): int {
-		static $cached = [];
-		if (array_key_exists($type, $cached)) {
-			return $cached[$type];
-		}
-
-		$hardwareConcurrency = self::getHardwareConcurrency();
-		switch ($type) {
-			case 'preview_concurrency_all':
-				$fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency * 2 : 8;
-				$concurrency_all = $this->config->getSystemValueInt($type, $fallback);
-				$concurrency_new = $this->getNumConcurrentPreviews('preview_concurrency_new');
-				$cached[$type] = max($concurrency_all, $concurrency_new);
-				break;
-			case 'preview_concurrency_new':
-				$fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency : 4;
-				$cached[$type] = $this->config->getSystemValueInt($type, $fallback);
-				break;
-			default:
-				return -1;
-		}
-		return $cached[$type];
-	}
-
-	/**
-	 * @param ISimpleFolder $previewFolder
-	 * @param ISimpleFile[] $previewFiles
-	 * @param File $file
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 */
-	private function getMaxPreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, $mimeType, $prefix) {
-		// We don't know the max preview size, so we can't use getCachedPreview.
-		// It might have been generated with a higher resolution than the current value.
-		foreach ($previewFiles as $node) {
-			$name = $node->getName();
-			if (($prefix === '' || str_starts_with($name, $prefix)) && strpos($name, 'max')) {
-				return $node;
-			}
-		}
-
-		$maxWidth = $this->config->getSystemValueInt('preview_max_x', 4096);
-		$maxHeight = $this->config->getSystemValueInt('preview_max_y', 4096);
-
-		return $this->generateProviderPreview($previewFolder, $file, $maxWidth, $maxHeight, false, true, $mimeType, $prefix);
-	}
-
-	private function generateProviderPreview(ISimpleFolder $previewFolder, File $file, int $width, int $height, bool $crop, bool $max, string $mimeType, string $prefix) {
-		$previewProviders = $this->previewManager->getProviders();
-		foreach ($previewProviders as $supportedMimeType => $providers) {
-			// Filter out providers that does not support this mime
-			if (!preg_match($supportedMimeType, $mimeType)) {
-				continue;
-			}
-
-			foreach ($providers as $providerClosure) {
-				$provider = $this->helper->getProvider($providerClosure);
-				if (!($provider instanceof IProviderV2)) {
-					continue;
-				}
-
-				if (!$provider->isAvailable($file)) {
-					continue;
-				}
-
-				$previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
-				$sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
-				try {
-					$this->logger->debug('Calling preview provider for {mimeType} with width={width}, height={height}', [
-						'mimeType' => $mimeType,
-						'width' => $width,
-						'height' => $height,
-					]);
-					$preview = $this->helper->getThumbnail($provider, $file, $width, $height);
-				} finally {
-					self::unguardWithSemaphore($sem);
-				}
-
-				if (!($preview instanceof IImage)) {
-					continue;
-				}
-
-				$path = $this->generatePath($preview->width(), $preview->height(), $crop, $max, $preview->dataMimeType(), $prefix);
-				try {
-					$file = $previewFolder->newFile($path);
-					if ($preview instanceof IStreamImage) {
-						$file->putContent($preview->resource());
-					} else {
-						$file->putContent($preview->data());
-					}
-				} catch (NotPermittedException $e) {
-					throw new NotFoundException();
-				}
-
-				return $file;
-			}
-		}
-
-		throw new NotFoundException('No provider successfully handled the preview generation');
-	}
-
-	/**
-	 * @param ISimpleFile $file
-	 * @param string $prefix
-	 * @return int[]
-	 */
-	private function getPreviewSize(ISimpleFile $file, string $prefix = '') {
-		$size = explode('-', substr($file->getName(), strlen($prefix)));
-		return [(int)$size[0], (int)$size[1]];
-	}
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param bool $max
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return string
-	 */
-	private function generatePath($width, $height, $crop, $max, $mimeType, $prefix) {
-		$path = $prefix . (string)$width . '-' . (string)$height;
-		if ($crop) {
-			$path .= '-crop';
-		}
-		if ($max) {
-			$path .= '-max';
-		}
-
-		$ext = $this->getExtension($mimeType);
-		$path .= '.' . $ext;
-		return $path;
-	}
-
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param int $maxWidth
-	 * @param int $maxHeight
-	 * @return int[]
-	 */
-	private function calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight) {
-		/*
+        // since we only ask for one preview, and the generate method return the last one it created, it returns the one we want
+        return $this->generatePreviews($file, [$specification], $mimeType);
+    }
+
+    /**
+     * Generates previews of a file
+     *
+     * @param File $file
+     * @param non-empty-array $specifications
+     * @param string $mimeType
+     * @return ISimpleFile the last preview that was generated
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    public function generatePreviews(File $file, array $specifications, $mimeType = null) {
+        //Make sure that we can read the file
+        if (!$file->isReadable()) {
+            $this->logger->warning('Cannot read file: {path}, skipping preview generation.', ['path' => $file->getPath()]);
+            throw new NotFoundException('Cannot read file');
+        }
+
+        if ($mimeType === null) {
+            $mimeType = $file->getMimeType();
+        }
+
+        $previewFolder = $this->getPreviewFolder($file);
+        // List every existing preview first instead of trying to find them one by one
+        $previewFiles = $previewFolder->getDirectoryListing();
+
+        $previewVersion = '';
+        if ($file instanceof IVersionedPreviewFile) {
+            $previewVersion = $file->getPreviewVersion() . '-';
+        }
+
+        // Get the max preview and infer the max preview sizes from that
+        $maxPreview = $this->getMaxPreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion);
+        $maxPreviewImage = null; // only load the image when we need it
+        if ($maxPreview->getSize() === 0) {
+            $maxPreview->delete();
+            $this->logger->error("Max preview generated for file {$file->getPath()} has size 0, deleting and throwing exception.");
+            throw new NotFoundException('Max preview size 0, invalid!');
+        }
+
+        [$maxWidth, $maxHeight] = $this->getPreviewSize($maxPreview, $previewVersion);
+
+        if ($maxWidth <= 0 || $maxHeight <= 0) {
+            throw new NotFoundException('The maximum preview sizes are zero or less pixels');
+        }
+
+        $preview = null;
+
+        foreach ($specifications as $specification) {
+            $width = $specification['width'] ?? -1;
+            $height = $specification['height'] ?? -1;
+            $crop = $specification['crop'] ?? false;
+            $mode = $specification['mode'] ?? IPreview::MODE_FILL;
+
+            // If both width and height are -1 we just want the max preview
+            if ($width === -1 && $height === -1) {
+                $width = $maxWidth;
+                $height = $maxHeight;
+            }
+
+            // Calculate the preview size
+            [$width, $height] = $this->calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight);
+
+            // No need to generate a preview that is just the max preview
+            if ($width === $maxWidth && $height === $maxHeight) {
+                // ensure correct return value if this was the last one
+                $preview = $maxPreview;
+                continue;
+            }
+
+            // Try to get a cached preview. Else generate (and store) one
+            try {
+                try {
+                    $preview = $this->getCachedPreview($previewFiles, $width, $height, $crop, $maxPreview->getMimeType(), $previewVersion);
+                } catch (NotFoundException $e) {
+                    if (!$this->previewManager->isMimeSupported($mimeType)) {
+                        throw new NotFoundException();
+                    }
+
+                    if ($maxPreviewImage === null) {
+                        $maxPreviewImage = $this->helper->getImage($maxPreview);
+                    }
+
+                    $this->logger->warning('Cached preview not found for file {path}, generating a new preview.', ['path' => $file->getPath()]);
+                    $preview = $this->generatePreview($previewFolder, $maxPreviewImage, $width, $height, $crop, $maxWidth, $maxHeight, $previewVersion);
+                    // New file, augment our array
+                    $previewFiles[] = $preview;
+                }
+            } catch (\InvalidArgumentException $e) {
+                throw new NotFoundException('', 0, $e);
+            }
+
+            if ($preview->getSize() === 0) {
+                $preview->delete();
+                throw new NotFoundException('Cached preview size 0, invalid!');
+            }
+        }
+        assert($preview !== null);
+
+        // Free memory being used by the embedded image resource.  Without this the image is kept in memory indefinitely.
+        // Garbage Collection does NOT free this memory.  We have to do it ourselves.
+        if ($maxPreviewImage instanceof \OCP\Image) {
+            $maxPreviewImage->destroy();
+        }
+
+        return $preview;
+    }
+
+    /**
+     * Acquire a semaphore of the specified id and concurrency, blocking if necessary.
+     * Return an identifier of the semaphore on success, which can be used to release it via
+     * {@see Generator::unguardWithSemaphore()}.
+     *
+     * @param int $semId
+     * @param int $concurrency
+     * @return false|\SysvSemaphore the semaphore on success or false on failure
+     */
+    public static function guardWithSemaphore(int $semId, int $concurrency) {
+        if (!extension_loaded('sysvsem')) {
+            return false;
+        }
+        $sem = sem_get($semId, $concurrency);
+        if ($sem === false) {
+            return false;
+        }
+        if (!sem_acquire($sem)) {
+            return false;
+        }
+        return $sem;
+    }
+
+    /**
+     * Releases the semaphore acquired from {@see Generator::guardWithSemaphore()}.
+     *
+     * @param false|\SysvSemaphore $semId the semaphore identifier returned by guardWithSemaphore
+     * @return bool
+     */
+    public static function unguardWithSemaphore(false|\SysvSemaphore $semId): bool {
+        if ($semId === false || !($semId instanceof \SysvSemaphore)) {
+            return false;
+        }
+        return sem_release($semId);
+    }
+
+    /**
+     * Get the number of concurrent threads supported by the host.
+     *
+     * @return int number of concurrent threads, or 0 if it cannot be determined
+     */
+    public static function getHardwareConcurrency(): int {
+        static $width;
+
+        if (!isset($width)) {
+            if (function_exists('ini_get')) {
+                $openBasedir = ini_get('open_basedir');
+                if (empty($openBasedir) || strpos($openBasedir, '/proc/cpuinfo') !== false) {
+                    $width = is_readable('/proc/cpuinfo') ? substr_count(file_get_contents('/proc/cpuinfo'), 'processor') : 0;
+                } else {
+                    $width = 0;
+                }
+            } else {
+                $width = 0;
+            }
+        }
+        return $width;
+    }
+
+    /**
+     * Get number of concurrent preview generations from system config
+     *
+     * Two config entries, `preview_concurrency_new` and `preview_concurrency_all`,
+     * are available. If not set, the default values are determined with the hardware concurrency
+     * of the host. In case the hardware concurrency cannot be determined, or the user sets an
+     * invalid value, fallback values are:
+     * For new images whose previews do not exist and need to be generated, 4;
+     * For all preview generation requests, 8.
+     * Value of `preview_concurrency_all` should be greater than or equal to that of
+     * `preview_concurrency_new`, otherwise, the latter is returned.
+     *
+     * @param string $type either `preview_concurrency_new` or `preview_concurrency_all`
+     * @return int number of concurrent preview generations, or -1 if $type is invalid
+     */
+    public function getNumConcurrentPreviews(string $type): int {
+        static $cached = [];
+        if (array_key_exists($type, $cached)) {
+            return $cached[$type];
+        }
+
+        $hardwareConcurrency = self::getHardwareConcurrency();
+        switch ($type) {
+            case 'preview_concurrency_all':
+                $fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency * 2 : 8;
+                $concurrency_all = $this->config->getSystemValueInt($type, $fallback);
+                $concurrency_new = $this->getNumConcurrentPreviews('preview_concurrency_new');
+                $cached[$type] = max($concurrency_all, $concurrency_new);
+                break;
+            case 'preview_concurrency_new':
+                $fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency : 4;
+                $cached[$type] = $this->config->getSystemValueInt($type, $fallback);
+                break;
+            default:
+                return -1;
+        }
+        return $cached[$type];
+    }
+
+    /**
+     * @param ISimpleFolder $previewFolder
+     * @param ISimpleFile[] $previewFiles
+     * @param File $file
+     * @param string $mimeType
+     * @param string $prefix
+     * @return ISimpleFile
+     * @throws NotFoundException
+     */
+    private function getMaxPreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, $mimeType, $prefix) {
+        // We don't know the max preview size, so we can't use getCachedPreview.
+        // It might have been generated with a higher resolution than the current value.
+        foreach ($previewFiles as $node) {
+            $name = $node->getName();
+            if (($prefix === '' || str_starts_with($name, $prefix)) && strpos($name, 'max')) {
+                return $node;
+            }
+        }
+
+        $maxWidth = $this->config->getSystemValueInt('preview_max_x', 4096);
+        $maxHeight = $this->config->getSystemValueInt('preview_max_y', 4096);
+
+        return $this->generateProviderPreview($previewFolder, $file, $maxWidth, $maxHeight, false, true, $mimeType, $prefix);
+    }
+
+    private function generateProviderPreview(ISimpleFolder $previewFolder, File $file, int $width, int $height, bool $crop, bool $max, string $mimeType, string $prefix) {
+        $previewProviders = $this->previewManager->getProviders();
+        foreach ($previewProviders as $supportedMimeType => $providers) {
+            // Filter out providers that does not support this mime
+            if (!preg_match($supportedMimeType, $mimeType)) {
+                continue;
+            }
+
+            foreach ($providers as $providerClosure) {
+                $provider = $this->helper->getProvider($providerClosure);
+                if (!($provider instanceof IProviderV2)) {
+                    continue;
+                }
+
+                if (!$provider->isAvailable($file)) {
+                    continue;
+                }
+
+                $previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
+                $sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
+                try {
+                    $this->logger->debug('Calling preview provider for {mimeType} with width={width}, height={height}', [
+                        'mimeType' => $mimeType,
+                        'width' => $width,
+                        'height' => $height,
+                    ]);
+                    $preview = $this->helper->getThumbnail($provider, $file, $width, $height);
+                } finally {
+                    self::unguardWithSemaphore($sem);
+                }
+
+                if (!($preview instanceof IImage)) {
+                    continue;
+                }
+
+                $path = $this->generatePath($preview->width(), $preview->height(), $crop, $max, $preview->dataMimeType(), $prefix);
+                try {
+                    $file = $previewFolder->newFile($path);
+                    if ($preview instanceof IStreamImage) {
+                        $file->putContent($preview->resource());
+                    } else {
+                        $file->putContent($preview->data());
+                    }
+                } catch (NotPermittedException $e) {
+                    throw new NotFoundException();
+                }
+
+                return $file;
+            }
+        }
+
+        throw new NotFoundException('No provider successfully handled the preview generation');
+    }
+
+    /**
+     * @param ISimpleFile $file
+     * @param string $prefix
+     * @return int[]
+     */
+    private function getPreviewSize(ISimpleFile $file, string $prefix = '') {
+        $size = explode('-', substr($file->getName(), strlen($prefix)));
+        return [(int)$size[0], (int)$size[1]];
+    }
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param bool $max
+     * @param string $mimeType
+     * @param string $prefix
+     * @return string
+     */
+    private function generatePath($width, $height, $crop, $max, $mimeType, $prefix) {
+        $path = $prefix . (string)$width . '-' . (string)$height;
+        if ($crop) {
+            $path .= '-crop';
+        }
+        if ($max) {
+            $path .= '-max';
+        }
+
+        $ext = $this->getExtension($mimeType);
+        $path .= '.' . $ext;
+        return $path;
+    }
+
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param int $maxWidth
+     * @param int $maxHeight
+     * @return int[]
+     */
+    private function calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight) {
+        /*
 		 * If we are not cropping we have to make sure the requested image
 		 * respects the aspect ratio of the original.
 		 */
-		if (!$crop) {
-			$ratio = $maxHeight / $maxWidth;
+        if (!$crop) {
+            $ratio = $maxHeight / $maxWidth;
 
-			if ($width === -1) {
-				$width = $height / $ratio;
-			}
-			if ($height === -1) {
-				$height = $width * $ratio;
-			}
+            if ($width === -1) {
+                $width = $height / $ratio;
+            }
+            if ($height === -1) {
+                $height = $width * $ratio;
+            }
 
-			$ratioH = $height / $maxHeight;
-			$ratioW = $width / $maxWidth;
+            $ratioH = $height / $maxHeight;
+            $ratioW = $width / $maxWidth;
 
-			/*
+            /*
 			 * Fill means that the $height and $width are the max
 			 * Cover means min.
 			 */
-			if ($mode === IPreview::MODE_FILL) {
-				if ($ratioH > $ratioW) {
-					$height = $width * $ratio;
-				} else {
-					$width = $height / $ratio;
-				}
-			} elseif ($mode === IPreview::MODE_COVER) {
-				if ($ratioH > $ratioW) {
-					$width = $height / $ratio;
-				} else {
-					$height = $width * $ratio;
-				}
-			}
-		}
-
-		if ($height !== $maxHeight && $width !== $maxWidth) {
-			/*
+            if ($mode === IPreview::MODE_FILL) {
+                if ($ratioH > $ratioW) {
+                    $height = $width * $ratio;
+                } else {
+                    $width = $height / $ratio;
+                }
+            } elseif ($mode === IPreview::MODE_COVER) {
+                if ($ratioH > $ratioW) {
+                    $width = $height / $ratio;
+                } else {
+                    $height = $width * $ratio;
+                }
+            }
+        }
+
+        if ($height !== $maxHeight && $width !== $maxWidth) {
+            /*
 			 * Scale to the nearest power of four
 			 */
-			$pow4height = 4 ** ceil(log($height) / log(4));
-			$pow4width = 4 ** ceil(log($width) / log(4));
-
-			// Minimum size is 64
-			$pow4height = max($pow4height, 64);
-			$pow4width = max($pow4width, 64);
-
-			$ratioH = $height / $pow4height;
-			$ratioW = $width / $pow4width;
-
-			if ($ratioH < $ratioW) {
-				$width = $pow4width;
-				$height /= $ratioW;
-			} else {
-				$height = $pow4height;
-				$width /= $ratioH;
-			}
-		}
-
-		/*
+            $pow4height = 4 ** ceil(log($height) / log(4));
+            $pow4width = 4 ** ceil(log($width) / log(4));
+
+            // Minimum size is 64
+            $pow4height = max($pow4height, 64);
+            $pow4width = max($pow4width, 64);
+
+            $ratioH = $height / $pow4height;
+            $ratioW = $width / $pow4width;
+
+            if ($ratioH < $ratioW) {
+                $width = $pow4width;
+                $height /= $ratioW;
+            } else {
+                $height = $pow4height;
+                $width /= $ratioH;
+            }
+        }
+
+        /*
 		 * Make sure the requested height and width fall within the max
 		 * of the preview.
 		 */
-		if ($height > $maxHeight) {
-			$ratio = $height / $maxHeight;
-			$height = $maxHeight;
-			$width /= $ratio;
-		}
-		if ($width > $maxWidth) {
-			$ratio = $width / $maxWidth;
-			$width = $maxWidth;
-			$height /= $ratio;
-		}
-
-		return [(int)round($width), (int)round($height)];
-	}
-
-	/**
-	 * @param ISimpleFolder $previewFolder
-	 * @param ISimpleFile $maxPreview
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param int $maxWidth
-	 * @param int $maxHeight
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	private function generatePreview(ISimpleFolder $previewFolder, IImage $maxPreview, $width, $height, $crop, $maxWidth, $maxHeight, $prefix) {
-		$preview = $maxPreview;
-		if (!$preview->valid()) {
-			throw new \InvalidArgumentException('Failed to generate preview, failed to load image');
-		}
-
-		$previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
-		$sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
-		try {
-			if ($crop) {
-				if ($height !== $preview->height() && $width !== $preview->width()) {
-					//Resize
-					$widthR = $preview->width() / $width;
-					$heightR = $preview->height() / $height;
-
-					if ($widthR > $heightR) {
-						$scaleH = $height;
-						$scaleW = $maxWidth / $heightR;
-					} else {
-						$scaleH = $maxHeight / $widthR;
-						$scaleW = $width;
-					}
-					$preview = $preview->preciseResizeCopy((int)round($scaleW), (int)round($scaleH));
-				}
-				$cropX = (int)floor(abs($width - $preview->width()) * 0.5);
-				$cropY = (int)floor(abs($height - $preview->height()) * 0.5);
-				$preview = $preview->cropCopy($cropX, $cropY, $width, $height);
-			} else {
-				$preview = $maxPreview->resizeCopy(max($width, $height));
-			}
-		} finally {
-			self::unguardWithSemaphore($sem);
-		}
-
-
-		$path = $this->generatePath($width, $height, $crop, false, $preview->dataMimeType(), $prefix);
-		try {
-			$file = $previewFolder->newFile($path);
-			$file->putContent($preview->data());
-		} catch (NotPermittedException $e) {
-			throw new NotFoundException();
-		}
-
-		return $file;
-	}
-
-	/**
-	 * @param ISimpleFile[] $files Array of FileInfo, as the result of getDirectoryListing()
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 *
-	 * @throws NotFoundException
-	 */
-	private function getCachedPreview($files, $width, $height, $crop, $mimeType, $prefix) {
-		$path = $this->generatePath($width, $height, $crop, false, $mimeType, $prefix);
-		foreach ($files as $file) {
-			if ($file->getName() === $path) {
-				$this->logger->debug('Found cached preview: {path}', ['path' => $path]);
-				return $file;
-			}
-		}
-		throw new NotFoundException();
-	}
-
-	/**
-	 * Get the specific preview folder for this file
-	 *
-	 * @param File $file
-	 * @return ISimpleFolder
-	 *
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	private function getPreviewFolder(File $file) {
-		// Obtain file id outside of try catch block to prevent the creation of an existing folder
-		$fileId = (string)$file->getId();
-
-		try {
-			$folder = $this->appData->getFolder($fileId);
-		} catch (NotFoundException $e) {
-			$folder = $this->appData->newFolder($fileId);
-		}
-
-		return $folder;
-	}
-
-	/**
-	 * @param string $mimeType
-	 * @return null|string
-	 * @throws \InvalidArgumentException
-	 */
-	private function getExtension($mimeType) {
-		switch ($mimeType) {
-			case 'image/png':
-				return 'png';
-			case 'image/jpeg':
-				return 'jpg';
-			case 'image/webp':
-				return 'webp';
-			case 'image/gif':
-				return 'gif';
-			default:
-				throw new \InvalidArgumentException('Not a valid mimetype: "' . $mimeType . '"');
-		}
-	}
+        if ($height > $maxHeight) {
+            $ratio = $height / $maxHeight;
+            $height = $maxHeight;
+            $width /= $ratio;
+        }
+        if ($width > $maxWidth) {
+            $ratio = $width / $maxWidth;
+            $width = $maxWidth;
+            $height /= $ratio;
+        }
+
+        return [(int)round($width), (int)round($height)];
+    }
+
+    /**
+     * @param ISimpleFolder $previewFolder
+     * @param ISimpleFile $maxPreview
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param int $maxWidth
+     * @param int $maxHeight
+     * @param string $prefix
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    private function generatePreview(ISimpleFolder $previewFolder, IImage $maxPreview, $width, $height, $crop, $maxWidth, $maxHeight, $prefix) {
+        $preview = $maxPreview;
+        if (!$preview->valid()) {
+            throw new \InvalidArgumentException('Failed to generate preview, failed to load image');
+        }
+
+        $previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
+        $sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
+        try {
+            if ($crop) {
+                if ($height !== $preview->height() && $width !== $preview->width()) {
+                    //Resize
+                    $widthR = $preview->width() / $width;
+                    $heightR = $preview->height() / $height;
+
+                    if ($widthR > $heightR) {
+                        $scaleH = $height;
+                        $scaleW = $maxWidth / $heightR;
+                    } else {
+                        $scaleH = $maxHeight / $widthR;
+                        $scaleW = $width;
+                    }
+                    $preview = $preview->preciseResizeCopy((int)round($scaleW), (int)round($scaleH));
+                }
+                $cropX = (int)floor(abs($width - $preview->width()) * 0.5);
+                $cropY = (int)floor(abs($height - $preview->height()) * 0.5);
+                $preview = $preview->cropCopy($cropX, $cropY, $width, $height);
+            } else {
+                $preview = $maxPreview->resizeCopy(max($width, $height));
+            }
+        } finally {
+            self::unguardWithSemaphore($sem);
+        }
+
+
+        $path = $this->generatePath($width, $height, $crop, false, $preview->dataMimeType(), $prefix);
+        try {
+            $file = $previewFolder->newFile($path);
+            $file->putContent($preview->data());
+        } catch (NotPermittedException $e) {
+            throw new NotFoundException();
+        }
+
+        return $file;
+    }
+
+    /**
+     * @param ISimpleFile[] $files Array of FileInfo, as the result of getDirectoryListing()
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mimeType
+     * @param string $prefix
+     * @return ISimpleFile
+     *
+     * @throws NotFoundException
+     */
+    private function getCachedPreview($files, $width, $height, $crop, $mimeType, $prefix) {
+        $path = $this->generatePath($width, $height, $crop, false, $mimeType, $prefix);
+        foreach ($files as $file) {
+            if ($file->getName() === $path) {
+                $this->logger->debug('Found cached preview: {path}', ['path' => $path]);
+                return $file;
+            }
+        }
+        throw new NotFoundException();
+    }
+
+    /**
+     * Get the specific preview folder for this file
+     *
+     * @param File $file
+     * @return ISimpleFolder
+     *
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    private function getPreviewFolder(File $file) {
+        // Obtain file id outside of try catch block to prevent the creation of an existing folder
+        $fileId = (string)$file->getId();
+
+        try {
+            $folder = $this->appData->getFolder($fileId);
+        } catch (NotFoundException $e) {
+            $folder = $this->appData->newFolder($fileId);
+        }
+
+        return $folder;
+    }
+
+    /**
+     * @param string $mimeType
+     * @return null|string
+     * @throws \InvalidArgumentException
+     */
+    private function getExtension($mimeType) {
+        switch ($mimeType) {
+            case 'image/png':
+                return 'png';
+            case 'image/jpeg':
+                return 'jpg';
+            case 'image/webp':
+                return 'webp';
+            case 'image/gif':
+                return 'gif';
+            default:
+                throw new \InvalidArgumentException('Not a valid mimetype: "' . $mimeType . '"');
+        }
+    }
 }

tests/lib/Preview/GeneratorTest.php

Indentation +450 added lines, -450 removed lines

@@ -22,454 +22,454 @@
 use Psr\Log\LoggerInterface;
 
 class GeneratorTest extends \Test\TestCase {
-	/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
-	private $config;
-
-	/** @var IPreview|\PHPUnit\Framework\MockObject\MockObject */
-	private $previewManager;
-
-	/** @var IAppData|\PHPUnit\Framework\MockObject\MockObject */
-	private $appData;
-
-	/** @var GeneratorHelper|\PHPUnit\Framework\MockObject\MockObject */
-	private $helper;
-
-	/** @var IEventDispatcher|\PHPUnit\Framework\MockObject\MockObject */
-	private $eventDispatcher;
-
-	/** @var Generator */
-	private $generator;
-
-	private LoggerInterface|\PHPUnit\Framework\MockObject\MockObject $logger;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->config = $this->createMock(IConfig::class);
-		$this->previewManager = $this->createMock(IPreview::class);
-		$this->appData = $this->createMock(IAppData::class);
-		$this->helper = $this->createMock(GeneratorHelper::class);
-		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
-
-		$this->generator = new Generator(
-			$this->config,
-			$this->previewManager,
-			$this->appData,
-			$this->helper,
-			$this->eventDispatcher,
-			$this->logger,
-		);
-	}
-
-	public function testGetCachedPreview(): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getMimeType')
-			->willReturn('myMimeType');
-		$file->method('getId')
-			->willReturn(42);
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$maxPreview = $this->createMock(ISimpleFile::class);
-		$maxPreview->method('getName')
-			->willReturn('1000-1000-max.png');
-		$maxPreview->method('getSize')->willReturn(1000);
-		$maxPreview->method('getMimeType')
-			->willReturn('image/png');
-
-		$previewFile = $this->createMock(ISimpleFile::class);
-		$previewFile->method('getSize')->willReturn(1000);
-		$previewFile->method('getName')->willReturn('256-256.png');
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([$maxPreview, $previewFile]);
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
-
-		$result = $this->generator->getPreview($file, 100, 100);
-		$this->assertSame($previewFile, $result);
-	}
-
-	public function testGetNewPreview(): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getMimeType')
-			->willReturn('myMimeType');
-		$file->method('getId')
-			->willReturn(42);
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willThrowException(new NotFoundException());
-
-		$this->appData->method('newFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$this->config->method('getSystemValue')
-			->willReturnCallback(function ($key, $default) {
-				return $default;
-			});
-
-		$this->config->method('getSystemValueInt')
-			->willReturnCallback(function ($key, $default) {
-				return $default;
-			});
-
-		$invalidProvider = $this->createMock(IProviderV2::class);
-		$invalidProvider->method('isAvailable')
-			->willReturn(true);
-		$unavailableProvider = $this->createMock(IProviderV2::class);
-		$unavailableProvider->method('isAvailable')
-			->willReturn(false);
-		$validProvider = $this->createMock(IProviderV2::class);
-		$validProvider->method('isAvailable')
-			->with($file)
-			->willReturn(true);
-
-		$this->previewManager->method('getProviders')
-			->willReturn([
-				'/image\/png/' => ['wrongProvider'],
-				'/myMimeType/' => ['brokenProvider', 'invalidProvider', 'unavailableProvider', 'validProvider'],
-			]);
-
-		$this->helper->method('getProvider')
-			->willReturnCallback(function ($provider) use ($invalidProvider, $validProvider, $unavailableProvider) {
-				if ($provider === 'wrongProvider') {
-					$this->fail('Wrongprovider should not be constructed!');
-				} elseif ($provider === 'brokenProvider') {
-					return false;
-				} elseif ($provider === 'invalidProvider') {
-					return $invalidProvider;
-				} elseif ($provider === 'validProvider') {
-					return $validProvider;
-				} elseif ($provider === 'unavailableProvider') {
-					return $unavailableProvider;
-				}
-				$this->fail('Unexpected provider requested');
-			});
-
-		$image = $this->createMock(IImage::class);
-		$image->method('width')->willReturn(2048);
-		$image->method('height')->willReturn(2048);
-		$image->method('valid')->willReturn(true);
-		$image->method('dataMimeType')->willReturn('image/png');
-
-		$this->helper->method('getThumbnail')
-			->willReturnCallback(function ($provider, $file, $x, $y) use ($invalidProvider, $validProvider, $image) {
-				if ($provider === $validProvider) {
-					return $image;
-				} else {
-					return false;
-				}
-			});
-
-		$image->method('data')
-			->willReturn('my data');
-
-		$maxPreview = $this->createMock(ISimpleFile::class);
-		$maxPreview->method('getName')->willReturn('2048-2048-max.png');
-		$maxPreview->method('getMimeType')->willReturn('image/png');
-		$maxPreview->method('getSize')->willReturn(1000);
-
-		$previewFile = $this->createMock(ISimpleFile::class);
-		$previewFile->method('getSize')->willReturn(1000);
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([]);
-		$previewFolder->method('newFile')
-			->willReturnCallback(function ($filename) use ($maxPreview, $previewFile) {
-				if ($filename === '2048-2048-max.png') {
-					return $maxPreview;
-				} elseif ($filename === '256-256.png') {
-					return $previewFile;
-				}
-				$this->fail('Unexpected file');
-			});
-
-		$maxPreview->expects($this->once())
-			->method('putContent')
-			->with($this->equalTo('my data'));
-
-		$previewFolder->method('getFile')
-			->with($this->equalTo('256-256.png'))
-			->willThrowException(new NotFoundException());
-
-		$image = $this->getMockImage(2048, 2048, 'my resized data');
-		$this->helper->method('getImage')
-			->with($this->equalTo($maxPreview))
-			->willReturn($image);
-
-		$previewFile->expects($this->once())
-			->method('putContent')
-			->with('my resized data');
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
-
-		$result = $this->generator->getPreview($file, 100, 100);
-		$this->assertSame($previewFile, $result);
-	}
-
-	public function testInvalidMimeType(): void {
-		$this->expectException(NotFoundException::class);
-
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getId')
-			->willReturn(42);
-
-		$this->previewManager->method('isMimeSupported')
-			->with('invalidType')
-			->willReturn(false);
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$maxPreview = $this->createMock(ISimpleFile::class);
-		$maxPreview->method('getName')
-			->willReturn('2048-2048-max.png');
-		$maxPreview->method('getMimeType')
-			->willReturn('image/png');
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([$maxPreview]);
-
-		$previewFolder->method('getFile')
-			->with($this->equalTo('1024-512-crop.png'))
-			->willThrowException(new NotFoundException());
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType'));
-
-		$this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
-	}
-
-	public function testReturnCachedPreviewsWithoutCheckingSupportedMimetype(): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getId')
-			->willReturn(42);
-
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$maxPreview = $this->createMock(ISimpleFile::class);
-		$maxPreview->method('getName')
-			->willReturn('2048-2048-max.png');
-		$maxPreview->method('getSize')->willReturn(1000);
-		$maxPreview->method('getMimeType')
-			->willReturn('image/png');
-
-		$preview = $this->createMock(ISimpleFile::class);
-		$preview->method('getSize')->willReturn(1000);
-		$preview->method('getName')->willReturn('1024-512-crop.png');
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([$maxPreview, $preview]);
-
-		$this->previewManager->expects($this->never())
-			->method('isMimeSupported');
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType'));
-
-		$result = $this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
-		$this->assertSame($preview, $result);
-	}
-
-	public function testNoProvider(): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getMimeType')
-			->willReturn('myMimeType');
-		$file->method('getId')
-			->willReturn(42);
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([]);
-
-		$this->previewManager->method('getProviders')
-			->willReturn([]);
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
-
-		$this->expectException(NotFoundException::class);
-		$this->generator->getPreview($file, 100, 100);
-	}
-
-	private function getMockImage($width, $height, $data = null) {
-		$image = $this->createMock(IImage::class);
-		$image->method('height')->willReturn($width);
-		$image->method('width')->willReturn($height);
-		$image->method('valid')->willReturn(true);
-		$image->method('dataMimeType')->willReturn('image/png');
-		$image->method('data')->willReturn($data);
-
-		$image->method('resizeCopy')->willReturnCallback(function ($size) use ($data) {
-			return $this->getMockImage($size, $size, $data);
-		});
-		$image->method('preciseResizeCopy')->willReturnCallback(function ($width, $height) use ($data) {
-			return $this->getMockImage($width, $height, $data);
-		});
-		$image->method('cropCopy')->willReturnCallback(function ($x, $y, $width, $height) use ($data) {
-			return $this->getMockImage($width, $height, $data);
-		});
-
-		return $image;
-	}
-
-	public function dataSize() {
-		return [
-			[1024, 2048, 512, 512, false, IPreview::MODE_FILL, 256, 512],
-			[1024, 2048, 512, 512, false, IPreview::MODE_COVER, 512, 1024],
-			[1024, 2048, 512, 512, true, IPreview::MODE_FILL, 1024, 1024],
-			[1024, 2048, 512, 512, true, IPreview::MODE_COVER, 1024, 1024],
-
-			[1024, 2048, -1, 512, false, IPreview::MODE_COVER, 256, 512],
-			[1024, 2048, 512, -1, false, IPreview::MODE_FILL, 512, 1024],
-
-			[1024, 2048, 250, 1100, true, IPreview::MODE_COVER, 256, 1126],
-			[1024, 1100, 250, 1100, true, IPreview::MODE_COVER, 250, 1100],
-
-			[1024, 2048, 4096, 2048, false, IPreview::MODE_FILL, 1024, 2048],
-			[1024, 2048, 4096, 2048, false, IPreview::MODE_COVER, 1024, 2048],
-
-
-			[2048, 1024, 512, 512, false, IPreview::MODE_FILL, 512, 256],
-			[2048, 1024, 512, 512, false, IPreview::MODE_COVER, 1024, 512],
-			[2048, 1024, 512, 512, true, IPreview::MODE_FILL, 1024, 1024],
-			[2048, 1024, 512, 512, true, IPreview::MODE_COVER, 1024, 1024],
-
-			[2048, 1024, -1, 512, false, IPreview::MODE_FILL, 1024, 512],
-			[2048, 1024, 512, -1, false, IPreview::MODE_COVER, 512, 256],
-
-			[2048, 1024, 4096, 1024, true, IPreview::MODE_FILL, 2048, 512],
-			[2048, 1024, 4096, 1024, true, IPreview::MODE_COVER, 2048, 512],
-
-			//Test minimum size
-			[2048, 1024, 32, 32, false, IPreview::MODE_FILL, 64, 32],
-			[2048, 1024, 32, 32, false, IPreview::MODE_COVER, 64, 32],
-			[2048, 1024, 32, 32, true, IPreview::MODE_FILL, 64, 64],
-			[2048, 1024, 32, 32, true, IPreview::MODE_COVER, 64, 64],
-		];
-	}
-
-	/**
-	 * @dataProvider dataSize
-	 *
-	 * @param int $maxX
-	 * @param int $maxY
-	 * @param int $reqX
-	 * @param int $reqY
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param int $expectedX
-	 * @param int $expectedY
-	 */
-	public function testCorrectSize($maxX, $maxY, $reqX, $reqY, $crop, $mode, $expectedX, $expectedY): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getMimeType')
-			->willReturn('myMimeType');
-		$file->method('getId')
-			->willReturn(42);
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$previewFolder = $this->createMock(ISimpleFolder::class);
-		$this->appData->method('getFolder')
-			->with($this->equalTo(42))
-			->willReturn($previewFolder);
-
-		$maxPreview = $this->createMock(ISimpleFile::class);
-		$maxPreview->method('getName')
-			->willReturn($maxX . '-' . $maxY . '-max.png');
-		$maxPreview->method('getMimeType')
-			->willReturn('image/png');
-		$maxPreview->method('getSize')->willReturn(1000);
-
-		$previewFolder->method('getDirectoryListing')
-			->willReturn([$maxPreview]);
-
-		$filename = $expectedX . '-' . $expectedY;
-		if ($crop) {
-			$filename .= '-crop';
-		}
-		$filename .= '.png';
-		$previewFolder->method('getFile')
-			->with($this->equalTo($filename))
-			->willThrowException(new NotFoundException());
-
-		$image = $this->getMockImage($maxX, $maxY);
-		$this->helper->method('getImage')
-			->with($this->equalTo($maxPreview))
-			->willReturn($image);
-
-		$preview = $this->createMock(ISimpleFile::class);
-		$preview->method('getSize')->willReturn(1000);
-		$previewFolder->method('newFile')
-			->with($this->equalTo($filename))
-			->willReturn($preview);
-
-		$this->eventDispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->with(new BeforePreviewFetchedEvent($file, $reqX, $reqY, $crop, $mode, null));
-
-		$result = $this->generator->getPreview($file, $reqX, $reqY, $crop, $mode);
-		if ($expectedX === $maxX && $expectedY === $maxY) {
-			$this->assertSame($maxPreview, $result);
-		} else {
-			$this->assertSame($preview, $result);
-		}
-	}
-
-	public function testUnreadbleFile(): void {
-		$file = $this->createMock(File::class);
-		$file->method('isReadable')
-			->willReturn(false);
-
-		$this->expectException(NotFoundException::class);
-
-		$this->generator->getPreview($file, 100, 100, false);
-	}
+    /** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
+    private $config;
+
+    /** @var IPreview|\PHPUnit\Framework\MockObject\MockObject */
+    private $previewManager;
+
+    /** @var IAppData|\PHPUnit\Framework\MockObject\MockObject */
+    private $appData;
+
+    /** @var GeneratorHelper|\PHPUnit\Framework\MockObject\MockObject */
+    private $helper;
+
+    /** @var IEventDispatcher|\PHPUnit\Framework\MockObject\MockObject */
+    private $eventDispatcher;
+
+    /** @var Generator */
+    private $generator;
+
+    private LoggerInterface|\PHPUnit\Framework\MockObject\MockObject $logger;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->config = $this->createMock(IConfig::class);
+        $this->previewManager = $this->createMock(IPreview::class);
+        $this->appData = $this->createMock(IAppData::class);
+        $this->helper = $this->createMock(GeneratorHelper::class);
+        $this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
+
+        $this->generator = new Generator(
+            $this->config,
+            $this->previewManager,
+            $this->appData,
+            $this->helper,
+            $this->eventDispatcher,
+            $this->logger,
+        );
+    }
+
+    public function testGetCachedPreview(): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getMimeType')
+            ->willReturn('myMimeType');
+        $file->method('getId')
+            ->willReturn(42);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $maxPreview = $this->createMock(ISimpleFile::class);
+        $maxPreview->method('getName')
+            ->willReturn('1000-1000-max.png');
+        $maxPreview->method('getSize')->willReturn(1000);
+        $maxPreview->method('getMimeType')
+            ->willReturn('image/png');
+
+        $previewFile = $this->createMock(ISimpleFile::class);
+        $previewFile->method('getSize')->willReturn(1000);
+        $previewFile->method('getName')->willReturn('256-256.png');
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([$maxPreview, $previewFile]);
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
+
+        $result = $this->generator->getPreview($file, 100, 100);
+        $this->assertSame($previewFile, $result);
+    }
+
+    public function testGetNewPreview(): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getMimeType')
+            ->willReturn('myMimeType');
+        $file->method('getId')
+            ->willReturn(42);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willThrowException(new NotFoundException());
+
+        $this->appData->method('newFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $this->config->method('getSystemValue')
+            ->willReturnCallback(function ($key, $default) {
+                return $default;
+            });
+
+        $this->config->method('getSystemValueInt')
+            ->willReturnCallback(function ($key, $default) {
+                return $default;
+            });
+
+        $invalidProvider = $this->createMock(IProviderV2::class);
+        $invalidProvider->method('isAvailable')
+            ->willReturn(true);
+        $unavailableProvider = $this->createMock(IProviderV2::class);
+        $unavailableProvider->method('isAvailable')
+            ->willReturn(false);
+        $validProvider = $this->createMock(IProviderV2::class);
+        $validProvider->method('isAvailable')
+            ->with($file)
+            ->willReturn(true);
+
+        $this->previewManager->method('getProviders')
+            ->willReturn([
+                '/image\/png/' => ['wrongProvider'],
+                '/myMimeType/' => ['brokenProvider', 'invalidProvider', 'unavailableProvider', 'validProvider'],
+            ]);
+
+        $this->helper->method('getProvider')
+            ->willReturnCallback(function ($provider) use ($invalidProvider, $validProvider, $unavailableProvider) {
+                if ($provider === 'wrongProvider') {
+                    $this->fail('Wrongprovider should not be constructed!');
+                } elseif ($provider === 'brokenProvider') {
+                    return false;
+                } elseif ($provider === 'invalidProvider') {
+                    return $invalidProvider;
+                } elseif ($provider === 'validProvider') {
+                    return $validProvider;
+                } elseif ($provider === 'unavailableProvider') {
+                    return $unavailableProvider;
+                }
+                $this->fail('Unexpected provider requested');
+            });
+
+        $image = $this->createMock(IImage::class);
+        $image->method('width')->willReturn(2048);
+        $image->method('height')->willReturn(2048);
+        $image->method('valid')->willReturn(true);
+        $image->method('dataMimeType')->willReturn('image/png');
+
+        $this->helper->method('getThumbnail')
+            ->willReturnCallback(function ($provider, $file, $x, $y) use ($invalidProvider, $validProvider, $image) {
+                if ($provider === $validProvider) {
+                    return $image;
+                } else {
+                    return false;
+                }
+            });
+
+        $image->method('data')
+            ->willReturn('my data');
+
+        $maxPreview = $this->createMock(ISimpleFile::class);
+        $maxPreview->method('getName')->willReturn('2048-2048-max.png');
+        $maxPreview->method('getMimeType')->willReturn('image/png');
+        $maxPreview->method('getSize')->willReturn(1000);
+
+        $previewFile = $this->createMock(ISimpleFile::class);
+        $previewFile->method('getSize')->willReturn(1000);
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([]);
+        $previewFolder->method('newFile')
+            ->willReturnCallback(function ($filename) use ($maxPreview, $previewFile) {
+                if ($filename === '2048-2048-max.png') {
+                    return $maxPreview;
+                } elseif ($filename === '256-256.png') {
+                    return $previewFile;
+                }
+                $this->fail('Unexpected file');
+            });
+
+        $maxPreview->expects($this->once())
+            ->method('putContent')
+            ->with($this->equalTo('my data'));
+
+        $previewFolder->method('getFile')
+            ->with($this->equalTo('256-256.png'))
+            ->willThrowException(new NotFoundException());
+
+        $image = $this->getMockImage(2048, 2048, 'my resized data');
+        $this->helper->method('getImage')
+            ->with($this->equalTo($maxPreview))
+            ->willReturn($image);
+
+        $previewFile->expects($this->once())
+            ->method('putContent')
+            ->with('my resized data');
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
+
+        $result = $this->generator->getPreview($file, 100, 100);
+        $this->assertSame($previewFile, $result);
+    }
+
+    public function testInvalidMimeType(): void {
+        $this->expectException(NotFoundException::class);
+
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getId')
+            ->willReturn(42);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with('invalidType')
+            ->willReturn(false);
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $maxPreview = $this->createMock(ISimpleFile::class);
+        $maxPreview->method('getName')
+            ->willReturn('2048-2048-max.png');
+        $maxPreview->method('getMimeType')
+            ->willReturn('image/png');
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([$maxPreview]);
+
+        $previewFolder->method('getFile')
+            ->with($this->equalTo('1024-512-crop.png'))
+            ->willThrowException(new NotFoundException());
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType'));
+
+        $this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
+    }
+
+    public function testReturnCachedPreviewsWithoutCheckingSupportedMimetype(): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getId')
+            ->willReturn(42);
+
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $maxPreview = $this->createMock(ISimpleFile::class);
+        $maxPreview->method('getName')
+            ->willReturn('2048-2048-max.png');
+        $maxPreview->method('getSize')->willReturn(1000);
+        $maxPreview->method('getMimeType')
+            ->willReturn('image/png');
+
+        $preview = $this->createMock(ISimpleFile::class);
+        $preview->method('getSize')->willReturn(1000);
+        $preview->method('getName')->willReturn('1024-512-crop.png');
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([$maxPreview, $preview]);
+
+        $this->previewManager->expects($this->never())
+            ->method('isMimeSupported');
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType'));
+
+        $result = $this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
+        $this->assertSame($preview, $result);
+    }
+
+    public function testNoProvider(): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getMimeType')
+            ->willReturn('myMimeType');
+        $file->method('getId')
+            ->willReturn(42);
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([]);
+
+        $this->previewManager->method('getProviders')
+            ->willReturn([]);
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, 100, 100, false, IPreview::MODE_FILL, null));
+
+        $this->expectException(NotFoundException::class);
+        $this->generator->getPreview($file, 100, 100);
+    }
+
+    private function getMockImage($width, $height, $data = null) {
+        $image = $this->createMock(IImage::class);
+        $image->method('height')->willReturn($width);
+        $image->method('width')->willReturn($height);
+        $image->method('valid')->willReturn(true);
+        $image->method('dataMimeType')->willReturn('image/png');
+        $image->method('data')->willReturn($data);
+
+        $image->method('resizeCopy')->willReturnCallback(function ($size) use ($data) {
+            return $this->getMockImage($size, $size, $data);
+        });
+        $image->method('preciseResizeCopy')->willReturnCallback(function ($width, $height) use ($data) {
+            return $this->getMockImage($width, $height, $data);
+        });
+        $image->method('cropCopy')->willReturnCallback(function ($x, $y, $width, $height) use ($data) {
+            return $this->getMockImage($width, $height, $data);
+        });
+
+        return $image;
+    }
+
+    public function dataSize() {
+        return [
+            [1024, 2048, 512, 512, false, IPreview::MODE_FILL, 256, 512],
+            [1024, 2048, 512, 512, false, IPreview::MODE_COVER, 512, 1024],
+            [1024, 2048, 512, 512, true, IPreview::MODE_FILL, 1024, 1024],
+            [1024, 2048, 512, 512, true, IPreview::MODE_COVER, 1024, 1024],
+
+            [1024, 2048, -1, 512, false, IPreview::MODE_COVER, 256, 512],
+            [1024, 2048, 512, -1, false, IPreview::MODE_FILL, 512, 1024],
+
+            [1024, 2048, 250, 1100, true, IPreview::MODE_COVER, 256, 1126],
+            [1024, 1100, 250, 1100, true, IPreview::MODE_COVER, 250, 1100],
+
+            [1024, 2048, 4096, 2048, false, IPreview::MODE_FILL, 1024, 2048],
+            [1024, 2048, 4096, 2048, false, IPreview::MODE_COVER, 1024, 2048],
+
+
+            [2048, 1024, 512, 512, false, IPreview::MODE_FILL, 512, 256],
+            [2048, 1024, 512, 512, false, IPreview::MODE_COVER, 1024, 512],
+            [2048, 1024, 512, 512, true, IPreview::MODE_FILL, 1024, 1024],
+            [2048, 1024, 512, 512, true, IPreview::MODE_COVER, 1024, 1024],
+
+            [2048, 1024, -1, 512, false, IPreview::MODE_FILL, 1024, 512],
+            [2048, 1024, 512, -1, false, IPreview::MODE_COVER, 512, 256],
+
+            [2048, 1024, 4096, 1024, true, IPreview::MODE_FILL, 2048, 512],
+            [2048, 1024, 4096, 1024, true, IPreview::MODE_COVER, 2048, 512],
+
+            //Test minimum size
+            [2048, 1024, 32, 32, false, IPreview::MODE_FILL, 64, 32],
+            [2048, 1024, 32, 32, false, IPreview::MODE_COVER, 64, 32],
+            [2048, 1024, 32, 32, true, IPreview::MODE_FILL, 64, 64],
+            [2048, 1024, 32, 32, true, IPreview::MODE_COVER, 64, 64],
+        ];
+    }
+
+    /**
+     * @dataProvider dataSize
+     *
+     * @param int $maxX
+     * @param int $maxY
+     * @param int $reqX
+     * @param int $reqY
+     * @param bool $crop
+     * @param string $mode
+     * @param int $expectedX
+     * @param int $expectedY
+     */
+    public function testCorrectSize($maxX, $maxY, $reqX, $reqY, $crop, $mode, $expectedX, $expectedY): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getMimeType')
+            ->willReturn('myMimeType');
+        $file->method('getId')
+            ->willReturn(42);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $previewFolder = $this->createMock(ISimpleFolder::class);
+        $this->appData->method('getFolder')
+            ->with($this->equalTo(42))
+            ->willReturn($previewFolder);
+
+        $maxPreview = $this->createMock(ISimpleFile::class);
+        $maxPreview->method('getName')
+            ->willReturn($maxX . '-' . $maxY . '-max.png');
+        $maxPreview->method('getMimeType')
+            ->willReturn('image/png');
+        $maxPreview->method('getSize')->willReturn(1000);
+
+        $previewFolder->method('getDirectoryListing')
+            ->willReturn([$maxPreview]);
+
+        $filename = $expectedX . '-' . $expectedY;
+        if ($crop) {
+            $filename .= '-crop';
+        }
+        $filename .= '.png';
+        $previewFolder->method('getFile')
+            ->with($this->equalTo($filename))
+            ->willThrowException(new NotFoundException());
+
+        $image = $this->getMockImage($maxX, $maxY);
+        $this->helper->method('getImage')
+            ->with($this->equalTo($maxPreview))
+            ->willReturn($image);
+
+        $preview = $this->createMock(ISimpleFile::class);
+        $preview->method('getSize')->willReturn(1000);
+        $previewFolder->method('newFile')
+            ->with($this->equalTo($filename))
+            ->willReturn($preview);
+
+        $this->eventDispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->with(new BeforePreviewFetchedEvent($file, $reqX, $reqY, $crop, $mode, null));
+
+        $result = $this->generator->getPreview($file, $reqX, $reqY, $crop, $mode);
+        if ($expectedX === $maxX && $expectedY === $maxY) {
+            $this->assertSame($maxPreview, $result);
+        } else {
+            $this->assertSame($preview, $result);
+        }
+    }
+
+    public function testUnreadbleFile(): void {
+        $file = $this->createMock(File::class);
+        $file->method('isReadable')
+            ->willReturn(false);
+
+        $this->expectException(NotFoundException::class);
+
+        $this->generator->getPreview($file, 100, 100, false);
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -40,7 +40,7 @@ 
 	/** @var Generator */
 	private $generator;
 
-	private LoggerInterface|\PHPUnit\Framework\MockObject\MockObject $logger;
+	private LoggerInterface | \PHPUnit\Framework\MockObject\MockObject $logger;
 
 	protected function setUp(): void {
 		parent::setUp();
@@ -125,12 +125,12 @@ 
 			->willReturn($previewFolder);
 
 		$this->config->method('getSystemValue')
-			->willReturnCallback(function ($key, $default) {
+			->willReturnCallback(function($key, $default) {
 				return $default;
 			});
 
 		$this->config->method('getSystemValueInt')
-			->willReturnCallback(function ($key, $default) {
+			->willReturnCallback(function($key, $default) {
 				return $default;
 			});
 
@@ -152,7 +152,7 @@ 
 			]);
 
 		$this->helper->method('getProvider')
-			->willReturnCallback(function ($provider) use ($invalidProvider, $validProvider, $unavailableProvider) {
+			->willReturnCallback(function($provider) use ($invalidProvider, $validProvider, $unavailableProvider) {
 				if ($provider === 'wrongProvider') {
 					$this->fail('Wrongprovider should not be constructed!');
 				} elseif ($provider === 'brokenProvider') {
@@ -174,7 +174,7 @@ 
 		$image->method('dataMimeType')->willReturn('image/png');
 
 		$this->helper->method('getThumbnail')
-			->willReturnCallback(function ($provider, $file, $x, $y) use ($invalidProvider, $validProvider, $image) {
+			->willReturnCallback(function($provider, $file, $x, $y) use ($invalidProvider, $validProvider, $image) {
 				if ($provider === $validProvider) {
 					return $image;
 				} else {
@@ -196,7 +196,7 @@ 
 		$previewFolder->method('getDirectoryListing')
 			->willReturn([]);
 		$previewFolder->method('newFile')
-			->willReturnCallback(function ($filename) use ($maxPreview, $previewFile) {
+			->willReturnCallback(function($filename) use ($maxPreview, $previewFile) {
 				if ($filename === '2048-2048-max.png') {
 					return $maxPreview;
 				} elseif ($filename === '256-256.png') {
@@ -342,13 +342,13 @@ 
 		$image->method('dataMimeType')->willReturn('image/png');
 		$image->method('data')->willReturn($data);
 
-		$image->method('resizeCopy')->willReturnCallback(function ($size) use ($data) {
+		$image->method('resizeCopy')->willReturnCallback(function($size) use ($data) {
 			return $this->getMockImage($size, $size, $data);
 		});
-		$image->method('preciseResizeCopy')->willReturnCallback(function ($width, $height) use ($data) {
+		$image->method('preciseResizeCopy')->willReturnCallback(function($width, $height) use ($data) {
 			return $this->getMockImage($width, $height, $data);
 		});
-		$image->method('cropCopy')->willReturnCallback(function ($x, $y, $width, $height) use ($data) {
+		$image->method('cropCopy')->willReturnCallback(function($x, $y, $width, $height) use ($data) {
 			return $this->getMockImage($width, $height, $data);
 		});
 
@@ -423,7 +423,7 @@ 
 
 		$maxPreview = $this->createMock(ISimpleFile::class);
 		$maxPreview->method('getName')
-			->willReturn($maxX . '-' . $maxY . '-max.png');
+			->willReturn($maxX.'-'.$maxY.'-max.png');
 		$maxPreview->method('getMimeType')
 			->willReturn('image/png');
 		$maxPreview->method('getSize')->willReturn(1000);
@@ -431,7 +431,7 @@ 
 		$previewFolder->method('getDirectoryListing')
 			->willReturn([$maxPreview]);
 
-		$filename = $expectedX . '-' . $expectedY;
+		$filename = $expectedX.'-'.$expectedY;
 		if ($crop) {
 			$filename .= '-crop';
 		}