wiki.techinc.nl/tests/phpunit/includes/Html/HtmlTest.php
C. Scott Ananian 94f193a894 SECURITY: Ensure emitted HTML is safe against Unicode NFC normalization
CVE-2025-32699

Ensure that Unicode NFC normalization can be applied to our HTML
output safely.  Even though the W3C officially recommends against
normalizing HTML

https://www.w3.org/International/questions/qa-html-css-normalization#converting

this is still easily done inadvertently, especially when using the
MediaWiki action API which normalizes parameters and results by
default.

See also I671648603c4635a35585c860b4857f5ea085e47f in Parsoid, and
T266140 / I2e78e660ba1867744e34eda7d00ea527ec016b71 for another similar
issue.

The following changes are made:

* The various HTML serializers (Remex/Tidy-derived, as well as the
  Html::* helpers) are tweaked to entity-escape U+0338 wherever it
  appears.

* Similarly, Message::escaped() is tweaked to entity-escape U+0338.

* Finally, a post-processing pass is added to the OutputTransform
  pipeline to catch any remaining U+0338 and entity-escape them.
  This catches U+0338 added during any of the previous OutputTransform
  stages (like TOC insertion, section edit links, etc).
  *When backporting* this code will likely need to be moved to
  ParserOutput::getText(), as the OutputTransform pipeline wasn't added
  until MW 1.42.

Bug: T387130
Change-Id: I66564e14e730f5393f4fa5780b80f24de6075af5
2025-04-10 15:56:06 +01:00

984 lines
29 KiB
PHP

<?php
use MediaWiki\Html\Html;
use MediaWiki\Html\HtmlJsCode;
use MediaWiki\MainConfigNames;
/**
* @covers \MediaWiki\Html\Html
*/
class HtmlTest extends MediaWikiIntegrationTestCase {
protected function setUp(): void {
parent::setUp();
$this->overrideConfigValue( MainConfigNames::UsePigLatinVariant, false );
$langFactory = $this->getServiceContainer()->getLanguageFactory();
$contLangObj = $langFactory->getLanguage( 'en' );
// Hardcode namespaces during test runs,
// so that html output based on existing namespaces
// can be properly evaluated.
$contLangObj->setNamespaces( [
-2 => 'Media',
-1 => 'Special',
0 => '',
1 => 'Talk',
2 => 'User',
3 => 'User_talk',
4 => 'MyWiki',
5 => 'MyWiki_Talk',
6 => 'File',
7 => 'File_talk',
8 => 'MediaWiki',
9 => 'MediaWiki_talk',
10 => 'Template',
11 => 'Template_talk',
14 => 'Category',
15 => 'Category_talk',
100 => 'Custom',
101 => 'Custom_talk',
] );
$this->setContentLang( $contLangObj );
$userLangObj = $langFactory->getLanguage( 'es' );
$userLangObj->setNamespaces( [
-2 => "Medio",
-1 => "Especial",
0 => "",
1 => "Discusión",
2 => "Usuario",
3 => "Usuario discusión",
4 => "Wiki",
5 => "Wiki discusión",
6 => "Archivo",
7 => "Archivo discusión",
8 => "MediaWiki",
9 => "MediaWiki discusión",
10 => "Plantilla",
11 => "Plantilla discusión",
12 => "Ayuda",
13 => "Ayuda discusión",
14 => "Categoría",
15 => "Categoría discusión",
100 => "Personalizado",
101 => "Personalizado discusión",
] );
$this->setUserLang( $userLangObj );
}
public function testOpenElement() {
$this->expectPHPError(
E_USER_NOTICE,
static function () {
Html::openElement( 'span id="x"' );
},
'given element name with space'
);
}
public function testElementBasics() {
$this->assertEquals(
'<img>',
Html::element( 'img', null, '' ),
'Self-closing tag for short-tag elements'
);
$this->assertEquals(
'<element></element>',
Html::element( 'element', null, null ),
'Close tag for empty element (null, null)'
);
$this->assertEquals(
'<element></element>',
Html::element( 'element', [], '' ),
'Close tag for empty element (array, string)'
);
$this->assertEquals(
"<p test=\"\u{0338}&quot;&amp;\">&#x338; &amp; &lt; ></p>",
Html::element( 'p', [ 'test' => "\u{0338}\"&" ], "\u{0338} & < >" ),
'Attribute and content escaping'
);
$this->assertEquals(
'<p>&#x338; &amp;</p>',
Html::rawElement( 'p', [], "\u{0338} &amp;" ),
"Combining characters escaped even in raw contents (T387130)"
);
}
public function dataXmlMimeType() {
return [
// ( $mimetype, $isXmlMimeType )
# HTML is not an XML MimeType
[ 'text/html', false ],
# XML is an XML MimeType
[ 'text/xml', true ],
[ 'application/xml', true ],
# XHTML is an XML MimeType
[ 'application/xhtml+xml', true ],
# Make sure other +xml MimeTypes are supported
# SVG is another random MimeType even though we don't use it
[ 'image/svg+xml', true ],
# Complete random other MimeTypes are not XML
[ 'text/plain', false ],
];
}
/**
* @dataProvider dataXmlMimeType
*/
public function testXmlMimeType( $mimetype, $isXmlMimeType ) {
$this->assertEquals( $isXmlMimeType, Html::isXmlMimeType( $mimetype ) );
}
public static function provideExpandAttributes() {
// $expect, $attributes
yield 'keep keys with an empty string' => [
' foo=""',
[ 'foo' => '' ]
];
yield 'False bool attribs have no output' => [
'',
[ 'selected' => false ]
];
yield 'Null bool attribs have no output' => [
'',
[ 'selected' => null ]
];
yield 'True bool attribs have output' => [
' selected=""',
[ 'selected' => true ]
];
yield 'True bool attribs have output (passed as numerical array)' => [
' selected=""',
[ 'selected' ]
];
yield 'integer value is cast to string' => [
' value="1"',
[ 'value' => 1 ]
];
yield 'float value is cast to string' => [
' value="1.1"',
[ 'value' => 1.1 ]
];
yield 'object value is converted to string' => [
' value="stringValue"',
[ 'value' => new HtmlTestValue() ]
];
yield 'Empty string is always quoted' => [
' empty_string=""',
[ 'empty_string' => '' ]
];
yield 'Simple string value needs no quotes' => [
' key="value"',
[ 'key' => 'value' ]
];
yield 'Number 1 value needs no quotes' => [
' one="1"',
[ 'one' => 1 ]
];
yield 'Number 0 value needs no quotes' => [
' zero="0"',
[ 'zero' => 0 ]
];
}
/**
* @dataProvider provideExpandAttributes
*/
public function testExpandAttributes( string $expect, array $attribs ) {
$this->assertEquals( $expect, Html::expandAttributes( $attribs ) );
}
public static function provideExpandAttributesEmpty() {
// $attributes
yield 'skip keys with null value' => [ [ 'foo' => null ] ];
yield 'skip keys with false value' => [ [ 'foo' => false ] ];
}
/**
* @dataProvider provideExpandAttributesEmpty
*/
public function testExpandAttributesEmpty( array $attribs ) {
$this->assertSame( '', Html::expandAttributes( $attribs ) );
}
public static function provideExpandAttributesClass() {
// $expect, $classes
// string values
yield 'Normalization should strip redundant spaces' => [
' class="redundant spaces here"',
' redundant spaces here '
];
yield 'Normalization should remove duplicates in string-lists' => [
' class="foo bar"',
'foo bar foo bar bar'
];
// array values
yield 'Value with an empty array' => [
' class=""',
[]
];
yield 'Array with null, empty string and spaces' => [
' class=""',
[ null, '', ' ', ' ' ]
];
yield 'Normalization should remove duplicates in the array' => [
' class="foo bar"',
[ 'foo', 'bar', 'foo', 'bar', 'bar' ]
];
yield 'Normalization should remove duplicates in string-lists in the array' => [
' class="foo bar"',
[ 'foo bar', 'bar foo', 'foo', 'bar bar' ]
];
// Feature added in r96188 - pass attributes values as a PHP array
// only applies to class, rel, and accesskey
yield 'Associative array' => [
' class="booltrue one"',
[
'booltrue' => true,
'one' => 1,
# Method use isset() internally, make sure we do discard
# attributes values which have been assigned well known values
'emptystring' => '',
'boolfalse' => false,
'zero' => 0,
'null' => null,
]
];
// How do we handle duplicate keys in HTML attributes expansion?
// We could pass a "class" the values: 'GREEN' and [ 'GREEN' => false ]
// The latter will take precedence
yield 'Duplicate keys' => [
' class=""',
[
'GREEN',
'GREEN' => false,
'GREEN',
]
];
}
/**
* Html::expandAttributes has special features for HTML
* attributes that use space separated lists and also
* allows arrays to be used as values.
*
* @dataProvider provideExpandAttributesClass
*/
public function testExpandAttributesClass( string $expect, $classes ) {
$this->assertEquals(
$expect,
Html::expandAttributes( [ 'class' => $classes ] )
);
}
public function testExpandAttributes_ArrayOnNonListValueAttribute_ThrowsException() {
// Real-life test case found in the Popups extension (see Gerrit cf0fd64),
// when used with an outdated BetaFeatures extension (see Gerrit deda1e7)
$this->expectException( UnexpectedValueException::class );
Html::expandAttributes( [
'src' => [
'ltr' => 'ltr.svg',
'rtl' => 'rtl.svg'
]
] );
}
public function testNamespaceSelector() {
$this->assertEquals(
'<select id="namespace" name="namespace">' . "\n" .
'<option value="0">(Principal)</option>' . "\n" .
'<option value="1">Talk</option>' . "\n" .
'<option value="2">User</option>' . "\n" .
'<option value="3">User talk</option>' . "\n" .
'<option value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'<option value="100">Custom</option>' . "\n" .
'<option value="101">Custom talk</option>' . "\n" .
'</select>',
Html::namespaceSelector(),
'Basic namespace selector without custom options'
);
$this->assertEquals(
'<label for="mw-test-namespace">Select a namespace:</label>' . "\u{00A0}" .
'<select id="mw-test-namespace" name="wpNamespace">' . "\n" .
'<option value="all">todos</option>' . "\n" .
'<option value="0">(Principal)</option>' . "\n" .
'<option value="1">Talk</option>' . "\n" .
'<option value="2" selected="">User</option>' . "\n" .
'<option value="3">User talk</option>' . "\n" .
'<option value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'<option value="100">Custom</option>' . "\n" .
'<option value="101">Custom talk</option>' . "\n" .
'</select>',
Html::namespaceSelector(
[ 'selected' => '2', 'all' => 'all', 'label' => 'Select a namespace:' ],
[ 'name' => 'wpNamespace', 'id' => 'mw-test-namespace' ]
),
'Basic namespace selector with custom values'
);
$this->assertEquals(
'<label for="namespace">Select a namespace:</label>' . "\u{00A0}" .
'<select id="namespace" name="namespace">' . "\n" .
'<option value="0">(Principal)</option>' . "\n" .
'<option value="1">Talk</option>' . "\n" .
'<option value="2">User</option>' . "\n" .
'<option value="3">User talk</option>' . "\n" .
'<option value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'<option value="100">Custom</option>' . "\n" .
'<option value="101">Custom talk</option>' . "\n" .
'</select>',
Html::namespaceSelector(
[ 'label' => 'Select a namespace:' ]
),
'Basic namespace selector with a custom label but no id attribtue for the <select>'
);
$this->assertEquals(
'<select id="namespace" name="namespace">' . "\n" .
'<option value="0">(Principal)</option>' . "\n" .
'<option value="1">Discusión</option>' . "\n" .
'<option value="2">Usuario</option>' . "\n" .
'<option value="3">Usuario discusión</option>' . "\n" .
'<option value="4">Wiki</option>' . "\n" .
'<option value="5">Wiki discusión</option>' . "\n" .
'<option value="6">Archivo</option>' . "\n" .
'<option value="7">Archivo discusión</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki discusión</option>' . "\n" .
'<option value="10">Plantilla</option>' . "\n" .
'<option value="11">Plantilla discusión</option>' . "\n" .
'<option value="12">Ayuda</option>' . "\n" .
'<option value="13">Ayuda discusión</option>' . "\n" .
'<option value="14">Categoría</option>' . "\n" .
'<option value="15">Categoría discusión</option>' . "\n" .
'<option value="100">Personalizado</option>' . "\n" .
'<option value="101">Personalizado discusión</option>' . "\n" .
'</select>',
Html::namespaceSelector(
[ 'in-user-lang' => true ]
),
'Basic namespace selector in user language'
);
}
public function testCanFilterOutNamespaces() {
$this->assertEquals(
'<select id="namespace" name="namespace">' . "\n" .
'<option value="2">User</option>' . "\n" .
'<option value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'</select>',
Html::namespaceSelector(
[ 'exclude' => [ 0, 1, 3, 100, 101 ] ]
),
'Namespace selector namespace filtering.'
);
$this->assertEquals(
'<select id="namespace" name="namespace">' . "\n" .
'<option value="" selected="">todos</option>' . "\n" .
'<option value="2">User</option>' . "\n" .
'<option value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'</select>',
Html::namespaceSelector(
[ 'exclude' => [ 0, 1, 3, 100, 101 ], 'all' => '' ]
),
'Namespace selector namespace filtering with empty custom "all" option.'
);
}
public function testCanDisableANamespaces() {
$this->assertEquals(
'<select id="namespace" name="namespace">' . "\n" .
'<option disabled="" value="0">(Principal)</option>' . "\n" .
'<option disabled="" value="1">Talk</option>' . "\n" .
'<option disabled="" value="2">User</option>' . "\n" .
'<option disabled="" value="3">User talk</option>' . "\n" .
'<option disabled="" value="4">MyWiki</option>' . "\n" .
'<option value="5">MyWiki Talk</option>' . "\n" .
'<option value="6">File</option>' . "\n" .
'<option value="7">File talk</option>' . "\n" .
'<option value="8">MediaWiki</option>' . "\n" .
'<option value="9">MediaWiki talk</option>' . "\n" .
'<option value="10">Template</option>' . "\n" .
'<option value="11">Template talk</option>' . "\n" .
'<option value="14">Category</option>' . "\n" .
'<option value="15">Category talk</option>' . "\n" .
'<option value="100">Custom</option>' . "\n" .
'<option value="101">Custom talk</option>' . "\n" .
'</select>',
Html::namespaceSelector( [
'disable' => [ 0, 1, 2, 3, 4 ]
] ),
'Namespace selector namespace disabling'
);
}
/**
* @dataProvider provideHtml5InputTypes
*/
public function testHtmlElementAcceptsNewHtml5TypesInHtml5Mode( $HTML5InputType ) {
$this->assertEquals(
'<input type="' . $HTML5InputType . '">',
Html::element( 'input', [ 'type' => $HTML5InputType ] ),
'In HTML5, Html::element() should accept type="' . $HTML5InputType . '"'
);
}
public function testWarningBox() {
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--warning">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">warn</div></div>',
Html::warningBox( 'warn' )
);
}
public function testErrorBox() {
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--error">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">err</div></div>',
Html::errorBox( 'err' )
);
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--error errorbox-custom-class">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">'
. '<h2>heading</h2>err'
. '</div></div>',
Html::errorBox( 'err', 'heading', 'errorbox-custom-class' )
);
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--error">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">'
. '<h2>0</h2>err'
. '</div></div>',
Html::errorBox( 'err', '0', '' )
);
}
public function testSuccessBox() {
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--success">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">great</div></div>',
Html::successBox( 'great' )
);
$this->assertEquals(
'<div class="cdx-message cdx-message--block cdx-message--success">'
. '<span class="cdx-message__icon"></span>'
. '<div class="cdx-message__content">'
. '<script>beware no escaping!</script>'
. '</div></div>',
Html::successBox( '<script>beware no escaping!</script>' )
);
}
/**
* List of input element types values introduced by HTML5
* Full list at https://www.w3.org/TR/html-markup/input.html
*/
public static function provideHtml5InputTypes() {
$types = [
'datetime',
'datetime-local',
'date',
'month',
'time',
'week',
'number',
'range',
'email',
'url',
'search',
'tel',
'color',
];
foreach ( $types as $type ) {
yield [ $type ];
}
}
/**
* Test out Html::element drops or enforces default value
* @dataProvider provideElementsWithAttributesHavingDefaultValues
*/
public function testDropDefaults( $expected, $element, $attribs, $message = '' ) {
$this->assertEquals( $expected, Html::element( $element, $attribs ), $message );
}
public static function provideElementsWithAttributesHavingDefaultValues() {
# Use cases in a concise format:
# <expected>, <element name>, <array of attributes> [, <message>]
# Will be mapped to Html::element()
$cases = [];
# ## Generic cases, match $attribDefault static array
$cases[] = [ '<area>',
'area', [ 'shape' => 'rect' ]
];
$cases[] = [ '<button type="submit"></button>',
'button', [ 'formaction' => 'GET' ]
];
$cases[] = [ '<button type="submit"></button>',
'button', [ 'formenctype' => 'application/x-www-form-urlencoded' ]
];
$cases[] = [ '<canvas></canvas>',
'canvas', [ 'height' => '150' ]
];
$cases[] = [ '<canvas></canvas>',
'canvas', [ 'width' => '300' ]
];
# Also check with numeric values
$cases[] = [ '<canvas></canvas>',
'canvas', [ 'height' => 150 ]
];
$cases[] = [ '<canvas></canvas>',
'canvas', [ 'width' => 300 ]
];
$cases[] = [ '<form></form>',
'form', [ 'action' => 'GET' ]
];
$cases[] = [ '<form></form>',
'form', [ 'autocomplete' => 'on' ]
];
$cases[] = [ '<form></form>',
'form', [ 'enctype' => 'application/x-www-form-urlencoded' ]
];
$cases[] = [ '<input>',
'input', [ 'formaction' => 'GET' ]
];
$cases[] = [ '<input>',
'input', [ 'type' => 'text' ]
];
$cases[] = [ '<keygen>',
'keygen', [ 'keytype' => 'rsa' ]
];
$cases[] = [ '<link>',
'link', [ 'media' => 'all' ]
];
$cases[] = [ '<menu></menu>',
'menu', [ 'type' => 'list' ]
];
$cases[] = [ '<script></script>',
'script', [ 'type' => 'text/javascript' ]
];
$cases[] = [ '<style></style>',
'style', [ 'media' => 'all' ]
];
$cases[] = [ '<style></style>',
'style', [ 'type' => 'text/css' ]
];
$cases[] = [ '<textarea></textarea>',
'textarea', [ 'wrap' => 'soft' ]
];
# ## SPECIFIC CASES
# <link type="text/css">
$cases[] = [ '<link>',
'link', [ 'type' => 'text/css' ]
];
# <input> specific handling
$cases[] = [ '<input type="checkbox">',
'input', [ 'type' => 'checkbox', 'value' => 'on' ],
'Default value "on" is stripped of checkboxes',
];
$cases[] = [ '<input type="radio">',
'input', [ 'type' => 'radio', 'value' => 'on' ],
'Default value "on" is stripped of radio buttons',
];
$cases[] = [ '<input type="submit" value="Submit">',
'input', [ 'type' => 'submit', 'value' => 'Submit' ],
'Default value "Submit" is kept on submit buttons (for possible l10n issues)',
];
$cases[] = [ '<input type="color">',
'input', [ 'type' => 'color', 'value' => '' ],
];
$cases[] = [ '<input type="range">',
'input', [ 'type' => 'range', 'value' => '' ],
];
# <button> specific handling
# see remarks on https://msdn.microsoft.com/library/ms535211(v=vs.85).aspx
$cases[] = [ '<button type="submit"></button>',
'button', [ 'type' => 'submit' ],
'According to standard the default type is "submit". '
. 'Depending on compatibility mode IE might use "button", instead.',
];
# <select> specific handling
$cases[] = [ '<select multiple=""></select>',
'select', [ 'size' => '4', 'multiple' => true ],
];
# .. with numeric value
$cases[] = [ '<select multiple=""></select>',
'select', [ 'size' => 4, 'multiple' => true ],
];
$cases[] = [ '<select></select>',
'select', [ 'size' => '1', 'multiple' => false ],
];
# .. with numeric value
$cases[] = [ '<select></select>',
'select', [ 'size' => 1, 'multiple' => false ],
];
# Passing an array as value
$cases[] = [ '<a class="css-class-one css-class-two"></a>',
'a', [ 'class' => [ 'css-class-one', 'css-class-two' ] ],
"dropDefaults accepts values given as an array"
];
# FIXME: doDropDefault should remove defaults given in an array
# Expected should be '<a></a>'
$cases[] = [ '<a class=""></a>',
'a', [ 'class' => [ '', '' ] ],
"dropDefaults accepts values given as an array"
];
return $cases;
}
public function testWrapperInput() {
$this->assertEquals(
'<input type="radio" value="testval" name="testname">',
Html::input( 'testname', 'testval', 'radio' ),
'Input wrapper with type and value.'
);
$this->assertEquals(
'<input name="testname">',
Html::input( 'testname' ),
'Input wrapper with all default values.'
);
}
public function testWrapperCheck() {
$this->assertEquals(
'<input type="checkbox" value="1" name="testname">',
Html::check( 'testname' ),
'Checkbox wrapper unchecked.'
);
$this->assertEquals(
'<input checked="" type="checkbox" value="1" name="testname">',
Html::check( 'testname', true ),
'Checkbox wrapper checked.'
);
$this->assertEquals(
'<input type="checkbox" value="testval" name="testname">',
Html::check( 'testname', false, [ 'value' => 'testval' ] ),
'Checkbox wrapper with a value override.'
);
}
public function testWrapperRadio() {
$this->assertEquals(
'<input type="radio" value="1" name="testname">',
Html::radio( 'testname' ),
'Radio wrapper unchecked.'
);
$this->assertEquals(
'<input checked="" type="radio" value="1" name="testname">',
Html::radio( 'testname', true ),
'Radio wrapper checked.'
);
$this->assertEquals(
'<input type="radio" value="testval" name="testname">',
Html::radio( 'testname', false, [ 'value' => 'testval' ] ),
'Radio wrapper with a value override.'
);
}
public function testWrapperLabel() {
$this->assertEquals(
'<label for="testid">testlabel</label>',
Html::label( 'testlabel', 'testid' ),
'Label wrapper'
);
}
public static function provideSrcSetImages() {
return [
[ [], '', 'when there are no images, return empty string' ],
[
[ '1x' => '1x.png', '1.5x' => '1_5x.png', '2x' => '2x.png' ],
'1x.png 1x, 1_5x.png 1.5x, 2x.png 2x',
'pixel depth keys may include a trailing "x"'
],
[
[ '1' => '1x.png', '1.5' => '1_5x.png', '2' => '2x.png' ],
'1x.png 1x, 1_5x.png 1.5x, 2x.png 2x',
'pixel depth keys may omit a trailing "x"'
],
[
[ '1' => 'small.png', '1.5' => 'large.png', '2' => 'large.png' ],
'small.png 1x, large.png 1.5x',
'omit larger duplicates'
],
[
[ '1' => 'small.png', '2' => 'large.png', '1.5' => 'large.png' ],
'small.png 1x, large.png 1.5x',
'omit larger duplicates in irregular order'
],
];
}
/**
* @dataProvider provideSrcSetImages
*/
public function testSrcSet( $images, $expected, $message ) {
$this->assertEquals( $expected, Html::srcSet( $images ), $message );
}
public static function provideInlineScript() {
return [
'Empty' => [
'',
'<script></script>'
],
'Simple' => [
'EXAMPLE.label("foo");',
'<script>EXAMPLE.label("foo");</script>'
],
'Ampersand' => [
'EXAMPLE.is(a && b);',
'<script>EXAMPLE.is(a && b);</script>'
],
'HTML' => [
'EXAMPLE.label("<a>");',
'<script>EXAMPLE.label("<a>");</script>'
],
'Script closing string (lower)' => [
'EXAMPLE.label("</script>");',
'<script>/* ERROR: Invalid script */</script>',
true,
],
'Script closing with non-standard attributes (mixed)' => [
'EXAMPLE.label("</SCriPT and STyLE>");',
'<script>/* ERROR: Invalid script */</script>',
true,
],
'HTML-comment-open and script-open' => [
// In HTML, <script> contents aren't just plain CDATA until </script>,
// there are levels of escaping modes, and the below sequence puts an
// HTML parser in a state where </script> would *not* close the script.
// https://html.spec.whatwg.org/multipage/parsing.html#script-data-double-escape-end-state
'var a = "<!--<script>";',
'<script>/* ERROR: Invalid script */</script>',
true,
],
];
}
/**
* @dataProvider provideInlineScript
*/
public function testInlineScript( $code, $expected, $error = false ) {
if ( $error ) {
$html = @Html::inlineScript( $code );
} else {
$html = Html::inlineScript( $code );
}
$this->assertSame( $expected, $html );
}
public static function provideEncodeJsVar() {
// $expected, $input
yield 'boolean' => [ 'true', true ];
yield 'null' => [ 'null', null ];
yield 'array' => [ '["a",1]', [ 'a', 1 ] ];
yield 'associative arary' => [ '{"a":"a","b":1}', [ 'a' => 'a', 'b' => 1 ] ];
yield 'object' => [ '{"a":"a","b":1}', (object)[ 'a' => 'a', 'b' => 1 ] ];
yield 'int' => [ '123456', 123456 ];
yield 'float' => [ '1.5', 1.5 ];
yield 'int-like string' => [ '"123456"', '123456' ];
$code = 'function () { foo( 42 ); }';
yield 'code' => [ $code, new HtmlJsCode( $code ) ];
}
/**
* @covers \MediaWiki\Html\Html
* @covers \MediaWiki\Html\HtmlJsCode
* @dataProvider provideEncodeJsVar
*/
public function testEncodeJsVar( string $expect, $input ) {
$this->assertEquals(
$expect,
Html::encodeJsVar( $input )
);
}
/**
* @covers \MediaWiki\Html\Html
* @covers \MediaWiki\Html\HtmlJsCode
*/
public function testEncodeObject() {
$codeA = 'function () { foo( 42 ); }';
$codeB = 'function ( jQuery ) { bar( 142857 ); }';
$obj = HtmlJsCode::encodeObject( [
'a' => new HtmlJsCode( $codeA ),
'b' => new HtmlJsCode( $codeB )
] );
$this->assertEquals(
"{\"a\":$codeA,\"b\":$codeB}",
Html::encodeJsVar( $obj )
);
}
public function testListDropdownOptions() {
$this->assertEquals(
[
'other reasons' => 'other',
'Empty group item' => 'Empty group item',
'Foo' => [
'Foo 1' => 'Foo 1',
'Example' => 'Example',
],
'Bar' => [
'Bar 1' => 'Bar 1',
],
],
Html::listDropdownOptions(
"*\n** Empty group item\n* Foo\n** Foo 1\n** Example\n* Bar\n** Bar 1",
[ 'other' => 'other reasons' ]
)
);
}
public function testListDropdownOptionsOthers() {
// Do not use the value for 'other' as option group - T251351
$this->assertEquals(
[
'other reasons' => 'other',
'Foo 1' => 'Foo 1',
'Example' => 'Example',
'Bar' => [
'Bar 1' => 'Bar 1',
],
],
Html::listDropdownOptions(
"* other reasons\n** Foo 1\n** Example\n* Bar\n** Bar 1",
[ 'other' => 'other reasons' ]
)
);
}
public function testListDropdownOptionsOoui() {
$this->assertEquals(
[
[ 'data' => 'other', 'label' => 'other reasons' ],
[ 'optgroup' => 'Foo' ],
[ 'data' => 'Foo 1', 'label' => 'Foo 1' ],
[ 'data' => 'Example', 'label' => 'Example' ],
[ 'optgroup' => 'Bar' ],
[ 'data' => 'Bar 1', 'label' => 'Bar 1' ],
],
Html::listDropdownOptionsOoui( [
'other reasons' => 'other',
'Foo' => [
'Foo 1' => 'Foo 1',
'Example' => 'Example',
],
'Bar' => [
'Bar 1' => 'Bar 1',
],
] )
);
}
public function testListDropdownOptionsCodex(): void {
$this->assertEquals(
[
[ 'label' => 'other reasons', 'value' => 'other' ],
[ 'label' => 'Foo', 'value' => '', 'disabled' => true ],
[ 'label' => 'Foo 1', 'value' => 'Foo 1' ],
[ 'label' => 'Example', 'value' => 'Example' ],
[ 'label' => 'Bar', 'value' => '', 'disabled' => true ],
[ 'label' => 'Bar 1', 'value' => 'Bar 1' ],
],
Html::listDropdownOptionsCodex( [
'other reasons' => 'other',
'Foo' => [
'Foo 1' => 'Foo 1',
'Example' => 'Example',
],
'Bar' => [
'Bar 1' => 'Bar 1',
],
] )
);
}
}
class HtmlTestValue implements Stringable {
public function __toString() {
return 'stringValue';
}
}