From 0b12aecd096c3ee45cc24e61135d0c2cd00c9230 Mon Sep 17 00:00:00 2001 From: Arlo Breault Date: Wed, 7 Apr 2021 12:10:39 -0400 Subject: [PATCH] Use a protected key to distinguish comments internal to Parsoid Bug: T279451 Change-Id: I40bdfddaed292a33479874b5e49b17fe616c3889 --- src/Utils/WTUtils.php | 8 ++++++-- src/Wt2Html/Grammar.pegphp | 2 ++ src/Wt2Html/Grammar.php | 2 ++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/Utils/WTUtils.php b/src/Utils/WTUtils.php index 40dff131b..1ef411056 100644 --- a/src/Utils/WTUtils.php +++ b/src/Utils/WTUtils.php @@ -788,7 +788,11 @@ class WTUtils { */ public static function fosterCommentData( string $typeOf, array $attrs ): string { return PHPUtils::jsonEncode( [ - '@type' => $typeOf, + // WARNING: The choice of "-type" as the key is because "-" will be + // encoded with self::encodeComment when comments come from source + // wikitext (see the grammar), so we can be sure when reinserting + // that the comments are internal to Parsoid + '-type' => $typeOf, 'attrs' => $attrs ] ); } @@ -811,7 +815,7 @@ class WTUtils { // not a valid json attribute, do nothing return null; } - $type = $data->{'@type'} ?? ''; + $type = $data->{'-type'} ?? ''; if ( preg_match( '/^mw:/', $type ) ) { $meta = $node->ownerDocument->createElement( 'meta' ); foreach ( $data->attrs as $attr ) { diff --git a/src/Wt2Html/Grammar.pegphp b/src/Wt2Html/Grammar.pegphp index a278ba9b4..879e4397f 100644 --- a/src/Wt2Html/Grammar.pegphp +++ b/src/Wt2Html/Grammar.pegphp @@ -677,6 +677,8 @@ heading = comment = '" .)* ('-->' / eof) { + // WARNING: This is encoding is important for the choice of key + // in WTUtils::fosterCommentData $data = WTUtils::encodeComment( $c ); return [ new CommentTk( $data, (object)[ 'tsr' => $this->tsrOffsets() ] ) ]; } diff --git a/src/Wt2Html/Grammar.php b/src/Wt2Html/Grammar.php index 1c7fac166..81d0403df 100644 --- a/src/Wt2Html/Grammar.php +++ b/src/Wt2Html/Grammar.php @@ -562,6 +562,8 @@ class Grammar extends \WikiPEG\PEGParserBase { } private function a26($c) { + // WARNING: This is encoding is important for the choice of key + // in WTUtils::fosterCommentData $data = WTUtils::encodeComment( $c ); return [ new CommentTk( $data, (object)[ 'tsr' => $this->tsrOffsets() ] ) ]; -- 2.31.1