9.5/_rich_text_element_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\RteCKEditor\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\Element\AbstractFormElement;

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

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Localization\Locales;

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

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


class ‪RichTextElement extends ‪AbstractFormElement

{

    protected ‪$defaultFieldInformation = [

        'tcaDescription' => [

            'renderType' => 'tcaDescription',

        ],

    ];


    protected ‪$defaultFieldWizard = [

        'localizationStateSelector' => [

            'renderType' => 'localizationStateSelector',

        ],

        'otherLanguageContent' => [

            'renderType' => 'otherLanguageContent',

            'after' => [

                'localizationStateSelector'

            ],

        ],

        'defaultLanguageDifferences' => [

            'renderType' => 'defaultLanguageDifferences',

            'after' => [

                'otherLanguageContent',

            ],

        ],

    ];


    protected ‪$rteConfiguration = [];


    public function ‪render(): array

    {

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

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

        $config = $parameterArray['fieldConf']['config'];


        $fieldId = $this->‪sanitizeFieldId($parameterArray['itemFormElName']);

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


        $value = $this->data['parameterArray']['itemFormElValue'] ?? '';


        $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);


        $attributes = [

            'style' => 'display:none',

            'data-formengine-validation-rules' => $this->‪getValidationDataAsJsonString($config),

            'id' => $fieldId,

            'name' => htmlspecialchars($itemFormElementName),

        ];


        $html = [];

        $html[] = '<div class="formengine-field-item t3js-formengine-field-item">';

        $html[] =   $fieldInformationHtml;

        $html[] =   '<div class="form-control-wrap">';

        $html[] =       '<div class="form-wizards-wrap">';

        $html[] =           '<div class="form-wizards-element">';

        $html[] =               '<textarea ' . GeneralUtility::implodeAttributes($attributes, true) . '>';

        $html[] =                   htmlspecialchars($value);

        $html[] =               '</textarea>';

        $html[] =           '</div>';

        if (!empty($fieldControlHtml)) {

            $html[] =           '<div class="form-wizards-items-aside">';

            $html[] =               '<div class="btn-group">';

            $html[] =                   $fieldControlHtml;

            $html[] =               '</div>';

            $html[] =           '</div>';

        }

        if (!empty($fieldWizardHtml)) {

            $html[] = '<div class="form-wizards-items-bottom">';

            $html[] = $fieldWizardHtml;

            $html[] = '</div>';

        }

        $html[] =       '</div>';

        $html[] =   '</div>';

        $html[] = '</div>';


        $resultArray['html'] = implode(LF, $html);


        $this->rteConfiguration = $config['richtextConfiguration']['editor'];

        $resultArray['requireJsModules'][] = [

            'ckeditor' => $this->‪getCkEditorRequireJsModuleCode($fieldId)

        ];


        return $resultArray;

    }


    protected function ‪getLanguageIsoCodeOfContent(): string

    {

        $currentLanguageUid = $this->data['databaseRow']['sys_language_uid'];

        if (is_array($currentLanguageUid)) {

            $currentLanguageUid = $currentLanguageUid[0];

        }

        $contentLanguageUid = (int)max($currentLanguageUid, 0);

        if ($contentLanguageUid) {

            $contentLanguage = $this->data['systemLanguageRows'][$currentLanguageUid]['iso'];

        } else {

            $contentLanguage = $this->rteConfiguration['config']['defaultContentLanguage'] ?? 'en_US';

            $languageCodeParts = explode('_', $contentLanguage);

            $contentLanguage = strtolower($languageCodeParts[0]) . ($languageCodeParts[1] ? '_' . strtoupper($languageCodeParts[1]) : '');

            // Find the configured language in the list of localization locales

            ‪$locales = GeneralUtility::makeInstance(Locales::class);

            // If not found, default to 'en'

            if (!in_array($contentLanguage, ‪$locales->getLocales(), true)) {

                $contentLanguage = 'en';

            }

        }

        return $contentLanguage;

    }


    protected function ‪getCkEditorRequireJsModuleCode(string $fieldId): string

    {

        $configuration = $this->‪prepareConfigurationForEditor();


        $externalPlugins = '';

        foreach ($this->‪getExtraPlugins() as $extraPluginName => $extraPluginConfig) {

            $configName = $extraPluginConfig['configName'] ?? $extraPluginName;

            if (!empty($extraPluginConfig['config']) && is_array($extraPluginConfig['config'])) {

                if (empty($configuration[$configName])) {

                    $configuration[$configName] = $extraPluginConfig['config'];

                } elseif (is_array($configuration[$configName])) {

                    $configuration[$configName] = array_replace_recursive($extraPluginConfig['config'], $configuration[$configName]);

                }

            }

            $configuration['extraPlugins'] .= ',' . $extraPluginName;


            $externalPlugins .= 'CKEDITOR.plugins.addExternal(';

            $externalPlugins .= GeneralUtility::quoteJSvalue($extraPluginName) . ',';

            $externalPlugins .= GeneralUtility::quoteJSvalue($extraPluginConfig['resource']) . ',';

            $externalPlugins .= '\'\');';

        }


        $jsonConfiguration = json_encode($configuration);


        // Make a hash of the configuration and append it to CKEDITOR.timestamp

        // This will mitigate browser caching issue when plugins are updated

        $configurationHash = GeneralUtility::shortMD5($jsonConfiguration);


        return 'function(CKEDITOR) {

                CKEDITOR.timestamp += "-' . $configurationHash . '";

                ' . $externalPlugins . '

                require([\'jquery\', \'TYPO3/CMS/Backend/FormEngine\'], function($, FormEngine) {

                    $(function(){

                        var escapedFieldSelector = \'#\' + $.escapeSelector(\'' . $fieldId . '\');

                        CKEDITOR.replace("' . $fieldId . '", ' . $jsonConfiguration . ');

                        CKEDITOR.instances["' . $fieldId . '"].on(\'change\', function(e) {

                            var commands = e.sender.commands;

                            CKEDITOR.instances["' . $fieldId . '"].updateElement();

                            FormEngine.Validation.validate();

                            FormEngine.Validation.markFieldAsChanged($(escapedFieldSelector));


                            // remember changes done in maximized state and mark field as changed, once minimized again

                            if (typeof commands.maximize !== \'undefined\' && commands.maximize.state === 1) {

                                CKEDITOR.instances["' . $fieldId . '"].on(\'maximize\', function(e) {

                                    $(this).off(\'maximize\');

                                    FormEngine.Validation.markFieldAsChanged($(escapedFieldSelector));

                                });

                            }

                        });

                        CKEDITOR.instances["' . $fieldId . '"].on(\'mode\', function() {

                            // detect field changes in source mode

                            if (this.mode === \'source\') {

                                var sourceArea = CKEDITOR.instances["' . $fieldId . '"].editable();

                                sourceArea.attachListener(sourceArea, \'change\', function() {

                                    FormEngine.Validation.markFieldAsChanged($(escapedFieldSelector));

                                });

                            }

                        });

                        $(document).on(\'inline:sorting-changed\', function() {

                            CKEDITOR.instances["' . $fieldId . '"].destroy();

                            CKEDITOR.replace("' . $fieldId . '", ' . $jsonConfiguration . ');

                        });

                        $(document).on(\'flexform:sorting-changed\', function() {

                            CKEDITOR.instances["' . $fieldId . '"].destroy();

                            CKEDITOR.replace("' . $fieldId . '", ' . $jsonConfiguration . ');

                        });

                    });

                });

        }';

    }


    protected function ‪getExtraPlugins(): array

    {

        $urlParameters = [

            'P' => [

                'table'      => $this->data['tableName'],

                'uid'        => $this->data['databaseRow']['uid'],

                'fieldName'  => $this->data['fieldName'],

                'recordType' => $this->data['recordTypeValue'],

                'pid'        => $this->data['effectivePid'],

                'richtextConfigurationName' => $this->data['parameterArray']['fieldConf']['config']['richtextConfigurationName']

            ]

        ];


        $pluginConfiguration = [];

        if (isset($this->rteConfiguration['externalPlugins']) && is_array($this->rteConfiguration['externalPlugins'])) {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            foreach ($this->rteConfiguration['externalPlugins'] as $pluginName => $configuration) {

                $pluginConfiguration[$pluginName] = [

                    'configName' => $configuration['configName'] ?? $pluginName,

                    'resource' => $this->‪resolveUrlPath($configuration['resource'])

                ];

                unset($configuration['configName'], $configuration['resource']);


                if ($configuration['route']) {

                    $configuration['routeUrl'] = (string)$uriBuilder->buildUriFromRoute($configuration['route'], $urlParameters);

                }


                $pluginConfiguration[$pluginName]['config'] = $configuration;

            }

        }

        return $pluginConfiguration;

    }


    protected function ‪replaceLanguageFileReferences(array $configuration): array

    {

        foreach ($configuration as $key => $value) {

            if (is_array($value)) {

                $configuration[$key] = $this->‪replaceLanguageFileReferences($value);

            } elseif (is_string($value) && stripos($value, 'LLL:') === 0) {

                $configuration[$key] = $this->‪getLanguageService()->‪sL($value);

            }

        }

        return $configuration;

    }


    protected function ‪replaceAbsolutePathsToRelativeResourcesPath(array $configuration): array

    {

        foreach ($configuration as $key => $value) {

            if (is_array($value)) {

                $configuration[$key] = $this->‪replaceAbsolutePathsToRelativeResourcesPath($value);

            } elseif (is_string($value) && stripos($value, 'EXT:') === 0) {

                $configuration[$key] = $this->‪resolveUrlPath($value);

            }

        }

        return $configuration;

    }


    protected function ‪resolveUrlPath(string $value): string

    {

        $value = GeneralUtility::getFileAbsFileName($value);

        return ‪PathUtility::getAbsoluteWebPath($value);

    }


    protected function ‪prepareConfigurationForEditor(): array

    {

        // Ensure custom config is empty so nothing additional is loaded

        // Of course this can be overridden by the editor configuration below

        $configuration = [

            'customConfig' => '',

        ];


        if (is_array($this->rteConfiguration['config'])) {

            $configuration = array_replace_recursive($configuration, $this->rteConfiguration['config']);

        }

        // Set the UI language of the editor if not hard-coded by the existing configuration

        if (empty($configuration['language'])) {

            $configuration['language'] = $this->‪getBackendUser()->uc['lang'] ?: ($this->‪getBackendUser()->user['lang'] ?: 'en');

        }

        $configuration['contentsLanguage'] = $this->‪getLanguageIsoCodeOfContent();


        // Replace all label references

        $configuration = $this->‪replaceLanguageFileReferences($configuration);

        // Replace all paths

        $configuration = $this->‪replaceAbsolutePathsToRelativeResourcesPath($configuration);


        // there are some places where we define an array, but it needs to be a list in order to work

        if (is_array($configuration['extraPlugins'])) {

            $configuration['extraPlugins'] = implode(',', $configuration['extraPlugins']);

        }

        if (is_array($configuration['removePlugins'])) {

            $configuration['removePlugins'] = implode(',', $configuration['removePlugins']);

        }

        if (is_array($configuration['removeButtons'])) {

            $configuration['removeButtons'] = implode(',', $configuration['removeButtons']);

        }


        return $configuration;

    }


    protected function ‪sanitizeFieldId(string $itemFormElementName): string

    {

        $fieldId = preg_replace('/[^a-zA-Z0-9_:.-]/', '_', $itemFormElementName);

        return htmlspecialchars(preg_replace('/^[^a-zA-Z]/', 'x', $fieldId));

    }


    protected function ‪getBackendUser()

    {

        return ‪$GLOBALS['BE_USER'];

    }

}