<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[52229] trunk: KSES: Use correct global in `wp_kses_xml_named_entities()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52229">52229</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52229","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-21 17:15:26 +0000 (Sun, 21 Nov 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>KSES: Use correct global in `wp_kses_xml_named_entities()`.
This fixes a discrepancy where the the global name used in the function did not match the one declared at the beginning of `kses.php`, and ensures that the function gets the correct array of allowed XML entity names.
Includes unit tests.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/48072">[48072]</a>.
Props ovidiul, costdev, peterwilsoncc, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/54060">#54060</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
<li><a href="#trunktestsphpunittestsksesphp">trunk/tests/phpunit/tests/kses.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2021-11-20 02:48:08 UTC (rev 52228)
+++ trunk/src/wp-includes/kses.php 2021-11-21 17:15:26 UTC (rev 52229)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -459,7 +459,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var string[] $allowedentitynames Array of KSES allowed HTML entitity names.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var string[] $allowedentitynames Array of KSES allowed HTML entity names.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $allowedentitynames = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -719,10 +719,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var string[] $allowedxmlentitynames Array of KSES allowed XML entitity names.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var string[] $allowedxmlentitynames Array of KSES allowed XML entity names.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowedxmlnamedentities = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowedxmlentitynames = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'amp',
</span><span class="cx" style="display: block; padding: 0 10px"> 'lt',
</span><span class="cx" style="display: block; padding: 0 10px"> 'gt',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1906,7 +1906,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Correctly encoded entity.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_xml_named_entities( $matches ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $allowedentitynames, $allowedxmlnamedentities;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $allowedentitynames, $allowedxmlentitynames;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $matches[1] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1914,7 +1914,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $i = $matches[1];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( in_array( $i, $allowedxmlnamedentities, true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( in_array( $i, $allowedxmlentitynames, true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return "&$i;";
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( in_array( $i, $allowedentitynames, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return html_entity_decode( "&$i;", ENT_HTML5 );
</span></span></pre></div>
<a id="trunktestsphpunittestsksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/kses.php 2021-11-20 02:48:08 UTC (rev 52228)
+++ trunk/tests/phpunit/tests/kses.php 2021-11-21 17:15:26 UTC (rev 52229)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1790,4 +1790,110 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $return_data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test that XML named entities are encoded correctly.
+ *
+ * @dataProvider data_wp_kses_xml_named_entities
+ *
+ * @ticket 54060
+ * @covers ::wp_kses_xml_named_entities
+ *
+ * @param array $input The input to wp_kses_xml_named_entities().
+ * @param string $expected The expected output.
+ */
+ public function test_wp_kses_xml_named_entities( $input, $expected ) {
+ $this->assertSame( $expected, wp_kses_xml_named_entities( $input ) );
+ }
+
+ /**
+ * Data provider for test_wp_kses_xml_named_entities().
+ *
+ * @return array Nested array of input, expected pairs.
+ */
+ public function data_wp_kses_xml_named_entities() {
+ return array(
+ // Empty string value testing.
+ 'empty string' => array(
+ 'input' => '',
+ 'expected' => '',
+ ),
+
+ // Empty string array value testing.
+ 'empty string array' => array(
+ 'input' => array( '', '' ),
+ 'expected' => '',
+ ),
+
+ // $allowedxmlentitynames values testing.
+ 'amp' => array(
+ 'input' => array( '', 'amp' ),
+ 'expected' => '&',
+ ),
+ 'lt' => array(
+ 'input' => array( '', 'lt' ),
+ 'expected' => '<',
+ ),
+ 'gt' => array(
+ 'input' => array( '', 'gt' ),
+ 'expected' => '>',
+ ),
+
+ // $allowedentitynames values testing.
+ 'nbsp' => array(
+ 'input' => array( '', 'nbsp' ),
+ 'expected' => utf8_encode( chr( 160 ) ),
+ ),
+ 'iexcl' => array(
+ 'input' => array( '', 'iexcl' ),
+ 'expected' => '¡',
+ ),
+ 'cent' => array(
+ 'input' => array( '', 'cent' ),
+ 'expected' => '¢',
+ ),
+
+ // Some other value testing.
+ 'test' => array(
+ 'input' => array( '', 'test' ),
+ 'expected' => '&test;',
+ ),
+
+ );
+ }
+
+ /**
+ * Test that KSES globals are defined.
+ *
+ * @dataProvider data_kses_globals_are_defined
+ *
+ * @ticket 54060
+ *
+ * @param string $global The name of the global variable.
+ */
+ public function test_kses_globals_are_defined( $global ) {
+ $this->assertArrayHasKey( $global, $GLOBALS );
+ }
+
+ /**
+ * Data provider for test_kses_globals_are_defined().
+ *
+ * @return array
+ */
+ public function data_kses_globals_are_defined() {
+ return array(
+ 'allowedposttags' => array(
+ 'global' => 'allowedposttags',
+ ),
+ 'allowedtags' => array(
+ 'global' => 'allowedtags',
+ ),
+ 'allowedentitynames' => array(
+ 'global' => 'allowedentitynames',
+ ),
+ 'allowedxmlentitynames' => array(
+ 'global' => 'allowedxmlentitynames',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>