SpecialResetTokens.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\MainConfigNames;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\SpecialPage\SpecialPage;
 
class SpecialResetTokens extends FormSpecialPage {
    private $tokensList;
 
    public function __construct() {
        parent::__construct( 'ResetTokens' );
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    protected function getTokensList() {
        if ( !isset( $this->tokensList ) ) {
            $tokens = [
                [ 'preference' => 'watchlisttoken', 'label-message' => 'resettokens-watchlist-token' ],
            ];
            $this->getHookRunner()->onSpecialResetTokensTokens( $tokens );
 
            $hiddenPrefs = $this->getConfig()->get( MainConfigNames::HiddenPrefs );
            $tokens = array_filter( $tokens, static function ( $tok ) use ( $hiddenPrefs ) {
                return !in_array( $tok['preference'], $hiddenPrefs );
            } );
 
            $this->tokensList = $tokens;
        }
 
        return $this->tokensList;
    }
 
    public function execute( $par ) {
        // This is a preferences page, so no user JS for y'all.
        $this->getOutput()->disallowUserJs();
        $this->requireNamedUser();
 
        parent::execute( $par );
 
        $this->getOutput()->addReturnTo( SpecialPage::getTitleFor( 'Preferences' ) );
    }
 
    public function onSuccess() {
        $this->getOutput()->wrapWikiMsg(
            Html::successBox( '$1' ),
            'resettokens-done'
        );
    }
 
    protected function getFormFields() {
        $user = $this->getUser();
        $tokens = $this->getTokensList();
 
        if ( $tokens ) {
            $tokensForForm = [];
            foreach ( $tokens as $tok ) {
                $label = $this->msg( 'resettokens-token-label' )
                    ->rawParams( $this->msg( $tok['label-message'] )->parse() )
                    ->params( $user->getTokenFromOption( $tok['preference'] ) )
                    ->escaped();
                $tokensForForm[$label] = $tok['preference'];
            }
 
            $desc = [
                'label-message' => 'resettokens-tokens',
                'type' => 'multiselect',
                'options' => $tokensForForm,
            ];
        } else {
            $desc = [
                'label-message' => 'resettokens-no-tokens',
                'type' => 'info',
            ];
        }
 
        return [
            'tokens' => $desc,
        ];
    }
 
    protected function alterForm( HTMLForm $form ) {
        $form->setSubmitDestructive();
        if ( $this->getTokensList() ) {
            $form->setSubmitTextMsg( 'resettokens-resetbutton' );
        } else {
            $form->suppressDefaultSubmit();
        }
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function onSubmit( array $formData ) {
        if ( $formData['tokens'] ) {
            $user = $this->getUser();
            foreach ( $formData['tokens'] as $tokenPref ) {
                $user->resetTokenFromOption( $tokenPref );
            }
            $user->saveSettings();
 
            return true;
        }
 
        return false;
    }
 
    protected function getGroupName() {
        return 'login';
    }
 
    public function isListed() {
        return (bool)$this->getTokensList();
    }
}
 
class_alias( SpecialResetTokens::class, 'SpecialResetTokens' );