SpecialCiteThisPage.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MediaWikiServices;
 
class SpecialCiteThisPage extends FormSpecialPage {
 
    private $citationParser;
 
    protected $title = false;
 
    public function __construct() {
        parent::__construct( 'CiteThisPage' );
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->addHelpLink( 'Extension:CiteThisPage' );
        parent::execute( $par );
        if ( $this->title instanceof Title ) {
            $id = $this->getRequest()->getInt( 'id' );
            $this->showCitations( $this->title, $id );
        }
    }
 
    protected function alterForm( HTMLForm $form ) {
        $form->setMethod( 'get' );
    }
 
    protected function getFormFields() {
        if ( isset( $this->par ) ) {
            $default = $this->par;
        } else {
            $default = '';
        }
        return [
            'page' => [
                'name' => 'page',
                'type' => 'title',
                'default' => $default,
                'label-message' => 'citethispage-change-target'
            ]
        ];
    }
 
    public function onSubmit( array $data ) {
        // GET forms are "submitted" on every view, so check
        // that some data was put in for page, as empty string
        // will pass validation
        if ( strlen( $data['page'] ) ) {
            $this->title = Title::newFromText( $data['page'] );
        }
        return true;
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $title = Title::newFromText( $search );
        if ( !$title || !$title->canExist() ) {
            // No prefix suggestion in special and media namespace
            return [];
        }
        // Autocomplete subpage the same as a normal search
        $result = SearchEngine::completionSearch( $search );
        return array_map( function ( $sub ) {
            return $sub->getSuggestedTitle();
        }, $result->getSuggestions() );
    }
 
    protected function getGroupName() {
        return 'pagetools';
    }
 
    private function showCitations( Title $title, $revId ) {
        if ( !$revId ) {
            $revId = $title->getLatestRevID();
        }
 
        $out = $this->getOutput();
 
        $revision = Revision::newFromTitle( $title, $revId );
        if ( !$revision ) {
            $out->wrapWikiMsg( '<div class="errorbox">$1</div>',
                [ 'citethispage-badrevision', $title->getPrefixedText(), $revId ] );
            return;
        }
 
        $parserOptions = $this->getParserOptions();
        // Set the overall timestamp to the revision's timestamp
        $parserOptions->setTimestamp( $revision->getTimestamp() );
 
        $parser = $this->getParser();
        // Register our <citation> tag which just parses using a different
        // context
        $parser->setHook( 'citation', [ $this, 'citationTag' ] );
        // Also hold on to a separate Parser instance for <citation> tag parsing
        // since we can't parse in a parse using the same Parser
        $this->citationParser = $this->getParser();
 
        $ret = $parser->parse(
            $this->getContentText(),
            $title,
            $parserOptions,
            /* $linestart = */ false,
            /* $clearstate = */ true,
            $revId
        );
 
        $this->getOutput()->addModuleStyles( 'ext.citeThisPage' );
        $this->getOutput()->addParserOutputContent( $ret, [
            'enableSectionEditLinks' => false,
        ] );
    }
 
    private function getParser() {
        $parserConf = $this->getConfig()->get( 'ParserConf' );
        return new $parserConf['class']( $parserConf );
    }
 
    private function getContentText() {
        $msg = $this->msg( 'citethispage-content' )->inContentLanguage()->plain();
        if ( $msg == '' ) {
            # With MediaWiki 1.20 the plain text files were deleted
            # and the text moved into SpecialCite.i18n.php
            # This code is kept for b/c in case an installation has its own file "citethispage-content-xx"
            # for a previously not supported language.
            global $wgContLanguageCode;
            $dir = __DIR__ . '/../';
            $code = MediaWikiServices::getInstance()->getContentLanguage()
                ->lc( $wgContLanguageCode );
            if ( file_exists( "${dir}citethispage-content-$code" ) ) {
                $msg = file_get_contents( "${dir}citethispage-content-$code" );
            } elseif ( file_exists( "${dir}citethispage-content" ) ) {
                $msg = file_get_contents( "${dir}citethispage-content" );
            }
        }
 
        return $msg;
    }
 
    private function getParserOptions() {
        $parserOptions = ParserOptions::newFromUser( $this->getUser() );
        $parserOptions->setDateFormat( 'default' );
        $parserOptions->setInterfaceMessage( true );
 
        // Having tidy on causes whitespace and <pre> tags to
        // be generated around the output of the CiteThisPageOutput
        // class TODO FIXME.
        $parserOptions->setTidy( false );
 
        return $parserOptions;
    }
 
    public function citationTag( $text, $params, Parser $parser ) {
        $parserOptions = $this->getParserOptions();
 
        $ret = $this->citationParser->parse(
            $text,
            $this->getPageTitle(),
            $parserOptions,
            /* $linestart = */ false
        );
 
        return $ret->getText( [
            'enableSectionEditLinks' => false,
            // This will be inserted into the output of another parser, so there will actually be a wrapper
            'unwrap' => true,
        ] );
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    public function requiresWrite() {
        return false;
    }
}