SpecialPage.php

Go to the documentation of this file.

<?php
class SpecialPage {
    // 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;

    public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
        $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );

        return Title::makeTitle( NS_SPECIAL, $name, $fragment );
    }

    public static function getSafeTitleFor( $name, $subpage = false ) {
        $name = SpecialPageFactory::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;
    }

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

    function getLocalName() {
        if ( !isset( $this->mLocalName ) ) {
            $this->mLocalName = SpecialPageFactory::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 );
        }
    }

    public function prefixSearchSubpages( $search, $limit = 10 ) {
        return array();
    }

    protected static function prefixSearchArray( $search, $limit, array $subpages ) {
        $escaped = preg_quote( $search, '/' );
        return array_slice( preg_grep( "/^$escaped/i", $subpages ), 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( array(
                'mediawiki.ui.input',
                'mediawiki.ui.checkbox',
            ) );
        }
    }

    final public function run( $subPage ) {
        wfRunHooks( 'SpecialPageBeforeExecute', array( $this, $subPage ) );

        $this->beforeExecute( $subPage );
        $this->execute( $subPage );
        $this->afterExecute( $subPage );

        wfRunHooks( 'SpecialPageAfterExecute', array( $this, $subPage ) );
    }

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

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

    public function execute( $subPage ) {
        $this->setHeaders();
        $this->checkPermissions();
        $this->outputHeader();
    }

    function outputHeader( $summaryMessageKey = '' ) {
        global $wgContLang;

        if ( $summaryMessageKey == '' ) {
            $msg = $wgContLang->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 ) {
        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( /* $args */ ) {
        $message = call_user_func_array(
            array( $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 + array( 'feedformat' => $format );
            $url = wfAppendQuery( $feedTemplate, $theseParams );
            $this->getOutput()->addFeedLink( $format, $url );
        }
    }

    public function getFinalGroupName() {
        $name = $this->getName();
        $specialPageGroups = $this->getConfig()->get( 'SpecialPageGroups' );

        // Allow overbidding 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();

            // Group '-' is used as default to have the chance to determine,
            // if the special pages overrides this method,
            // if not overridden, $wgSpecialPageGroups is checked for b/c
            if ( $group === '-' && isset( $specialPageGroups[$name] ) ) {
                $group = $specialPageGroups[$name];
            }
        }

        // never give '-' back, change to 'other'
        if ( $group === '-' ) {
            $group = 'other';
        }

        return $group;
    }

    protected function getGroupName() {
        // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
        // Needed for b/c in getFinalGroupName
        return '-';
    }
}