ApiTokens.php

Go to the documentation of this file.

<?php
class ApiTokens extends ApiBase {

    public function execute() {
        $params = $this->extractRequestParams();
        $res = array();

        $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 JSON callback mode, no tokens can be obtained
        if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
            return array();
        }

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

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

    public function getResultProperties() {
        $props = array(
            '' => array(),
        );

        self::addTokenProperties( $props, $this->getTokenTypes() );

        return $props;
    }

    public function getParamDescription() {
        return array(
            'type' => 'Type of token(s) to request'
        );
    }

    public function getDescription() {
        return 'Gets tokens for data-modifying actions';
    }

    protected function getExamples() {
        return array(
            'api.php?action=tokens' => 'Retrieve an edit token (the default)',
            'api.php?action=tokens&type=email|move' => 'Retrieve an email token and a move token'
        );
    }
}