SpecialPage.php

Go to the documentation of this file.

<?php
namespace MediaWiki\SpecialPage;
 
use MediaWiki\Auth\AuthManager;
use MediaWiki\Config\Config;
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\Debug\DeprecationHelper;
use MediaWiki\Exception\ErrorPageError;
use MediaWiki\Exception\PermissionsError;
use MediaWiki\Exception\ReadOnlyError;
use MediaWiki\Exception\UserNotLoggedIn;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Language\Language;
use MediaWiki\Language\MessageLocalizer;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Navigation\PagerNavigationBuilder;
use MediaWiki\Output\OutputPage;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Request\WebRequest;
use MediaWiki\Search\SearchEngineFactory;
use MediaWiki\Skin\Skin;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\User;
use MediaWiki\Utils\MWCryptRand;
use Wikimedia\Message\MessageParam;
use Wikimedia\Message\MessageSpecifier;
 
abstract class SpecialPage implements MessageLocalizer {
    use DeprecationHelper;
 
    protected $mName;
 
    private $mLocalName;
 
    private $mRestriction;
 
    private $mListed;
 
    protected $mIncluding;
 
    protected $mIncludable;
 
    protected $mContext;
 
    private $contentLanguage;
 
    private $linkRenderer = null;
 
    private $hookContainer;
    private $hookRunner;
 
    private $authManager = null;
 
    private $specialPageFactory;
 
    public static function newSearchPage( User $user ) {
        // Try user preference first
        $userOptionsManager = MediaWikiServices::getInstance()->getUserOptionsManager();
        $title = $userOptionsManager->getOption( $user, 'search-special-page' );
        if ( $title ) {
            $page = self::getTitleFor( $title );
            $factory = MediaWikiServices::getInstance()->getSpecialPageFactory();
            if ( $factory->exists( $page->getText() ) ) {
                return $page;
            }
        }
        return self::getTitleFor( 'Search' );
    }
 
    public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
        return Title::newFromLinkTarget(
            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
    ) {
        if ( func_num_args() > 1 ) {
            wfDeprecated( __CLASS__ . ' constructor parameters $restriction, ' .
                '$listed, $function, $file and $includable', '1.46' );
        }
        $this->mName = $name;
        $this->mRestriction = $restriction;
        $this->deprecatePublicProperty( 'mRestriction', '1.46', __CLASS__ );
        $this->mListed = $listed;
        $this->mIncludable = $includable;
    }
 
    public function getName() {
        return $this->mName;
    }
 
    public function getRestriction(): string {
        return (string)$this->mRestriction;
    }
 
    public function isListed() {
        return $this->mListed;
    }
 
    public function isIncludable() {
        if ( $this->mIncludable ) {
            wfDeprecated( __CLASS__ . ' property $mIncludable', '1.46' );
        }
        return $this->mIncludable;
    }
 
    public function maxIncludeCacheTime() {
        return $this->getConfig()->get( MainConfigNames::MiserMode ) ? $this->getCacheTTL() : 0;
    }
 
    protected function getCacheTTL() {
        return 60 * 60;
    }
 
    public function including( $x = null ) {
        return wfSetVar( $this->mIncluding, $x );
    }
 
    public function getLocalName() {
        if ( $this->mLocalName === null ) {
            $this->mLocalName = $this->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->getRestriction() != '' && !MediaWikiServices::getInstance()
            ->getGroupPermissionsLookup()
            ->groupHasPermission( '*', $this->getRestriction() );
    }
 
    public function userCanExecute( User $user ) {
        return MediaWikiServices::getInstance()
            ->getPermissionManager()
            ->userHasRight( $user, $this->getRestriction() );
    }
 
    protected function authorizeAction( ?string $action = null ): PermissionStatus {
        $action ??= $this->getRestriction();
 
        if ( !$action ) {
            return PermissionStatus::newGood();
        }
 
        $status = PermissionStatus::newEmpty();
        $this->getAuthority()->authorizeAction( $action, $status );
        return $status;
    }
 
    protected function displayRestrictionError() {
        throw new PermissionsError( $this->getRestriction() );
    }
 
    public function checkPermissions() {
        if ( !$this->userCanExecute( $this->getUser() ) ) {
            $this->displayRestrictionError();
        }
    }
 
    public function checkReadOnly() {
        // Can not inject the ReadOnlyMode as it would break the installer since
        // it instantiates SpecialPageFactory before the DB (via ParserFactory for message parsing)
        if ( MediaWikiServices::getInstance()->getReadOnlyMode()->isReadOnly() ) {
            throw new ReadOnlyError;
        }
    }
 
    public function requireLogin(
        $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
    ) {
        if ( $this->getUser()->isAnon() ) {
            throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
        }
    }
 
    public function requireNamedUser(
        $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin', bool $alwaysRedirectToLoginPage = false
    ) {
        if ( !$this->getUser()->isNamed() ) {
            throw new UserNotLoggedIn( $reasonMsg, $titleMsg, [], $alwaysRedirectToLoginPage );
        }
    }
 
    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 = $this->getAuthManager()->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 );
    }
 
    final protected function setAuthManager( AuthManager $authManager ): void {
        $this->authManager = $authManager;
    }
 
    final protected function getAuthManager(): AuthManager {
        if ( $this->authManager === null ) {
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            $this->authManager = MediaWikiServices::getInstance()->getAuthManager();
        }
        return $this->authManager;
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $subpages = $this->getSubpagesForPrefixSearch();
        if ( !$subpages ) {
            return [];
        }
 
        return self::prefixSearchArray( $search, $limit, $subpages, $offset );
    }
 
    protected function getSubpagesForPrefixSearch() {
        return [];
    }
 
    public function getAssociatedNavigationLinks() {
        return [];
    }
 
    protected function prefixSearchString(
        $search,
        $limit,
        $offset,
        ?SearchEngineFactory $searchEngineFactory = null
    ) {
        $title = Title::newFromText( $search );
        if ( !$title || !$title->canExist() ) {
            // No prefix suggestion in special and media namespace
            return [];
        }
 
        $searchEngine = $searchEngineFactory
            ? $searchEngineFactory->create()
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            : MediaWikiServices::getInstance()->newSearchEngine();
        $searchEngine->setLimitOffset( $limit, $offset );
        $searchEngine->setNamespaces( [] );
        $result = $searchEngine->defaultPrefixSearch( $search );
        return array_map( static 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 );
    }
 
    protected function setHeaders() {
        $out = $this->getOutput();
        $out->setArticleRelated( false );
        $out->setRobotPolicy( $this->getRobotPolicy() );
        $out->setPageTitleMsg( $this->getDescription() );
    }
 
    final public function run( $subPage ) {
        $scope = LoggerFactory::getContext()->addScoped( [
            'context.special_page_name' => $this->getName(),
            'context.special_page_subpage' => $subPage ?? '',
        ] );
        if ( !$this->getHookRunner()->onSpecialPageBeforeExecute( $this, $subPage ) ) {
            return;
        }
 
        if ( $this->beforeExecute( $subPage ) === false ) {
            return;
        }
        $this->execute( $subPage );
        $this->afterExecute( $subPage );
 
        $this->getHookRunner()->onSpecialPageAfterExecute( $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();
    }
 
    protected function outputHeader( $summaryMessageKey = '' ) {
        if ( $summaryMessageKey == '' ) {
            $msg = strtolower( $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 );
        }
    }
 
    public function getDescription() {
        return $this->msg( strtolower( $this->mName ) );
    }
 
    public function getShortDescription( string $path = '' ): string {
        $lowerPath = strtolower( str_replace( '/', '-', $path ) );
        $shortKey = 'special-tab-' . $lowerPath;
        $shortKey .= '-short';
        $msgShort = $this->msg( $shortKey );
        return $msgShort->text();
    }
 
    public 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 ) ) {
            wfDebug( __METHOD__ . " called and \$mContext is null. " .
                "Using RequestContext::getMain()" );
 
            $this->mContext = RequestContext::getMain();
        }
        return $this->mContext;
    }
 
    public function getRequest() {
        return $this->getContext()->getRequest();
    }
 
    public function getOutput() {
        return $this->getContext()->getOutput();
    }
 
    public function getUser() {
        return $this->getContext()->getUser();
    }
 
    public function getAuthority(): Authority {
        return $this->getContext()->getAuthority();
    }
 
    public function getSkin() {
        return $this->getContext()->getSkin();
    }
 
    public function getLanguage() {
        return $this->getContext()->getLanguage();
    }
 
    final public function getContentLanguage(): Language {
        if ( $this->contentLanguage === null ) {
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            $this->contentLanguage = MediaWikiServices::getInstance()->getContentLanguage();
        }
        return $this->contentLanguage;
    }
 
    final public function setContentLanguage( Language $contentLanguage ) {
        $this->contentLanguage = $contentLanguage;
    }
 
    public function getConfig() {
        return $this->getContext()->getConfig();
    }
 
    public function getFullTitle() {
        return $this->getContext()->getTitle();
    }
 
    protected function getRobotPolicy() {
        return 'noindex,nofollow';
    }
 
    public function msg( $key, ...$params ) {
        $message = $this->getContext()->msg( $key, ...$params );
        // 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( MainConfigNames::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( strtolower( $this->getName() ) . '-helppage' );
 
        if ( !$msg->isDisabled() ) {
            $title = Title::newFromText( $msg->plain() );
            if ( $title instanceof Title ) {
                $this->getOutput()->addHelpLink( $title->getLocalURL(), 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(): LinkRenderer {
        if ( $this->linkRenderer === null ) {
            // TODO Inject the service
            $this->linkRenderer = MediaWikiServices::getInstance()->getLinkRendererFactory()
                ->create();
        }
        return $this->linkRenderer;
    }
 
    public function setLinkRenderer( LinkRenderer $linkRenderer ) {
        $this->linkRenderer = $linkRenderer;
    }
 
    protected function buildPrevNextNavigation(
        $offset,
        $limit,
        array $query = [],
        $atEnd = false,
        $subpage = false
    ) {
        $navBuilder = new PagerNavigationBuilder( $this );
        $navBuilder
            ->setPage( $this->getPageTitle( $subpage ) )
            ->setLinkQuery( [ 'limit' => $limit, 'offset' => $offset ] + $query )
            ->setLimitLinkQueryParam( 'limit' )
            ->setCurrentLimit( $limit )
            ->setPrevTooltipMsg( 'prevn-title' )
            ->setNextTooltipMsg( 'nextn-title' )
            ->setLimitTooltipMsg( 'shown-title' );
 
        if ( $offset > 0 ) {
            $navBuilder->setPrevLinkQuery( [ 'offset' => (string)max( $offset - $limit, 0 ) ] );
        }
        if ( !$atEnd ) {
            $navBuilder->setNextLinkQuery( [ 'offset' => (string)( $offset + $limit ) ] );
        }
 
        return $navBuilder->getHtml();
    }
 
    public function setHookContainer( HookContainer $hookContainer ) {
        $this->hookContainer = $hookContainer;
        $this->hookRunner = new HookRunner( $hookContainer );
    }
 
    protected function getHookContainer() {
        if ( !$this->hookContainer ) {
            $this->hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        }
        return $this->hookContainer;
    }
 
    protected function getHookRunner() {
        if ( !$this->hookRunner ) {
            $this->hookRunner = new HookRunner( $this->getHookContainer() );
        }
        return $this->hookRunner;
    }
 
    final public function setSpecialPageFactory( SpecialPageFactory $specialPageFactory ) {
        $this->specialPageFactory = $specialPageFactory;
    }
 
    final protected function getSpecialPageFactory(): SpecialPageFactory {
        if ( !$this->specialPageFactory ) {
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            $this->specialPageFactory = MediaWikiServices::getInstance()->getSpecialPageFactory();
        }
        return $this->specialPageFactory;
    }
}
 
class_alias( SpecialPage::class, 'SpecialPage' );