<!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>[32850] trunk: Since PHP 5.2.3, the `htmlspecialchars()` function has an optional `$double_encode` parameter, which we can now use.</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 { 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/32850">32850</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/32850","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-18 21:59:10 +0000 (Thu, 18 Jun 2015)</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'>Since PHP 5.2.3, the `htmlspecialchars()` function has an optional `$double_encode` parameter, which we can now use. This will save us a few expensive kses/html decoding calls.
Adds unit tests.
Props miqrogroove.
Fixes <a href="https://core.trac.wordpress.org/ticket/17780">#17780</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunktestsphpunittestsformattingEscAttrphp">trunk/tests/phpunit/tests/formatting/EscAttr.php</a></li>
<li><a href="#trunktestsphpunittestsformattingEscHtmlphp">trunk/tests/phpunit/tests/formatting/EscHtml.php</a></li>
<li><a href="#trunktestsphpunittestsformattingJSEscapephp">trunk/tests/phpunit/tests/formatting/JSEscape.php</a></li>
<li><a href="#trunktestsphpunittestsformattingWPSpecialcharsphp">trunk/tests/phpunit/tests/formatting/WPSpecialchars.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2015-06-18 21:32:53 UTC (rev 32849)
+++ trunk/src/wp-includes/formatting.php 2015-06-18 21:59:10 UTC (rev 32850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -688,25 +688,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $quote_style = ENT_NOQUOTES;
</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">- // Handle double encoding ourselves
- if ( $double_encode ) {
- $string = @htmlspecialchars( $string, $quote_style, $charset );
- } else {
- // Decode & into &
- $string = wp_specialchars_decode( $string, $_quote_style );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $string = @htmlspecialchars( $string, $quote_style, $charset, $double_encode );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Guarantee every &entity; is valid or re-encode the &
- $string = wp_kses_normalize_entities( $string );
-
- // Now re-encode everything except &entity;
- $string = preg_split( '/(&#?x?[0-9a-z]+;)/i', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
-
- for ( $i = 0, $c = count( $string ); $i < $c; $i += 2 ) {
- $string[$i] = @htmlspecialchars( $string[$i], $quote_style, $charset );
- }
- $string = implode( '', $string );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Backwards compatibility
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'single' === $_quote_style )
</span><span class="cx" style="display: block; padding: 0 10px"> $string = str_replace( "'", ''', $string );
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingEscAttrphp"></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/formatting/EscAttr.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/EscAttr.php 2015-06-18 21:32:53 UTC (rev 32849)
+++ trunk/tests/phpunit/tests/formatting/EscAttr.php 2015-06-18 21:59:10 UTC (rev 32850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,7 +26,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"> function test_esc_attr_amp() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $out = esc_attr( 'foo & bar &baz; '' );
- $this->assertEquals( "foo & bar &baz; '", $out );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $out = esc_attr( 'foo & bar &baz; ' );
+ $this->assertEquals( "foo & bar &baz; ", $out );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingEscHtmlphp"></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/formatting/EscHtml.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/EscHtml.php 2015-06-18 21:32:53 UTC (rev 32849)
+++ trunk/tests/phpunit/tests/formatting/EscHtml.php 2015-06-18 21:59:10 UTC (rev 32850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,7 +34,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_ignores_existing_entities() {
</span><span class="cx" style="display: block; padding: 0 10px"> $source = '& £ " &';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $res = '& £ " &';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $res = '& £ " &';
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $res, esc_html($source) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingJSEscapephp"></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/formatting/JSEscape.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/JSEscape.php 2015-06-18 21:32:53 UTC (rev 32849)
+++ trunk/tests/phpunit/tests/formatting/JSEscape.php 2015-06-18 21:59:10 UTC (rev 32850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,13 +23,13 @@
</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"> function test_js_escape_amp() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $out = esc_js('foo & bar &baz; '');
- $this->assertEquals("foo & bar &baz; '", $out);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $out = esc_js('foo & bar &baz; ');
+ $this->assertEquals("foo & bar &baz; ", $out);
</ins><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"> function test_js_escape_quote_entity() {
</span><span class="cx" style="display: block; padding: 0 10px"> $out = esc_js('foo ' bar ' baz &');
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals("foo \\' bar \\' baz &", $out);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals("foo \\' bar \\' baz &", $out);
</ins><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"> function test_js_no_carriage_return() {
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingWPSpecialcharsphp"></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/formatting/WPSpecialchars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/WPSpecialchars.php 2015-06-18 21:32:53 UTC (rev 32849)
+++ trunk/tests/phpunit/tests/formatting/WPSpecialchars.php 2015-06-18 21:59:10 UTC (rev 32850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,6 +17,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Allowed entities should be unchanged
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $allowedentitynames as $ent ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'apos' == $ent ) {
+ // But for some reason, PHP doesn't allow '
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $ent = '&' . $ent . ';';
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $ent, _wp_specialchars( $ent ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,4 +43,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '"'hello!'"', _wp_specialchars($source, true) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $source, _wp_specialchars($source) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Check some of the double-encoding features for entity references.
+ *
+ * @ticket 17780
+ * @dataProvider data_double_encoding
+ */
+ function test_double_encoding( $input, $output ) {
+ return $this->assertEquals( $output, _wp_specialchars( $input, ENT_NOQUOTES, false, true ) );
+ }
+
+ function data_double_encoding() {
+ return array(
+ array(
+ 'This & that, this & that, — " " Ú " " " " " $ ×',
+ 'This & that, this &amp; that, &#8212; &quot; &QUOT; &Uacute; &nbsp; &#34; &#034; &#0034; &#x00022; &#x22; &dollar; &times;',
+ ),
+ array(
+ '&& && && &;',
+ '&& &&amp; &amp;&amp; &amp;;',
+ ),
+ array(
+ '&garbage; &***; &aaaa; &0000; &####; &;;',
+ '&garbage; &***; &aaaa; &0000; &####; &;;',
+ ),
+ );
+ }
+
+ /**
+ * Check some of the double-encoding features for entity references.
+ *
+ * @ticket 17780
+ * @dataProvider data_no_double_encoding
+ */
+ function test_no_double_encoding( $input, $output ) {
+ return $this->assertEquals( $output, _wp_specialchars( $input, ENT_NOQUOTES, false, false ) );
+ }
+
+ function data_no_double_encoding() {
+ return array(
+ array(
+ 'This & that, this & that, — " " Ú " " " " " $ ×',
+ 'This & that, this & that, — " &QUOT; Ú " " " " " &dollar; ×',
+ ),
+ array(
+ '&& && && &;',
+ '&& && && &;',
+ ),
+ array(
+ '&garbage; &***; &aaaa; &0000; &####; &;;',
+ '&garbage; &***; &aaaa; &0000; &####; &;;',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>