Your IP : 216.73.216.220
<?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;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Frontend\Imaging\GifBuilder;
/**
* Helper class to locally perform a crop/scale/mask task with the TYPO3 image processing classes.
*/
class LocalCropScaleMaskHelper
{
/**
* This method actually does the processing of files locally
*
* Takes the original file (for remote storages this will be fetched from the remote server),
* does the IM magic on the local server by creating a temporary typo3temp/ file,
* copies the typo3temp/ file to the processing folder of the target storage and
* removes the typo3temp/ file.
*
* The returned array has the following structure:
* width => 100
* height => 200
* filePath => /some/path
*
* If filePath isn't set but width and height are the original file is used as ProcessedFile
* with the returned width and height. This is for example useful for SVG images.
*
* @param TaskInterface $task
* @return array|null
*/
public function process(TaskInterface $task)
{
return $this->processWithLocalFile($task, $task->getSourceFile()->getForLocalProcessing(false));
}
/**
* Does the heavy lifting prescribed in processTask()
* except that the processing can be performed on any given local image
*/
public function processWithLocalFile(TaskInterface $task, string $originalFileName): ?array
{
$result = null;
$targetFile = $task->getTargetFile();
$gifBuilder = GeneralUtility::makeInstance(GifBuilder::class);
$configuration = $targetFile->getProcessingConfiguration();
$configuration['additionalParameters'] = $this->modifyImageMagickStripProfileParameters((string)($configuration['additionalParameters'] ?? ''), $configuration);
if (empty($configuration['fileExtension'])) {
$configuration['fileExtension'] = $task->getTargetFileExtension();
}
$options = $this->getConfigurationForImageCropScaleMask($targetFile, $gifBuilder);
$croppedImage = null;
if (!empty($configuration['crop'])) {
// check if it is a json object
$cropData = json_decode($configuration['crop']);
if ($cropData) {
$offsetLeft = (int)($cropData->x ?? 0);
$offsetTop = (int)($cropData->y ?? 0);
$newWidth = (int)($cropData->width ?? 0);
$newHeight = (int)($cropData->height ?? 0);
} else {
[$offsetLeft, $offsetTop, $newWidth, $newHeight] = explode(',', $configuration['crop'], 4);
}
$backupPrefix = $gifBuilder->filenamePrefix;
$gifBuilder->filenamePrefix = 'crop_';
$jpegQuality = MathUtility::forceIntegerInRange($GLOBALS['TYPO3_CONF_VARS']['GFX']['jpg_quality'], 10, 100, 85);
// the result info is an array with 0=width,1=height,2=extension,3=filename
$result = $gifBuilder->imageMagickConvert(
$originalFileName,
$configuration['fileExtension'],
'',
'',
sprintf('-crop %dx%d+%d+%d +repage -quality %d', $newWidth, $newHeight, $offsetLeft, $offsetTop, $jpegQuality),
'',
['noScale' => true],
true
);
$gifBuilder->filenamePrefix = $backupPrefix;
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 = $gifBuilder->imageMagickConvert(
$originalFileName,
$configuration['fileExtension'],
$configuration['width'] ?? '',
$configuration['height'] ?? '',
$configuration['additionalParameters'],
$configuration['frame'] ?? '',
$options,
// in case file is in `/typo3temp/`, it must create a result
$this->isTemporaryFile($originalFileName)
);
} 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) {
$temporaryExtension = 'png';
if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_allowTemporaryMasksAsPng']) {
// If ImageMagick version 5+
$temporaryExtension = $gifBuilder->gifExtension;
}
$tempFileInfo = $gifBuilder->imageMagickConvert(
$originalFileName,
$temporaryExtension,
$configuration['width'] ?? '',
$configuration['height'] ?? '',
$configuration['additionalParameters'],
$configuration['frame'] ?? '',
$options
);
if (is_array($tempFileInfo)) {
$maskBottomImage = $configuration['maskImages']['maskBottomImage'];
if ($maskBottomImage instanceof FileInterface) {
$maskBottomImageMask = $configuration['maskImages']['maskBottomImageMask'];
} else {
$maskBottomImageMask = null;
}
// Scaling: ****
$tempScale = [];
$command = '-geometry ' . $tempFileInfo[0] . 'x' . $tempFileInfo[1] . '!';
$command = $this->modifyImageMagickStripProfileParameters($command, $configuration);
$tmpStr = $gifBuilder->randomName();
// m_mask
$tempScale['m_mask'] = $tmpStr . '_mask.' . $temporaryExtension;
$gifBuilder->imageMagickExec($maskImage->getForLocalProcessing(true), $tempScale['m_mask'], $command);
// m_bgImg
$tempScale['m_bgImg'] = $tmpStr . '_bgImg.miff';
$gifBuilder->imageMagickExec($maskBackgroundImage->getForLocalProcessing(), $tempScale['m_bgImg'], $command);
// m_bottomImg / m_bottomImg_mask
if ($maskBottomImage instanceof FileInterface && $maskBottomImageMask instanceof FileInterface) {
$tempScale['m_bottomImg'] = $tmpStr . '_bottomImg.' . $temporaryExtension;
$gifBuilder->imageMagickExec($maskBottomImage->getForLocalProcessing(), $tempScale['m_bottomImg'], $command);
$tempScale['m_bottomImg_mask'] = ($tmpStr . '_bottomImg_mask.') . $temporaryExtension;
$gifBuilder->imageMagickExec($maskBottomImageMask->getForLocalProcessing(), $tempScale['m_bottomImg_mask'], $command);
// BEGIN combining:
// The image onto the background
$gifBuilder->combineExec($tempScale['m_bgImg'], $tempScale['m_bottomImg'], $tempScale['m_bottomImg_mask'], $tempScale['m_bgImg']);
}
// The image onto the background
$gifBuilder->combineExec($tempScale['m_bgImg'], $tempFileInfo[3], $tempScale['m_mask'], $temporaryFileName);
$tempFileInfo[3] = $temporaryFileName;
// Unlink the temp-images...
foreach ($tempScale as $tempFile) {
if (@is_file($tempFile)) {
unlink($tempFile);
}
}
}
$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)) {
$imageOperations = GeneralUtility::makeInstance(GraphicalFunctions::class);
$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;
}
/**
* @return array
*/
protected function getConfigurationForImageCropScaleMask(ProcessedFile $processedFile, GifBuilder $gifBuilder)
{
$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;
}
/**
* Returns the filename for a cropped/scaled/masked file.
*
* @return string
*/
protected function getFilenameForImageCropScaleMask(TaskInterface $task)
{
$configuration = $task->getTargetFile()->getProcessingConfiguration();
$targetFileExtension = $task->getSourceFile()->getExtension();
$processedFileExtension = $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png'] ? 'png' : 'gif';
if (is_array($configuration['maskImages']) && $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_enabled'] && $task->getSourceFile()->getExtension() != $processedFileExtension) {
$targetFileExtension = 'jpg';
} elseif ($configuration['fileExtension']) {
$targetFileExtension = $configuration['fileExtension'];
}
return $task->getTargetFile()->generateProcessedFileNameWithoutExtension() . '.' . ltrim(trim($targetFileExtension), '.');
}
/**
* Modifies the parameters for ImageMagick for stripping of profile information.
*
* @param string $parameters The parameters to be modified (if required)
* @param array $configuration The TypoScript configuration of [IMAGE].file
* @return string
*/
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;
}
protected function isTemporaryFile(string $filePath): bool
{
return str_starts_with($filePath, Environment::getPublicPath() . '/typo3temp/');
}
}