LocalPreviewHelper.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Processing;
 
use ‪TYPO3\CMS\Core\Imaging\GraphicalFunctions;
use ‪TYPO3\CMS\Core\Imaging\ImageMagickFile;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Utility\CommandUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
 
class ‪LocalPreviewHelper
{
    protected static ‪$defaultConfiguration = [
        'width' => 64,
        'height' => 64,
    ];
 
    public static function ‪preProcessConfiguration(array $configuration): array
    {
        $configuration = array_replace(static::$defaultConfiguration, $configuration);
        $configuration['width'] = ‪MathUtility::forceIntegerInRange($configuration['width'], 1, 1000);
        $configuration['height'] = ‪MathUtility::forceIntegerInRange($configuration['height'], 1, 1000);
 
        return array_filter(
            $configuration,
            function ($value, $name) {
                return !empty($value) && in_array($name, ['width', 'height'], true);
            },
            ARRAY_FILTER_USE_BOTH
        );
    }
 
    public function ‪process(‪TaskInterface $task)
    {
        $sourceFile = $task->‪getSourceFile();
        $configuration = static::preProcessConfiguration($task->‪getConfiguration());
 
        // Do not scale up if the source file has a size and the target size is larger
        if ($sourceFile->getProperty('width') > 0 && $sourceFile->getProperty('height') > 0
            && $configuration['width'] > $sourceFile->getProperty('width')
            && $configuration['height'] > $sourceFile->getProperty('height')) {
            return null;
        }
 
        return $this->‪generatePreviewFromFile($sourceFile, $configuration, $this->‪getTemporaryFilePath($task));
    }
 
    public function ‪processWithLocalFile(‪TaskInterface $task, string $localFile): ?array
    {
        return $this->‪generatePreviewFromLocalFile($localFile, $task->‪getConfiguration(), $this->getTemporaryFilePath($task));
    }
 
    protected function ‪getTemporaryFilePath(‪TaskInterface $task)
    {
        return GeneralUtility::tempnam('preview_', '.' . $task->‪getTargetFileExtension());
    }
 
    protected function ‪generatePreviewFromFile(‪File $file, array $configuration, string $targetFilePath)
    {
        // Check file extension
        if ($file->‪getType() !== ‪File::FILETYPE_IMAGE && !$file->‪isImage()) {
            // Create a default image
            $graphicalFunctions = GeneralUtility::makeInstance(GraphicalFunctions::class);
            $graphicalFunctions->getTemporaryImageWithText(
                $targetFilePath,
                'Not imagefile!',
                'No ext!',
                $file->‪getName()
            );
            return [
                'filePath' => $targetFilePath,
            ];
        }
 
        return $this->‪generatePreviewFromLocalFile($file->‪getForLocalProcessing(false), $configuration, $targetFilePath);
    }
 
    protected function ‪generatePreviewFromLocalFile(string $originalFileName, array $configuration, string $targetFilePath)
    {
        // Create the temporary file
        if (‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_enabled']) {
            $arguments = ‪CommandUtility::escapeShellArguments([
                'width' => $configuration['width'],
                'height' => $configuration['height'],
            ]);
            $parameters = '-sample ' . $arguments['width'] . 'x' . $arguments['height']
                . ' ' . ‪ImageMagickFile::fromFilePath($originalFileName, 0)
                . ' ' . ‪CommandUtility::escapeShellArgument($targetFilePath);
 
            $cmd = ‪CommandUtility::imageMagickCommand('convert', $parameters) . ' 2>&1';
            ‪CommandUtility::exec($cmd);
 
            if (!file_exists($targetFilePath)) {
                // Create an error gif
                $graphicalFunctions = GeneralUtility::makeInstance(GraphicalFunctions::class);
                $graphicalFunctions->getTemporaryImageWithText(
                    $targetFilePath,
                    'No thumb',
                    'generated!',
                    ''
                );
            }
        }
 
        return [
            'filePath' => $targetFilePath,
        ];
    }
}