FileProcessingService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Resource\Service;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use TYPO3\CMS\Core\Resource\Driver\DriverInterface;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileProcessingEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileProcessingEvent;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\FileReference;
use ‪TYPO3\CMS\Core\Resource\ProcessedFile;
use ‪TYPO3\CMS\Core\Resource\ProcessedFileRepository;
use ‪TYPO3\CMS\Core\Resource\Processing\ProcessorInterface;
use ‪TYPO3\CMS\Core\Resource\Processing\ProcessorRegistry;
use ‪TYPO3\CMS\Core\Resource\Processing\TaskInterface;
 
class ‪FileProcessingService
{
    public function ‪__construct(
        protected readonly EventDispatcherInterface $eventDispatcher,
        protected readonly ‪ProcessedFileRepository $processedFileRepository,
        protected readonly ‪ProcessorRegistry $processorRegistry,
    ) {}
 
    public function ‪processFile(‪File|‪FileReference $fileObject, string $taskType, DriverInterface $driver, array $configuration): ‪ProcessedFile
    {
        // Processing always works on the original file
        $originalFile = $fileObject instanceof ‪FileReference ? $fileObject->getOriginalFile() : $fileObject;
 
        // Find an entry in the DB or create a new ProcessedFile which can then be added (see ->add below)
        $processedFile = $this->processedFileRepository->findOneByOriginalFileAndTaskTypeAndConfiguration($originalFile, $taskType, $configuration);
 
        // Pre-process the file
        $event = $this->eventDispatcher->dispatch(
            new ‪BeforeFileProcessingEvent($driver, $processedFile, $fileObject, $taskType, $configuration)
        );
        $processedFile = $event->getProcessedFile();
        $task = $processedFile->getTask();
 
        // Only handle the file if it is not processed yet
        // (maybe modified or already processed by an event)
        // or (in case of preview images) already in the DB/in the processing folder
        if ($task->fileNeedsProcessing()) {
            $this->‪getProcessorByTask($task)->processTask($task);
            if ($task->isExecuted() && $task->isSuccessful() && $processedFile->isProcessed()) {
                $this->processedFileRepository->add($processedFile);
            }
        }
 
        // Post-process (enrich) the file
        $event = $this->eventDispatcher->dispatch(
            new ‪AfterFileProcessingEvent($driver, $processedFile, $fileObject, $taskType, $configuration)
        );
 
        return $event->getProcessedFile();
    }
 
    protected function ‪getProcessorByTask(‪TaskInterface $task): ‪ProcessorInterface
    {
        return $this->processorRegistry->getProcessorByTask($task);
    }
}