MediaWiki  1.28.1
ApiRemoveAuthenticationData.php
Go to the documentation of this file.
1 <?php
24 
31 
32  private $authAction;
33  private $operation;
34 
35  public function __construct( ApiMain $main, $action ) {
36  parent::__construct( $main, $action );
37 
38  $this->authAction = $action === 'unlinkaccount'
39  ? AuthManager::ACTION_UNLINK
40  : AuthManager::ACTION_REMOVE;
41  $this->operation = $action === 'unlinkaccount'
42  ? 'UnlinkAccount'
43  : 'RemoveCredentials';
44  }
45 
46  public function execute() {
47  if ( !$this->getUser()->isLoggedIn() ) {
48  $this->dieUsage( 'Must be logged in to remove authentication data', 'notloggedin' );
49  }
50 
51  $params = $this->extractRequestParams();
52  $manager = AuthManager::singleton();
53 
54  // Check security-sensitive operation status
55  ApiAuthManagerHelper::newForModule( $this )->securitySensitiveOperation( $this->operation );
56 
57  // Fetch the request. No need to load from the request, so don't use
58  // ApiAuthManagerHelper's method.
59  $blacklist = $this->authAction === AuthManager::ACTION_REMOVE
60  ? array_flip( $this->getConfig()->get( 'RemoveCredentialsBlacklist' ) )
61  : [];
62  $reqs = array_filter(
63  $manager->getAuthenticationRequests( $this->authAction, $this->getUser() ),
64  function ( $req ) use ( $params, $blacklist ) {
65  return $req->getUniqueId() === $params['request'] &&
66  !isset( $blacklist[get_class( $req )] );
67  }
68  );
69  if ( count( $reqs ) !== 1 ) {
70  $this->dieUsage( 'Failed to create change request', 'badrequest' );
71  }
72  $req = reset( $reqs );
73 
74  // Perform the removal
75  $status = $manager->allowsAuthenticationDataChange( $req, true );
76  Hooks::run( 'ChangeAuthenticationDataAudit', [ $req, $status ] );
77  if ( !$status->isGood() ) {
78  $this->dieStatus( $status );
79  }
80  $manager->changeAuthenticationData( $req );
81 
82  $this->getResult()->addValue( null, $this->getModuleName(), [ 'status' => 'success' ] );
83  }
84 
85  public function isWriteMode() {
86  return true;
87  }
88 
89  public function needsToken() {
90  return 'csrf';
91  }
92 
93  public function getAllowedParams() {
94  return ApiAuthManagerHelper::getStandardParams( $this->authAction,
95  'request'
96  );
97  }
98 
99  protected function getExamplesMessages() {
100  $path = $this->getModulePath();
101  $action = $this->getModuleName();
102  return [
103  "action={$action}&request=FooAuthenticationRequest&token=123ABC"
104  => "apihelp-{$path}-example-simple",
105  ];
106  }
107 
108  public function getHelpUrls() {
109  return 'https://www.mediawiki.org/wiki/API:Manage_authentication_data';
110  }
111 }
static getStandardParams($action, $param)
Fetch the standard parameters this helper recognizes.
static newForModule(ApiBase $module)
Static version of the constructor, for chaining.
getResult()
Get the result object.
Definition: ApiBase.php:584
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
getModulePath()
Get the path to this module.
Definition: ApiBase.php:528
getConfig()
Get the Config object.
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
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
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
Remove authentication data from AuthManager.
dieStatus($status)
Throw a UsageException based on the errors in the Status object.
Definition: ApiBase.php:1674
getUser()
Get the User object.