ApiResetPassword.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\MainConfigNames;
use MediaWiki\ParamValidator\TypeDef\UserDef;
use MediaWiki\Status\Status;
use MediaWiki\User\PasswordReset;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiResetPassword extends ApiBase {
 
    private PasswordReset $passwordReset;
 
    public function __construct(
        ApiMain $main,
        string $action,
        PasswordReset $passwordReset
    ) {
        parent::__construct( $main, $action );
 
        $this->passwordReset = $passwordReset;
    }
 
    private $hasAnyRoutes = null;
 
    private function hasAnyRoutes() {
        if ( $this->hasAnyRoutes === null ) {
            $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
            $this->hasAnyRoutes = !empty( $resetRoutes['username'] ) || !empty( $resetRoutes['email'] );
        }
        return $this->hasAnyRoutes;
    }
 
    protected function getExtendedDescription() {
        if ( !$this->hasAnyRoutes() ) {
            return 'apihelp-resetpassword-extended-description-noroutes';
        }
        return parent::getExtendedDescription();
    }
 
    public function execute() {
        if ( !$this->hasAnyRoutes() ) {
            $this->dieWithError( 'apihelp-resetpassword-description-noroutes', 'moduledisabled' );
        }
 
        $params = $this->extractRequestParams() + [
            // Make sure the keys exist even if getAllowedParams didn't define them
            'user' => null,
            'email' => null,
        ];
 
        $status = $this->passwordReset->isAllowed( $this->getUser() );
        if ( !$status->isOK() ) {
            $this->dieStatus( Status::wrap( $status ) );
        }
 
        $status = $this->passwordReset->execute(
            $this->getUser(), $params['user'], $params['email']
        );
        if ( !$status->isOK() ) {
            $status->value = null;
            $this->dieStatus( Status::wrap( $status ) );
        }
 
        $result = $this->getResult();
        $result->addValue( [ 'resetpassword' ], 'status', 'success' );
    }
 
    public function isWriteMode() {
        return $this->hasAnyRoutes();
    }
 
    public function needsToken() {
        if ( !$this->hasAnyRoutes() ) {
            return false;
        }
        return 'csrf';
    }
 
    public function getAllowedParams() {
        if ( !$this->hasAnyRoutes() ) {
            return [];
        }
 
        $ret = [
            'user' => [
                ParamValidator::PARAM_TYPE => 'user',
                UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name' ],
            ],
            'email' => [
                ParamValidator::PARAM_TYPE => 'string',
            ],
        ];
 
        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
        if ( empty( $resetRoutes['username'] ) ) {
            unset( $ret['user'] );
        }
        if ( empty( $resetRoutes['email'] ) ) {
            unset( $ret['email'] );
        }
 
        return $ret;
    }
 
    protected function getExamplesMessages() {
        $ret = [];
        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
 
        if ( !empty( $resetRoutes['username'] ) ) {
            $ret['action=resetpassword&user=Example&token=123ABC'] = 'apihelp-resetpassword-example-user';
        }
        if ( !empty( $resetRoutes['email'] ) ) {
            $ret['action=resetpassword&user=user@example.com&token=123ABC'] =
                'apihelp-resetpassword-example-email';
        }
 
        return $ret;
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data';
    }
}
 
class_alias( ApiResetPassword::class, 'ApiResetPassword' );