ApiTokens.php

Go to the documentation of this file.

<?php
class ApiTokens extends ApiBase {

    public function execute() {
        $this->setWarning(
            'action=tokens has been deprecated. Please use action=query&meta=tokens instead.'
        );
        $this->logFeatureUsage( 'action=tokens' );

        $params = $this->extractRequestParams();
        $res = [
            ApiResult::META_TYPE => 'assoc',
        ];

        $types = $this->getTokenTypes();
        foreach ( $params['type'] as $type ) {
            $val = call_user_func( $types[$type], null, null );

            if ( $val === false ) {
                $this->setWarning( "Action '$type' is not allowed for the current user" );
            } else {
                $res[$type . 'token'] = $val;
            }
        }

        $this->getResult()->addValue( null, $this->getModuleName(), $res );
    }

    private function getTokenTypes() {
        // If we're in a mode that breaks the same-origin policy, no tokens can
        // be obtained
        if ( $this->lacksSameOriginSecurity() ) {
            return [];
        }

        static $types = null;
        if ( $types ) {
            return $types;
        }
        $types = [ 'patrol' => [ 'ApiQueryRecentChanges', 'getPatrolToken' ] ];
        $names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
            'email', 'import', 'watch', 'options' ];
        foreach ( $names as $name ) {
            $types[$name] = [ 'ApiQueryInfo', 'get' . ucfirst( $name ) . 'Token' ];
        }
        Hooks::run( 'ApiTokensGetTokenTypes', [ &$types ] );

        // For forwards-compat, copy any token types from ApiQueryTokens that
        // we don't already have something for.
        $user = $this->getUser();
        $request = $this->getRequest();
        foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
            if ( !isset( $types[$name] ) ) {
                $types[$name] = function () use ( $salt, $user, $request ) {
                    return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
                };
            }
        }

        ksort( $types );

        return $types;
    }

    public function isDeprecated() {
        return true;
    }

    public function getAllowedParams() {
        return [
            'type' => [
                ApiBase::PARAM_DFLT => 'edit',
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
            ],
        ];
    }

    protected function getExamplesMessages() {
        return [
            'action=tokens'
                => 'apihelp-tokens-example-edit',
            'action=tokens&type=email|move'
                => 'apihelp-tokens-example-emailmove',
        ];
    }
}