SpecialPage.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthManager;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;

class SpecialPage implements MessageLocalizer {
    // The canonical name of this special page
    // Also used for the default <h1> heading, @see getDescription()
    protected $mName;

    // The local name of this special page
    private $mLocalName;

    // Minimum user level required to access this page, or "" for anyone.
    // Also used to categorise the pages in Special:Specialpages
    protected $mRestriction;

    // Listed in Special:Specialpages?
    private $mListed;

    // Whether or not this special page is being included from an article
    protected $mIncluding;

    // Whether the special page can be included in an article
    protected $mIncludable;

    protected $mContext;

    private $linkRenderer;

    public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
        return Title::newFromTitleValue(
            self::getTitleValueFor( $name, $subpage, $fragment )
        );
    }

    public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
        $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
            getLocalNameFor( $name, $subpage );

        return new TitleValue( NS_SPECIAL, $name, $fragment );
    }

    public static function getSafeTitleFor( $name, $subpage = false ) {
        $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
            getLocalNameFor( $name, $subpage );
        if ( $name ) {
            return Title::makeTitleSafe( NS_SPECIAL, $name );
        } else {
            return null;
        }
    }

    public function __construct(
        $name = '', $restriction = '', $listed = true,
        $function = false, $file = '', $includable = false
    ) {
        $this->mName = $name;
        $this->mRestriction = $restriction;
        $this->mListed = $listed;
        $this->mIncludable = $includable;
    }

    function getName() {
        return $this->mName;
    }

    function getRestriction() {
        return $this->mRestriction;
    }

    // @todo FIXME: Decide which syntax to use for this, and stick to it

    function isListed() {
        return $this->mListed;
    }

    function setListed( $listed ) {
        return wfSetVar( $this->mListed, $listed );
    }

    function listed( $x = null ) {
        return wfSetVar( $this->mListed, $x );
    }

    public function isIncludable() {
        return $this->mIncludable;
    }

    public function maxIncludeCacheTime() {
        return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
    }

    protected function getCacheTTL() {
        return 60 * 60;
    }

    function including( $x = null ) {
        return wfSetVar( $this->mIncluding, $x );
    }

    function getLocalName() {
        if ( !isset( $this->mLocalName ) ) {
            $this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
                getLocalNameFor( $this->mName );
        }

        return $this->mLocalName;
    }

    public function isExpensive() {
        return false;
    }

    public function isCached() {
        return false;
    }

    public function isRestricted() {
        // DWIM: If anons can do something, then it is not restricted
        return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
    }

    public function userCanExecute( User $user ) {
        return $user->isAllowed( $this->mRestriction );
    }

    function displayRestrictionError() {
        throw new PermissionsError( $this->mRestriction );
    }

    public function checkPermissions() {
        if ( !$this->userCanExecute( $this->getUser() ) ) {
            $this->displayRestrictionError();
        }
    }

    public function checkReadOnly() {
        if ( wfReadOnly() ) {
            throw new ReadOnlyError;
        }
    }

    public function requireLogin(
        $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
    ) {
        if ( $this->getUser()->isAnon() ) {
            throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
        }
    }

    protected function getLoginSecurityLevel() {
        return false;
    }

    protected function setReauthPostData( array $data ) {
    }

    protected function checkLoginSecurityLevel( $level = null ) {
        $level = $level ?: $this->getName();
        $key = 'SpecialPage:reauth:' . $this->getName();
        $request = $this->getRequest();

        $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
        if ( $securityStatus === AuthManager::SEC_OK ) {
            $uniqueId = $request->getVal( 'postUniqueId' );
            if ( $uniqueId ) {
                $key .= ':' . $uniqueId;
                $session = $request->getSession();
                $data = $session->getSecret( $key );
                if ( $data ) {
                    $session->remove( $key );
                    $this->setReauthPostData( $data );
                }
            }
            return true;
        } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
            $title = self::getTitleFor( 'Userlogin' );
            $queryParams = $request->getQueryValues();

            if ( $request->wasPosted() ) {
                $data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
                if ( $data ) {
                    // unique ID in case the same special page is open in multiple browser tabs
                    $uniqueId = MWCryptRand::generateHex( 6 );
                    $key .= ':' . $uniqueId;
                    $queryParams['postUniqueId'] = $uniqueId;
                    $session = $request->getSession();
                    $session->persist(); // Just in case
                    $session->setSecret( $key, $data );
                }
            }

            $query = [
                'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
                'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
                'force' => $level,
            ];
            $url = $title->getFullURL( $query, false, PROTO_HTTPS );

            $this->getOutput()->redirect( $url );
            return false;
        }

        $titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
        $errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
        throw new ErrorPageError( $titleMessage, $errorMessage );
    }

    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $subpages = $this->getSubpagesForPrefixSearch();
        if ( !$subpages ) {
            return [];
        }

        return self::prefixSearchArray( $search, $limit, $subpages, $offset );
    }

    protected function getSubpagesForPrefixSearch() {
        return [];
    }

    protected function prefixSearchString( $search, $limit, $offset ) {
        $title = Title::newFromText( $search );
        if ( !$title || !$title->canExist() ) {
            // No prefix suggestion in special and media namespace
            return [];
        }

        $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
        $searchEngine->setLimitOffset( $limit, $offset );
        $searchEngine->setNamespaces( [] );
        $result = $searchEngine->defaultPrefixSearch( $search );
        return array_map( function ( Title $t ) {
            return $t->getPrefixedText();
        }, $result );
    }

    protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
        $escaped = preg_quote( $search, '/' );
        return array_slice( preg_grep( "/^$escaped/i",
            array_slice( $subpages, $offset ) ), 0, $limit );
    }

    function setHeaders() {
        $out = $this->getOutput();
        $out->setArticleRelated( false );
        $out->setRobotPolicy( $this->getRobotPolicy() );
        $out->setPageTitle( $this->getDescription() );
        if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
            $out->addModuleStyles( [
                'mediawiki.ui.input',
                'mediawiki.ui.radio',
                'mediawiki.ui.checkbox',
            ] );
        }
    }

    final public function run( $subPage ) {
        if ( !Hooks::run( 'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
            return;
        }

        if ( $this->beforeExecute( $subPage ) === false ) {
            return;
        }
        $this->execute( $subPage );
        $this->afterExecute( $subPage );

        Hooks::run( 'SpecialPageAfterExecute', [ $this, $subPage ] );
    }

    protected function beforeExecute( $subPage ) {
        // No-op
    }

    protected function afterExecute( $subPage ) {
        // No-op
    }

    public function execute( $subPage ) {
        $this->setHeaders();
        $this->checkPermissions();
        $securityLevel = $this->getLoginSecurityLevel();
        if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
            return;
        }
        $this->outputHeader();
    }

    function outputHeader( $summaryMessageKey = '' ) {
        if ( $summaryMessageKey == '' ) {
            $msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
                '-summary';
        } else {
            $msg = $summaryMessageKey;
        }
        if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
            $this->getOutput()->wrapWikiMsg(
                "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
        }
    }

    function getDescription() {
        return $this->msg( strtolower( $this->mName ) )->text();
    }

    function getTitle( $subpage = false ) {
        wfDeprecated( __METHOD__, '1.23' );
        return $this->getPageTitle( $subpage );
    }

    function getPageTitle( $subpage = false ) {
        return self::getTitleFor( $this->mName, $subpage );
    }

    public function setContext( $context ) {
        $this->mContext = $context;
    }

    public function getContext() {
        if ( $this->mContext instanceof IContextSource ) {
            return $this->mContext;
        } else {
            wfDebug( __METHOD__ . " called and \$mContext is null. " .
                "Return RequestContext::getMain(); for sanity\n" );

            return RequestContext::getMain();
        }
    }

    public function getRequest() {
        return $this->getContext()->getRequest();
    }

    public function getOutput() {
        return $this->getContext()->getOutput();
    }

    public function getUser() {
        return $this->getContext()->getUser();
    }

    public function getSkin() {
        return $this->getContext()->getSkin();
    }

    public function getLanguage() {
        return $this->getContext()->getLanguage();
    }

    public function getConfig() {
        return $this->getContext()->getConfig();
    }

    public function getFullTitle() {
        return $this->getContext()->getTitle();
    }

    protected function getRobotPolicy() {
        return 'noindex,nofollow';
    }

    public function msg( $key /* $args */ ) {
        $message = $this->getContext()->msg( ...func_get_args() );
        // RequestContext passes context to wfMessage, and the language is set from
        // the context, but setting the language for Message class removes the
        // interface message status, which breaks for example usernameless gender
        // invocations. Restore the flag when not including special page in content.
        if ( $this->including() ) {
            $message->setInterfaceMessageFlag( false );
        }

        return $message;
    }

    protected function addFeedLinks( $params ) {
        $feedTemplate = wfScript( 'api' );

        foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
            $theseParams = $params + [ 'feedformat' => $format ];
            $url = wfAppendQuery( $feedTemplate, $theseParams );
            $this->getOutput()->addFeedLink( $format, $url );
        }
    }

    public function addHelpLink( $to, $overrideBaseUrl = false ) {
        if ( $this->including() ) {
            return;
        }

        $msg = $this->msg(
            MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
            '-helppage' );

        if ( !$msg->isDisabled() ) {
            $helpUrl = Skin::makeUrl( $msg->plain() );
            $this->getOutput()->addHelpLink( $helpUrl, true );
        } else {
            $this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
        }
    }

    public function getFinalGroupName() {
        $name = $this->getName();

        // Allow overriding the group from the wiki side
        $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
        if ( !$msg->isBlank() ) {
            $group = $msg->text();
        } else {
            // Than use the group from this object
            $group = $this->getGroupName();
        }

        return $group;
    }

    public function doesWrites() {
        return false;
    }

    protected function getGroupName() {
        return 'other';
    }

    protected function useTransactionalTimeLimit() {
        if ( $this->getRequest()->wasPosted() ) {
            wfTransactionalTimeLimit();
        }
    }

    public function getLinkRenderer() {
        if ( $this->linkRenderer ) {
            return $this->linkRenderer;
        } else {
            return MediaWikiServices::getInstance()->getLinkRenderer();
        }
    }

    public function setLinkRenderer( LinkRenderer $linkRenderer ) {
        $this->linkRenderer = $linkRenderer;
    }

    protected function buildPrevNextNavigation( $offset, $limit,
        array $query = [], $atend = false, $subpage = false
    ) {
        $lang = $this->getLanguage();

        # Make 'previous' link
        $prev = $this->msg( 'prevn' )->numParams( $limit )->text();
        if ( $offset > 0 ) {
            $plink = $this->numLink( max( $offset - $limit, 0 ), $limit, $query,
                $prev, 'prevn-title', 'mw-prevlink', $subpage );
        } else {
            $plink = htmlspecialchars( $prev );
        }

        # Make 'next' link
        $next = $this->msg( 'nextn' )->numParams( $limit )->text();
        if ( $atend ) {
            $nlink = htmlspecialchars( $next );
        } else {
            $nlink = $this->numLink( $offset + $limit, $limit,
                $query, $next, 'nextn-title', 'mw-nextlink', $subpage );
        }

        # Make links to set number of items per page
        $numLinks = [];
        foreach ( [ 20, 50, 100, 250, 500 ] as $num ) {
            $numLinks[] = $this->numLink( $offset, $num, $query,
                $lang->formatNum( $num ), 'shown-title', 'mw-numlink', $subpage );
        }

        return $this->msg( 'viewprevnext' )->rawParams( $plink, $nlink, $lang->pipeList( $numLinks ) )->
            escaped();
    }

    private function numLink( $offset, $limit, array $query, $link,
        $tooltipMsg, $class, $subpage = false
    ) {
        $query = [ 'limit' => $limit, 'offset' => $offset ] + $query;
        $tooltip = $this->msg( $tooltipMsg )->numParams( $limit )->text();
        $href = $this->getPageTitle( $subpage )->getLocalURL( $query );
        return Html::element( 'a', [ 'href' => $href,
            'title' => $tooltip, 'class' => $class ], $link );
    }
}