LoginHelper.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
 
class LoginHelper extends ContextSource {
    use ProtectedHookAccessorTrait;
 
    public static $validErrorMessages = [
        'exception-nologin-text',
        'exception-nologin-text-for-temp-user',
        'watchlistanontext',
        'watchlistanontext-for-temp-user',
        'changeemail-no-info',
        'confirmemail_needlogin',
        'prefsnologintext2',
        'prefsnologintext2-for-temp-user',
        'specialmute-login-required',
        'specialmute-login-required-for-temp-user',
        'mailnologintext',
    ];
 
    private static ?array $validErrorMessagesCache = null;
 
    public static function getValidErrorMessages(): array {
        if ( !static::$validErrorMessagesCache ) {
            static::$validErrorMessagesCache = self::$validErrorMessages;
            ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
                ->onLoginFormValidErrorMessages( static::$validErrorMessagesCache );
        }
 
        return static::$validErrorMessagesCache;
    }
 
    public function __construct( IContextSource $context ) {
        $this->setContext( $context );
    }
 
    public function showReturnToPage(
        $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false, $returnToAnchor = ''
    ) {
        $config = $this->getConfig();
        if ( $type !== 'error' && $config->get( MainConfigNames::RedirectOnLogin ) !== null ) {
            $returnTo = $config->get( MainConfigNames::RedirectOnLogin );
            $returnToQuery = [];
        } elseif ( is_string( $returnToQuery ) ) {
            $returnToQuery = wfCgiToArray( $returnToQuery );
        }
        if ( $returnToAnchor !== '' && $returnToAnchor[0] !== '#' ) {
            $returnToAnchor = '';
        }
 
        // Allow modification of redirect behavior
        $oldReturnTo = $returnTo;
        $oldReturnToQuery = $returnToQuery;
        $this->getHookRunner()->onPostLoginRedirect( $returnTo, $returnToQuery, $type );
        if ( $returnTo !== $oldReturnTo || $returnToQuery !== $oldReturnToQuery ) {
            // PostLoginRedirect does not handle $returnToAnchor, and changing hooks is hard.
            // At least don't add the anchor if the hook changed the URL.
            $returnToAnchor = '';
        }
 
        $returnToTitle = Title::newFromText( $returnTo ) ?: Title::newMainPage();
 
        if ( $config->get( MainConfigNames::ForceHTTPS )
            || ( $config->get( MainConfigNames::SecureLogin ) && $stickHTTPS )
        ) {
            $options = [ 'https' ];
            $proto = PROTO_HTTPS;
        } elseif ( $config->get( MainConfigNames::SecureLogin ) && !$stickHTTPS ) {
            $options = [ 'http' ];
            $proto = PROTO_HTTP;
        } else {
            $options = [];
            $proto = PROTO_RELATIVE;
        }
 
        if ( $type === 'successredirect' ) {
            $redirectUrl = $returnToTitle->getFullUrlForRedirect( $returnToQuery, $proto )
                . $returnToAnchor;
            $this->getOutput()->redirect( $redirectUrl );
        } else {
            $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
        }
    }
}