LocalCropScaleMaskHelper.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\Core\Environment;
use ‪TYPO3\CMS\Core\Imaging\GraphicalFunctions;
use ‪TYPO3\CMS\Core\Resource\FileInterface;
use ‪TYPO3\CMS\Core\Resource\ProcessedFile;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪LocalCropScaleMaskHelper
{
    public function ‪process(‪TaskInterface $task)
    {
        return $this->‪processWithLocalFile($task, $task->‪getSourceFile()->‪getForLocalProcessing(false));
    }
 
    public function ‪processWithLocalFile(‪TaskInterface $task, string $originalFileName): ?array
    {
        $result = null;
        $targetFile = $task->‪getTargetFile();
 
        $imageOperations = GeneralUtility::makeInstance(GraphicalFunctions::class);
 
        $configuration = $targetFile->getProcessingConfiguration();
        $configuration['additionalParameters'] = $this->‪modifyImageMagickStripProfileParameters((string)($configuration['additionalParameters'] ?? ''), $configuration);
 
        if (empty($configuration['fileExtension'])) {
            $configuration['fileExtension'] = $task->‪getTargetFileExtension();
        }
 
        $options = $this->‪getConfigurationForImageCropScaleMask($targetFile);
 
        $croppedImage = null;
        if (!empty($configuration['crop'])) {
            // the result info is an array with 0=width,1=height,2=extension,3=filename
            $result = $imageOperations->crop($originalFileName, $configuration['fileExtension'], $configuration['crop']);
            if ($result !== null) {
                $originalFileName = $croppedImage = $result[3];
            }
        }
 
        // Normal situation (no masking)
        if (!(is_array($configuration['maskImages'] ?? null) && ‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_enabled'])) {
            // the result info is an array with 0=width,1=height,2=extension,3=filename
            $result = $imageOperations->imageMagickConvert(
                $originalFileName,
                $configuration['fileExtension'],
                $configuration['width'] ?? '',
                $configuration['height'] ?? '',
                $configuration['additionalParameters'],
                $configuration['frame'] ?? '',
                $options,
                // in case file is in `/typo3temp/` from the crop operation above, it must create a result
                $result !== null
            );
        } else {
            $targetFileName = $this->‪getFilenameForImageCropScaleMask($task);
            $temporaryFileName = ‪Environment::getPublicPath() . '/typo3temp/' . $targetFileName;
            $maskImage = $configuration['maskImages']['maskImage'] ?? null;
            $maskBackgroundImage = $configuration['maskImages']['backgroundImage'];
            if ($maskImage instanceof ‪FileInterface && $maskBackgroundImage instanceof ‪FileInterface) {
                // This converts the original image to a temporary PNG file during all steps of the masking process
                $tempFileInfo = $imageOperations->imageMagickConvert(
                    $originalFileName,
                    'png',
                    $configuration['width'] ?? '',
                    $configuration['height'] ?? '',
                    $configuration['additionalParameters'],
                    $configuration['frame'] ?? '',
                    $options
                );
                if (is_array($tempFileInfo)) {
                    // Scaling
                    $command = '-geometry ' . $tempFileInfo[0] . 'x' . $tempFileInfo[1] . '!';
                    $command = $this->‪modifyImageMagickStripProfileParameters($command, $configuration);
 
                    $imageOperations->mask(
                        $tempFileInfo[3],
                        $temporaryFileName,
                        $maskImage->getForLocalProcessing(),
                        $maskBackgroundImage->getForLocalProcessing(),
                        $command
                    );
                    $maskBottomImage = $configuration['maskImages']['maskBottomImage'] ?? null;
                    $maskBottomImageMask = $configuration['maskImages']['maskBottomImageMask'] ?? null;
                    if ($maskBottomImage instanceof ‪FileInterface && $maskBottomImageMask instanceof ‪FileInterface) {
                        // Uses the temporary PNG file from the previous step and applies another mask
                        $imageOperations->mask(
                            $temporaryFileName,
                            $temporaryFileName,
                            $maskBottomImage->getForLocalProcessing(),
                            $maskBottomImageMask->getForLocalProcessing(),
                            $command
                        );
                    }
                    $tempFileInfo[3] = $temporaryFileName;
                }
                $result = $tempFileInfo;
            }
        }
 
        // check if the processing really generated a new file (scaled and/or cropped)
        if ($result !== null) {
            if ($result[3] !== $originalFileName || $originalFileName === $croppedImage) {
                $result = [
                    'width' => $result[0],
                    'height' => $result[1],
                    'filePath' => $result[3],
                ];
            } else {
                // No file was generated
                $result = null;
            }
        }
 
        // Cleanup temp file if it isn't used as result
        if ($croppedImage && ($result === null || $croppedImage !== $result['filePath'])) {
            GeneralUtility::unlink_tempfile($croppedImage);
        }
 
        // If noScale option is applied, we need to reset the width and height to ensure the scaled values
        // are used for the generated image tag even if the image itself is not scaled. This is needed, as
        // the result is discarded due to the fact that the original image is used.
        // @see https://forge.typo3.org/issues/100972
        // Note: This should only happen if no image has been generated ($result === null).
        if ($result === null && ($options['noScale'] ?? false)) {
            $configuration = $task->‪getConfiguration();
            $localProcessedFile = $task->‪getSourceFile()->‪getForLocalProcessing(false);
            $imageDimensions = $imageOperations->getImageDimensions($localProcessedFile);
            $imageScaleInfo = $imageOperations->getImageScale(
                $imageDimensions,
                $configuration['width'] ?? '',
                $configuration['height'] ?? '',
                $options
            );
            $targetFile->updateProperties([
                'width' => $imageScaleInfo[0],
                'height' => $imageScaleInfo[1],
            ]);
        }
 
        return $result;
    }
 
    protected function ‪getConfigurationForImageCropScaleMask(‪ProcessedFile $processedFile): array
    {
        $configuration = $processedFile->‪getProcessingConfiguration();
 
        $options = [];
        if ($configuration['sample'] ?? false) {
            $options['sample'] = true;
        }
        if ($configuration['maxWidth'] ?? false) {
            $options['maxW'] = $configuration['maxWidth'];
        }
        if ($configuration['maxHeight'] ?? false) {
            $options['maxH'] = $configuration['maxHeight'];
        }
        if ($configuration['minWidth'] ?? false) {
            $options['minW'] = $configuration['minWidth'];
        }
        if ($configuration['minHeight'] ?? false) {
            $options['minH'] = $configuration['minHeight'];
        }
 
        $options['noScale'] = $configuration['noScale'] ?? null;
 
        return $options;
    }
 
    protected function ‪getFilenameForImageCropScaleMask(‪TaskInterface $task)
    {
        $configuration = $task->‪getTargetFile()->‪getProcessingConfiguration();
        $targetFileExtension = $configuration['fileExtension'] ?? $task->‪getSourceFile()->‪getExtension();
        return $task->‪getTargetFile()->‪generateProcessedFileNameWithoutExtension() . '.' . ltrim(trim($targetFileExtension), '.');
    }
 
    protected function ‪modifyImageMagickStripProfileParameters(string $parameters, array $configuration)
    {
        // Strips profile information of image to save some space:
        if (isset($configuration['stripProfile'])) {
            if (
                $configuration['stripProfile']
                && ‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileCommand'] !== ''
            ) {
                $parameters = ‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileCommand'] . $parameters;
            } else {
                $parameters .= '###SkipStripProfile###';
            }
        }
        return $parameters;
    }
}