N°6405 - Fix XML displayed corrupted when using \DesignerLongTextField due to usage of \utils::EscapeHtml() without double encoding

This commit is contained in:
Molkobain
2023-06-21 11:32:52 +02:00
parent 2074a0fa0d
commit 216a1b95b1
5 changed files with 133 additions and 10 deletions

View File

@@ -0,0 +1,82 @@
<?php
/**
* Copyright (C) 2018 Dennis Lassiter
*
* This file is part of iTop.
*
* iTop is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* iTop is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with iTop. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace Combodo\iTop\Test\UnitTest\Application;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use DesignerXMLField;
use utils;
/**
* @covers DesignerFormField
*/
class DesignerFormFieldTest extends ItopTestCase
{
/**
* @param string $sFieldFQCN
* @param string $sInputValue
* @param string $sExpectedValue
*
* @return void
* @throws \ReflectionException
* @covers DesignerLongTextField::PrepareValueForRendering
* @dataProvider PrepareValueForRenderingProvider
*/
public function testPrepareValueForRendering(string $sFieldFQCN, string $sInputValue, string $sExpectedValue)
{
$oField = new $sFieldFQCN('field_code', 'Field label', $sInputValue);
$sTestedValue = $this->InvokeNonPublicMethod($sFieldFQCN, 'PrepareValueForRendering', $oField, []);
$this->assertEquals($sExpectedValue, $sTestedValue);
}
public function PrepareValueForRenderingProvider(): array
{
return [
'DesignerLongTextField should not double encode XML' => [
'\\DesignerLongTextField',
<<<XML
<root>
<title id="title">Foo &amp; Bar</title>
</root>
XML,
<<<HTML
&lt;root&gt;
&lt;title id=&quot;title&quot;&gt;Foo &amp; Bar&lt;/title&gt;
&lt;/root&gt;
HTML
],
'DesignerXMLField should double encode XML' => [
'\\DesignerXMLField',
<<<XML
<root>
<title id="title">Foo &amp; Bar</title>
</root>
XML,
<<<HTML
&lt;root&gt;
&lt;title id=&quot;title&quot;&gt;Foo &amp;amp; Bar&lt;/title&gt;
&lt;/root&gt;
HTML
],
];
}
}

View File

@@ -841,17 +841,19 @@ class utilsTest extends ItopTestCase
*
* @dataProvider escapeHtmlProvider
*/
public function testEscapeHtml($sInput, $sExpectedEscaped)
public function testEscapeHtml($sInput, $sExpectedEscaped, $bDoubleEncode = false)
{
if (is_null($sExpectedEscaped)) {
$sExpectedEscaped = $sInput;
}
$sEscaped = utils::EscapeHtml($sInput);
$sEscaped = utils::EscapeHtml($sInput, $bDoubleEncode);
self::assertSame($sExpectedEscaped, $sEscaped);
$sEscapedDecoded = utils::EscapedHtmlDecode($sEscaped);
self::assertSame($sInput, $sEscapedDecoded);
if (false === $bDoubleEncode) {
self::assertSame($sInput, $sEscapedDecoded);
}
}
public function escapeHtmlProvider()
@@ -859,8 +861,17 @@ class utilsTest extends ItopTestCase
return [
'no escape' => ['abcdefghijklmnop', null],
'&amp;' => ['abcdefghijklmnop&0123456789', 'abcdefghijklmnop&amp;0123456789'],
['"double quotes"', '&quot;double quotes&quot;'],
["'simple quotes'", '&apos;simple quotes&apos;'],
'double quotes' => ['"double quotes"', '&quot;double quotes&quot;'],
'simple quotes' => ["'simple quotes'", '&apos;simple quotes&apos;'],
'no double encode' => [
'<root><title>Foo & Bar</title></root>',
'&lt;root&gt;&lt;title&gt;Foo &amp; Bar&lt;/title&gt;&lt;/root&gt;'
],
'double encode forced (for XML mostly)' => [
'<root><title>Foo &amp; Bar</title></root>',
'&lt;root&gt;&lt;title&gt;Foo &amp;amp; Bar&lt;/title&gt;&lt;/root&gt;',
true
],
];
}
}