4 * Created on Mar 24, 2009
5 * API for MediaWiki 1.8+
7 * Copyright (C) 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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");
34 class ApiUserrights
extends ApiBase
{
36 public function __construct($main, $action) {
37 parent
:: __construct($main, $action);
40 public function execute() {
42 $params = $this->extractRequestParams();
43 if(is_null($params['user']))
44 $this->dieUsageMsg(array('missingparam', 'user'));
45 if(is_null($params['token']))
46 $this->dieUsageMsg(array('missingparam', 'token'));
48 $user = UserrightsPage
::fetchUser($params['user']);
49 if($user instanceof WikiErrorMsg
)
50 $this->dieUsageMsg(array_merge(
51 (array)$user->getMessageKey(),
52 $user->getMessageArgs()));
53 if(!$wgUser->matchEditToken($params['token'], $user->getName()))
54 $this->dieUsageMsg(array('sessionfailure'));
56 $r['user'] = $user->getName();
57 list($r['added'], $r['removed']) =
58 $form->doSaveUserGroups(
59 $user, (array)$params['add'],
60 (array)$params['remove'], $params['reason']);
62 $this->getResult()->setIndexedTagName($r['added'], 'group');
63 $this->getResult()->setIndexedTagName($r['removed'], 'group');
64 $this->getResult()->addValue(null, $this->getModuleName(), $r);
67 public function mustBePosted() {
71 public function isWriteMode() {
75 public function getAllowedParams() {
79 ApiBase
:: PARAM_TYPE
=> User
::getAllGroups(),
80 ApiBase
:: PARAM_ISMULTI
=> true
83 ApiBase
:: PARAM_TYPE
=> User
::getAllGroups(),
84 ApiBase
:: PARAM_ISMULTI
=> true
88 ApiBase
:: PARAM_DFLT
=> ''
93 public function getParamDescription() {
95 'user' => 'User name',
96 'add' => 'Add the user to these groups',
97 'remove' => 'Remove the user from these groups',
98 'token' => 'A userrights token previously retrieved through list=users',
99 'reason' => 'Reason for the change',
103 public function getDescription() {
105 'Add/remove a user to/from groups',
109 protected function getExamples() {
111 'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
115 public function getVersion() {
116 return __CLASS__
. ': $Id$';