fdddf94570
The current token handling is a mess. This simplifies things greatly: * *All* tokens are obtained from action=query&meta=tokens, rather than being spread over action=tokens, action=query&prop=info, action=query&prop=revisions, action=query&prop=recentchanges, and action=query&prop=users. All these old methods are deprecated. * Similarly, there is only one hook to register new token types. All old hooks are deprecated. * All tokens are cacheable. * Most token types are dropped in favor of a 'csrf' token. They already were returning the same token anyway. * All token-using modules will document the required token type in a standard manner in action=help and are documented in machine-readable fashion in action=paraminfo. Note this will require updates to all extensions using tokens. Change-Id: I2793a3f2dd64a4bebb0b4d065e09af1e9f63fb89
108 lines
2.9 KiB
PHP
108 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on Jul 29, 2011
|
|
*
|
|
* Copyright © 2011 John Du Hart john@johnduhart.me
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* @deprecated since 1.24
|
|
* @ingroup API
|
|
*/
|
|
class ApiTokens extends ApiBase {
|
|
|
|
public function execute() {
|
|
$this->setWarning(
|
|
"action=tokens has been deprecated. Please use action=query&meta=tokens instead."
|
|
);
|
|
|
|
$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 getParamDescription() {
|
|
return array(
|
|
'type' => 'Type of token(s) to request'
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return array(
|
|
'This module is deprecated in favor of action=query&meta=tokens.',
|
|
'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'
|
|
);
|
|
}
|
|
}
|