9.5/_image_manipulation_element_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Backend\Form\Element;


/*

 * 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!

 */


use ‪TYPO3\CMS\Backend\Form\NodeFactory;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Core\Imaging\ImageManipulation\Area;

use ‪TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;

use ‪TYPO3\CMS\Core\Imaging\ImageManipulation\InvalidConfigurationException;

use ‪TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;

use ‪TYPO3\CMS\Core\Resource\File;

use ‪TYPO3\CMS\Core\Resource\ResourceFactory;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\Utility\MathUtility;

use ‪TYPO3\CMS\Core\Utility\StringUtility;

use ‪TYPO3\CMS\Fluid\View\StandaloneView;


class ‪ImageManipulationElement extends ‪AbstractFormElement

{

    private ‪$wizardRouteName = 'ajax_wizard_image_manipulation';


    protected static ‪$defaultConfig = [

        'file_field' => 'uid_local',

        'allowedExtensions' => null, // default: $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']

        'cropVariants' => [

            'default' => [

                'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.crop_variant.default',

                'allowedAspectRatios' => [

                    '16:9' => [

                        'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.ratio.16_9',

                        'value' => 16 / 9

                    ],

                    '3:2' => [

                        'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.ratio.3_2',

                        'value' => 3 / 2

                    ],

                    '4:3' => [

                        'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.ratio.4_3',

                        'value' => 4 / 3

                    ],

                    '1:1' => [

                        'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.ratio.1_1',

                        'value' => 1.0

                    ],

                    'NaN' => [

                        'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_wizards.xlf:imwizard.ratio.free',

                        'value' => 0.0

                    ],

                ],

                'selectedRatio' => 'NaN',

                'cropArea' => [

                    'x' => 0.0,

                    'y' => 0.0,

                    'width' => 1.0,

                    'height' => 1.0,

                ],

            ],

        ]

    ];


    protected ‪$defaultFieldInformation = [

        'tcaDescription' => [

            'renderType' => 'tcaDescription',

        ],

    ];


    protected ‪$defaultFieldWizard = [

        'localizationStateSelector' => [

            'renderType' => 'localizationStateSelector',

        ],

        'otherLanguageContent' => [

            'renderType' => 'otherLanguageContent',

            'after' => [

                'localizationStateSelector'

            ],

        ],

        'defaultLanguageDifferences' => [

            'renderType' => 'defaultLanguageDifferences',

            'after' => [

                'otherLanguageContent',

            ],

        ],

    ];


    protected ‪$templateView;


    protected ‪$uriBuilder;


    public function ‪__construct(‪NodeFactory ‪$nodeFactory, array ‪$data)

    {

        parent::__construct(‪$nodeFactory, ‪$data);

        // Would be great, if we could inject the view here, but since the constructor is in the interface, we can't

        $this->templateView = GeneralUtility::makeInstance(StandaloneView::class);

        $this->templateView->setLayoutRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Layouts/')]);

        $this->templateView->setPartialRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Partials/ImageManipulation/')]);

        $this->templateView->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/ImageManipulation/ImageManipulationElement.html'));

        $this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

    }


    public function ‪render()

    {

        $resultArray = $this->‪initializeResultArray();

        $parameterArray = $this->data['parameterArray'];

        $config = $this->‪populateConfiguration($parameterArray['fieldConf']['config']);


        $file = $this->‪getFile($this->data['databaseRow'], $config['file_field']);

        if (!$file) {

            // Early return in case we do not find a file

            return $resultArray;

        }


        $config = $this->‪processConfiguration($config, $parameterArray['itemFormElValue'], $file);


        $fieldInformationResult = $this->‪renderFieldInformation();

        $fieldInformationHtml = $fieldInformationResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldInformationResult, false);


        $fieldControlResult = $this->‪renderFieldControl();

        $fieldControlHtml = $fieldControlResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldControlResult, false);


        $fieldWizardResult = $this->‪renderFieldWizard();

        $fieldWizardHtml = $fieldWizardResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldWizardResult, false);


        $arguments = [

            'fieldInformation' => $fieldInformationHtml,

            'fieldControl' => $fieldControlHtml,

            'fieldWizard' => $fieldWizardHtml,

            'isAllowedFileExtension' => in_array(strtolower($file->getExtension()), GeneralUtility::trimExplode(',', strtolower($config['allowedExtensions'])), true),

            'image' => $file,

            'formEngine' => [

                'field' => [

                    'value' => $parameterArray['itemFormElValue'],

                    'name' => $parameterArray['itemFormElName']

                ],

                'validation' => '[]'

            ],

            'config' => $config,

            'wizardUri' => $this->‪getWizardUri(),

            'wizardPayload' => json_encode($this->‪getWizardPayload($config['cropVariants'], $file)),

            'previewUrl' => $this->‪getPreviewUrl($this->data['databaseRow'], $file),

        ];


        if ($arguments['isAllowedFileExtension']) {

            $resultArray['requireJsModules'][] = [

                'TYPO3/CMS/Backend/ImageManipulation' => 'function (ImageManipulation) {top.require(["cropper"], function() { ImageManipulation.initializeTrigger(); }); }'

            ];

            $arguments['formEngine']['field']['id'] = ‪StringUtility::getUniqueId('formengine-image-manipulation-');

            if (GeneralUtility::inList($config['eval'], 'required')) {

                $arguments['formEngine']['validation'] = $this->‪getValidationDataAsJsonString(['required' => true]);

            }

        }

        $this->templateView->assignMultiple($arguments);

        $resultArray['html'] = $this->templateView->render();


        return $resultArray;

    }


    protected function ‪getFile(array $row, $fieldName)

    {

        $file = null;

        $fileUid = !empty($row[$fieldName]) ? $row[$fieldName] : null;

        if (is_array($fileUid) && isset($fileUid[0]['uid'])) {

            $fileUid = $fileUid[0]['uid'];

        }

        if (‪MathUtility::canBeInterpretedAsInteger($fileUid)) {

            try {

                $file = ‪ResourceFactory::getInstance()->‪getFileObject($fileUid);

            } catch (FileDoesNotExistException $e) {

            } catch (\InvalidArgumentException $e) {

            }

        }

        return $file;

    }


    protected function ‪getPreviewUrl(array $databaseRow, ‪File $file): string

    {

        $previewUrl = '';

        // Hook to generate a preview URL

        $hookParameters = [

            'databaseRow' => $databaseRow,

            'file' => $file,

            'previewUrl' => $previewUrl,

        ];

        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['Backend/Form/Element/ImageManipulationElement']['previewUrl'] ?? [] as $listener) {

            $previewUrl = GeneralUtility::callUserFunction($listener, $hookParameters, $this);

        }

        return $previewUrl;

    }


    protected function ‪populateConfiguration(array $baseConfiguration)

    {

        ‪$defaultConfig = ‪self::$defaultConfig;


        // If ratios are set do not add default options

        if (isset($baseConfiguration['cropVariants'])) {

            unset(‪$defaultConfig['cropVariants']);

        }


        $config = array_replace_recursive(‪$defaultConfig, $baseConfiguration);


        if (!is_array($config['cropVariants'])) {

            throw new ‪InvalidConfigurationException('Crop variants configuration must be an array', 1485377267);

        }


        $cropVariants = [];

        foreach ($config['cropVariants'] as $id => $cropVariant) {

            // Ignore disabled crop variants

            if (!empty($cropVariant['disabled'])) {

                continue;

            }

            // Enforce a crop area (default is full image)

            if (empty($cropVariant['cropArea'])) {

                $cropVariant['cropArea'] = ‪Area::createEmpty()->‪asArray();

            }

            $cropVariants[$id] = $cropVariant;

        }


        $config['cropVariants'] = $cropVariants;


        // By default we allow all image extensions that can be handled by the GFX functionality

        if ($config['allowedExtensions'] === null) {

            $config['allowedExtensions'] = ‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'];

        }

        return $config;

    }


    protected function ‪processConfiguration(array $config, string &$elementValue, ‪File $file)

    {

        $cropVariantCollection = ‪CropVariantCollection::create($elementValue, $config['cropVariants']);

        if (empty($config['readOnly']) && !empty($file->‪getProperty('width'))) {

            $cropVariantCollection = $cropVariantCollection->applyRatioRestrictionToSelectedCropArea($file);

            $elementValue = (string)$cropVariantCollection;

        }

        $config['cropVariants'] = $cropVariantCollection->asArray();

        $config['allowedExtensions'] = implode(', ', GeneralUtility::trimExplode(',', $config['allowedExtensions'], true));

        return $config;

    }


    protected function ‪getWizardUri(): string

    {

        return (string)$this->uriBuilder->buildUriFromRoute($this->wizardRouteName);

    }


    protected function ‪getWizardPayload(array $cropVariants, ‪File $image): array

    {

        $arguments = [

            'cropVariants' => $cropVariants,

            'image' => $image->‪getUid(),

        ];

        $uriArguments['arguments'] = json_encode($arguments);

        $uriArguments['signature'] = GeneralUtility::hmac($uriArguments['arguments'], $this->wizardRouteName);


        return $uriArguments;

    }

}