MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
32  public function __construct( ApiMain $main, $action ) {
33  parent::__construct( $main, $action, 'changeauth' );
34  }
36  public function execute() {
37  if ( !$this->getUser()->isLoggedIn() ) {
38  $this->dieUsage( 'Must be logged in to change authentication data', 'notloggedin' );
39  }
41  $helper = new ApiAuthManagerHelper( $this );
42  $manager = AuthManager::singleton();
44  // Check security-sensitive operation status
45  $helper->securitySensitiveOperation( 'ChangeCredentials' );
47  // Fetch the request
49  $helper->loadAuthenticationRequests( AuthManager::ACTION_CHANGE ),
50  $this->getConfig()->get( 'ChangeCredentialsBlacklist' )
51  );
52  if ( count( $reqs ) !== 1 ) {
53  $this->dieUsage( 'Failed to create change request', 'badrequest' );
54  }
55  $req = reset( $reqs );
57  // Make the change
58  $status = $manager->allowsAuthenticationDataChange( $req, true );
59  Hooks::run( 'ChangeAuthenticationDataAudit', [ $req, $status ] );
60  if ( !$status->isGood() ) {
61  $this->dieStatus( $status );
62  }
63  $manager->changeAuthenticationData( $req );
65  $this->getResult()->addValue( null, 'changeauthenticationdata', [ 'status' => 'success' ] );
66  }
68  public function isWriteMode() {
69  return true;
70  }
72  public function needsToken() {
73  return 'csrf';
74  }
76  public function getAllowedParams() {
77  return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_CHANGE,
78  'request'
79  );
80  }
82  public function dynamicParameterDocumentation() {
83  return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_CHANGE ];
84  }
86  protected function getExamplesMessages() {
87  return [
88  'action=changeauthenticationdata' .
89  '&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest' .
90  '&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC'
91  => 'apihelp-changeauthenticationdata-example-password',
92  ];
93  }
95  public function getHelpUrls() {
96  return '';
97  }
98 }
static getStandardParams($action, $param)
Fetch the standard parameters this helper recognizes.
Get the result object.
Definition: ApiBase.php:584
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Get the Config object.
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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:35
this hook is for auditing only $req
Definition: hooks.txt:1007
Change authentication data with AuthManager.
static blacklistAuthenticationRequests(array $reqs, array $blacklist)
Filter out authentication requests by class name.
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1585
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
Throw a UsageException based on the errors in the Status object.
Definition: ApiBase.php:1674
Helper class for AuthManager-using API modules.
Get the User object.