Use Weston's snippet to correct ensure the amp-mustache template's ou…

…tput Now, it doesn't have </table> stripped, or the closing </td>.
ampproject · Feb 25, 2020 · 826a430 · 826a430
1 parent b059e63
commit 826a430
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 0 deletions.
diff --git a/src/Dom/Document.php b/src/Dom/Document.php
@@ -320,6 +320,7 @@ public function loadHTML( $source, $options = 0 ) {
 		$source = $this->replace_self_closing_tags( $source );
 		$source = $this->normalize_document_structure( $source );
 		$source = $this->maybe_replace_noscript_elements( $source );
+		$source = $this->replace_mustache_templates( $source );
 		$source = $this->secure_doctype_node( $source );
 
 		list( $source, $this->original_encoding ) = $this->detect_and_strip_encoding( $source );
@@ -341,6 +342,7 @@ public function loadHTML( $source, $options = 0 ) {
 
 		if ( $success ) {
 			$this->normalize_html_attributes();
+			$this->restore_mustache_templates();
 
 			// Remove http-equiv charset again.
 			$meta = $this->head->firstChild;
@@ -666,6 +668,45 @@ private function maybe_restore_noscript_elements( $html ) {
 		);
 	}
 
+	/**
+	 * Replaces the tag name of script[template="amp-mustache"], as a workaround to a parsing issue.
+	 *
+	 * This script can have closing tags of its children table and td stripped.
+	 * So this changes its name from script to tmp-script to avoid this.
+	 *
+	 * @link https://github.com/ampproject/amp-wp/issues/4254
+	 * @see restore_mustache_templates() Reciprocal function.
+	 *
+	 * @param string $html To replace the tag name of the mustache templates in.
+	 * @return string The HTML, with the tag name of the mustache templates replaced.
+	 */
+	private function replace_mustache_templates( $html ) {
+		return preg_replace(
+			'#<script(\s[^>]*template="amp-mustache"[^>]*)>(.*?)</script>#s',
+			'<tmp-script$1>$2</tmp-script>',
+			$html
+		);
+	}
+
+	/**
+	 * Restores the tag names of script[template="amp-mustache"] elements that were replaced earlier.
+	 *
+	 * @see replace_mustache_templates() Reciprocal function.
+	 */
+	private function restore_mustache_templates() {
+		$tmp_script_elements = iterator_to_array( $this->getElementsByTagName( 'tmp-script' ) );
+		foreach ( $tmp_script_elements as $tmp_script_element ) {
+			$script = $this->createElement( 'script' );
+			foreach ( $tmp_script_element->attributes as $attr ) {
+				$script->setAttribute( $attr->nodeName, $attr->nodeValue );
+			}
+			while ( $tmp_script_element->firstChild ) {
+				$script->appendChild( $tmp_script_element->firstChild );
+			}
+			$tmp_script_element->parentNode->replaceChild( $script, $tmp_script_element );
+		}
+	}
+
 	/**
 	 * Replace AMP binding attributes with something that libxml can parse (as HTML5 data-* attributes).
 	 *

diff --git a/tests/php/test-class-amp-dom-document.php b/tests/php/test-class-amp-dom-document.php
@@ -199,6 +199,21 @@ public function data_dom_document() {
 				'<!DOCTYPE html><html><head profile=""></head><body></body></html>',
 				'<!DOCTYPE html><html><head><meta charset="utf-8"></head><body></body></html>',
 			],
+			'amp_mustache_template_with_table'         => [
+				'utf-8',
+				'<!DOCTYPE html><html>' . $head . '<body><template type="amp-mustache"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></template></body></html>',
+				'<!DOCTYPE html><html>' . $head . '<body><template type="amp-mustache"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></template></body></html>',
+			],
+			'amp_mustache_template_script_with_table'  => [
+				'utf-8',
+				'<!DOCTYPE html><html>' . $head . '<body><script id="baz" type="text/plain" template="amp-mustache"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></script></body></html>',
+				'<!DOCTYPE html><html>' . $head . '<body><script id="baz" type="text/plain" template="amp-mustache"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></script></body></html>',
+			],
+			'multiple_mustache_templates_still_appear' => [
+				'utf-8',
+				'<!DOCTYPE html><html>' . $head . '<body><script template="amp-mustache" type="text/plain" id="foo"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></script><script type="text/plain" template="amp-mustache" id="example"><p>{{#baz}}This is inside a template{{/baz}}</p></script></body></html>',
+				'<!DOCTYPE html><html>' . $head . '<body><script template="amp-mustache" type="text/plain" id="foo"><table><tr>{{#example}}<td></td>{{/example}}</tr></table></script><script type="text/plain" template="amp-mustache" id="example"><p>{{#baz}}This is inside a template{{/baz}}</p></script></body></html>',
+			],
 		];
 	}