Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
33.33% |
1 / 3 |
CRAP | |
63.46% |
33 / 52 |
Nowiki | |
0.00% |
0 / 1 |
|
33.33% |
1 / 3 |
39.51 | |
63.46% |
33 / 52 |
getConfig | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
sourceToDom | |
100.00% |
1 / 1 |
4 | |
100.00% |
21 / 21 |
|||
domToWikitext | |
0.00% |
0 / 1 |
63.60 | |
40.00% |
12 / 30 |
<?php | |
declare( strict_types = 1 ); | |
namespace Wikimedia\Parsoid\Ext\Nowiki; | |
use Wikimedia\Assert\Assert; | |
use Wikimedia\Parsoid\DOM\Comment; | |
use Wikimedia\Parsoid\DOM\DocumentFragment; | |
use Wikimedia\Parsoid\DOM\Element; | |
use Wikimedia\Parsoid\DOM\Text; | |
use Wikimedia\Parsoid\Ext\DOMDataUtils; | |
use Wikimedia\Parsoid\Ext\DOMUtils; | |
use Wikimedia\Parsoid\Ext\ExtensionModule; | |
use Wikimedia\Parsoid\Ext\ExtensionTagHandler; | |
use Wikimedia\Parsoid\Ext\ParsoidExtensionAPI; | |
use Wikimedia\Parsoid\Ext\Utils; | |
use Wikimedia\Parsoid\NodeData\DataParsoid; | |
use Wikimedia\Parsoid\Utils\DOMCompat; | |
/** | |
* Nowiki treats anything inside it as plain text. | |
*/ | |
class Nowiki extends ExtensionTagHandler implements ExtensionModule { | |
/** @inheritDoc */ | |
public function getConfig(): array { | |
return [ | |
'name' => '<nowiki>', | |
'tags' => [ | |
[ | |
'name' => 'nowiki', | |
'handler' => self::class, | |
] | |
] | |
]; | |
} | |
/** @inheritDoc */ | |
public function sourceToDom( | |
ParsoidExtensionAPI $extApi, string $txt, array $extArgs | |
): DocumentFragment { | |
$domFragment = $extApi->htmlToDom( '' ); | |
$doc = $domFragment->ownerDocument; | |
$span = $doc->createElement( 'span' ); | |
DOMUtils::addTypeOf( $span, 'mw:Nowiki' ); | |
foreach ( preg_split( '/(&[#0-9a-zA-Z]+;)/', $txt, -1, PREG_SPLIT_DELIM_CAPTURE ) as $i => $t ) { | |
if ( $i % 2 === 1 ) { | |
$cc = Utils::decodeWtEntities( $t ); | |
if ( $cc !== $t ) { | |
// This should match the output of the "htmlentity" rule | |
// in the tokenizer. | |
$entity = $doc->createElement( 'span' ); | |
DOMUtils::addTypeOf( $entity, 'mw:Entity' ); | |
$dp = new DataParsoid; | |
$dp->src = $t; | |
$dp->srcContent = $cc; | |
DOMDataUtils::setDataParsoid( $entity, $dp ); | |
$entity->appendChild( $doc->createTextNode( $cc ) ); | |
$span->appendChild( $entity ); | |
continue; | |
} | |
// else, fall down there | |
} | |
$span->appendChild( $doc->createTextNode( $t ) ); | |
} | |
DOMCompat::normalize( $span ); | |
$domFragment->appendChild( $span ); | |
return $domFragment; | |
} | |
/** @inheritDoc */ | |
public function domToWikitext( | |
ParsoidExtensionAPI $extApi, Element $node, bool $wrapperUnmodified | |
) { | |
if ( !$node->hasChildNodes() ) { | |
$extApi->setHtml2wtStateFlag( 'hasSelfClosingNowikis' ); // FIXME | |
return '<nowiki/>'; | |
} | |
$str = '<nowiki>'; | |
for ( $child = $node->firstChild; $child; $child = $child->nextSibling ) { | |
$out = null; | |
if ( $child instanceof Element ) { | |
if ( DOMUtils::isDiffMarker( $child ) ) { | |
/* ignore */ | |
} elseif ( DOMCompat::nodeName( $child ) === 'span' && | |
DOMUtils::hasTypeOf( $child, 'mw:Entity' ) && | |
DOMUtils::hasNChildren( $child, 1 ) | |
) { | |
$dp = DOMDataUtils::getDataParsoid( $child ); | |
if ( isset( $dp->src ) && $dp->srcContent === $child->textContent ) { | |
// Unedited content | |
$out = $dp->src; | |
} else { | |
// Edited content | |
$out = Utils::entityEncodeAll( $child->firstChild->nodeValue ); | |
} | |
// DisplaySpace is added in a final post-processing pass so, | |
// even though it isn't emitted in the extension handler, we | |
// need to deal with the possibility of its presence | |
// FIXME(T254501): Should avoid the need for this | |
} elseif ( | |
DOMCompat::nodeName( $child ) === 'span' && | |
DOMUtils::hasTypeOf( $child, 'mw:DisplaySpace' ) && | |
DOMUtils::hasNChildren( $child, 1 ) | |
) { | |
$out = ' '; | |
} else { | |
/* This is a hacky fallback for what is essentially | |
* undefined behavior. No matter what we emit here, | |
* this won't roundtrip html2html. */ | |
$extApi->log( 'error/html2wt/nowiki', 'Invalid nowiki content' ); | |
$out = $child->textContent; | |
} | |
} elseif ( $child instanceof Text ) { | |
$out = $child->nodeValue; | |
} else { | |
Assert::invariant( $child instanceof Comment, "Expected a comment here" ); | |
/* Comments can't be embedded in a <nowiki> */ | |
$extApi->log( 'error/html2wt/nowiki', | |
'Discarded invalid embedded comment in a <nowiki>' ); | |
$out = ''; | |
} | |
// Always escape any nowikis found in $out | |
if ( $out ) { | |
// Inlined helper that previously existed in Parsoid's WT Utils | |
$str .= preg_replace( '#<(/?nowiki\s*/?\s*)>#i', '<$1>', $out ); | |
} | |
} | |
return $str . '</nowiki>'; | |
} | |
} |