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
104 lines
2.7 KiB
PHP
104 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* Module to fetch tokens via action=query&meta=tokens
|
|
*
|
|
* Created on August 8, 2014
|
|
*
|
|
* Copyright © 2014 Brad Jorsch bjorsch@wikimedia.org
|
|
*
|
|
* 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
|
|
* @since 1.24
|
|
*/
|
|
|
|
/**
|
|
* Module to fetch tokens via action=query&meta=tokens
|
|
*
|
|
* @ingroup API
|
|
* @since 1.24
|
|
*/
|
|
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';
|
|
}
|
|
}
|