TextContentHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Content;
 
use MediaWiki\Content\Renderer\ContentParseParams;
use MediaWiki\Content\Transform\PreSaveTransformParams;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\WikiPage;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Revision\RevisionRecord;
use SearchEngine;
use SearchIndexField;
 
class TextContentHandler extends ContentHandler {
 
    public function __construct( $modelId = CONTENT_MODEL_TEXT, $formats = [ CONTENT_FORMAT_TEXT ] ) {
        parent::__construct( $modelId, $formats );
    }
 
    public function serializeContent( Content $content, $format = null ) {
        $this->checkFormat( $format );
 
        // @phan-suppress-next-line PhanUndeclaredMethod
        return $content->getText();
    }
 
    public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
        // Nothing to do when the unsaved edit is already identical to the latest revision
        if ( $myContent->equals( $yourContent ) ) {
            return $yourContent;
        }
        // Impossible to have a conflict when the user just edited the latest revision. This can
        // happen e.g. when $wgDiff3 is badly configured.
        if ( $oldContent->equals( $yourContent ) ) {
            return $myContent;
        }
 
        $this->checkModelID( $oldContent->getModel() );
        $this->checkModelID( $myContent->getModel() );
        $this->checkModelID( $yourContent->getModel() );
 
        $format = $this->getDefaultFormat();
 
        $old = $this->serializeContent( $oldContent, $format );
        $mine = $this->serializeContent( $myContent, $format );
        $yours = $this->serializeContent( $yourContent, $format );
 
        $ok = wfMerge( $old, $mine, $yours, $result );
 
        if ( !$ok ) {
            return false;
        }
 
        if ( !$result ) {
            return $this->makeEmptyContent();
        }
 
        $mergedContent = $this->unserializeContent( $result, $format );
 
        return $mergedContent;
    }
 
    protected function getContentClass() {
        return TextContent::class;
    }
 
    public function unserializeContent( $text, $format = null ) {
        $this->checkFormat( $format );
 
        $class = $this->getContentClass();
        return new $class( $text );
    }
 
    public function makeEmptyContent() {
        $class = $this->getContentClass();
        return new $class( '' );
    }
 
    public function supportsDirectEditing() {
        return true;
    }
 
    public function getFieldsForSearchIndex( SearchEngine $engine ) {
        $fields = parent::getFieldsForSearchIndex( $engine );
        $fields['language'] =
            $engine->makeSearchFieldMapping( 'language', SearchIndexField::INDEX_TYPE_KEYWORD );
 
        return $fields;
    }
 
    public function getDataForSearchIndex(
        WikiPage $page,
        ParserOutput $output,
        SearchEngine $engine,
        ?RevisionRecord $revision = null
    ) {
        $fields = parent::getDataForSearchIndex( $page, $output, $engine, $revision );
        $fields['language'] =
            $this->getPageLanguage( $page->getTitle(), $page->getContent() )->getCode();
        return $fields;
    }
 
    public function preSaveTransform(
        Content $content,
        PreSaveTransformParams $pstParams
    ): Content {
        '@phan-var TextContent $content';
 
        $text = $content->getText();
 
        $pst = TextContent::normalizeLineEndings( $text );
 
        $contentClass = $this->getContentClass();
        return ( $text === $pst ) ? $content : new $contentClass( $pst, $content->getModel() );
    }
 
    protected function fillParserOutput(
        Content $content,
        ContentParseParams $cpoParams,
        ParserOutput &$output
    ) {
        $textModelsToParse = MediaWikiServices::getInstance()->getMainConfig()->get(
            MainConfigNames::TextModelsToParse );
        '@phan-var TextContent $content';
        if ( in_array( $content->getModel(), $textModelsToParse ) ) {
            // parse just to get links etc into the database, HTML is replaced below.
            $output = MediaWikiServices::getInstance()->getParserFactory()->getInstance()
                ->parse(
                    $content->getText(),
                    $cpoParams->getPage(),
                    $cpoParams->getParserOptions(),
                    true,
                    true,
                    $cpoParams->getRevId()
                );
        }
 
        if ( $cpoParams->getGenerateHtml() ) {
            // Return an HTML representation of the content
            $html = htmlspecialchars( $content->getText(), ENT_COMPAT );
            $html = "<pre>$html</pre>";
        } else {
            $html = null;
        }
 
        $output->clearWrapperDivClass();
        $output->setRawText( $html );
    }
}
class_alias( TextContentHandler::class, 'TextContentHandler' );