MediaWiki  REL1_31
ApiValidatePassword.php
Go to the documentation of this file.
1 <?php
2 
4 
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',
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/Special:MyLanguage/API:Validatepassword';
80  }
81 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:111
ApiValidatePassword\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiValidatePassword.php:51
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiValidatePassword\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiValidatePassword.php:78
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
$params
$params
Definition: styleTest.css.php:40
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiValidatePassword
Definition: ApiValidatePassword.php:8
ApiValidatePassword\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiValidatePassword.php:55
ApiValidatePassword\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiValidatePassword.php:69
ApiValidatePassword\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiValidatePassword.php:10
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:730
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:83
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ApiBase\getErrorFormatter
getErrorFormatter()
Get the error formatter.
Definition: ApiBase.php:655
ApiBase\requirePostedParameters
requirePostedParameters( $params, $prefix='prefix')
Die if any of the specified parameters were found in the query part of the URL rather than the post b...
Definition: ApiBase.php:881
$messages
$messages
Definition: LogTests.i18n.php:8