4 * Created on Mar 24, 2009
5 * API for MediaWiki 1.8+
7 * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
33 class ApiUserrights
extends ApiBase
{
35 public function __construct( $main, $action ) {
36 parent
::__construct( $main, $action );
39 private $mUser = null;
41 public function execute() {
42 $params = $this->extractRequestParams();
44 $user = $this->getUser();
46 $form = new UserrightsPage
;
47 $r['user'] = $user->getName();
48 list( $r['added'], $r['removed'] ) =
49 $form->doSaveUserGroups(
50 $user, (array)$params['add'],
51 (array)$params['remove'], $params['reason'] );
53 $this->getResult()->setIndexedTagName( $r['added'], 'group' );
54 $this->getResult()->setIndexedTagName( $r['removed'], 'group' );
55 $this->getResult()->addValue( null, $this->getModuleName(), $r );
58 private function getUser() {
59 if ( $this->mUser
!== null ) {
63 $params = $this->extractRequestParams();
64 if ( is_null( $params['user'] ) ) {
65 $this->dieUsageMsg( array( 'missingparam', 'user' ) );
68 $form = new UserrightsPage
;
69 $status = $form->fetchUser( $params['user'] );
70 if ( !$status->isOK() ) {
71 $errors = $status->getErrorsArray();
72 $this->dieUsageMsg( $errors[0] );
74 $user = $status->value
;
81 public function mustBePosted() {
85 public function isWriteMode() {
89 public function getAllowedParams() {
93 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
94 ApiBase
::PARAM_ISMULTI
=> true
97 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
98 ApiBase
::PARAM_ISMULTI
=> true
102 ApiBase
::PARAM_DFLT
=> ''
107 public function getParamDescription() {
109 'user' => 'User name',
110 'add' => 'Add the user to these groups',
111 'remove' => 'Remove the user from these groups',
112 'token' => 'A userrights token previously retrieved through list=users',
113 'reason' => 'Reason for the change',
117 public function getDescription() {
118 return 'Add/remove a user to/from groups';
121 public function getPossibleErrors() {
122 return array_merge( parent
::getPossibleErrors(), array(
123 array( 'missingparam', 'user' ),
127 public function getTokenSalt() {
128 return $this->getUser()->getName();
131 protected function getExamples() {
133 'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
137 public function getVersion() {
138 return __CLASS__
. ': $Id$';