ApiClientLogin.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Auth\CreateFromLoginAuthenticationRequest;
use MediaWiki\Utils\UrlUtils;
 
class ApiClientLogin extends ApiBase {
 
    private AuthManager $authManager;
    private UrlUtils $urlUtils;
 
    public function __construct(
        ApiMain $main,
        $action,
        AuthManager $authManager,
        UrlUtils $urlUtils
    ) {
        parent::__construct( $main, $action, 'login' );
        $this->authManager = $authManager;
        $this->urlUtils = $urlUtils;
    }
 
    public function getFinalDescription() {
        // A bit of a hack to append 'api-help-authmanager-general-usage'
        $msgs = parent::getFinalDescription();
        $msgs[] = $this->msg( 'api-help-authmanager-general-usage',
            $this->getModulePrefix(),
            $this->getModuleName(),
            $this->getModulePath(),
            AuthManager::ACTION_LOGIN,
            $this->needsToken(),
        );
        return $msgs;
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        $this->requireAtLeastOneParameter( $params, 'continue', 'returnurl' );
 
        if ( $params['returnurl'] !== null ) {
            $bits = $this->urlUtils->parse( $params['returnurl'] );
            if ( !$bits || $bits['scheme'] === '' ) {
                $encParamName = $this->encodeParamName( 'returnurl' );
                $this->dieWithError(
                    [ 'apierror-badurl', $encParamName, wfEscapeWikiText( $params['returnurl'] ) ],
                    "badurl_{$encParamName}"
                );
            }
        }
 
        $helper = new ApiAuthManagerHelper( $this, $this->authManager );
 
        // Make sure it's possible to log in
        if ( !$this->authManager->canAuthenticateNow() ) {
            $res = AuthenticationResponse::newFail( $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_LOGIN ) );
            $this->getResult()->addValue( null, 'clientlogin',
                $helper->formatAuthenticationResponse( $res ) );
            $helper->logAuthenticationResult( 'login', $res );
            return;
        }
 
        // Perform the login step
        if ( $params['continue'] ) {
            $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN_CONTINUE );
            $res = $this->authManager->continueAuthentication( $reqs );
        } else {
            $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN );
            if ( $params['preservestate'] ) {
                $req = $helper->getPreservedRequest();
                if ( $req ) {
                    $reqs[] = $req;
                }
            }
            $res = $this->authManager->beginAuthentication( $reqs, $params['returnurl'] );
        }
 
        // Remove CreateFromLoginAuthenticationRequest from $res->neededRequests.
        // It's there so a RESTART treated as UI will work right, but showing
        // it to the API client is just confusing.
        $res->neededRequests = ApiAuthManagerHelper::blacklistAuthenticationRequests(
            $res->neededRequests, [ CreateFromLoginAuthenticationRequest::class ]
        );
 
        $this->getResult()->addValue( null, 'clientlogin',
            $helper->formatAuthenticationResponse( $res ) );
        $helper->logAuthenticationResult( 'login', $res );
    }
 
    public function isReadMode() {
        return false;
    }
 
    public function isWriteMode() {
        // (T283394) Logging in triggers some database writes, so should be marked appropriately.
        return true;
    }
 
    public function needsToken() {
        return 'login';
    }
 
    public function getAllowedParams() {
        return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_LOGIN,
            'requests', 'messageformat', 'mergerequestfields', 'preservestate', 'returnurl', 'continue'
        );
    }
 
    public function dynamicParameterDocumentation() {
        return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_LOGIN ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=clientlogin&username=Example&password=ExamplePassword&'
                . 'loginreturnurl=http://example.org/&logintoken=123ABC'
                => 'apihelp-clientlogin-example-login',
            'action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC'
                => 'apihelp-clientlogin-example-login2',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login';
    }
}