nextcloud / server

lib/private/PreviewManager.php

Indentation +414 added lines, -414 removed lines

@@ -34,418 +34,418 @@
  * @psalm-import-type ProviderClosure from IPreview
  */
 class PreviewManager implements IPreview {
-	protected IConfig $config;
-	protected IRootFolder $rootFolder;
-	protected IEventDispatcher $eventDispatcher;
-	private ?Generator $generator = null;
-	private GeneratorHelper $helper;
-	protected bool $providerListDirty = false;
-	protected bool $registeredCoreProviders = false;
-	/**
-	 * @var array<string, list<ProviderClosure>> $providers
-	 */
-	protected array $providers = [];
-
-	/** @var array mime type => support status */
-	protected array $mimeTypeSupportMap = [];
-	/** @var ?list<class-string<IProviderV2>> $defaultProviders */
-	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,
-		IEventDispatcher $eventDispatcher,
-		GeneratorHelper $helper,
-		?string $userId,
-		Coordinator $bootstrapCoordinator,
-		ContainerInterface $container,
-		IBinaryFinder $binaryFinder,
-		IMagickSupport $imagickSupport,
-	) {
-		$this->config = $config;
-		$this->rootFolder = $rootFolder;
-		$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
-	 *
-	 * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
-	 * @param ProviderClosure $callable
-	 */
-	public function registerProvider(string $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,
-				new GeneratorHelper(),
-				$this->eventDispatcher,
-				$this->container->get(LoggerInterface::class),
-				$this->container->get(PreviewMapper::class),
-				$this->container->get(StorageFactory::class),
-				$this->container->get(IGenerator::class),
-			);
-		}
-		return $this->generator;
-	}
-
-	public function getPreview(
-		File $file,
-		int $width = -1,
-		int $height = -1,
-		bool $crop = false,
-		string $mode = IPreview::MODE_FILL,
-		?string $mimeType = null,
-		bool $cacheResult = true,
-	): ISimpleFile {
-		$this->throwIfPreviewsDisabled($file, $mimeType);
-		$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, $cacheResult);
-		} finally {
-			Generator::unguardWithSemaphore($sem);
-		}
-
-		return $preview;
-	}
-
-	/**
-	 * Generates previews of a file
-	 *
-	 * @param array $specifications
-	 * @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, ?string $mimeType = null): ISimpleFile {
-		$this->throwIfPreviewsDisabled($file, $mimeType);
-		return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
-	}
-
-	public function isMimeSupported(string $mimeType = '*'): bool {
-		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;
-	}
-
-	public function isAvailable(\OCP\Files\FileInfo $file, ?string $mimeType = null): bool {
-		if (!$this->enablePreviews) {
-			return false;
-		}
-
-		$fileMimeType = $mimeType ?? $file->getMimeType();
-
-		$this->registerCoreProviders();
-		if (!$this->isMimeSupported($fileMimeType)) {
-			return false;
-		}
-
-		$mount = $file->getMountPoint();
-		if ($mount && !$mount->getOption('previews', true)) {
-			return false;
-		}
-
-		foreach ($this->providers as $supportedMimeType => $providers) {
-			if (preg_match($supportedMimeType, $fileMimeType)) {
-				foreach ($providers as $providerClosure) {
-					$provider = $this->helper->getProvider($providerClosure);
-					if (!$provider) {
-						continue;
-					}
-					if ($provider->isAvailable($file)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * List of enabled default providers
-	 *
-	 * The following providers are enabled by default:
-	 *  - OC\Preview\BMP
-	 *  - OC\Preview\GIF
-	 *  - OC\Preview\JPEG
-	 *  - OC\Preview\MarkDown
-	 *  - OC\Preview\PNG
-	 *  - OC\Preview\TXT
-	 *  - OC\Preview\XBitmap
-	 *
-	 * The following providers are disabled by default due to performance or privacy concerns:
-	 *  - OC\Preview\Font
-	 *  - OC\Preview\HEIC
-	 *  - OC\Preview\Illustrator
-	 *  - OC\Preview\MP3
-	 *  - OC\Preview\MSOffice2003
-	 *  - OC\Preview\MSOffice2007
-	 *  - OC\Preview\MSOfficeDoc
-	 *  - OC\Preview\Movie
-	 *  - OC\Preview\OpenDocument
-	 *  - OC\Preview\PDF
-	 *  - OC\Preview\Photoshop
-	 *  - OC\Preview\Postscript
-	 *  - OC\Preview\SVG
-	 *  - OC\Preview\StarOffice
-	 *  - OC\Preview\TIFF
-	 *
-	 * @return list<class-string<IProviderV2>>
-	 */
-	protected function getEnabledDefaultProvider(): array {
-		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\TXT::class,
-			Preview\OpenDocument::class,
-		], $imageProviders));
-
-		if (in_array(Preview\Image::class, $this->defaultProviders)) {
-			$this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
-		}
-		$this->defaultProviders = array_values(array_unique($this->defaultProviders));
-		/** @var list<class-string<IProviderV2>> $providers */
-		$providers = $this->defaultProviders;
-		return $providers;
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 */
-	protected function registerCoreProvider(string $class, string $mimeType, array $options = []): void {
-		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(): void {
-		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 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('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): IProviderV2|false {
-				try {
-					return $this->container->get($provider->getService());
-				} catch (NotFoundExceptionInterface) {
-					return false;
-				}
-			});
-		}
-	}
-
-	/**
-	 * @throws NotFoundException if preview generation is disabled
-	 */
-	private function throwIfPreviewsDisabled(File $file, ?string $mimeType = null): void {
-		if (!$this->isAvailable($file, $mimeType)) {
-			throw new NotFoundException('Previews disabled');
-		}
-	}
+    protected IConfig $config;
+    protected IRootFolder $rootFolder;
+    protected IEventDispatcher $eventDispatcher;
+    private ?Generator $generator = null;
+    private GeneratorHelper $helper;
+    protected bool $providerListDirty = false;
+    protected bool $registeredCoreProviders = false;
+    /**
+     * @var array<string, list<ProviderClosure>> $providers
+     */
+    protected array $providers = [];
+
+    /** @var array mime type => support status */
+    protected array $mimeTypeSupportMap = [];
+    /** @var ?list<class-string<IProviderV2>> $defaultProviders */
+    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,
+        IEventDispatcher $eventDispatcher,
+        GeneratorHelper $helper,
+        ?string $userId,
+        Coordinator $bootstrapCoordinator,
+        ContainerInterface $container,
+        IBinaryFinder $binaryFinder,
+        IMagickSupport $imagickSupport,
+    ) {
+        $this->config = $config;
+        $this->rootFolder = $rootFolder;
+        $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
+     *
+     * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
+     * @param ProviderClosure $callable
+     */
+    public function registerProvider(string $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,
+                new GeneratorHelper(),
+                $this->eventDispatcher,
+                $this->container->get(LoggerInterface::class),
+                $this->container->get(PreviewMapper::class),
+                $this->container->get(StorageFactory::class),
+                $this->container->get(IGenerator::class),
+            );
+        }
+        return $this->generator;
+    }
+
+    public function getPreview(
+        File $file,
+        int $width = -1,
+        int $height = -1,
+        bool $crop = false,
+        string $mode = IPreview::MODE_FILL,
+        ?string $mimeType = null,
+        bool $cacheResult = true,
+    ): ISimpleFile {
+        $this->throwIfPreviewsDisabled($file, $mimeType);
+        $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, $cacheResult);
+        } finally {
+            Generator::unguardWithSemaphore($sem);
+        }
+
+        return $preview;
+    }
+
+    /**
+     * Generates previews of a file
+     *
+     * @param array $specifications
+     * @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, ?string $mimeType = null): ISimpleFile {
+        $this->throwIfPreviewsDisabled($file, $mimeType);
+        return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
+    }
+
+    public function isMimeSupported(string $mimeType = '*'): bool {
+        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;
+    }
+
+    public function isAvailable(\OCP\Files\FileInfo $file, ?string $mimeType = null): bool {
+        if (!$this->enablePreviews) {
+            return false;
+        }
+
+        $fileMimeType = $mimeType ?? $file->getMimeType();
+
+        $this->registerCoreProviders();
+        if (!$this->isMimeSupported($fileMimeType)) {
+            return false;
+        }
+
+        $mount = $file->getMountPoint();
+        if ($mount && !$mount->getOption('previews', true)) {
+            return false;
+        }
+
+        foreach ($this->providers as $supportedMimeType => $providers) {
+            if (preg_match($supportedMimeType, $fileMimeType)) {
+                foreach ($providers as $providerClosure) {
+                    $provider = $this->helper->getProvider($providerClosure);
+                    if (!$provider) {
+                        continue;
+                    }
+                    if ($provider->isAvailable($file)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * List of enabled default providers
+     *
+     * The following providers are enabled by default:
+     *  - OC\Preview\BMP
+     *  - OC\Preview\GIF
+     *  - OC\Preview\JPEG
+     *  - OC\Preview\MarkDown
+     *  - OC\Preview\PNG
+     *  - OC\Preview\TXT
+     *  - OC\Preview\XBitmap
+     *
+     * The following providers are disabled by default due to performance or privacy concerns:
+     *  - OC\Preview\Font
+     *  - OC\Preview\HEIC
+     *  - OC\Preview\Illustrator
+     *  - OC\Preview\MP3
+     *  - OC\Preview\MSOffice2003
+     *  - OC\Preview\MSOffice2007
+     *  - OC\Preview\MSOfficeDoc
+     *  - OC\Preview\Movie
+     *  - OC\Preview\OpenDocument
+     *  - OC\Preview\PDF
+     *  - OC\Preview\Photoshop
+     *  - OC\Preview\Postscript
+     *  - OC\Preview\SVG
+     *  - OC\Preview\StarOffice
+     *  - OC\Preview\TIFF
+     *
+     * @return list<class-string<IProviderV2>>
+     */
+    protected function getEnabledDefaultProvider(): array {
+        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\TXT::class,
+            Preview\OpenDocument::class,
+        ], $imageProviders));
+
+        if (in_array(Preview\Image::class, $this->defaultProviders)) {
+            $this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
+        }
+        $this->defaultProviders = array_values(array_unique($this->defaultProviders));
+        /** @var list<class-string<IProviderV2>> $providers */
+        $providers = $this->defaultProviders;
+        return $providers;
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     */
+    protected function registerCoreProvider(string $class, string $mimeType, array $options = []): void {
+        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(): void {
+        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 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('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): IProviderV2|false {
+                try {
+                    return $this->container->get($provider->getService());
+                } catch (NotFoundExceptionInterface) {
+                    return false;
+                }
+            });
+        }
+    }
+
+    /**
+     * @throws NotFoundException if preview generation is disabled
+     */
+    private function throwIfPreviewsDisabled(File $file, ?string $mimeType = null): void {
+        if (!$this->isAvailable($file, $mimeType)) {
+            throw new NotFoundException('Previews disabled');
+        }
+    }
 }

lib/private/DB/SchemaWrapper.php

Indentation +133 added lines, -133 removed lines

@@ -15,137 +15,137 @@
 use Psr\Log\LoggerInterface;
 
 class SchemaWrapper implements ISchemaWrapper {
-	/** @var Connection */
-	protected $connection;
-
-	/** @var Schema */
-	protected $schema;
-
-	/** @var array */
-	protected $tablesToDelete = [];
-
-	public function __construct(Connection $connection, ?Schema $schema = null) {
-		$this->connection = $connection;
-		if ($schema) {
-			$this->schema = $schema;
-		} else {
-			$this->schema = $this->connection->createSchema();
-		}
-	}
-
-	public function getWrappedSchema() {
-		return $this->schema;
-	}
-
-	public function performDropTableCalls() {
-		foreach ($this->tablesToDelete as $tableName => $true) {
-			$this->connection->dropTable($tableName);
-			foreach ($this->connection->getShardConnections() as $shardConnection) {
-				$shardConnection->dropTable($tableName);
-			}
-			unset($this->tablesToDelete[$tableName]);
-		}
-	}
-
-	/**
-	 * Gets all table names
-	 *
-	 * @return array
-	 */
-	public function getTableNamesWithoutPrefix() {
-		$tableNames = $this->schema->getTableNames();
-		return array_map(function ($tableName) {
-			if (str_starts_with($tableName, $this->connection->getPrefix())) {
-				return substr($tableName, strlen($this->connection->getPrefix()));
-			}
-
-			return $tableName;
-		}, $tableNames);
-	}
-
-	// Overwritten methods
-
-	/**
-	 * @return array
-	 */
-	public function getTableNames() {
-		return $this->schema->getTableNames();
-	}
-
-	/**
-	 * @param string $tableName
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table
-	 * @throws \Doctrine\DBAL\Schema\SchemaException
-	 */
-	public function getTable($tableName) {
-		return $this->schema->getTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Does this schema have a table with the given name?
-	 *
-	 * @param string $tableName
-	 *
-	 * @return boolean
-	 */
-	public function hasTable($tableName) {
-		return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Creates a new table.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	public function createTable($tableName) {
-		unset($this->tablesToDelete[$tableName]);
-		return $this->schema->createTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Drops a table from the schema.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Schema
-	 */
-	public function dropTable($tableName) {
-		$this->tablesToDelete[$tableName] = true;
-		return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Gets all tables of this schema.
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table[]
-	 */
-	public function getTables() {
-		return $this->schema->getTables();
-	}
-
-	/**
-	 * Gets the DatabasePlatform for the database.
-	 *
-	 * @return AbstractPlatform
-	 *
-	 * @throws Exception
-	 */
-	public function getDatabasePlatform() {
-		return $this->connection->getDatabasePlatform();
-	}
-
-	public function dropAutoincrementColumn(string $table, string $column): void {
-		$tableObj = $this->schema->getTable($this->connection->getPrefix() . $table);
-		$tableObj->modifyColumn('id', ['autoincrement' => false]);
-		$platform = $this->getDatabasePlatform();
-		if ($platform instanceof OraclePlatform) {
-			try {
-				$this->connection->executeStatement('DROP TRIGGER "' . $this->connection->getPrefix() . $table . '_AI_PK"');
-				$this->connection->executeStatement('DROP SEQUENCE "' . $this->connection->getPrefix() . $table . '_SEQ"');
-			} catch (Exception $e) {
-				Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
-			}
-		}
-	}
+    /** @var Connection */
+    protected $connection;
+
+    /** @var Schema */
+    protected $schema;
+
+    /** @var array */
+    protected $tablesToDelete = [];
+
+    public function __construct(Connection $connection, ?Schema $schema = null) {
+        $this->connection = $connection;
+        if ($schema) {
+            $this->schema = $schema;
+        } else {
+            $this->schema = $this->connection->createSchema();
+        }
+    }
+
+    public function getWrappedSchema() {
+        return $this->schema;
+    }
+
+    public function performDropTableCalls() {
+        foreach ($this->tablesToDelete as $tableName => $true) {
+            $this->connection->dropTable($tableName);
+            foreach ($this->connection->getShardConnections() as $shardConnection) {
+                $shardConnection->dropTable($tableName);
+            }
+            unset($this->tablesToDelete[$tableName]);
+        }
+    }
+
+    /**
+     * Gets all table names
+     *
+     * @return array
+     */
+    public function getTableNamesWithoutPrefix() {
+        $tableNames = $this->schema->getTableNames();
+        return array_map(function ($tableName) {
+            if (str_starts_with($tableName, $this->connection->getPrefix())) {
+                return substr($tableName, strlen($this->connection->getPrefix()));
+            }
+
+            return $tableName;
+        }, $tableNames);
+    }
+
+    // Overwritten methods
+
+    /**
+     * @return array
+     */
+    public function getTableNames() {
+        return $this->schema->getTableNames();
+    }
+
+    /**
+     * @param string $tableName
+     *
+     * @return \Doctrine\DBAL\Schema\Table
+     * @throws \Doctrine\DBAL\Schema\SchemaException
+     */
+    public function getTable($tableName) {
+        return $this->schema->getTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Does this schema have a table with the given name?
+     *
+     * @param string $tableName
+     *
+     * @return boolean
+     */
+    public function hasTable($tableName) {
+        return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Creates a new table.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    public function createTable($tableName) {
+        unset($this->tablesToDelete[$tableName]);
+        return $this->schema->createTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Drops a table from the schema.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Schema
+     */
+    public function dropTable($tableName) {
+        $this->tablesToDelete[$tableName] = true;
+        return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Gets all tables of this schema.
+     *
+     * @return \Doctrine\DBAL\Schema\Table[]
+     */
+    public function getTables() {
+        return $this->schema->getTables();
+    }
+
+    /**
+     * Gets the DatabasePlatform for the database.
+     *
+     * @return AbstractPlatform
+     *
+     * @throws Exception
+     */
+    public function getDatabasePlatform() {
+        return $this->connection->getDatabasePlatform();
+    }
+
+    public function dropAutoincrementColumn(string $table, string $column): void {
+        $tableObj = $this->schema->getTable($this->connection->getPrefix() . $table);
+        $tableObj->modifyColumn('id', ['autoincrement' => false]);
+        $platform = $this->getDatabasePlatform();
+        if ($platform instanceof OraclePlatform) {
+            try {
+                $this->connection->executeStatement('DROP TRIGGER "' . $this->connection->getPrefix() . $table . '_AI_PK"');
+                $this->connection->executeStatement('DROP SEQUENCE "' . $this->connection->getPrefix() . $table . '_SEQ"');
+            } catch (Exception $e) {
+                Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
+            }
+        }
+    }
 }

lib/private/Snowflake/Decoder.php

Indentation +98 added lines, -98 removed lines

@@ -21,102 +21,102 @@
  * @since 33.0.0
  */
 final class Decoder implements IDecoder {
-	#[Override]
-	public function decode(string $snowflakeId): array {
-		if (!ctype_digit($snowflakeId)) {
-			throw new \Exception('Invalid Snowflake ID: ' . $snowflakeId);
-		}
-
-		/** @var array{seconds: positive-int, milliseconds: int<0,999>, serverId: int<0, 1023>, sequenceId: int<0,4095>, isCli: bool} $data */
-		$data = PHP_INT_SIZE === 8
-			? $this->decode64bits((int)$snowflakeId)
-			: $this->decode32bits($snowflakeId);
-
-		$data['createdAt'] = new \DateTimeImmutable(
-			sprintf(
-				'@%d.%03d',
-				$data['seconds'] + IGenerator::TS_OFFSET + intdiv($data['milliseconds'], 1000),
-				$data['milliseconds'] % 1000,
-			)
-		);
-
-		return $data;
-	}
-
-	private function decode64bits(int $snowflakeId): array {
-		$firstHalf = $snowflakeId >> 32;
-		$secondHalf = $snowflakeId & 0xFFFFFFFF;
-
-		$seconds = $firstHalf & 0x7FFFFFFF;
-		$milliseconds = $secondHalf >> 22;
-
-		return [
-			'seconds' => $seconds,
-			'milliseconds' => $milliseconds,
-			'serverId' => ($secondHalf >> 13) & 0x1FF,
-			'sequenceId' => $secondHalf & 0xFFF,
-			'isCli' => (bool)(($secondHalf >> 12) & 0x1),
-		];
-	}
-
-	private function decode32bits(string $snowflakeId): array {
-		$id = $this->convertBase16($snowflakeId);
-
-		$firstQuarter = (int)hexdec(substr($id, 0, 4));
-		$secondQuarter = (int)hexdec(substr($id, 4, 4));
-		$thirdQuarter = (int)hexdec(substr($id, 8, 4));
-		$fourthQuarter = (int)hexdec(substr($id, 12, 4));
-
-		$seconds = (($firstQuarter & 0x7FFF) << 16) | ($secondQuarter & 0xFFFF);
-		$milliseconds = ($thirdQuarter >> 6) & 0x3FF;
-
-		return [
-			'seconds' => $seconds,
-			'milliseconds' => $milliseconds,
-			'serverId' => (($thirdQuarter & 0x3F) << 3) | (($fourthQuarter >> 13) & 0x7),
-			'sequenceId' => $fourthQuarter & 0xFFF,
-			'isCli' => (bool)(($fourthQuarter >> 12) & 0x1),
-		];
-	}
-
-	/**
-	 * Convert base 10 number to base 16, padded to 16 characters
-	 *
-	 * Required on 32 bits systems as base_convert will lose precision with large numbers
-	 */
-	private function convertBase16(string $decimal): string {
-		$hex = '';
-		$digits = '0123456789ABCDEF';
-
-		while (strlen($decimal) > 0 && $decimal !== '0') {
-			$remainder = 0;
-			$newDecimal = '';
-
-			// Perform division by 16 manually for arbitrary precision
-			for ($i = 0; $i < strlen($decimal); $i++) {
-				$digit = (int)$decimal[$i];
-				$current = $remainder * 10 + $digit;
-
-				if ($current >= 16) {
-					$quotient = (int)($current / 16);
-					$remainder = $current % 16;
-					$newDecimal .= chr(ord('0') + $quotient);
-				} else {
-					$remainder = $current;
-					// Only add quotient digit if we already have some digits in result
-					if (strlen($newDecimal) > 0) {
-						$newDecimal .= '0';
-					}
-				}
-			}
-
-			// Add the remainder (0-15) as hex digit
-			$hex = $digits[$remainder] . $hex;
-
-			// Update decimal for next iteration
-			$decimal = ltrim($newDecimal, '0');
-		}
-
-		return str_pad($hex, 16, '0', STR_PAD_LEFT);
-	}
+    #[Override]
+    public function decode(string $snowflakeId): array {
+        if (!ctype_digit($snowflakeId)) {
+            throw new \Exception('Invalid Snowflake ID: ' . $snowflakeId);
+        }
+
+        /** @var array{seconds: positive-int, milliseconds: int<0,999>, serverId: int<0, 1023>, sequenceId: int<0,4095>, isCli: bool} $data */
+        $data = PHP_INT_SIZE === 8
+            ? $this->decode64bits((int)$snowflakeId)
+            : $this->decode32bits($snowflakeId);
+
+        $data['createdAt'] = new \DateTimeImmutable(
+            sprintf(
+                '@%d.%03d',
+                $data['seconds'] + IGenerator::TS_OFFSET + intdiv($data['milliseconds'], 1000),
+                $data['milliseconds'] % 1000,
+            )
+        );
+
+        return $data;
+    }
+
+    private function decode64bits(int $snowflakeId): array {
+        $firstHalf = $snowflakeId >> 32;
+        $secondHalf = $snowflakeId & 0xFFFFFFFF;
+
+        $seconds = $firstHalf & 0x7FFFFFFF;
+        $milliseconds = $secondHalf >> 22;
+
+        return [
+            'seconds' => $seconds,
+            'milliseconds' => $milliseconds,
+            'serverId' => ($secondHalf >> 13) & 0x1FF,
+            'sequenceId' => $secondHalf & 0xFFF,
+            'isCli' => (bool)(($secondHalf >> 12) & 0x1),
+        ];
+    }
+
+    private function decode32bits(string $snowflakeId): array {
+        $id = $this->convertBase16($snowflakeId);
+
+        $firstQuarter = (int)hexdec(substr($id, 0, 4));
+        $secondQuarter = (int)hexdec(substr($id, 4, 4));
+        $thirdQuarter = (int)hexdec(substr($id, 8, 4));
+        $fourthQuarter = (int)hexdec(substr($id, 12, 4));
+
+        $seconds = (($firstQuarter & 0x7FFF) << 16) | ($secondQuarter & 0xFFFF);
+        $milliseconds = ($thirdQuarter >> 6) & 0x3FF;
+
+        return [
+            'seconds' => $seconds,
+            'milliseconds' => $milliseconds,
+            'serverId' => (($thirdQuarter & 0x3F) << 3) | (($fourthQuarter >> 13) & 0x7),
+            'sequenceId' => $fourthQuarter & 0xFFF,
+            'isCli' => (bool)(($fourthQuarter >> 12) & 0x1),
+        ];
+    }
+
+    /**
+     * Convert base 10 number to base 16, padded to 16 characters
+     *
+     * Required on 32 bits systems as base_convert will lose precision with large numbers
+     */
+    private function convertBase16(string $decimal): string {
+        $hex = '';
+        $digits = '0123456789ABCDEF';
+
+        while (strlen($decimal) > 0 && $decimal !== '0') {
+            $remainder = 0;
+            $newDecimal = '';
+
+            // Perform division by 16 manually for arbitrary precision
+            for ($i = 0; $i < strlen($decimal); $i++) {
+                $digit = (int)$decimal[$i];
+                $current = $remainder * 10 + $digit;
+
+                if ($current >= 16) {
+                    $quotient = (int)($current / 16);
+                    $remainder = $current % 16;
+                    $newDecimal .= chr(ord('0') + $quotient);
+                } else {
+                    $remainder = $current;
+                    // Only add quotient digit if we already have some digits in result
+                    if (strlen($newDecimal) > 0) {
+                        $newDecimal .= '0';
+                    }
+                }
+            }
+
+            // Add the remainder (0-15) as hex digit
+            $hex = $digits[$remainder] . $hex;
+
+            // Update decimal for next iteration
+            $decimal = ltrim($newDecimal, '0');
+        }
+
+        return str_pad($hex, 16, '0', STR_PAD_LEFT);
+    }
 }

lib/private/Snowflake/Generator.php

Indentation +114 added lines, -114 removed lines

@@ -21,118 +21,118 @@
  * @since 33.0.0
  */
 final class Generator implements IGenerator {
-	public function __construct(
-		private readonly ITimeFactory $timeFactory,
-	) {
-	}
-
-	#[Override]
-	public function nextId(): string {
-		// Time related
-		[$seconds, $milliseconds] = $this->getCurrentTime();
-
-		$serverId = $this->getServerId() & 0x1FF; // Keep 9 bits
-		$isCli = (int)$this->isCli(); // 1 bit
-		$sequenceId = $this->getSequenceId($seconds, $milliseconds, $serverId); //  12 bits
-		if ($sequenceId > 0xFFF || $sequenceId === false) {
-			// Throttle a bit, wait for next millisecond
-			usleep(1000);
-			return $this->nextId();
-		}
-
-		if (PHP_INT_SIZE === 8) {
-			$firstHalf = $seconds & 0x7FFFFFFF;
-			$secondHalf = (($milliseconds & 0x3FF) << 22) | ($serverId << 13) | ($isCli << 12) | $sequenceId;
-			return (string)($firstHalf << 32 | $secondHalf);
-		}
-
-		// Fallback for 32 bits systems
-		$firstQuarter = ($seconds >> 16) & 0x7FFF;
-		$secondQuarter = $seconds & 0xFFFF;
-		$thirdQuarter = ($milliseconds & 0x3FF) << 6 | ($serverId >> 3) & 0x3F;
-		$fourthQuarter = ($serverId & 0x7) << 13 | ($isCli & 0x1) << 12 | $sequenceId & 0xFFF;
-
-		$bin = pack('n*', $firstQuarter, $secondQuarter, $thirdQuarter, $fourthQuarter);
-
-		$bytes = unpack('C*', $bin);
-		if ($bytes === false) {
-			throw new \Exception('Fail to unpack');
-		}
-
-		return $this->convertToDecimal(array_values($bytes));
-	}
-
-	/**
-	 * Mostly copied from Symfony:
-	 * https://github.com/symfony/symfony/blob/v7.3.4/src/Symfony/Component/Uid/BinaryUtil.php#L49
-	 */
-	private function convertToDecimal(array $bytes): string {
-		$base = 10;
-		$digits = '';
-
-		while ($count = \count($bytes)) {
-			$quotient = [];
-			$remainder = 0;
-
-			for ($i = 0; $i !== $count; ++$i) {
-				$carry = $bytes[$i] + ($remainder << (PHP_INT_SIZE === 8 ? 16 : 8));
-				$digit = intdiv($carry, $base);
-				$remainder = $carry % $base;
-
-				if ($digit || $quotient) {
-					$quotient[] = $digit;
-				}
-			}
-
-			$digits = $remainder . $digits;
-			$bytes = $quotient;
-		}
-
-		return $digits;
-	}
-
-	private function getCurrentTime(): array {
-		$time = $this->timeFactory->now();
-		return [
-			$time->getTimestamp() - self::TS_OFFSET,
-			(int)$time->format('v'),
-		];
-	}
-
-	private function getServerId(): int {
-		return crc32(gethostname() ?: random_bytes(8));
-	}
-
-	private function isCli(): bool {
-		return PHP_SAPI === 'cli';
-	}
-
-	/**
-	 * Generates sequence ID from APCu (general case) or random if APCu disabled or CLI
-	 *
-	 * @return int|false Sequence ID or false if APCu not ready
-	 * @throws \Exception if there is an error with APCu
-	 */
-	private function getSequenceId(int $seconds, int $milliseconds, int $serverId): int|false {
-		$key = 'seq:' . $seconds . ':' . $milliseconds;
-
-		// Use APCu as fastest local cache, but not shared between processes in CLI
-		if (!$this->isCli() && function_exists('apcu_enabled') && apcu_enabled()) {
-			if ((int)apcu_cache_info(true)['creation_time'] === $seconds) {
-				// APCu cache was just started
-				// It means a sequence was maybe deleted
-				return false;
-			}
-
-			$sequenceId = apcu_inc($key, success: $success, ttl: 1);
-			if ($success === true) {
-				return $sequenceId;
-			}
-
-			throw new \Exception('Failed to generate SnowflakeId with APCu');
-		}
-
-		// Otherwise, just return a random number
-		return random_int(0, 0xFFF - 1);
-	}
+    public function __construct(
+        private readonly ITimeFactory $timeFactory,
+    ) {
+    }
+
+    #[Override]
+    public function nextId(): string {
+        // Time related
+        [$seconds, $milliseconds] = $this->getCurrentTime();
+
+        $serverId = $this->getServerId() & 0x1FF; // Keep 9 bits
+        $isCli = (int)$this->isCli(); // 1 bit
+        $sequenceId = $this->getSequenceId($seconds, $milliseconds, $serverId); //  12 bits
+        if ($sequenceId > 0xFFF || $sequenceId === false) {
+            // Throttle a bit, wait for next millisecond
+            usleep(1000);
+            return $this->nextId();
+        }
+
+        if (PHP_INT_SIZE === 8) {
+            $firstHalf = $seconds & 0x7FFFFFFF;
+            $secondHalf = (($milliseconds & 0x3FF) << 22) | ($serverId << 13) | ($isCli << 12) | $sequenceId;
+            return (string)($firstHalf << 32 | $secondHalf);
+        }
+
+        // Fallback for 32 bits systems
+        $firstQuarter = ($seconds >> 16) & 0x7FFF;
+        $secondQuarter = $seconds & 0xFFFF;
+        $thirdQuarter = ($milliseconds & 0x3FF) << 6 | ($serverId >> 3) & 0x3F;
+        $fourthQuarter = ($serverId & 0x7) << 13 | ($isCli & 0x1) << 12 | $sequenceId & 0xFFF;
+
+        $bin = pack('n*', $firstQuarter, $secondQuarter, $thirdQuarter, $fourthQuarter);
+
+        $bytes = unpack('C*', $bin);
+        if ($bytes === false) {
+            throw new \Exception('Fail to unpack');
+        }
+
+        return $this->convertToDecimal(array_values($bytes));
+    }
+
+    /**
+     * Mostly copied from Symfony:
+     * https://github.com/symfony/symfony/blob/v7.3.4/src/Symfony/Component/Uid/BinaryUtil.php#L49
+     */
+    private function convertToDecimal(array $bytes): string {
+        $base = 10;
+        $digits = '';
+
+        while ($count = \count($bytes)) {
+            $quotient = [];
+            $remainder = 0;
+
+            for ($i = 0; $i !== $count; ++$i) {
+                $carry = $bytes[$i] + ($remainder << (PHP_INT_SIZE === 8 ? 16 : 8));
+                $digit = intdiv($carry, $base);
+                $remainder = $carry % $base;
+
+                if ($digit || $quotient) {
+                    $quotient[] = $digit;
+                }
+            }
+
+            $digits = $remainder . $digits;
+            $bytes = $quotient;
+        }
+
+        return $digits;
+    }
+
+    private function getCurrentTime(): array {
+        $time = $this->timeFactory->now();
+        return [
+            $time->getTimestamp() - self::TS_OFFSET,
+            (int)$time->format('v'),
+        ];
+    }
+
+    private function getServerId(): int {
+        return crc32(gethostname() ?: random_bytes(8));
+    }
+
+    private function isCli(): bool {
+        return PHP_SAPI === 'cli';
+    }
+
+    /**
+     * Generates sequence ID from APCu (general case) or random if APCu disabled or CLI
+     *
+     * @return int|false Sequence ID or false if APCu not ready
+     * @throws \Exception if there is an error with APCu
+     */
+    private function getSequenceId(int $seconds, int $milliseconds, int $serverId): int|false {
+        $key = 'seq:' . $seconds . ':' . $milliseconds;
+
+        // Use APCu as fastest local cache, but not shared between processes in CLI
+        if (!$this->isCli() && function_exists('apcu_enabled') && apcu_enabled()) {
+            if ((int)apcu_cache_info(true)['creation_time'] === $seconds) {
+                // APCu cache was just started
+                // It means a sequence was maybe deleted
+                return false;
+            }
+
+            $sequenceId = apcu_inc($key, success: $success, ttl: 1);
+            if ($success === true) {
+                return $sequenceId;
+            }
+
+            throw new \Exception('Failed to generate SnowflakeId with APCu');
+        }
+
+        // Otherwise, just return a random number
+        return random_int(0, 0xFFF - 1);
+    }
 }

apps/settings/lib/SetupChecks/PhpModules.php

Indentation +80 added lines, -80 removed lines

@@ -14,90 +14,90 @@
 use OCP\SetupCheck\SetupResult;
 
 class PhpModules implements ISetupCheck {
-	protected const REQUIRED_MODULES = [
-		'ctype',
-		'curl',
-		'dom',
-		'fileinfo',
-		'gd',
-		'mbstring',
-		'openssl',
-		'posix',
-		'session',
-		'xml',
-		'xmlreader',
-		'xmlwriter',
-		'zip',
-		'zlib',
-	];
-	protected const RECOMMENDED_MODULES = [
-		'apcu',
-		'exif',
-		'gmp',
-		'intl',
-		'sodium',
-		'sysvsem',
-	];
+    protected const REQUIRED_MODULES = [
+        'ctype',
+        'curl',
+        'dom',
+        'fileinfo',
+        'gd',
+        'mbstring',
+        'openssl',
+        'posix',
+        'session',
+        'xml',
+        'xmlreader',
+        'xmlwriter',
+        'zip',
+        'zlib',
+    ];
+    protected const RECOMMENDED_MODULES = [
+        'apcu',
+        'exif',
+        'gmp',
+        'intl',
+        'sodium',
+        'sysvsem',
+    ];
 
-	public function __construct(
-		private IL10N $l10n,
-		private IURLGenerator $urlGenerator,
-	) {
-	}
+    public function __construct(
+        private IL10N $l10n,
+        private IURLGenerator $urlGenerator,
+    ) {
+    }
 
-	public function getName(): string {
-		return $this->l10n->t('PHP modules');
-	}
+    public function getName(): string {
+        return $this->l10n->t('PHP modules');
+    }
 
-	public function getCategory(): string {
-		return 'php';
-	}
+    public function getCategory(): string {
+        return 'php';
+    }
 
-	protected function getRecommendedModuleDescription(string $module): string {
-		return match($module) {
-			'intl' => $this->l10n->t('increases language translation performance and fixes sorting of non-ASCII characters'),
-			'sodium' => $this->l10n->t('for Argon2 for password hashing'),
-			'gmp' => $this->l10n->t('required for SFTP storage and recommended for WebAuthn performance'),
-			'exif' => $this->l10n->t('for picture rotation in server and metadata extraction in the Photos app'),
-			default => '',
-		};
-	}
+    protected function getRecommendedModuleDescription(string $module): string {
+        return match($module) {
+            'intl' => $this->l10n->t('increases language translation performance and fixes sorting of non-ASCII characters'),
+            'sodium' => $this->l10n->t('for Argon2 for password hashing'),
+            'gmp' => $this->l10n->t('required for SFTP storage and recommended for WebAuthn performance'),
+            'exif' => $this->l10n->t('for picture rotation in server and metadata extraction in the Photos app'),
+            default => '',
+        };
+    }
 
-	public function run(): SetupResult {
-		$missingRecommendedModules = $this->getMissingModules(self::RECOMMENDED_MODULES);
-		$missingRequiredModules = $this->getMissingModules(self::REQUIRED_MODULES);
-		if (!empty($missingRequiredModules)) {
-			return SetupResult::error(
-				$this->l10n->t('This instance is missing some required PHP modules. It is required to install them: %s.', implode(', ', $missingRequiredModules)),
-				$this->urlGenerator->linkToDocs('admin-php-modules')
-			);
-		} elseif (!empty($missingRecommendedModules)) {
-			$moduleList = implode(
-				"\n",
-				array_map(
-					fn (string $module) => '- ' . $module . ' ' . $this->getRecommendedModuleDescription($module),
-					$missingRecommendedModules
-				)
-			);
-			return SetupResult::info(
-				$this->l10n->t("This instance is missing some recommended PHP modules. For improved performance and better compatibility it is highly recommended to install them:\n%s", $moduleList),
-				$this->urlGenerator->linkToDocs('admin-php-modules')
-			);
-		} else {
-			return SetupResult::success();
-		}
-	}
+    public function run(): SetupResult {
+        $missingRecommendedModules = $this->getMissingModules(self::RECOMMENDED_MODULES);
+        $missingRequiredModules = $this->getMissingModules(self::REQUIRED_MODULES);
+        if (!empty($missingRequiredModules)) {
+            return SetupResult::error(
+                $this->l10n->t('This instance is missing some required PHP modules. It is required to install them: %s.', implode(', ', $missingRequiredModules)),
+                $this->urlGenerator->linkToDocs('admin-php-modules')
+            );
+        } elseif (!empty($missingRecommendedModules)) {
+            $moduleList = implode(
+                "\n",
+                array_map(
+                    fn (string $module) => '- ' . $module . ' ' . $this->getRecommendedModuleDescription($module),
+                    $missingRecommendedModules
+                )
+            );
+            return SetupResult::info(
+                $this->l10n->t("This instance is missing some recommended PHP modules. For improved performance and better compatibility it is highly recommended to install them:\n%s", $moduleList),
+                $this->urlGenerator->linkToDocs('admin-php-modules')
+            );
+        } else {
+            return SetupResult::success();
+        }
+    }
 
-	/**
-	 * Checks for potential PHP modules that would improve the instance
-	 *
-	 * @param string[] $modules modules to test
-	 * @return string[] A list of PHP modules which are missing
-	 */
-	protected function getMissingModules(array $modules): array {
-		return array_values(array_filter(
-			$modules,
-			fn (string $module) => !extension_loaded($module),
-		));
-	}
+    /**
+     * Checks for potential PHP modules that would improve the instance
+     *
+     * @param string[] $modules modules to test
+     * @return string[] A list of PHP modules which are missing
+     */
+    protected function getMissingModules(array $modules): array {
+        return array_values(array_filter(
+            $modules,
+            fn (string $module) => !extension_loaded($module),
+        ));
+    }
 }

tests/lib/Preview/GeneratorTest.php

Indentation +428 added lines, -428 removed lines

@@ -34,432 +34,432 @@
 }
 
 class GeneratorTest extends TestCase {
-	private IConfig&MockObject $config;
-	private IPreview&MockObject $previewManager;
-	private GeneratorHelper&MockObject $helper;
-	private IEventDispatcher&MockObject $eventDispatcher;
-	private Generator $generator;
-	private LoggerInterface&MockObject $logger;
-	private StorageFactory&MockObject $storageFactory;
-	private PreviewMapper&MockObject $previewMapper;
-	private IGenerator&MockObject $snowflakeGenerator;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->config = $this->createMock(IConfig::class);
-		$this->previewManager = $this->createMock(IPreview::class);
-		$this->helper = $this->createMock(GeneratorHelper::class);
-		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->previewMapper = $this->createMock(PreviewMapper::class);
-		$this->storageFactory = $this->createMock(StorageFactory::class);
-		$this->snowflakeGenerator = $this->createMock(IGenerator::class);
-
-		$this->generator = new Generator(
-			$this->config,
-			$this->previewManager,
-			$this->helper,
-			$this->eventDispatcher,
-			$this->logger,
-			$this->previewMapper,
-			$this->storageFactory,
-			$this->snowflakeGenerator,
-		);
-	}
-
-	private function getFile(int $fileId, string $mimeType, bool $hasVersion = false): File {
-		$mountPoint = $this->createMock(IMountPoint::class);
-		$mountPoint->method('getNumericStorageId')->willReturn(42);
-		if ($hasVersion) {
-			$file = $this->createMock(VersionedPreviewFile::class);
-			$file->method('getPreviewVersion')->willReturn('abc');
-		} else {
-			$file = $this->createMock(File::class);
-		}
-		$file->method('isReadable')
-			->willReturn(true);
-		$file->method('getMimeType')
-			->willReturn($mimeType);
-		$file->method('getId')
-			->willReturn($fileId);
-		$file->method('getMountPoint')
-			->willReturn($mountPoint);
-		return $file;
-	}
-
-	#[TestWith([true])]
-	#[TestWith([false])]
-	public function testGetCachedPreview(bool $hasPreview): void {
-		$file = $this->getFile(42, 'myMimeType', $hasPreview);
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$maxPreview = new Preview();
-		$maxPreview->setWidth(1000);
-		$maxPreview->setHeight(1000);
-		$maxPreview->setMax(true);
-		$maxPreview->setSize(1000);
-		$maxPreview->setCropped(false);
-		$maxPreview->setStorageId(1);
-		$maxPreview->setVersion($hasPreview ? 'abc' : null);
-		$maxPreview->setMimeType('image/png');
-
-		$previewFile = new Preview();
-		$previewFile->setWidth(256);
-		$previewFile->setHeight(256);
-		$previewFile->setMax(false);
-		$previewFile->setSize(1000);
-		$previewFile->setVersion($hasPreview ? 'abc' : null);
-		$previewFile->setCropped(false);
-		$previewFile->setStorageId(1);
-		$previewFile->setMimeType('image/png');
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => [
-				$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($hasPreview ? 'abc-256-256.png' : '256-256.png', $result->getName());
-		$this->assertSame(1000, $result->getSize());
-	}
-
-	#[TestWith([true])]
-	#[TestWith([false])]
-	public function testGetNewPreview(bool $hasVersion): void {
-		$file = $this->getFile(42, 'myMimeType', $hasVersion);
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => []]);
-
-		$this->config->method('getSystemValueString')
-			->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): false|IImage {
-				if ($provider === $validProvider) {
-					return $image;
-				} else {
-					return false;
-				}
-			});
-
-		$image->method('data')
-			->willReturn('my data');
-
-		$this->previewMapper->method('insert')
-			->willReturnCallback(fn (Preview $preview): Preview => $preview);
-
-		$this->previewMapper->method('update')
-			->willReturnCallback(fn (Preview $preview): Preview => $preview);
-
-		$this->storageFactory->method('writePreview')
-			->willReturnCallback(function (Preview $preview, mixed $data) use ($hasVersion): int {
-				$data = stream_get_contents($data);
-				if ($hasVersion) {
-					switch ($preview->getName()) {
-						case 'abc-2048-2048-max.png':
-							$this->assertSame('my data', $data);
-							return 1000;
-						case 'abc-256-256.png':
-							$this->assertSame('my resized data', $data);
-							return 1000;
-					}
-				} else {
-					switch ($preview->getName()) {
-						case '2048-2048-max.png':
-							$this->assertSame('my data', $data);
-							return 1000;
-						case '256-256.png':
-							$this->assertSame('my resized data', $data);
-							return 1000;
-					}
-				}
-				$this->fail('file name is wrong:' . $preview->getName());
-			});
-
-		$image = $this->getMockImage(2048, 2048, 'my resized data');
-		$this->helper->method('getImage')
-			->willReturn($image);
-
-		$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($hasVersion ? 'abc-256-256.png' : '256-256.png', $result->getName());
-		$this->assertSame(1000, $result->getSize());
-	}
-
-	public function testInvalidMimeType(): void {
-		$this->expectException(NotFoundException::class);
-
-		$file = $this->getFile(42, 'invalidType');
-
-		$this->previewManager->method('isMimeSupported')
-			->with('invalidType')
-			->willReturn(false);
-
-		$maxPreview = new Preview();
-		$maxPreview->setWidth(2048);
-		$maxPreview->setHeight(2048);
-		$maxPreview->setMax(true);
-		$maxPreview->setSize(1000);
-		$maxPreview->setVersion(null);
-		$maxPreview->setMimetype('image/png');
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => [
-				$maxPreview,
-			]]);
-
-		$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->getFile(42, 'myMimeType');
-
-		$maxPreview = new Preview();
-		$maxPreview->setWidth(2048);
-		$maxPreview->setHeight(2048);
-		$maxPreview->setMax(true);
-		$maxPreview->setSize(1000);
-		$maxPreview->setVersion(null);
-		$maxPreview->setMimeType('image/png');
-
-		$previewFile = new Preview();
-		$previewFile->setWidth(1024);
-		$previewFile->setHeight(512);
-		$previewFile->setMax(false);
-		$previewFile->setSize(1000);
-		$previewFile->setCropped(true);
-		$previewFile->setVersion(null);
-		$previewFile->setMimeType('image/png');
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => [
-				$maxPreview,
-				$previewFile,
-			]]);
-
-		$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('1024-512-crop.png', $result->getName());
-	}
-
-	public function testNoProvider(): void {
-		$file = $this->getFile(42, 'myMimeType');
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => []]);
-
-		$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(int $width, int $height, string $data = '') {
-		$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 static function dataSize(): array {
-		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')]
-	public function testCorrectSize(int $maxX, int $maxY, int $reqX, int $reqY, bool $crop, string $mode, int $expectedX, int $expectedY): void {
-		$file = $this->getFile(42, 'myMimeType');
-
-		$this->previewManager->method('isMimeSupported')
-			->with($this->equalTo('myMimeType'))
-			->willReturn(true);
-
-		$maxPreview = new Preview();
-		$maxPreview->setWidth($maxX);
-		$maxPreview->setHeight($maxY);
-		$maxPreview->setMax(true);
-		$maxPreview->setSize(1000);
-		$maxPreview->setVersion(null);
-		$maxPreview->setMimeType('image/png');
-
-		$this->assertSame($maxPreview->getName(), $maxX . '-' . $maxY . '-max.png');
-		$this->assertSame($maxPreview->getMimeType(), 'image/png');
-
-		$this->previewMapper->method('getAvailablePreviews')
-			->with($this->equalTo([42]))
-			->willReturn([42 => [
-				$maxPreview,
-			]]);
-
-		$filename = $expectedX . '-' . $expectedY;
-		if ($crop) {
-			$filename .= '-crop';
-		}
-		$filename .= '.png';
-
-		$image = $this->getMockImage($maxX, $maxY);
-		$this->helper->method('getImage')
-			->willReturn($image);
-
-		$this->previewMapper->method('insert')
-			->willReturnCallback(function (Preview $preview) use ($filename): Preview {
-				$this->assertSame($preview->getName(), $filename);
-				return $preview;
-			});
-
-		$this->previewMapper->method('update')
-			->willReturnCallback(fn (Preview $preview): Preview => $preview);
-
-		$this->storageFactory->method('writePreview')
-			->willReturn(1000);
-
-		$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->getName(), $result->getName());
-		} else {
-			$this->assertSame($filename, $result->getName());
-		}
-	}
-
-	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);
-	}
+    private IConfig&MockObject $config;
+    private IPreview&MockObject $previewManager;
+    private GeneratorHelper&MockObject $helper;
+    private IEventDispatcher&MockObject $eventDispatcher;
+    private Generator $generator;
+    private LoggerInterface&MockObject $logger;
+    private StorageFactory&MockObject $storageFactory;
+    private PreviewMapper&MockObject $previewMapper;
+    private IGenerator&MockObject $snowflakeGenerator;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->config = $this->createMock(IConfig::class);
+        $this->previewManager = $this->createMock(IPreview::class);
+        $this->helper = $this->createMock(GeneratorHelper::class);
+        $this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->previewMapper = $this->createMock(PreviewMapper::class);
+        $this->storageFactory = $this->createMock(StorageFactory::class);
+        $this->snowflakeGenerator = $this->createMock(IGenerator::class);
+
+        $this->generator = new Generator(
+            $this->config,
+            $this->previewManager,
+            $this->helper,
+            $this->eventDispatcher,
+            $this->logger,
+            $this->previewMapper,
+            $this->storageFactory,
+            $this->snowflakeGenerator,
+        );
+    }
+
+    private function getFile(int $fileId, string $mimeType, bool $hasVersion = false): File {
+        $mountPoint = $this->createMock(IMountPoint::class);
+        $mountPoint->method('getNumericStorageId')->willReturn(42);
+        if ($hasVersion) {
+            $file = $this->createMock(VersionedPreviewFile::class);
+            $file->method('getPreviewVersion')->willReturn('abc');
+        } else {
+            $file = $this->createMock(File::class);
+        }
+        $file->method('isReadable')
+            ->willReturn(true);
+        $file->method('getMimeType')
+            ->willReturn($mimeType);
+        $file->method('getId')
+            ->willReturn($fileId);
+        $file->method('getMountPoint')
+            ->willReturn($mountPoint);
+        return $file;
+    }
+
+    #[TestWith([true])]
+    #[TestWith([false])]
+    public function testGetCachedPreview(bool $hasPreview): void {
+        $file = $this->getFile(42, 'myMimeType', $hasPreview);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $maxPreview = new Preview();
+        $maxPreview->setWidth(1000);
+        $maxPreview->setHeight(1000);
+        $maxPreview->setMax(true);
+        $maxPreview->setSize(1000);
+        $maxPreview->setCropped(false);
+        $maxPreview->setStorageId(1);
+        $maxPreview->setVersion($hasPreview ? 'abc' : null);
+        $maxPreview->setMimeType('image/png');
+
+        $previewFile = new Preview();
+        $previewFile->setWidth(256);
+        $previewFile->setHeight(256);
+        $previewFile->setMax(false);
+        $previewFile->setSize(1000);
+        $previewFile->setVersion($hasPreview ? 'abc' : null);
+        $previewFile->setCropped(false);
+        $previewFile->setStorageId(1);
+        $previewFile->setMimeType('image/png');
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => [
+                $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($hasPreview ? 'abc-256-256.png' : '256-256.png', $result->getName());
+        $this->assertSame(1000, $result->getSize());
+    }
+
+    #[TestWith([true])]
+    #[TestWith([false])]
+    public function testGetNewPreview(bool $hasVersion): void {
+        $file = $this->getFile(42, 'myMimeType', $hasVersion);
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => []]);
+
+        $this->config->method('getSystemValueString')
+            ->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): false|IImage {
+                if ($provider === $validProvider) {
+                    return $image;
+                } else {
+                    return false;
+                }
+            });
+
+        $image->method('data')
+            ->willReturn('my data');
+
+        $this->previewMapper->method('insert')
+            ->willReturnCallback(fn (Preview $preview): Preview => $preview);
+
+        $this->previewMapper->method('update')
+            ->willReturnCallback(fn (Preview $preview): Preview => $preview);
+
+        $this->storageFactory->method('writePreview')
+            ->willReturnCallback(function (Preview $preview, mixed $data) use ($hasVersion): int {
+                $data = stream_get_contents($data);
+                if ($hasVersion) {
+                    switch ($preview->getName()) {
+                        case 'abc-2048-2048-max.png':
+                            $this->assertSame('my data', $data);
+                            return 1000;
+                        case 'abc-256-256.png':
+                            $this->assertSame('my resized data', $data);
+                            return 1000;
+                    }
+                } else {
+                    switch ($preview->getName()) {
+                        case '2048-2048-max.png':
+                            $this->assertSame('my data', $data);
+                            return 1000;
+                        case '256-256.png':
+                            $this->assertSame('my resized data', $data);
+                            return 1000;
+                    }
+                }
+                $this->fail('file name is wrong:' . $preview->getName());
+            });
+
+        $image = $this->getMockImage(2048, 2048, 'my resized data');
+        $this->helper->method('getImage')
+            ->willReturn($image);
+
+        $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($hasVersion ? 'abc-256-256.png' : '256-256.png', $result->getName());
+        $this->assertSame(1000, $result->getSize());
+    }
+
+    public function testInvalidMimeType(): void {
+        $this->expectException(NotFoundException::class);
+
+        $file = $this->getFile(42, 'invalidType');
+
+        $this->previewManager->method('isMimeSupported')
+            ->with('invalidType')
+            ->willReturn(false);
+
+        $maxPreview = new Preview();
+        $maxPreview->setWidth(2048);
+        $maxPreview->setHeight(2048);
+        $maxPreview->setMax(true);
+        $maxPreview->setSize(1000);
+        $maxPreview->setVersion(null);
+        $maxPreview->setMimetype('image/png');
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => [
+                $maxPreview,
+            ]]);
+
+        $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->getFile(42, 'myMimeType');
+
+        $maxPreview = new Preview();
+        $maxPreview->setWidth(2048);
+        $maxPreview->setHeight(2048);
+        $maxPreview->setMax(true);
+        $maxPreview->setSize(1000);
+        $maxPreview->setVersion(null);
+        $maxPreview->setMimeType('image/png');
+
+        $previewFile = new Preview();
+        $previewFile->setWidth(1024);
+        $previewFile->setHeight(512);
+        $previewFile->setMax(false);
+        $previewFile->setSize(1000);
+        $previewFile->setCropped(true);
+        $previewFile->setVersion(null);
+        $previewFile->setMimeType('image/png');
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => [
+                $maxPreview,
+                $previewFile,
+            ]]);
+
+        $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('1024-512-crop.png', $result->getName());
+    }
+
+    public function testNoProvider(): void {
+        $file = $this->getFile(42, 'myMimeType');
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => []]);
+
+        $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(int $width, int $height, string $data = '') {
+        $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 static function dataSize(): array {
+        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')]
+    public function testCorrectSize(int $maxX, int $maxY, int $reqX, int $reqY, bool $crop, string $mode, int $expectedX, int $expectedY): void {
+        $file = $this->getFile(42, 'myMimeType');
+
+        $this->previewManager->method('isMimeSupported')
+            ->with($this->equalTo('myMimeType'))
+            ->willReturn(true);
+
+        $maxPreview = new Preview();
+        $maxPreview->setWidth($maxX);
+        $maxPreview->setHeight($maxY);
+        $maxPreview->setMax(true);
+        $maxPreview->setSize(1000);
+        $maxPreview->setVersion(null);
+        $maxPreview->setMimeType('image/png');
+
+        $this->assertSame($maxPreview->getName(), $maxX . '-' . $maxY . '-max.png');
+        $this->assertSame($maxPreview->getMimeType(), 'image/png');
+
+        $this->previewMapper->method('getAvailablePreviews')
+            ->with($this->equalTo([42]))
+            ->willReturn([42 => [
+                $maxPreview,
+            ]]);
+
+        $filename = $expectedX . '-' . $expectedY;
+        if ($crop) {
+            $filename .= '-crop';
+        }
+        $filename .= '.png';
+
+        $image = $this->getMockImage($maxX, $maxY);
+        $this->helper->method('getImage')
+            ->willReturn($image);
+
+        $this->previewMapper->method('insert')
+            ->willReturnCallback(function (Preview $preview) use ($filename): Preview {
+                $this->assertSame($preview->getName(), $filename);
+                return $preview;
+            });
+
+        $this->previewMapper->method('update')
+            ->willReturnCallback(fn (Preview $preview): Preview => $preview);
+
+        $this->storageFactory->method('writePreview')
+            ->willReturn(1000);
+
+        $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->getName(), $result->getName());
+        } else {
+            $this->assertSame($filename, $result->getName());
+        }
+    }
+
+    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);
+    }
 }

tests/lib/Preview/PreviewServiceTest.php

Indentation +38 added lines, -38 removed lines

@@ -20,42 +20,42 @@
 #[CoversClass(PreviewService::class)]
 #[\PHPUnit\Framework\Attributes\Group('DB')]
 class PreviewServiceTest extends TestCase {
-	private PreviewService $previewService;
-	private PreviewMapper $previewMapper;
-	private IGenerator $snowflakeGenerator;
-
-	protected function setUp(): void {
-		$this->previewService = Server::get(PreviewService::class);
-		$this->previewMapper = Server::get(PreviewMapper::class);
-		$this->snowflakeGenerator = Server::get(IGenerator::class);
-		$this->previewService->deleteAll();
-	}
-
-	public function tearDown(): void {
-		$this->previewService->deleteAll();
-	}
-
-	public function testGetAvailableFileIds(): void {
-		foreach (range(1, 20) as $i) {
-			$preview = new Preview();
-			$preview->setId($this->snowflakeGenerator->nextId());
-			$preview->setFileId($i % 10);
-			$preview->setStorageId(1);
-			$preview->setWidth($i);
-			$preview->setHeight($i);
-			$preview->setMax(true);
-			$preview->setSourceMimeType('image/jpeg');
-			$preview->setCropped(true);
-			$preview->setEncrypted(false);
-			$preview->setMimetype('image/jpeg');
-			$preview->setEtag('abc');
-			$preview->setMtime((new \DateTime())->getTimestamp());
-			$preview->setSize(0);
-			$this->previewMapper->insert($preview);
-		}
-
-		$files = iterator_to_array($this->previewService->getAvailableFileIds());
-		$this->assertCount(1, $files);
-		$this->assertCount(10, $files[0]['fileIds']);
-	}
+    private PreviewService $previewService;
+    private PreviewMapper $previewMapper;
+    private IGenerator $snowflakeGenerator;
+
+    protected function setUp(): void {
+        $this->previewService = Server::get(PreviewService::class);
+        $this->previewMapper = Server::get(PreviewMapper::class);
+        $this->snowflakeGenerator = Server::get(IGenerator::class);
+        $this->previewService->deleteAll();
+    }
+
+    public function tearDown(): void {
+        $this->previewService->deleteAll();
+    }
+
+    public function testGetAvailableFileIds(): void {
+        foreach (range(1, 20) as $i) {
+            $preview = new Preview();
+            $preview->setId($this->snowflakeGenerator->nextId());
+            $preview->setFileId($i % 10);
+            $preview->setStorageId(1);
+            $preview->setWidth($i);
+            $preview->setHeight($i);
+            $preview->setMax(true);
+            $preview->setSourceMimeType('image/jpeg');
+            $preview->setCropped(true);
+            $preview->setEncrypted(false);
+            $preview->setMimetype('image/jpeg');
+            $preview->setEtag('abc');
+            $preview->setMtime((new \DateTime())->getTimestamp());
+            $preview->setSize(0);
+            $this->previewMapper->insert($preview);
+        }
+
+        $files = iterator_to_array($this->previewService->getAvailableFileIds());
+        $this->assertCount(1, $files);
+        $this->assertCount(10, $files[0]['fileIds']);
+    }
 }

tests/lib/Preview/PreviewMapperTest.php

Indentation +62 added lines, -62 removed lines

@@ -19,76 +19,76 @@
 
 #[\PHPUnit\Framework\Attributes\Group('DB')]
 class PreviewMapperTest extends TestCase {
-	private PreviewMapper $previewMapper;
-	private IDBConnection $connection;
-	private IGenerator $snowflake;
+    private PreviewMapper $previewMapper;
+    private IDBConnection $connection;
+    private IGenerator $snowflake;
 
-	public function setUp(): void {
-		$this->previewMapper = Server::get(PreviewMapper::class);
-		$this->connection = Server::get(IDBConnection::class);
-		$this->snowflake = Server::get(IGenerator::class);
+    public function setUp(): void {
+        $this->previewMapper = Server::get(PreviewMapper::class);
+        $this->connection = Server::get(IDBConnection::class);
+        $this->snowflake = Server::get(IGenerator::class);
 
-		$qb = $this->connection->getQueryBuilder();
-		$qb->delete('preview_locations')->executeStatement();
+        $qb = $this->connection->getQueryBuilder();
+        $qb->delete('preview_locations')->executeStatement();
 
-		$qb = $this->connection->getQueryBuilder();
-		$qb->delete('preview_versions')->executeStatement();
+        $qb = $this->connection->getQueryBuilder();
+        $qb->delete('preview_versions')->executeStatement();
 
-		$qb = $this->connection->getQueryBuilder();
-		$qb->delete('previews')->executeStatement();
-	}
+        $qb = $this->connection->getQueryBuilder();
+        $qb->delete('previews')->executeStatement();
+    }
 
-	public function testGetAvailablePreviews(): void {
-		// Empty
-		$this->assertEquals([], $this->previewMapper->getAvailablePreviews([]));
+    public function testGetAvailablePreviews(): void {
+        // Empty
+        $this->assertEquals([], $this->previewMapper->getAvailablePreviews([]));
 
-		// No preview available
-		$this->assertEquals([42 => []], $this->previewMapper->getAvailablePreviews([42]));
+        // No preview available
+        $this->assertEquals([42 => []], $this->previewMapper->getAvailablePreviews([42]));
 
-		$this->createPreviewForFileId(42);
-		$previews = $this->previewMapper->getAvailablePreviews([42]);
-		$this->assertNotEmpty($previews[42]);
-		$this->assertNull($previews[42][0]->getLocationId());
-		$this->assertNull($previews[42][0]->getBucketName());
-		$this->assertNull($previews[42][0]->getObjectStoreName());
+        $this->createPreviewForFileId(42);
+        $previews = $this->previewMapper->getAvailablePreviews([42]);
+        $this->assertNotEmpty($previews[42]);
+        $this->assertNull($previews[42][0]->getLocationId());
+        $this->assertNull($previews[42][0]->getBucketName());
+        $this->assertNull($previews[42][0]->getObjectStoreName());
 
-		$this->createPreviewForFileId(43, 2);
-		$previews = $this->previewMapper->getAvailablePreviews([43]);
-		$this->assertNotEmpty($previews[43]);
-		$this->assertEquals('preview-2', $previews[43][0]->getBucketName());
-		$this->assertEquals('default', $previews[43][0]->getObjectStoreName());
-	}
+        $this->createPreviewForFileId(43, 2);
+        $previews = $this->previewMapper->getAvailablePreviews([43]);
+        $this->assertNotEmpty($previews[43]);
+        $this->assertEquals('preview-2', $previews[43][0]->getBucketName());
+        $this->assertEquals('default', $previews[43][0]->getObjectStoreName());
+    }
 
-	private function createPreviewForFileId(int $fileId, ?int $bucket = null): void {
-		$locationId = null;
-		if ($bucket) {
-			$qb = $this->connection->getQueryBuilder();
-			$locationId = $this->snowflake->nextId();
-			$qb->insert('preview_locations')
-				->values([
-					'id' => $locationId,
-					'bucket_name' => $qb->createNamedParameter('preview-' . $bucket),
-					'object_store_name' => $qb->createNamedParameter('default'),
-				]);
-			$qb->executeStatement();
-		}
-		$preview = new Preview();
-		$preview->setId($this->snowflake->nextId());
-		$preview->setFileId($fileId);
-		$preview->setStorageId(1);
-		$preview->setCropped(true);
-		$preview->setMax(true);
-		$preview->setWidth(100);
-		$preview->setSourceMimeType('image/jpeg');
-		$preview->setHeight(100);
-		$preview->setSize(100);
-		$preview->setMtime(time());
-		$preview->setMimetype('image/jpeg');
-		$preview->setEtag('abcdefg');
+    private function createPreviewForFileId(int $fileId, ?int $bucket = null): void {
+        $locationId = null;
+        if ($bucket) {
+            $qb = $this->connection->getQueryBuilder();
+            $locationId = $this->snowflake->nextId();
+            $qb->insert('preview_locations')
+                ->values([
+                    'id' => $locationId,
+                    'bucket_name' => $qb->createNamedParameter('preview-' . $bucket),
+                    'object_store_name' => $qb->createNamedParameter('default'),
+                ]);
+            $qb->executeStatement();
+        }
+        $preview = new Preview();
+        $preview->setId($this->snowflake->nextId());
+        $preview->setFileId($fileId);
+        $preview->setStorageId(1);
+        $preview->setCropped(true);
+        $preview->setMax(true);
+        $preview->setWidth(100);
+        $preview->setSourceMimeType('image/jpeg');
+        $preview->setHeight(100);
+        $preview->setSize(100);
+        $preview->setMtime(time());
+        $preview->setMimetype('image/jpeg');
+        $preview->setEtag('abcdefg');
 
-		if ($locationId !== null) {
-			$preview->setLocationId($locationId);
-		}
-		$this->previewMapper->insert($preview);
-	}
+        if ($locationId !== null) {
+            $preview->setLocationId($locationId);
+        }
+        $this->previewMapper->insert($preview);
+    }
 }

tests/lib/Preview/MovePreviewJobTest.php

Indentation +191 added lines, -191 removed lines

@@ -32,195 +32,195 @@
 
 #[\PHPUnit\Framework\Attributes\Group('DB')]
 class MovePreviewJobTest extends TestCase {
-	private IAppData $previewAppData;
-	private PreviewMapper $previewMapper;
-	private IAppConfig&MockObject $appConfig;
-	private IConfig $config;
-	private StorageFactory $storageFactory;
-	private PreviewService $previewService;
-	private IDBConnection $db;
-	private IMimeTypeLoader&MockObject $mimeTypeLoader;
-	private IMimeTypeDetector&MockObject $mimeTypeDetector;
-	private LoggerInterface&MockObject $logger;
-
-	public function setUp(): void {
-		parent::setUp();
-		$this->previewAppData = Server::get(IAppDataFactory::class)->get('preview');
-		$this->previewMapper = Server::get(PreviewMapper::class);
-		$this->config = Server::get(IConfig::class);
-		$this->appConfig = $this->createMock(IAppConfig::class);
-		$this->appConfig->expects($this->any())
-			->method('getValueBool')
-			->willReturn(false);
-		$this->appConfig->expects($this->any())
-			->method('setValueBool')
-			->willReturn(true);
-		$this->storageFactory = Server::get(StorageFactory::class);
-		$this->previewService = Server::get(PreviewService::class);
-		$this->db = Server::get(IDBConnection::class);
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('filecache')
-			->where($qb->expr()->eq('fileid', $qb->createNamedParameter(5)))
-			->executeStatement();
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->insert('filecache')
-			->values([
-				'fileid' => $qb->createNamedParameter(5),
-				'storage' => $qb->createNamedParameter(1),
-				'path' => $qb->createNamedParameter('test/abc'),
-				'path_hash' => $qb->createNamedParameter(md5('test')),
-				'parent' => $qb->createNamedParameter(0),
-				'name' => $qb->createNamedParameter('abc'),
-				'mimetype' => $qb->createNamedParameter(42),
-				'size' => $qb->createNamedParameter(1000),
-				'mtime' => $qb->createNamedParameter(1000),
-				'storage_mtime' => $qb->createNamedParameter(1000),
-				'encrypted' => $qb->createNamedParameter(0),
-				'unencrypted_size' => $qb->createNamedParameter(0),
-				'etag' => $qb->createNamedParameter('abcdefg'),
-				'permissions' => $qb->createNamedParameter(0),
-				'checksum' => $qb->createNamedParameter('abcdefg'),
-			])->executeStatement();
-
-		$this->mimeTypeDetector = $this->createMock(IMimeTypeDetector::class);
-		$this->mimeTypeDetector->method('detectPath')->willReturn('image/png');
-		$this->mimeTypeLoader = $this->createMock(IMimeTypeLoader::class);
-		$this->mimeTypeLoader->method('getId')->with('image/png')->willReturn(42);
-		$this->mimeTypeLoader->method('getMimetypeById')->with(42)->willReturn('image/png');
-		$this->logger = $this->createMock(LoggerInterface::class);
-	}
-
-	public function tearDown(): void {
-		foreach ($this->previewAppData->getDirectoryListing() as $folder) {
-			$folder->delete();
-		}
-		$this->previewService->deleteAll();
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('filecache')
-			->where($qb->expr()->eq('fileid', $qb->createNamedParameter(5)))
-			->executeStatement();
-	}
-
-	#[TestDox('Test the migration from the legacy flat hierarchy to the new database format')]
-	public function testMigrationLegacyPath(): void {
-		$folder = $this->previewAppData->newFolder('5');
-		$folder->newFile('64-64-crop.jpg', 'abcdefg');
-		$folder->newFile('128-128-crop.png', 'abcdefg');
-		$this->assertEquals(1, count($this->previewAppData->getDirectoryListing()));
-		$this->assertEquals(2, count($folder->getDirectoryListing()));
-		$this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
-
-		$job = new MovePreviewJob(
-			Server::get(ITimeFactory::class),
-			$this->appConfig,
-			$this->config,
-			$this->previewMapper,
-			$this->storageFactory,
-			Server::get(IDBConnection::class),
-			Server::get(IRootFolder::class),
-			$this->mimeTypeDetector,
-			$this->mimeTypeLoader,
-			$this->logger,
-			Server::get(IGenerator::class),
-			Server::get(IAppDataFactory::class),
-		);
-		$this->invokePrivate($job, 'run', [[]]);
-		$this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
-		$this->assertEquals(2, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
-	}
-
-	private static function getInternalFolder(string $name): string {
-		return implode('/', str_split(substr(md5($name), 0, 7))) . '/' . $name;
-	}
-
-	#[TestDox("Test the migration from the 'new' nested hierarchy to the database format")]
-	public function testMigrationPath(): void {
-		$folder = $this->previewAppData->newFolder(self::getInternalFolder((string)5));
-		$folder->newFile('64-64-crop.jpg', 'abcdefg');
-		$folder->newFile('128-128-crop.png', 'abcdefg');
-
-		$folder = $this->previewAppData->getFolder(self::getInternalFolder((string)5));
-		$this->assertEquals(2, count($folder->getDirectoryListing()));
-		$this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
-
-		$job = new MovePreviewJob(
-			Server::get(ITimeFactory::class),
-			$this->appConfig,
-			$this->config,
-			$this->previewMapper,
-			$this->storageFactory,
-			Server::get(IDBConnection::class),
-			Server::get(IRootFolder::class),
-			$this->mimeTypeDetector,
-			$this->mimeTypeLoader,
-			$this->logger,
-			Server::get(IGenerator::class),
-			Server::get(IAppDataFactory::class)
-		);
-		$this->invokePrivate($job, 'run', [[]]);
-		$this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
-		$this->assertEquals(2, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
-	}
-
-	#[TestDox("Test the migration from the 'new' nested hierarchy to the database format")]
-	public function testMigrationPathWithVersion(): void {
-		$folder = $this->previewAppData->newFolder(self::getInternalFolder((string)5));
-		// No version
-		$folder->newFile('128-128-crop.png', 'abcdefg');
-		$folder->newFile('256-256-max.png', 'abcdefg');
-		$folder->newFile('128-128.png', 'abcdefg');
-
-		// Version 1000
-		$folder->newFile('1000-128-128-crop.png', 'abcdefg');
-		$folder->newFile('1000-256-256-max.png', 'abcdefg');
-		$folder->newFile('1000-128-128.png', 'abcdefg');
-
-		// Version 1001
-		$folder->newFile('1001-128-128-crop.png', 'abcdefg');
-		$folder->newFile('1001-256-256-max.png', 'abcdefg');
-		$folder->newFile('1001-128-128.png', 'abcdefg');
-
-		$folder = $this->previewAppData->getFolder(self::getInternalFolder((string)5));
-		$this->assertEquals(9, count($folder->getDirectoryListing()));
-		$this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
-
-		$job = new MovePreviewJob(
-			Server::get(ITimeFactory::class),
-			$this->appConfig,
-			$this->config,
-			$this->previewMapper,
-			$this->storageFactory,
-			Server::get(IDBConnection::class),
-			Server::get(IRootFolder::class),
-			$this->mimeTypeDetector,
-			$this->mimeTypeLoader,
-			$this->logger,
-			Server::get(IGenerator::class),
-			Server::get(IAppDataFactory::class)
-		);
-		$this->invokePrivate($job, 'run', [[]]);
-		$previews = iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5));
-		$this->assertEquals(9, count($previews));
-		$this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
-
-		$nameVersionMapping = [];
-		foreach ($previews as $preview) {
-			$nameVersionMapping[$preview->getName($this->mimeTypeLoader)] = $preview->getVersion();
-		}
-
-		$this->assertEquals([
-			'1000-128-128-crop.png' => 1000,
-			'1000-128-128.png' => 1000,
-			'1000-256-256-max.png' => 1000,
-			'1001-128-128-crop.png' => 1001,
-			'1001-128-128.png' => 1001,
-			'1001-256-256-max.png' => 1001,
-			'128-128-crop.png' => null,
-			'128-128.png' => null,
-			'256-256-max.png' => null,
-		], $nameVersionMapping);
-	}
+    private IAppData $previewAppData;
+    private PreviewMapper $previewMapper;
+    private IAppConfig&MockObject $appConfig;
+    private IConfig $config;
+    private StorageFactory $storageFactory;
+    private PreviewService $previewService;
+    private IDBConnection $db;
+    private IMimeTypeLoader&MockObject $mimeTypeLoader;
+    private IMimeTypeDetector&MockObject $mimeTypeDetector;
+    private LoggerInterface&MockObject $logger;
+
+    public function setUp(): void {
+        parent::setUp();
+        $this->previewAppData = Server::get(IAppDataFactory::class)->get('preview');
+        $this->previewMapper = Server::get(PreviewMapper::class);
+        $this->config = Server::get(IConfig::class);
+        $this->appConfig = $this->createMock(IAppConfig::class);
+        $this->appConfig->expects($this->any())
+            ->method('getValueBool')
+            ->willReturn(false);
+        $this->appConfig->expects($this->any())
+            ->method('setValueBool')
+            ->willReturn(true);
+        $this->storageFactory = Server::get(StorageFactory::class);
+        $this->previewService = Server::get(PreviewService::class);
+        $this->db = Server::get(IDBConnection::class);
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('filecache')
+            ->where($qb->expr()->eq('fileid', $qb->createNamedParameter(5)))
+            ->executeStatement();
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->insert('filecache')
+            ->values([
+                'fileid' => $qb->createNamedParameter(5),
+                'storage' => $qb->createNamedParameter(1),
+                'path' => $qb->createNamedParameter('test/abc'),
+                'path_hash' => $qb->createNamedParameter(md5('test')),
+                'parent' => $qb->createNamedParameter(0),
+                'name' => $qb->createNamedParameter('abc'),
+                'mimetype' => $qb->createNamedParameter(42),
+                'size' => $qb->createNamedParameter(1000),
+                'mtime' => $qb->createNamedParameter(1000),
+                'storage_mtime' => $qb->createNamedParameter(1000),
+                'encrypted' => $qb->createNamedParameter(0),
+                'unencrypted_size' => $qb->createNamedParameter(0),
+                'etag' => $qb->createNamedParameter('abcdefg'),
+                'permissions' => $qb->createNamedParameter(0),
+                'checksum' => $qb->createNamedParameter('abcdefg'),
+            ])->executeStatement();
+
+        $this->mimeTypeDetector = $this->createMock(IMimeTypeDetector::class);
+        $this->mimeTypeDetector->method('detectPath')->willReturn('image/png');
+        $this->mimeTypeLoader = $this->createMock(IMimeTypeLoader::class);
+        $this->mimeTypeLoader->method('getId')->with('image/png')->willReturn(42);
+        $this->mimeTypeLoader->method('getMimetypeById')->with(42)->willReturn('image/png');
+        $this->logger = $this->createMock(LoggerInterface::class);
+    }
+
+    public function tearDown(): void {
+        foreach ($this->previewAppData->getDirectoryListing() as $folder) {
+            $folder->delete();
+        }
+        $this->previewService->deleteAll();
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('filecache')
+            ->where($qb->expr()->eq('fileid', $qb->createNamedParameter(5)))
+            ->executeStatement();
+    }
+
+    #[TestDox('Test the migration from the legacy flat hierarchy to the new database format')]
+    public function testMigrationLegacyPath(): void {
+        $folder = $this->previewAppData->newFolder('5');
+        $folder->newFile('64-64-crop.jpg', 'abcdefg');
+        $folder->newFile('128-128-crop.png', 'abcdefg');
+        $this->assertEquals(1, count($this->previewAppData->getDirectoryListing()));
+        $this->assertEquals(2, count($folder->getDirectoryListing()));
+        $this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
+
+        $job = new MovePreviewJob(
+            Server::get(ITimeFactory::class),
+            $this->appConfig,
+            $this->config,
+            $this->previewMapper,
+            $this->storageFactory,
+            Server::get(IDBConnection::class),
+            Server::get(IRootFolder::class),
+            $this->mimeTypeDetector,
+            $this->mimeTypeLoader,
+            $this->logger,
+            Server::get(IGenerator::class),
+            Server::get(IAppDataFactory::class),
+        );
+        $this->invokePrivate($job, 'run', [[]]);
+        $this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
+        $this->assertEquals(2, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
+    }
+
+    private static function getInternalFolder(string $name): string {
+        return implode('/', str_split(substr(md5($name), 0, 7))) . '/' . $name;
+    }
+
+    #[TestDox("Test the migration from the 'new' nested hierarchy to the database format")]
+    public function testMigrationPath(): void {
+        $folder = $this->previewAppData->newFolder(self::getInternalFolder((string)5));
+        $folder->newFile('64-64-crop.jpg', 'abcdefg');
+        $folder->newFile('128-128-crop.png', 'abcdefg');
+
+        $folder = $this->previewAppData->getFolder(self::getInternalFolder((string)5));
+        $this->assertEquals(2, count($folder->getDirectoryListing()));
+        $this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
+
+        $job = new MovePreviewJob(
+            Server::get(ITimeFactory::class),
+            $this->appConfig,
+            $this->config,
+            $this->previewMapper,
+            $this->storageFactory,
+            Server::get(IDBConnection::class),
+            Server::get(IRootFolder::class),
+            $this->mimeTypeDetector,
+            $this->mimeTypeLoader,
+            $this->logger,
+            Server::get(IGenerator::class),
+            Server::get(IAppDataFactory::class)
+        );
+        $this->invokePrivate($job, 'run', [[]]);
+        $this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
+        $this->assertEquals(2, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
+    }
+
+    #[TestDox("Test the migration from the 'new' nested hierarchy to the database format")]
+    public function testMigrationPathWithVersion(): void {
+        $folder = $this->previewAppData->newFolder(self::getInternalFolder((string)5));
+        // No version
+        $folder->newFile('128-128-crop.png', 'abcdefg');
+        $folder->newFile('256-256-max.png', 'abcdefg');
+        $folder->newFile('128-128.png', 'abcdefg');
+
+        // Version 1000
+        $folder->newFile('1000-128-128-crop.png', 'abcdefg');
+        $folder->newFile('1000-256-256-max.png', 'abcdefg');
+        $folder->newFile('1000-128-128.png', 'abcdefg');
+
+        // Version 1001
+        $folder->newFile('1001-128-128-crop.png', 'abcdefg');
+        $folder->newFile('1001-256-256-max.png', 'abcdefg');
+        $folder->newFile('1001-128-128.png', 'abcdefg');
+
+        $folder = $this->previewAppData->getFolder(self::getInternalFolder((string)5));
+        $this->assertEquals(9, count($folder->getDirectoryListing()));
+        $this->assertEquals(0, count(iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5))));
+
+        $job = new MovePreviewJob(
+            Server::get(ITimeFactory::class),
+            $this->appConfig,
+            $this->config,
+            $this->previewMapper,
+            $this->storageFactory,
+            Server::get(IDBConnection::class),
+            Server::get(IRootFolder::class),
+            $this->mimeTypeDetector,
+            $this->mimeTypeLoader,
+            $this->logger,
+            Server::get(IGenerator::class),
+            Server::get(IAppDataFactory::class)
+        );
+        $this->invokePrivate($job, 'run', [[]]);
+        $previews = iterator_to_array($this->previewMapper->getAvailablePreviewsForFile(5));
+        $this->assertEquals(9, count($previews));
+        $this->assertEquals(0, count($this->previewAppData->getDirectoryListing()));
+
+        $nameVersionMapping = [];
+        foreach ($previews as $preview) {
+            $nameVersionMapping[$preview->getName($this->mimeTypeLoader)] = $preview->getVersion();
+        }
+
+        $this->assertEquals([
+            '1000-128-128-crop.png' => 1000,
+            '1000-128-128.png' => 1000,
+            '1000-256-256-max.png' => 1000,
+            '1001-128-128-crop.png' => 1001,
+            '1001-128-128.png' => 1001,
+            '1001-256-256-max.png' => 1001,
+            '128-128-crop.png' => null,
+            '128-128.png' => null,
+            '256-256-max.png' => null,
+        ], $nameVersionMapping);
+    }
 }