ApiResetPassword.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthManager;

class ApiResetPassword extends ApiBase {

    private $hasAnyRoutes = null;

    private function hasAnyRoutes() {
        if ( $this->hasAnyRoutes === null ) {
            $resetRoutes = $this->getConfig()->get( 'PasswordResetRoutes' );
            $this->hasAnyRoutes = !empty( $resetRoutes['username'] ) || !empty( $resetRoutes['email'] );
        }
        return $this->hasAnyRoutes;
    }

    protected function getDescriptionMessage() {
        if ( !$this->hasAnyRoutes() ) {
            return 'apihelp-resetpassword-description-noroutes';
        }
        return parent::getDescriptionMessage();
    }

    public function execute() {
        if ( !$this->hasAnyRoutes() ) {
            $this->dieUsage( 'No password reset routes are available.', 'moduledisabled' );
        }

        $params = $this->extractRequestParams() + [
            // Make sure the keys exist even if getAllowedParams didn't define them
            'user' => null,
            'email' => null,
        ];

        $this->requireOnlyOneParameter( $params, 'user', 'email' );

        $passwordReset = new PasswordReset( $this->getConfig(), AuthManager::singleton() );

        $status = $passwordReset->isAllowed( $this->getUser(), $params['capture'] );
        if ( !$status->isOK() ) {
            $this->dieStatus( Status::wrap( $status ) );
        }

        $status = $passwordReset->execute(
            $this->getUser(), $params['user'], $params['email'], $params['capture']
        );
        if ( !$status->isOK() ) {
            $status->value = null;
            $this->dieStatus( Status::wrap( $status ) );
        }

        $result = $this->getResult();
        $result->addValue( [ 'resetpassword' ], 'status', 'success' );
        if ( $params['capture'] ) {
            $passwords = $status->getValue() ?: [];
            ApiResult::setArrayType( $passwords, 'kvp', 'user' );
            ApiResult::setIndexedTagName( $passwords, 'p' );
            $result->addValue( [ 'resetpassword' ], 'passwords', $passwords );
        }
    }

    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' => [
                ApiBase::PARAM_TYPE => 'user',
            ],
            'email' => [
                ApiBase::PARAM_TYPE => 'string',
            ],
            'capture' => false,
        ];

        $resetRoutes = $this->getConfig()->get( '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( '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/API:Manage_authentication_data';
    }
}