SpecialComparePages.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
 
class SpecialComparePages extends SpecialPage {
 
    // Stored objects
    protected $opts, $skin;
 
    // Some internal settings
    protected $showNavigation = false;
 
    public function __construct() {
        parent::__construct( 'ComparePages' );
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $this->getOutput()->addModuleStyles( 'mediawiki.special' );
        $this->addHelpLink( 'Help:Diff' );
 
        $form = HTMLForm::factory( 'ooui', [
            'Page1' => [
                'type' => 'title',
                'name' => 'page1',
                'label-message' => 'compare-page1',
                'size' => '40',
                'section' => 'page1',
                'validation-callback' => [ $this, 'checkExistingTitle' ],
                'required' => false,
            ],
            'Revision1' => [
                'type' => 'int',
                'name' => 'rev1',
                'label-message' => 'compare-rev1',
                'size' => '8',
                'section' => 'page1',
                'validation-callback' => [ $this, 'checkExistingRevision' ],
            ],
            'Page2' => [
                'type' => 'title',
                'name' => 'page2',
                'label-message' => 'compare-page2',
                'size' => '40',
                'section' => 'page2',
                'validation-callback' => [ $this, 'checkExistingTitle' ],
                'required' => false,
            ],
            'Revision2' => [
                'type' => 'int',
                'name' => 'rev2',
                'label-message' => 'compare-rev2',
                'size' => '8',
                'section' => 'page2',
                'validation-callback' => [ $this, 'checkExistingRevision' ],
            ],
            'Action' => [
                'type' => 'hidden',
                'name' => 'action',
            ],
            'Diffonly' => [
                'type' => 'hidden',
                'name' => 'diffonly',
            ],
            'Unhide' => [
                'type' => 'hidden',
                'name' => 'unhide',
            ],
        ], $this->getContext(), 'compare' );
        $form->setSubmitTextMsg( 'compare-submit' );
        $form->suppressReset();
        $form->setMethod( 'get' );
        $form->setSubmitCallback( [ __CLASS__, 'showDiff' ] );
 
        $form->loadData();
        $form->displayForm( '' );
        $form->trySubmit();
    }
 
    public static function showDiff( $data, HTMLForm $form ) {
        $rev1 = self::revOrTitle( $data['Revision1'], $data['Page1'] );
        $rev2 = self::revOrTitle( $data['Revision2'], $data['Page2'] );
 
        if ( $rev1 && $rev2 ) {
            $revisionRecord = MediaWikiServices::getInstance()
                ->getRevisionLookup()
                ->getRevisionById( $rev1 );
 
            if ( $revisionRecord ) { // NOTE: $rev1 was already checked, should exist.
                $contentModel = $revisionRecord->getSlot(
                    SlotRecord::MAIN,
                    RevisionRecord::RAW
                )->getModel();
                $contentHandler = MediaWikiServices::getInstance()
                    ->getContentHandlerFactory()
                    ->getContentHandler( $contentModel );
                $de = $contentHandler->createDifferenceEngine( $form->getContext(),
                    $rev1,
                    $rev2,
                    null, // rcid
                    ( $data['Action'] == 'purge' ),
                    ( $data['Unhide'] == '1' )
                );
                $de->showDiffPage( true );
            }
        }
    }
 
    public static function revOrTitle( $revision, $title ) {
        if ( $revision ) {
            return $revision;
        } elseif ( $title ) {
            $title = Title::newFromText( $title );
            if ( $title instanceof Title ) {
                return $title->getLatestRevID();
            }
        }
 
        return null;
    }
 
    public function checkExistingTitle( $value, $alldata ) {
        if ( $value === '' || $value === null ) {
            return true;
        }
        $title = Title::newFromText( $value );
        if ( !$title instanceof Title ) {
            return $this->msg( 'compare-invalid-title' )->parseAsBlock();
        }
        if ( !$title->exists() ) {
            return $this->msg( 'compare-title-not-exists' )->parseAsBlock();
        }
 
        return true;
    }
 
    public function checkExistingRevision( $value, $alldata ) {
        if ( $value === '' || $value === null ) {
            return true;
        }
        $revisionRecord = MediaWikiServices::getInstance()
            ->getRevisionLookup()
            ->getRevisionById( $value );
        if ( $revisionRecord === null ) {
            return $this->msg( 'compare-revision-not-exists' )->parseAsBlock();
        }
 
        return true;
    }
 
    protected function getGroupName() {
        return 'pagetools';
    }
}