UserNotLoggedIn.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Exception;
 
use LoginHelper;
use MediaWiki\Context\RequestContext;
use MediaWiki\SpecialPage\SpecialPage;
 
class UserNotLoggedIn extends ErrorPageError {
 
    private bool $alwaysRedirectToLoginPage;
 
    public function __construct(
        $reasonMsg = 'exception-nologin-text',
        $titleMsg = 'exception-nologin',
        $params = [],
        bool $alwaysRedirectToLoginPage = false
    ) {
        $context = RequestContext::getMain();
        // Replace the reason message for one that describes creating account when the user is a temporary account
        // when such a custom message exists (T358586).
        if ( $context->getUser()->isTemp() && !$alwaysRedirectToLoginPage ) {
            // For grep to find usages: exception-nologin-text-for-temp-user
            $tempUserReasonMsg = $reasonMsg . '-for-temp-user';
            if ( $context->msg( $tempUserReasonMsg )->exists() ) {
                $reasonMsg = $tempUserReasonMsg;
            }
        }
        parent::__construct( $titleMsg, $reasonMsg, $params );
        $this->alwaysRedirectToLoginPage = $alwaysRedirectToLoginPage;
    }
 
    public function report( $action = self::SEND_OUTPUT ) {
        // If an unsupported message is used, don't try redirecting to Special:Userlogin,
        // since the message may not be compatible.
        if ( !in_array( $this->msg, LoginHelper::getValidErrorMessages() ) ) {
            parent::report( $action );
            return;
        }
 
        $context = RequestContext::getMain();
 
        // Message is valid. Redirect to Special:Userlogin, unless the user is a temporary account in which case
        // redirect to Special:CreateAccount (T358586).
        $specialPageName = 'Userlogin';
        if ( $context->getUser()->isTemp() && !$this->alwaysRedirectToLoginPage ) {
            $specialPageName = 'CreateAccount';
        }
 
        $output = $context->getOutput();
        $query = $context->getRequest()->getQueryValues();
        // Title will be overridden by returnto
        unset( $query['title'] );
        // Redirect to Special:Userlogin
        $output->redirect( SpecialPage::getTitleFor( $specialPageName )->getFullURL( [
            // Return to this page when the user logs in
            'returnto' => $context->getTitle()->getFullText(),
            'returntoquery' => wfArrayToCgi( $query ),
            'warning' => $this->msg,
            // Forward the 'display' parameter if provided
            'display' => $query['display'] ?? null,
        ] ) );
 
        if ( $action === self::SEND_OUTPUT ) {
            $output->output();
        }
    }
}
 
class_alias( UserNotLoggedIn::class, 'UserNotLoggedIn' );