Page MenuHomeWickedGov Phorge
Files F4097309

ParsoidLocalization.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ParsoidLocalization.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\OutputTransform\Stages;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Message\Message;
use MediaWiki\OutputTransform\ContentDOMTransformStage;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\Parsoid\ParsoidParser;
use MediaWiki\Title\TitleFactory;
use Psr\Log\LoggerInterface;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Bcp47Code\Bcp47CodeValue;
use Wikimedia\Parsoid\DOM\Document;
use Wikimedia\Parsoid\DOM\DocumentFragment;
use Wikimedia\Parsoid\DOM\Element;
use Wikimedia\Parsoid\NodeData\I18nInfo;
use Wikimedia\Parsoid\Utils\ContentUtils;
use Wikimedia\Parsoid\Utils\DOMCompat;
use Wikimedia\Parsoid\Utils\DOMDataUtils;
use Wikimedia\Parsoid\Utils\DOMTraverser;
use Wikimedia\Parsoid\Utils\DOMUtils;
/**
* Resolves the mw:I18n and mw:LocalizedAttrs to their localised forms
* @internal
*/
class ParsoidLocalization extends ContentDOMTransformStage {
private TitleFactory $titleFactory;
public function __construct(
ServiceOptions $options, LoggerInterface $logger, TitleFactory $titleFactory
) {
parent::__construct( $options, $logger );
$this->titleFactory = $titleFactory;
}
public function transformDOM(
DocumentFragment $df, ParserOutput $po, ?ParserOptions $popts, array &$options
): DocumentFragment {
$poLang = $po->getLanguage();
if ( $poLang == null ) {
$this->logger->warning( 'Localization pass started on ParserOutput without defined language',
[
'pass' => 'Localization',
] );
return $df;
}
$pageReference = $this->getPageReference( $po );
// TODO this traversal will need to also traverse rich attributes
$traverser = new DOMTraverser( false, false );
$traverser->addHandler( null, function ( $node ) use ( $poLang, $pageReference ) {
if ( $node instanceof Element ) {
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable ownerDocument is not null
return $this->localizeElement( $node, $poLang, $node->ownerDocument, $pageReference );
}
return true;
} );
$traverser->traverse( null, $df );
return $df;
}
public function shouldRun( ParserOutput $po, ?ParserOptions $popts, array $options = [] ): bool {
return $po->getContentHolder()->isParsoidContent();
}
/**
* @return bool|Element
*/
private function localizeElement( Element $node, Bcp47Code $lang, Document $doc, PageReference $pageRef ) {
if ( DOMUtils::hasTypeOf( $node, 'mw:LocalizedAttrs' ) ) {
$i18nNames = DOMDataUtils::getDataAttrI18nNames( $node );
if ( count( $i18nNames ) === 0 ) {
$this->logger->warning( 'node with mw:LocalizedAttrs typeof does not contain localisation data',
[
'pass' => 'Localization',
'node' => $node,
] );
}
foreach ( $i18nNames as $name ) {
$i18n = DOMDataUtils::getDataAttrI18n( $node, $name );
if ( $i18n === null ) {
$this->logger->warning( 'null localization element for attribute ' . $name, [
'pass' => 'Localization',
'node' => DOMCompat::getOuterHTML( $node ),
] );
continue;
}
$frag = $this->localizeI18n( $i18n, $lang, $doc, true, $pageRef );
$node->setAttribute( $name, $frag->textContent );
}
}
if (
( DOMUtils::nodeName( $node ) === 'span' || DOMUtils::nodeName( $node ) === 'div' )
&& DOMUtils::hasTypeOf( $node, 'mw:I18n' )
) {
$i18n = DOMDataUtils::getDataNodeI18n( $node );
if ( $i18n !== null ) {
$frag = $this->localizeI18n( $i18n, $lang, $doc, DOMUtils::nodeName( $node ) === 'span', $pageRef );
if ( $frag->hasChildNodes() ) {
$node->appendChild( $frag );
}
} else {
$this->logger->warning( 'element with mw:I18n typeof does not contain i18n data', [
'pass' => 'Localization',
'node' => DOMCompat::getOuterHTML( $node ),
] );
}
}
return true;
}
private function localizeI18n(
I18nInfo $i18n, Bcp47Code $poLang, Document $doc, bool $inline, PageReference $title
): DocumentFragment {
$msg = Message::newFromKey( $i18n->key, ...( $i18n->params ?? [] ) );
$msg->page( $title );
if ( $i18n->lang === I18nInfo::PAGE_LANG ) {
$msg = $msg->inLanguage( $poLang );
} elseif ( $i18n->lang === I18nInfo::USER_LANG ) {
// note: there's a high chance we'll want to access parseroptions->getUserLang here when we introduce
// post-proc cache (so that we split the cache accordingly)
$msg = $msg->inUserLanguage();
} else {
$msg = $msg->inLanguage( new Bcp47CodeValue( $i18n->lang ) );
}
if ( $msg->isDisabled() ) {
$txt = '';
} else {
$txt = $inline ? $msg->parse() : $msg->parseAsBlock();
}
return ContentUtils::createAndLoadDocumentFragment( $doc, $txt );
}
/**
* @param ParserOutput $po
* @return PageReference
*/
private function getPageReference( ParserOutput $po ): PageReference {
$titleDbKey = $po->getExtensionData( ParsoidParser::PARSOID_TITLE_KEY );
if ( !$titleDbKey ) {
// We don't think this should ever trigger, but being conservative
$this->logger->error( __METHOD__ . ": Missing title information in ParserOutput" );
$titleDbKey = 'Special:BadTitle/Localization';
}
// TODO split PARSOID_TITLE_KEY into ns + title & use PageReferenceValue directly
$pageRef = $this->titleFactory->newFromDBkey( $titleDbKey );
if ( !$pageRef ) {
$this->logger->error( __METHOD__ . ": Bad title information in ParserOutput" );
$pageRef = PageReferenceValue::localReference( NS_SPECIAL, 'BadTitle/Localization' );
}
return $pageRef;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 14:49 (3 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
85/f1/374b76aac750a3883df138add66d
Default Alt Text
ParsoidLocalization.php (5 KB)

Event Timeline