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
146 lines
3.6 KiB
PHP
146 lines
3.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
*
|
|
*
|
|
* Created on Mar 24, 2009
|
|
*
|
|
* Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* @ingroup API
|
|
*/
|
|
class ApiUserrights extends ApiBase {
|
|
|
|
private $mUser = null;
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
|
|
$user = $this->getUrUser( $params );
|
|
|
|
$form = new UserrightsPage;
|
|
$form->setContext( $this->getContext() );
|
|
$r['user'] = $user->getName();
|
|
$r['userid'] = $user->getId();
|
|
list( $r['added'], $r['removed'] ) = $form->doSaveUserGroups(
|
|
$user, (array)$params['add'],
|
|
(array)$params['remove'], $params['reason']
|
|
);
|
|
|
|
$result = $this->getResult();
|
|
$result->setIndexedTagName( $r['added'], 'group' );
|
|
$result->setIndexedTagName( $r['removed'], 'group' );
|
|
$result->addValue( null, $this->getModuleName(), $r );
|
|
}
|
|
|
|
/**
|
|
* @param array $params
|
|
* @return User
|
|
*/
|
|
private function getUrUser( array $params ) {
|
|
if ( $this->mUser !== null ) {
|
|
return $this->mUser;
|
|
}
|
|
|
|
$this->requireOnlyOneParameter( $params, 'user', 'userid' );
|
|
|
|
$user = isset( $params['user'] ) ? $params['user'] : '#' . $params['userid'];
|
|
|
|
$form = new UserrightsPage;
|
|
$form->setContext( $this->getContext() );
|
|
$status = $form->fetchUser( $user );
|
|
if ( !$status->isOK() ) {
|
|
$this->dieStatus( $status );
|
|
}
|
|
|
|
$this->mUser = $status->value;
|
|
|
|
return $status->value;
|
|
}
|
|
|
|
public function mustBePosted() {
|
|
return true;
|
|
}
|
|
|
|
public function isWriteMode() {
|
|
return true;
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'user' => array(
|
|
ApiBase::PARAM_TYPE => 'string',
|
|
),
|
|
'userid' => array(
|
|
ApiBase::PARAM_TYPE => 'integer',
|
|
),
|
|
'add' => array(
|
|
ApiBase::PARAM_TYPE => User::getAllGroups(),
|
|
ApiBase::PARAM_ISMULTI => true
|
|
),
|
|
'remove' => array(
|
|
ApiBase::PARAM_TYPE => User::getAllGroups(),
|
|
ApiBase::PARAM_ISMULTI => true
|
|
),
|
|
'reason' => array(
|
|
ApiBase::PARAM_DFLT => ''
|
|
)
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'user' => 'User name',
|
|
'userid' => 'User id',
|
|
'add' => 'Add the user to these groups',
|
|
'remove' => 'Remove the user from these groups',
|
|
'token' => array(
|
|
/* Standard description automatically prepended */
|
|
'For compatibility, the token used in the web UI is also accepted.'
|
|
),
|
|
'reason' => 'Reason for the change',
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Add/remove a user to/from groups.';
|
|
}
|
|
|
|
public function needsToken() {
|
|
return 'userrights';
|
|
}
|
|
|
|
protected function getWebUITokenSalt( array $params ) {
|
|
return $this->getUrUser( $params )->getName();
|
|
}
|
|
|
|
public function getExamples() {
|
|
return array(
|
|
'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC',
|
|
'api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC'
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:User_group_membership';
|
|
}
|
|
}
|