ApiQueryAuthManagerInfo.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Auth\AuthManager;
use MediaWiki\MainConfigNames;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiQueryAuthManagerInfo extends ApiQueryBase {
 
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        private readonly AuthManager $authManager,
    ) {
        parent::__construct( $query, $moduleName, 'ami' );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
        $helper = new ApiAuthManagerHelper( $this, $this->authManager );
        $ret = [
            'canauthenticatenow' => $this->authManager->canAuthenticateNow(),
            'cancreateaccounts' => $this->authManager->canCreateAccounts(),
            'canlinkaccounts' => $this->authManager->canLinkAccounts(),
        ];
 
        if ( $params['securitysensitiveoperation'] !== null ) {
            $ret['securitysensitiveoperationstatus'] = $this->authManager->securitySensitiveOperationStatus(
                $params['securitysensitiveoperation']
            );
        }
 
        if ( $params['requestsfor'] ) {
            $action = $params['requestsfor'];
 
            $preservedReq = $helper->getPreservedRequest();
            if ( $preservedReq ) {
                $ret += [
                    'haspreservedstate' => $preservedReq->hasStateForAction( $action ),
                    'hasprimarypreservedstate' => $preservedReq->hasPrimaryStateForAction( $action ),
                    'preservedusername' => (string)$preservedReq->username,
                ];
            } else {
                $ret += [
                    'haspreservedstate' => false,
                    'hasprimarypreservedstate' => false,
                    'preservedusername' => '',
                ];
            }
 
            $options = [];
            if ( $params['reauthenticate'] !== null ) {
                if ( !$this->getUser()->isRegistered() ) {
                    $this->dieWithError( 'apierror-mustbeloggedin-reauthenticate' );
                } elseif ( $action !== AuthManager::ACTION_LOGIN ) {
                    $this->dieWithError( $this->msg( 'apierror-invalidparammix-mustusewith',
                        'reauthenticate', 'requestsfor=login' ) );
                }
                $options['securityLevel'] = $params['reauthenticate'];
            }
            $reqs = $this->authManager->getAuthenticationRequests( $action, $this->getUser(), $options );
 
            // Filter out blacklisted requests, depending on the action
            switch ( $action ) {
                case AuthManager::ACTION_CHANGE:
                    $reqs = ApiAuthManagerHelper::blacklistAuthenticationRequests( $reqs,
                        $this->getConfig()->get( MainConfigNames::ChangeCredentialsBlacklist )
                    );
                    break;
                case AuthManager::ACTION_REMOVE:
                    $reqs = ApiAuthManagerHelper::blacklistAuthenticationRequests( $reqs,
                        $this->getConfig()->get( MainConfigNames::RemoveCredentialsBlacklist )
                    );
                    break;
            }
 
            $ret += $helper->formatRequests( $reqs );
        }
 
        $this->getResult()->addValue( [ 'query' ], $this->getModuleName(), $ret );
    }
 
    public function isReadMode() {
        return false;
    }
 
    public function getAllowedParams() {
        return [
            'securitysensitiveoperation' => null,
            'requestsfor' => [
                ParamValidator::PARAM_TYPE => [
                    AuthManager::ACTION_LOGIN,
                    AuthManager::ACTION_LOGIN_CONTINUE,
                    AuthManager::ACTION_CREATE,
                    AuthManager::ACTION_CREATE_CONTINUE,
                    AuthManager::ACTION_LINK,
                    AuthManager::ACTION_LINK_CONTINUE,
                    AuthManager::ACTION_CHANGE,
                    AuthManager::ACTION_REMOVE,
                    AuthManager::ACTION_UNLINK,
                ],
            ],
            'reauthenticate' => [
                ApiBase::PARAM_TYPE => 'string',
            ],
        ] + ApiAuthManagerHelper::getStandardParams( '', 'mergerequestfields', 'messageformat' );
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&meta=authmanagerinfo&amirequestsfor=' . urlencode( AuthManager::ACTION_LOGIN )
                => 'apihelp-query+authmanagerinfo-example-login',
            'action=query&meta=authmanagerinfo&amirequestsfor=' . urlencode( AuthManager::ACTION_LOGIN ) .
                '&amimergerequestfields=1'
                => 'apihelp-query+authmanagerinfo-example-login-merged',
            'action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo'
                => 'apihelp-query+authmanagerinfo-example-securitysensitiveoperation',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Authmanagerinfo';
    }
}
 
class_alias( ApiQueryAuthManagerInfo::class, 'ApiQueryAuthManagerInfo' );