DefaultOutputPipelineFactory.php

<?php

namespace MediaWiki\OutputTransform;

use Language;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Languages\LanguageFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\OutputTransform\Stages\AddRedirectHeader;
use MediaWiki\OutputTransform\Stages\AddWrapperDivClass;
use MediaWiki\OutputTransform\Stages\DeduplicateStyles;
use MediaWiki\OutputTransform\Stages\ExecutePostCacheTransformHooks;
use MediaWiki\OutputTransform\Stages\ExpandToAbsoluteUrls;
use MediaWiki\OutputTransform\Stages\ExtractBody;
use MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks;
use MediaWiki\OutputTransform\Stages\HandleSectionLinks;
use MediaWiki\OutputTransform\Stages\HandleTOCMarkers;
use MediaWiki\OutputTransform\Stages\HydrateHeaderPlaceholders;
use MediaWiki\OutputTransform\Stages\ParsoidLocalization;
use MediaWiki\OutputTransform\Stages\RenderDebugInfo;
use MediaWiki\Tidy\TidyDriverBase;
use MediaWiki\Title\TitleFactory;
use Psr\Log\LoggerInterface;

/**
 * This class contains the default output transformation pipeline factory for wikitext. It is a postprocessor for
 * ParserOutput objects either directly resulting from a parse or fetched from ParserCache.
 * @unstable
 */
class DefaultOutputPipelineFactory {

	/** @internal */
	public const CONSTRUCTOR_OPTIONS = [
		MainConfigNames::ParserEnableLegacyHeadingDOM, // For HandleSectionLinks
	];

	private ServiceOptions $options;
	private HookContainer $hookContainer;
	private LoggerInterface $logger;
	private TidyDriverBase $tidy;
	private LanguageFactory $langFactory;
	private Language $contentLang;
	private TitleFactory $titleFactory;

	public function __construct(
		ServiceOptions $options,
		HookContainer $hookContainer,
		TidyDriverBase $tidy,
		LanguageFactory $langFactory,
		Language $contentLang,
		LoggerInterface $logger,
		TitleFactory $titleFactory
	) {
		$this->options = $options;
		$this->hookContainer = $hookContainer;
		$this->logger = $logger;
		$this->langFactory = $langFactory;
		$this->contentLang = $contentLang;
		$this->tidy = $tidy;
		$this->titleFactory = $titleFactory;
	}

	/**
	 * Creates a pipeline of transformations to transform the content of the ParserOutput object from "parsed HTML"
	 * to "output HTML" and returns it.
	 * @internal
	 * @return OutputTransformPipeline
	 */
	public function buildPipeline(): OutputTransformPipeline {
		return ( new OutputTransformPipeline() )
			->addStage( new ExtractBody( $this->logger ) )
			->addStage( new AddRedirectHeader() )
			->addStage( new RenderDebugInfo( $this->hookContainer ) )
			->addStage( new ParsoidLocalization( $this->logger ) )
			->addStage( new ExecutePostCacheTransformHooks( $this->hookContainer ) )
			->addStage( new AddWrapperDivClass( $this->langFactory, $this->contentLang ) )
			->addStage( new HandleSectionLinks( $this->options, $this->titleFactory ) )
			->addStage( new HandleParsoidSectionLinks( $this->logger, $this->titleFactory ) )
			->addStage( new HandleTOCMarkers( $this->tidy ) )
			->addStage( new DeduplicateStyles() )
			->addStage( new ExpandToAbsoluteUrls() )
			->addStage( new HydrateHeaderPlaceholders() );
	}
}