includes/api/ApiValidatePassword.php

   1 <?php
   2
   3 use MediaWiki\Auth\AuthManager;
   4
   5 /**
   6  * @ingroup API
   7  */
   8 class ApiValidatePassword extends ApiBase {
   9
  10         public function execute() {
  11                 $params = $this->extractRequestParams();
  12
  13                 // For sanity
  14                 $this->requirePostedParameters( [ 'password' ] );
  15
  16                 if ( $params['user'] !== null ) {
  17                         $user = User::newFromName( $params['user'], 'creatable' );
  18                         if ( !$user ) {
  19                                 $encParamName = $this->encodeParamName( 'user' );
  20                                 $this->dieWithError(
  21                                         [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $params['user'] ) ],
  22                                         "baduser_{$encParamName}"
  23                                 );
  24                         }
  25
  26                         if ( !$user->isAnon() || AuthManager::singleton()->userExists( $user->getName() ) ) {
  27                                 $this->dieWithError( 'userexists' );
  28                         }
  29
  30                         $user->setEmail( (string)$params['email'] );
  31                         $user->setRealName( (string)$params['realname'] );
  32                 } else {
  33                         $user = $this->getUser();
  34                 }
  35
  36                 $validity = $user->checkPasswordValidity( $params['password'] );
  37                 $r['validity'] = $validity->isGood() ? 'Good' : ( $validity->isOK() ? 'Change' : 'Invalid' );
  38                 $messages = array_merge(
  39                         $this->getErrorFormatter()->arrayFromStatus( $validity, 'error' ),
  40                         $this->getErrorFormatter()->arrayFromStatus( $validity, 'warning' )
  41                 );
  42                 if ( $messages ) {
  43                         $r['validitymessages'] = $messages;
  44                 }
  45
  46                 Hooks::run( 'ApiValidatePassword', [ $this, &$r ] );
  47
  48                 $this->getResult()->addValue( null, $this->getModuleName(), $r );
  49         }
  50
  51         public function mustBePosted() {
  52                 return true;
  53         }
  54
  55         public function getAllowedParams() {
  56                 return [
  57                         'password' => [
  58                                 ApiBase::PARAM_TYPE => 'password',
  59                                 ApiBase::PARAM_REQUIRED => true
  60                         ],
  61                         'user' => [
  62                                 ApiBase::PARAM_TYPE => 'user',
  63                         ],
  64                         'email' => null,
  65                         'realname' => null,
  66                 ];
  67         }
  68
  69         protected function getExamplesMessages() {
  70                 return [
  71                         'action=validatepassword&password=foobar'
  72                                 => 'apihelp-validatepassword-example-1',
  73                         'action=validatepassword&password=querty&user=Example'
  74                                 => 'apihelp-validatepassword-example-2',
  75                 ];
  76         }
  77
  78         public function getHelpUrls() {
  79                 return 'https://www.mediawiki.org/wiki/API:Validatepassword';
  80         }
  81 }