cms-backend/Classes/Wizard/PageWizardStepBuilder.php

<?php

declare(strict_types=1);

/*
 * 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\Backend\Wizard;

use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Form\FormDataCompiler;
use TYPO3\CMS\Backend\Form\FormDataGroup\TcaDatabaseRecord;
use TYPO3\CMS\Backend\Form\FormResultFactory;
use TYPO3\CMS\Backend\Form\NodeFactory;
use TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Backend\Wizard\DTO\Step;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;
use TYPO3\CMS\Core\Schema\Exception\UndefinedSchemaException;
use TYPO3\CMS\Core\Schema\Field\FieldCollection;
use TYPO3\CMS\Core\Schema\Field\FieldTypeInterface;
use TYPO3\CMS\Core\Schema\Struct\WizardStep;
use TYPO3\CMS\Core\Schema\TcaSchema;
use TYPO3\CMS\Core\Schema\TcaSchemaFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\StringUtility;

/**
 * @internal This is not a public API method, do not use in own extensions
 */
final readonly class PageWizardStepBuilder
{
    public function __construct(
        private TcaSchemaFactory $tcaSchemaFactory,
        private UriBuilder $uriBuilder,
        private NodeFactory $nodeFactory,
        private FormResultFactory $formResultFactory,
        private FormDataCompiler $formDataCompiler,
    ) {}

    /**
     * @throws UndefinedSchemaException
     */
    public function getStepsForDokType(string $dokType, int $pageUid, ServerRequestInterface $serverRequest): array
    {
        $steps = [];
        $dokTypeSchema = $this->getSchemaForDokType($dokType);
        $requiredFields = $dokTypeSchema->getFields(fn(FieldTypeInterface $field) => $field->isRequired())->getNames();
        $newId = StringUtility::getUniqueId('NEW');

        foreach ($dokTypeSchema->getWizardSteps() as $wizardStep) {
            $requiredFields = array_diff($requiredFields, $wizardStep->getFields()->getNames());
            $formData = $this->getFormData($serverRequest, $dokType, $pageUid, $wizardStep, $newId);
            $steps[] = $this->buildStep($wizardStep, $formData);
        }

        if ($requiredFields !== []) {
            $requiredStep = new WizardStep('requiredFields', $this->getLanguageService()->sL('core.wizard:wizard.step.required'), $this->getFieldCollection($requiredFields, $dokTypeSchema));
            $formData = $this->getFormData($serverRequest, $dokType, $pageUid, $requiredStep, $newId);

            $visibleRequiredFields = array_intersect($requiredFields, array_keys($formData['processedTca']['columns'] ?? []));
            if ($visibleRequiredFields !== []) {
                $steps[] = $this->buildStep($requiredStep, $formData);
            }
        }

        return $steps;
    }

    private function buildStep(WizardStep $wizardStep, array $formData): Step
    {
        $formResult = $this->nodeFactory->create($formData)->render();
        $formResult = $this->formResultFactory->create($formResult);

        return Step::create('@typo3/backend/page-wizard/steps/form-engine-step.js')
            ->withConfigurationData([
                'title' => $this->getLanguageService()->sL($wizardStep->getTitle()),
                'key' => $wizardStep->getIdentifier(),
                'html' => '<form name="editform">' . $formResult->html . '<input type="submit" hidden></form>',
                'modules' => [
                    JavaScriptModuleInstruction::create('@typo3/backend/form-engine.js')
                        ->invoke(
                            'initialize',
                            (string)$this->uriBuilder->buildUriFromRoute('wizard_element_browser')
                        ),
                    ...$formResult->javaScriptModules,
                ],
                'labels' => $this->getLabelsForFields($formData),
            ]);
    }

    private function getFormData(ServerRequestInterface $serverRequest, string $doktype, int $pid, WizardStep $wizardStep, string $newId): array
    {
        $fieldList = implode(',', $wizardStep->getFields()->getNames());

        $formDataCompilerInput = [
            'request' => $serverRequest,
            'tableName' => 'pages',
            'recordTypeValue' => $doktype,
            'command' => 'new',
            'vanillaUid' => $pid,
            'processedTca' => $GLOBALS['TCA']['pages'],
            'databaseRow' => [
                'uid' => $newId,
            ],
        ];
        $formDataCompilerInput['processedTca']['types'][$doktype]['showitem'] = $fieldList;

        $formData = $this->formDataCompiler->compile($formDataCompilerInput, GeneralUtility::makeInstance(TcaDatabaseRecord::class));
        $formData['renderType'] = 'listOfFieldsContainer';
        $formData['fieldListToRender'] = $fieldList;
        return $formData;
    }

    private function getFieldCollection(array $fieldNames, TcaSchema $tcaSchema): FieldCollection
    {
        $fields = [];
        foreach ($fieldNames as $fieldName) {
            $fields[$fieldName] = $tcaSchema->getField($fieldName);
        }
        return new FieldCollection($fields);
    }

    private function getLabelsForFields(array $formData): array
    {
        $labels = [];
        $processedFields = $formData['processedTca']['columns'] ?? [];

        foreach ($processedFields as $fieldName => $fieldConfiguration) {
            $labels[$fieldName] = $fieldConfiguration['label'] ?? '';
        }

        return $labels;
    }

    /**
     * @throws UndefinedSchemaException
     * @throws \RuntimeException
     */
    private function getSchemaForDokType(string $dokType): TcaSchema
    {
        $tcaSchema = $this->tcaSchemaFactory->get('pages');
        if (!$tcaSchema->hasSubSchema($dokType)) {
            throw new \RuntimeException('Requested doktype is missing.', 1773673880);
        }
        return $tcaSchema->getSubSchema($dokType);
    }

    private function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }
}