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
31 class ApiUserrights
extends ApiBase
{
33 public function __construct( $main, $action ) {
34 parent
::__construct( $main, $action );
37 private $mUser = null;
39 public function execute() {
40 $params = $this->extractRequestParams();
42 $user = $this->getUrUser();
44 $form = new UserrightsPage
;
45 $r['user'] = $user->getName();
46 $r['userid'] = $user->getId();
47 list( $r['added'], $r['removed'] ) =
48 $form->doSaveUserGroups(
49 $user, (array)$params['add'],
50 (array)$params['remove'], $params['reason'] );
52 $result = $this->getResult();
53 $result->setIndexedTagName( $r['added'], 'group' );
54 $result->setIndexedTagName( $r['removed'], 'group' );
55 $result->addValue( null, $this->getModuleName(), $r );
61 private function getUrUser() {
62 if ( $this->mUser
!== null ) {
66 $params = $this->extractRequestParams();
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() {
92 ApiBase
::PARAM_TYPE
=> 'string',
93 ApiBase
::PARAM_REQUIRED
=> true
96 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
97 ApiBase
::PARAM_ISMULTI
=> true
100 ApiBase
::PARAM_TYPE
=> User
::getAllGroups(),
101 ApiBase
::PARAM_ISMULTI
=> true
104 ApiBase
::PARAM_TYPE
=> 'string',
105 ApiBase
::PARAM_REQUIRED
=> 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->getUrUser()->getName();
135 public function getExamples() {
137 'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
141 public function getHelpUrls() {
142 return 'https://www.mediawiki.org/wiki/API:User_group_membership';
145 public function getVersion() {
146 return __CLASS__
. ': $Id$';