<!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>[59401] branches/6.7/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php: HTML API: Include doctype in full parser serialize.</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/59401">59401</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/59401","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>cbravobernal</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-11-13 16:13:52 +0000 (Wed, 13 Nov 2024)</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'>HTML API: Include doctype in full parser serialize.
Output DOCTYPE when calling `WP_HTML_Processor::serialize` on a full document that includes a DOCTYPE.
The DOCTYPE should be included in the serialized/normalized HTML output as it has an impact in how the document is handled, in particular whether the document should be handled in quirks or no-quirks mode.
This only affects the serialization of full parsers at this time because DOCTYPE tokens are currently ignored in all possible fragments. The omission of the DOCTYPE is subtle but can change the serialized document's quirks/no-quirks mode.
Reviewed by cbravobernal.
Merges <a href="https://core.trac.wordpress.org/changeset/59399">[59399]</a> to the 6.7 branch.
Props jonsurrell.
Fixes <a href="https://core.trac.wordpress.org/ticket/62396">#62396</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches67srcwpincludeshtmlapiclasswphtmlprocessorphp">branches/6.7/src/wp-includes/html-api/class-wp-html-processor.php</a></li>
<li><a href="#branches67testsphpunittestshtmlapiwpHtmlProcessorserializephp">branches/6.7/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches67">branches/6.7/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.7
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.7 2024-11-13 12:25:43 UTC (rev 59400)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.7 2024-11-13 16:13:52 UTC (rev 59401)
</ins><a id="branches67"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.7</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:58570,59279-59280,59283,59286,59289-59290,59293,59306-59307,59314-59319,59325-59326,59329-59330,59339,59341,59344,59346-59348,59358,59362,59366,59368,59374,59379-59380,59382,59386
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:58570,59279-59280,59283,59286,59289-59290,59293,59306-59307,59314-59319,59325-59326,59329-59330,59339,59341,59344,59346-59348,59358,59362,59366,59368,59374,59379-59380,59382,59386,59399
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches67srcwpincludeshtmlapiclasswphtmlprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.7/src/wp-includes/html-api/class-wp-html-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.7/src/wp-includes/html-api/class-wp-html-processor.php 2024-11-13 12:25:43 UTC (rev 59400)
+++ branches/6.7/src/wp-includes/html-api/class-wp-html-processor.php 2024-11-13 16:13:52 UTC (rev 59401)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1157,6 +1157,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $token_type = $this->get_token_type();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $token_type ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case '#doctype':
+ $doctype = $this->get_doctype_info();
+ if ( null === $doctype ) {
+ break;
+ }
+
+ $html .= '<!DOCTYPE';
+
+ if ( $doctype->name ) {
+ $html .= " {$doctype->name}";
+ }
+
+ if ( null !== $doctype->public_identifier ) {
+ $html .= " PUBLIC \"{$doctype->public_identifier}\"";
+ }
+ if ( null !== $doctype->system_identifier ) {
+ if ( null === $doctype->public_identifier ) {
+ $html .= ' SYSTEM';
+ }
+ $html .= " \"{$doctype->system_identifier}\"";
+ }
+ $html .= '>';
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> case '#text':
</span><span class="cx" style="display: block; padding: 0 10px"> $html .= htmlspecialchars( $this->get_modifiable_text(), ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML5, 'UTF-8' );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1173,10 +1197,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case '#cdata-section':
</span><span class="cx" style="display: block; padding: 0 10px"> $html .= "<![CDATA[{$this->get_modifiable_text()}]]>";
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- case 'html':
- $html .= '<!DOCTYPE html>';
- break;
</del><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"> if ( '#tag' !== $token_type ) {
</span></span></pre></div>
<a id="branches67testsphpunittestshtmlapiwpHtmlProcessorserializephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.7/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.7/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php 2024-11-13 12:25:43 UTC (rev 59400)
+++ branches/6.7/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php 2024-11-13 16:13:52 UTC (rev 59401)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,4 +284,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Comment text' => array( "<!-- \x00 -->", "<!-- \u{FFFD} -->" ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 62396
+ *
+ * @dataProvider data_provider_serialize_doctype
+ */
+ public function test_full_document_serialize_includes_doctype( string $doctype_input, string $doctype_output ) {
+ $processor = WP_HTML_Processor::create_full_parser(
+ "{$doctype_input}👌"
+ );
+ $this->assertSame(
+ "{$doctype_output}<html><head></head><body>👌</body></html>",
+ $processor->serialize()
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public static function data_provider_serialize_doctype() {
+ return array(
+ 'None' => array( '', '' ),
+ 'Empty' => array( '<!DOCTYPE>', '<!DOCTYPE>' ),
+ 'HTML5' => array( '<!DOCTYPE html>', '<!DOCTYPE html>' ),
+ 'Strange name' => array( '<!DOCTYPE WordPress>', '<!DOCTYPE wordpress>' ),
+ 'With public' => array( '<!DOCTYPE html PUBLIC "x">', '<!DOCTYPE html PUBLIC "x">' ),
+ 'With system' => array( '<!DOCTYPE html SYSTEM "y">', '<!DOCTYPE html SYSTEM "y">' ),
+ 'With public and system' => array( '<!DOCTYPE html PUBLIC "x" "y">', '<!DOCTYPE html PUBLIC "x" "y">' ),
+ 'Weird casing' => array( '<!docType HtmL pubLIc\'xxx\'"yyy" all this is ignored>', '<!DOCTYPE html PUBLIC "xxx" "yyy">' ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>