ApiRemoveAuthenticationData.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthManager;
 
class ApiRemoveAuthenticationData extends ApiBase {
 
    private $authAction;
    private $operation;
 
    public function __construct( ApiMain $main, $action ) {
        parent::__construct( $main, $action );
 
        $this->authAction = $action === 'unlinkaccount'
            ? AuthManager::ACTION_UNLINK
            : AuthManager::ACTION_REMOVE;
        $this->operation = $action === 'unlinkaccount'
            ? 'UnlinkAccount'
            : 'RemoveCredentials';
    }
 
    public function execute() {
        if ( !$this->getUser()->isLoggedIn() ) {
            $this->dieUsage( 'Must be logged in to remove authentication data', 'notloggedin' );
        }
 
        $params = $this->extractRequestParams();
        $manager = AuthManager::singleton();
 
        // Check security-sensitive operation status
        ApiAuthManagerHelper::newForModule( $this )->securitySensitiveOperation( $this->operation );
 
        // Fetch the request. No need to load from the request, so don't use
        // ApiAuthManagerHelper's method.
        $blacklist = $this->authAction === AuthManager::ACTION_REMOVE
            ? array_flip( $this->getConfig()->get( 'RemoveCredentialsBlacklist' ) )
            : [];
        $reqs = array_filter(
            $manager->getAuthenticationRequests( $this->authAction, $this->getUser() ),
            function ( $req ) use ( $params, $blacklist ) {
                return $req->getUniqueId() === $params['request'] &&
                    !isset( $blacklist[get_class( $req )] );
            }
        );
        if ( count( $reqs ) !== 1 ) {
            $this->dieUsage( 'Failed to create change request', 'badrequest' );
        }
        $req = reset( $reqs );
 
        // Perform the removal
        $status = $manager->allowsAuthenticationDataChange( $req, true );
        Hooks::run( 'ChangeAuthenticationDataAudit', [ $req, $status ] );
        if ( !$status->isGood() ) {
            $this->dieStatus( $status );
        }
        $manager->changeAuthenticationData( $req );
 
        $this->getResult()->addValue( null, $this->getModuleName(), [ 'status' => 'success' ] );
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    public function getAllowedParams() {
        return ApiAuthManagerHelper::getStandardParams( $this->authAction,
            'request'
        );
    }
 
    protected function getExamplesMessages() {
        $path = $this->getModulePath();
        $action = $this->getModuleName();
        return [
            "action={$action}&request=FooAuthenticationRequest&token=123ABC"
                => "apihelp-{$path}-example-simple",
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Manage_authentication_data';
    }
}