HtmlViewHelperTest.php

Go to the documentation of this file.

<?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\Fluid\Tests\Functional\ViewHelpers\Format;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Tests\Functional\SiteHandling\SiteBasedTestTrait;
use ‪TYPO3\CMS\Fluid\Core\Rendering\RenderingContextFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\Frontend\InternalRequest;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
use TYPO3Fluid\Fluid\View\TemplateView;
 
final class ‪HtmlViewHelperTest extends FunctionalTestCase
{
    use ‪SiteBasedTestTrait;
 
    protected const ‪LANGUAGE_PRESETS = [
        'EN' => ['id' => 0, 'title' => 'English', 'locale' => 'en_US.UTF8'],
    ];
 
    public static function ‪contentIsRenderedDataProvider(): array
    {
        return [
            'format.html: process lib.parseFunc_RTE by default' => [
                '<f:format.html>{$project} is a cool CMS</f:format.html>',
                'TYPO3 is a cool CMS',
            ],
            'format.html: process inline notation with undefined variable returns empty string' => [
                '{undefinedVariable -> f:format.html()}',
                '',
            ],
            'format.html: process specific TS path' => [
                '<f:format.html parseFuncTSPath="lib.foo">{$foo} is BAR</f:format.html>',
                'BAR is BAR',
            ],
            'format.html: specific TS path with current' => [
                '<f:format.html parseFuncTSPath="lib.inventor" current="Kasper">Hello</f:format.html>',
                'Hello Kasper',
            ],
            'format.html: specific TS path with data' => [
                '<f:format.html parseFuncTSPath="lib.record" data="{uid: 1, pid: 12, title: \'foo\'}">Hello</f:format.html>',
                'Hello foo',
            ],
            'format.html: specific TS path with data and currentValueKey' => [
                '<f:format.html parseFuncTSPath="lib.record" data="{uid: 1, pid: 12, title: \'Bar\'}" currentValueKey="title">Hello</f:format.html>',
                'Hello Bar',
            ],
            'format.html: specific TS path with data, currentValueKey and a constant' => [
                '<f:format.html parseFuncTSPath="lib.news" data="{uid: 1, pid: 12, title: \'Great news\'}" currentValueKey="title">{$project} news:</f:format.html>',
                'TYPO3 news: Great news',
            ],
            // table attribute is hard to test. It was only used as parent for CONTENT and RECORD cObj.
            // Further the table will be used in FILES cObj as fallback, if a table was not given in references array.
        ];
    }
 
    #[DataProvider('contentIsRenderedDataProvider')]
    #[Test]
    public function ‪contentIsRendered(string $fluidTemplateSource, string $expected): void
    {
        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/pages.csv');
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(1, '/'),
            [
                $this->‪buildDefaultLanguageConfiguration('EN', '/en/'),
            ]
        );
        $this->‪createTypoScriptTemplate($fluidTemplateSource);
 
        $response = $this->executeFrontendSubRequest(
            (new InternalRequest())->withPageId(1)
        );
        self::assertStringContainsString($expected, (string)$response->getBody());
    }
 
    public static function ‪invalidInvocationIsDeterminedDataProvider(): array
    {
        return [
            'explicitly empty parseFunc path' => [
                '<f:format.html parseFuncTSPath="">TYPO3 is a cool CMS</f:format.html>',
            ],
            'non-existing parseFunc path' => [
                '<f:format.html parseFuncTSPath="null.this.does.not.exist">TYPO3 is a cool CMS</f:format.html>',
            ],
        ];
    }
 
    #[DataProvider('invalidInvocationIsDeterminedDataProvider')]
    #[Test]
    public function ‪invalidInvocationIsDetermined(string $fluidTemplateSource): void
    {
        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/pages.csv');
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(1, '/'),
            [
                $this->‪buildDefaultLanguageConfiguration('EN', '/en/'),
            ]
        );
        $this->‪createTypoScriptTemplate($fluidTemplateSource);
 
        $this->expectException(\LogicException::class);
        $this->expectExceptionCode(1641989097);
        $this->executeFrontendSubRequest(
            (new InternalRequest())->withPageId(1)
        );
    }
 
    private function ‪createTypoScriptTemplate(string $fluidTemplateSource): void
    {
        (new ‪ConnectionPool())->getConnectionForTable('sys_template')
            ->insert(
                'sys_template',
                [
                    'pid' => 1,
                    'root' => 1,
                    'clear' => 3,
                    'constants' => <<<EOT
project = ‪TYPO3
foo = BAR
EOT,
                    'config' => <<<EOT
lib.parseFunc_RTE {
    htmlSanitize = 1
}
lib.foo {
    htmlSanitize = 1
}
lib.inventor {
    htmlSanitize = 1
    plainTextStdWrap.noTrimWrap = || |
    plainTextStdWrap.dataWrap = |{CURRENT:1}
}
lib.record {
    htmlSanitize = 1
    plainTextStdWrap.noTrimWrap = || |
    plainTextStdWrap.dataWrap = |{FIELD:title}
}
lib.news {
    htmlSanitize = 1
    plainTextStdWrap.noTrimWrap = || |
    plainTextStdWrap.dataWrap = |{CURRENT:1}
}
page = PAGE
page.10 = FLUIDTEMPLATE
page.10 {
    template = TEXT
    template.value = $fluidTemplateSource
}
EOT
                ]
            );
    }
 
    #[Test]
    public function throwsExceptionIfCalledInBackendContext(): void
    {
        $context = $this->get(RenderingContextFactory::class)->create();
        $request = (new ‪ServerRequest())
            ->withAttribute('applicationType', ‪SystemEnvironmentBuilder::REQUESTTYPE_BE);
        $context->setRequest($request);
        $context->getTemplatePaths()->setTemplateSource('<f:format.html>TYPO3 is a cool CMS</f:format.html>');
 
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1686813703);
        $this->expectExceptionMessage('Using f:format.html in backend context is not allowed. Use f:sanitize.html or f:transform.html instead.');
 
        (new TemplateView($context))->render();
    }
}