SpecialUserLogout.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Exception\ErrorPageError;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Session\SessionManager;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Status\Status;
use MediaWiki\User\TempUser\TempUserConfig;
 
class SpecialUserLogout extends FormSpecialPage {
    private $oldUserName;
 
    private TempUserConfig $tempUserConfig;
 
    public function __construct( TempUserConfig $tempUserConfig ) {
        parent::__construct( 'Userlogout' );
        $this->tempUserConfig = $tempUserConfig;
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function isListed() {
        return $this->getAuthManager()->canAuthenticateNow();
    }
 
    protected function getGroupName() {
        return 'login';
    }
 
    protected function getFormFields() {
        return [];
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function execute( $par ) {
        $user = $this->getUser();
        if ( $user->isAnon() ) {
            $this->setHeaders();
            $this->showSuccess();
            return;
        }
        $this->oldUserName = $user->getName();
 
        parent::execute( $par );
    }
 
    public function alterForm( HTMLForm $form ) {
        $form->setTokenSalt( 'logoutToken' );
        $form->addHeaderHtml( $this->msg(
            $this->getUser()->isTemp() ? 'userlogout-temp' : 'userlogout-continue'
        ) );
 
        $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
    }
 
    public function onSubmit( array $data ) {
        // Make sure it's possible to log out
        $session = SessionManager::getGlobalSession();
        if ( !$session->canSetUser() ) {
            throw new ErrorPageError(
                'cannotlogoutnow-title',
                'cannotlogoutnow-text',
                [
                    $session->getProvider()->describe( $this->getLanguage() )
                ]
            );
        }
 
        $user = $this->getUser();
 
        $user->logout();
        return new Status();
    }
 
    public function onSuccess() {
        $this->showSuccess();
 
        $out = $this->getOutput();
        // Hook.
        $injected_html = '';
        $this->getHookRunner()->onUserLogoutComplete( $this->getUser(), $injected_html, $this->oldUserName );
        $out->addHTML( $injected_html );
    }
 
    private function showSuccess() {
        $loginURL = SpecialPage::getTitleFor( 'Userlogin' )->getFullURL(
            $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
 
        $out = $this->getOutput();
 
        $messageKey = 'logouttext';
        if (
            ( $this->oldUserName !== null && $this->tempUserConfig->isTempName( $this->oldUserName ) ) ||
            $this->getRequest()->getCheck( 'wasTempUser' )
        ) {
            // Generates the message key logouttext-for-temporary-account which is used to customise the success
            // message for a temporary account.
            $messageKey .= '-for-temporary-account';
        }
        $out->addWikiMsg( $messageKey, $loginURL );
 
        $out->returnToMain();
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    public function getDescription() {
        // Set the page title as "templogout" if the user is (or just was) logged in to a temporary account
        if (
            $this->getUser()->isTemp() ||
            ( $this->oldUserName !== null && $this->tempUserConfig->isTempName( $this->oldUserName ) ) ||
            $this->getRequest()->getCheck( 'wasTempUser' )
        ) {
            return $this->msg( 'templogout' );
        }
        return parent::getDescription();
    }
}
 
class_alias( SpecialUserLogout::class, 'SpecialUserLogout' );