SpecialComparePages.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use DifferenceEngine;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
 
class SpecialComparePages extends SpecialPage {
 
    private RevisionLookup $revisionLookup;
    private IContentHandlerFactory $contentHandlerFactory;
 
    private $differenceEngine;
 
    public function __construct(
        RevisionLookup $revisionLookup,
        IContentHandlerFactory $contentHandlerFactory
    ) {
        parent::__construct( 'ComparePages' );
        $this->revisionLookup = $revisionLookup;
        $this->contentHandlerFactory = $contentHandlerFactory;
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $this->getOutput()->addModuleStyles( 'mediawiki.special' );
        $this->addHelpLink( 'Help:Diff' );
 
        $form = HTMLForm::factory( 'ooui', [
            'Page1' => [
                'type' => 'title',
                'exists' => true,
                'name' => 'page1',
                'label-message' => 'compare-page1',
                'size' => '40',
                'section' => 'page1',
                'required' => false,
            ],
            'Revision1' => [
                'type' => 'int',
                'name' => 'rev1',
                'label-message' => 'compare-rev1',
                'size' => '8',
                'section' => 'page1',
                'validation-callback' => $this->checkExistingRevision( ... ),
            ],
            'Page2' => [
                'type' => 'title',
                'name' => 'page2',
                'exists' => true,
                'label-message' => 'compare-page2',
                'size' => '40',
                'section' => 'page2',
                'required' => false,
            ],
            'Revision2' => [
                'type' => 'int',
                'name' => 'rev2',
                'label-message' => 'compare-rev2',
                'size' => '8',
                'section' => 'page2',
                'validation-callback' => $this->checkExistingRevision( ... ),
            ],
            'Action' => [
                'type' => 'hidden',
                'name' => 'action',
            ],
            'Unhide' => [
                'type' => 'hidden',
                'name' => 'unhide',
            ],
        ], $this->getContext(), 'compare' );
 
        $form->setMethod( 'get' )
            ->setSubmitTextMsg( 'compare-submit' )
            ->setSubmitCallback( $this->showDiff( ... ) )
            ->show();
 
        if ( $this->differenceEngine ) {
            $this->differenceEngine->showDiffPage( true );
        }
    }
 
    private function showDiff( $data, HTMLForm $form ) {
        $rev1 = $this->revOrTitle( $data['Revision1'], $data['Page1'] );
        $rev2 = $this->revOrTitle( $data['Revision2'], $data['Page2'] );
 
        if ( $rev1 && $rev2 ) {
            // Revision IDs either passed the existence check or were fetched from existing titles.
            $revisionRecord = $this->revisionLookup->getRevisionById( $rev1 );
            $contentModel = $revisionRecord->getSlot(
                SlotRecord::MAIN,
                RevisionRecord::RAW
            )->getModel();
            $contentHandler = $this->contentHandlerFactory->getContentHandler( $contentModel );
            $this->differenceEngine = $contentHandler->createDifferenceEngine( $form->getContext(),
                $rev1,
                $rev2,
                0, // rcid
                ( $data['Action'] == 'purge' ),
                ( $data['Unhide'] == '1' )
            );
        }
    }
 
    private function revOrTitle( ?string $revision, ?string $title ): ?int {
        if ( $revision ) {
            return (int)$revision;
        } elseif ( $title ) {
            return Title::newFromText( $title )->getLatestRevID();
        }
 
        return null;
    }
 
    private function checkExistingRevision( $value, $alldata ) {
        if ( $value === '' || $value === null ) {
            return true;
        }
        $revisionRecord = $this->revisionLookup->getRevisionById( (int)$value );
        if ( $revisionRecord === null ) {
            return $this->msg( 'compare-revision-not-exists' )->parseAsBlock();
        }
 
        return true;
    }
 
    protected function getGroupName() {
        return 'pagetools';
    }
}
 
class_alias( SpecialComparePages::class, 'SpecialComparePages' );