gplx/mediawiki/extensions/SemanticMediaWiki/includes/ContentParser.php

<?php

namespace SMW;

use MediaWiki\Context\RequestContext;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use SMW\MediaWiki\RevisionGuardAwareTrait;

/**
 * Fetches the ParserOutput either by parsing an invoked text component,
 * re-parsing a text revision, or accessing the ContentHandler to generate a
 * ParserOutput object
 *
 * @ingroup SMW
 *
 * @license GPL-2.0-or-later
 * @since 1.9
 *
 * @author mwjames
 */
class ContentParser {

	use RevisionGuardAwareTrait;

	/** @var Title */
	protected $title;

	/** @var Parser */
	protected $parser = null;

	/** @var ParserOutput */
	protected $parserOutput = null;

	/** @var RevisionRecord */
	protected $revision = null;

	/** @var array */
	protected $errors = [];

	/**
	 * @var bool
	 */
	private $skipInTextAnnotationParser = false;

	/**
	 * @since 1.9
	 *
	 * @param Title $title
	 * @param Parser $parser
	 */
	public function __construct( Title $title, Parser $parser ) {
		$this->title  = $title;
		$this->parser = $parser;
	}

	/**
	 * @since 2.3
	 *
	 * @return Parser $parser
	 */
	public function setParser( Parser $parser ) {
		$this->parser = $parser;
	}

	/**
	 * @since 1.9.1
	 *
	 * @return ContentParser
	 */
	public function setRevision( ?RevisionRecord $revision = null ) {
		$this->revision = $revision;
		return $this;
	}

	/**
	 * @since 1.9
	 *
	 * @return Title
	 */
	public function getTitle() {
		return $this->title;
	}

	/**
	 * @since 1.9
	 *
	 * @return ParserOutput|null
	 */
	public function getOutput() {
		return $this->parserOutput;
	}

	/**
	 * @since 1.9
	 *
	 * @return array
	 */
	public function getErrors() {
		return $this->errors;
	}

	/**
	 * @since 1.9
	 */
	public function skipInTextAnnotationParser() {
		return $this->skipInTextAnnotationParser = true;
	}

	/**
	 * Generates or fetches the ParserOutput object from an appropriate source
	 *
	 * @since 1.9
	 *
	 * @param string|null $text
	 * @param bool $clear Whether to clear the parser cache.
	 *
	 * @return ContentParser
	 */
	public function parse( ?string $text = null, bool $clear = true ) {
		if ( $text !== null ) {
			return $this->parseText( $text, $clear );
		}

		return $this->fetchFromContent();
	}

	private function parseText( ?string $text, bool $clear ) {
		$options = $this->makeParserOptions();

		// Deal with uninitialised parser output:
		if ( !$clear ) {
			$this->parser->setOptions( $options );
			$this->parser->clearState();
		}

		$this->parserOutput = $this->parser->parse( $text, $this->getTitle(), $options, true, $clear );

		return $this;
	}

	private function fetchFromContent() {
		if ( $this->getRevision() === null ) {
			return $this->msgForNullRevision();
		}

		$revision = $this->getRevision();
		$content = $revision->getContent( SlotRecord::MAIN, RevisionRecord::RAW );

		if ( !$content ) {
			$mainSlot = $revision->getSlot( SlotRecord::MAIN, RevisionRecord::RAW );
			$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
			$handler = $contentHandlerFactory->getContentHandler( $mainSlot->getModel() );
			$content = $handler->makeEmptyContent();
		}

		// Avoid "The content model 'xyz' is not registered on this wiki."
		try {
			$services = MediaWikiServices::getInstance();
			// MW 1.42+
			if ( version_compare( MW_VERSION, '1.42', '<' ) ) {
				$revision = $revision->getId();
			}
			$contentRenderer = $services->getContentRenderer();
			$this->parserOutput = $contentRenderer->getParserOutput(
				$content,
				$this->getTitle(),
				$revision
			);
		} catch ( \MWUnknownContentModelException $e ) {
			$this->parserOutput = null;
		}

		return $this;
	}

	private function msgForNullRevision( $fname = __METHOD__ ) {
		$this->errors = [ $fname . " No revision available for {$this->getTitle()->getPrefixedDBkey()}" ];
		return $this;
	}

	private function makeParserOptions() {
		$user = null;

		if ( $this->getRevision() !== null ) {
			$identity = $this->getRevision()->getUser();
			if ( $identity ) {
				$user = MediaWikiServices::getInstance()->getUserFactory()->newFromUserIdentity( $identity );
			}
		}

		$user = $user ?? RequestContext::getMain()->getUser();
		$parserOptions = new ParserOptions( $user );

		// Use the InterfaceMessage marker to skip InTextAnnotationParser
		// processing
		$parserOptions->setInterfaceMessage( $this->skipInTextAnnotationParser );

		return $parserOptions;
	}

	private function getRevision() {
		if ( $this->revision instanceof RevisionRecord ) {
			return $this->revision;
		}

		$this->revision = $this->revisionGuard->getRevision(
			$this->getTitle(),
			$this->revision
		);

		return $this->revision;
	}

}