ApiQueryTokens.php

Go to the documentation of this file.

<?php
class ApiQueryTokens extends ApiQueryBase {

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

        if ( $this->getMain()->getRequest()->getVal( 'callback' ) !== null ) {
            $this->setWarning( 'Tokens may not be obtained when using a callback' );
            return;
        }

        $salts = self::getTokenTypeSalts();
        foreach ( $params['type'] as $type ) {
            $salt = $salts[$type];
            $val = $this->getUser()->getEditToken( $salt, $this->getRequest() );
            $res[$type . 'token'] = $val;
        }

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

    public static function getTokenTypeSalts() {
        static $salts = null;
        if ( !$salts ) {
            wfProfileIn( __METHOD__ );
            $salts = array(
                'csrf' => '',
                'watch' => 'watch',
                'patrol' => 'patrol',
                'rollback' => 'rollback',
                'userrights' => 'userrights',
            );
            wfRunHooks( 'ApiQueryTokensRegisterTypes', array( &$salts ) );
            ksort( $salts );
            wfProfileOut( __METHOD__ );
        }

        return $salts;
    }

    public function getAllowedParams() {
        return array(
            'type' => array(
                ApiBase::PARAM_DFLT => 'csrf',
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => array_keys( self::getTokenTypeSalts() ),
            ),
        );
    }

    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=query&meta=tokens' => 'Retrieve a csrf token (the default)',
            'api.php?action=query&meta=tokens&type=watch|patrol' => 'Retrieve a watch token and a patrol token'
        );
    }

    public function getCacheMode( $params ) {
        return 'private';
    }
}