6 * Created on Mar 24, 2009
8 * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
28 if ( !defined( 'MEDIAWIKI' ) ) {
29 // Eclipse helper - will be ignored in production
30 require_once( "ApiBase.php" );
36 class ApiUserrights
extends ApiBase
{
38 public function __construct( $main, $action ) {
39 parent
::__construct( $main, $action );
42 private $mUser = null;
44 public function execute() {
45 $params = $this->extractRequestParams();
47 $user = $this->getUser();
49 $form = new UserrightsPage
;
50 $r['user'] = $user->getName();
51 list( $r['added'], $r['removed'] ) =
52 $form->doSaveUserGroups(
53 $user, (array)$params['add'],
54 (array)$params['remove'], $params['reason'] );
56 $this->getResult()->setIndexedTagName( $r['added'], 'group' );
57 $this->getResult()->setIndexedTagName( $r['removed'], 'group' );
58 $this->getResult()->addValue( null, $this->getModuleName(), $r );
64 private function getUser() {
65 if ( $this->mUser
!== null ) {
69 $params = $this->extractRequestParams();
71 $form = new UserrightsPage
;
72 $status = $form->fetchUser( $params['user'] );
73 if ( !$status->isOK() ) {
74 $errors = $status->getErrorsArray();
75 $this->dieUsageMsg( $errors[0] );
77 $user = $status->value
;
84 public function mustBePosted() {
88 public function isWriteMode() {
92 public function getAllowedParams() {
95 ApiBase
::PARAM_TYPE
=> 'string',
96 ApiBase
::PARAM_REQUIRED
=> true
99 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
100 ApiBase
::PARAM_ISMULTI
=> true
103 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
104 ApiBase
::PARAM_ISMULTI
=> true
108 ApiBase
::PARAM_DFLT
=> ''
113 public function getParamDescription() {
115 'user' => 'User name',
116 'add' => 'Add the user to these groups',
117 'remove' => 'Remove the user from these groups',
118 'token' => 'A userrights token previously retrieved through list=users',
119 'reason' => 'Reason for the change',
123 public function getDescription() {
124 return 'Add/remove a user to/from groups';
127 public function needsToken() {
131 public function getTokenSalt() {
132 return $this->getUser()->getName();
135 protected function getExamples() {
137 'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
141 public function getVersion() {
142 return __CLASS__
. ': $Id$';