PageBundleParserOutputConverter.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Parser\Parsoid;
 
use MediaWiki\Language\LanguageCode;
use MediaWiki\Parser\ParserOutput;
use Wikimedia\Parsoid\Core\PageBundle;
 
final class PageBundleParserOutputConverter {
    public const PARSOID_PAGE_BUNDLE_KEY = 'parsoid-page-bundle';
 
    private function __construct() {
    }
 
    public static function parserOutputFromPageBundle(
        PageBundle $pageBundle, ?ParserOutput $originalParserOutput = null
    ): ParserOutput {
        $parserOutput = new ParserOutput( $pageBundle->html );
        if ( $originalParserOutput ) {
            $parserOutput->mergeHtmlMetaDataFrom( $originalParserOutput );
            $parserOutput->mergeTrackingMetaDataFrom( $originalParserOutput );
            $parserOutput->mergeInternalMetaDataFrom( $originalParserOutput );
        }
        self::applyPageBundleDataToParserOutput( $pageBundle, $parserOutput );
        return $parserOutput;
    }
 
    public static function applyPageBundleDataToParserOutput(
        $pageBundle, ParserOutput $parserOutput
    ): void {
        // Overwriting ExtensionData was deprecated in 1.38 but it's safe inside an OutputTransform pipeline,
        // which is the only place where this should happen right now.
        $parserOutput->setExtensionData(
            self::PARSOID_PAGE_BUNDLE_KEY,
            [
                'parsoid' => $pageBundle->parsoid ?? null,
                'mw' => $pageBundle->mw ?? null,
                'version' => $pageBundle->version ?? null,
                'headers' => $pageBundle->headers ?? null,
                'contentmodel' => $pageBundle->contentmodel ?? null,
            ]
        );
 
        if ( isset( $pageBundle->headers['content-language'] ) ) {
            $lang = LanguageCode::normalizeNonstandardCodeAndWarn(
            // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
                $pageBundle->headers['content-language']
            );
            $parserOutput->setLanguage( $lang );
        }
    }
 
    public static function pageBundleFromParserOutput( ParserOutput $parserOutput ): PageBundle {
        $pageBundleData = $parserOutput->getExtensionData( self::PARSOID_PAGE_BUNDLE_KEY );
        $lang = $parserOutput->getLanguage();
 
        $headers = $pageBundleData['headers'] ?? [];
 
        if ( $lang ) {
            $headers['content-language'] = $lang->toBcp47Code();
        }
 
        return new PageBundle(
            $parserOutput->getRawText(),
            $pageBundleData['parsoid'] ?? [ 'ids' => [] ],
            $pageBundleData['mw'] ?? null,
            // It would be nice to have this be "null", but PageBundle::responseData()
            // chocks on that: T325137.
            $pageBundleData['version'] ?? '0.0.0',
            $pageBundleData['headers'] ?? $headers,
            $pageBundleData['contentmodel'] ?? null
        );
    }
 
    public static function hasPageBundle( ParserOutput $parserOutput ) {
        return $parserOutput->getExtensionData( self::PARSOID_PAGE_BUNDLE_KEY ) !== null;
    }
}