SpecialPasswordReset.php

Go to the documentation of this file.

<?php
use MediaWiki\MainConfigNames;
 
class SpecialPasswordReset extends FormSpecialPage {
    private $passwordReset;
 
    private $result;
 
    private $method;
 
    public function __construct( PasswordReset $passwordReset ) {
        parent::__construct( 'PasswordReset', 'editmyprivateinfo' );
 
        $this->passwordReset = $passwordReset;
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function userCanExecute( User $user ) {
        return $this->passwordReset->isAllowed( $user )->isGood();
    }
 
    public function checkExecutePermissions( User $user ) {
        $status = Status::wrap( $this->passwordReset->isAllowed( $user ) );
        if ( !$status->isGood() ) {
            throw new ErrorPageError( 'internalerror', $status->getMessage() );
        }
 
        parent::checkExecutePermissions( $user );
    }
 
    public function execute( $par ) {
        $out = $this->getOutput();
        $out->disallowUserJs();
        parent::execute( $par );
    }
 
    protected function getFormFields() {
        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
        $a = [];
        if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
            $a['Username'] = [
                'type' => 'text',
                'default' => $this->getRequest()->getSession()->suggestLoginUsername(),
                'label-message' => 'passwordreset-username',
            ];
 
            if ( $this->getUser()->isRegistered() ) {
                $a['Username']['default'] = $this->getUser()->getName();
            }
        }
 
        if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
            $a['Email'] = [
                'type' => 'email',
                'label-message' => 'passwordreset-email',
            ];
        }
 
        return $a;
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function alterForm( HTMLForm $form ) {
        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
 
        $form->setSubmitDestructive();
 
        $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
 
        $i = 0;
        if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
            $i++;
        }
        if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
            $i++;
        }
 
        $message = ( $i > 1 ) ? 'passwordreset-text-many' : 'passwordreset-text-one';
 
        $form->setHeaderHtml( $this->msg( $message, $i )->parseAsBlock() );
        $form->setSubmitTextMsg( 'mailmypassword' );
    }
 
    public function onSubmit( array $data ) {
        $username = $data['Username'] ?? null;
        $email = $data['Email'] ?? null;
 
        $this->method = $username ? 'username' : 'email';
        $this->result = Status::wrap(
            $this->passwordReset->execute( $this->getUser(), $username, $email ) );
 
        if ( $this->result->hasMessage( 'actionthrottledtext' ) ) {
            throw new ThrottledError;
        }
 
        return $this->result;
    }
 
    public function onSuccess() {
        $output = $this->getOutput();
 
        // Information messages.
        $output->addWikiMsg( 'passwordreset-success' );
        $output->addWikiMsg( 'passwordreset-success-details-generic',
            $this->getConfig()->get( MainConfigNames::PasswordReminderResendTime ) );
 
        // Confirmation of what the user has just submitted.
        $info = "\n";
        $postVals = $this->getRequest()->getPostValues();
        if ( isset( $postVals['wpUsername'] ) && $postVals['wpUsername'] !== '' ) {
            $info .= "* " . $this->msg( 'passwordreset-username' ) . ' '
                . wfEscapeWikiText( $postVals['wpUsername'] ) . "\n";
        }
        if ( isset( $postVals['wpEmail'] ) && $postVals['wpEmail'] !== '' ) {
            $info .= "* " . $this->msg( 'passwordreset-email' ) . ' '
                . wfEscapeWikiText( $postVals['wpEmail'] ) . "\n";
        }
        $output->addWikiMsg( 'passwordreset-success-info', $info );
 
        // Link to main page.
        $output->returnToMain();
    }
 
    public function isListed() {
        if ( $this->passwordReset->isAllowed( $this->getUser() )->isGood() ) {
            return parent::isListed();
        }
 
        return false;
    }
 
    protected function getGroupName() {
        return 'login';
    }
}