ApiTokens.php

Go to the documentation of this file.

<?php
class ApiTokens extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

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

                $types = $this->getTokenTypes();
                foreach ( $params['type'] as $type ) {
                        $type = strtolower( $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 );
                wfProfileOut( __METHOD__ );
        }

        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' => 'ApiQueryRecentChanges::getPatrolToken' );
                $names = array( 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
                        'email', 'import', 'watch', 'options' );
                foreach ( $names as $name ) {
                        $types[$name] = '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() {
                return array(
                        '' => array(
                                'patroltoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'edittoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'deletetoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'protecttoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'movetoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'blocktoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'unblocktoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'emailtoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'importtoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'watchtoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'optionstoken' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                )
                        )
                );
        }

        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'
                );
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}