includes/api/ApiUserrights.php

   1 <?php
   2
   3 /*
   4  * Created on Mar 24, 2009
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  */
  24
  25 if (!defined('MEDIAWIKI')) {
  26         // Eclipse helper - will be ignored in production
  27         require_once ("ApiBase.php");
  28 }
  29
  30
  31 /**
  32  * @ingroup API
  33  */
  34 class ApiUserrights extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action);
  38         }
  39
  40         public function execute() {
  41                 global $wgUser;
  42                 $params = $this->extractRequestParams();
  43                 if(is_null($params['user']))
  44                         $this->dieUsageMsg(array('missingparam', 'user'));
  45                 $user = User::newFromName($params['user']);
  46                 if($user->isAnon())
  47                         $this->dieUsageMsg(array('nosuchuser', $params['user']));
  48                 if(is_null($params['token']))
  49                         $this->dieUsageMsg(array('missingparam', 'token'));
  50                 if(!$wgUser->matchEditToken($params['token'], $user->getName()))
  51                         $this->dieUsageMsg(array('sessionfailure'));
  52
  53                 $r['user'] = $user->getName();
  54                 list($r['added'], $r['removed']) =
  55                         UserrightsPage::doSaveUserGroups(
  56                                 $user, (array)$params['add'],
  57                                 (array)$params['remove'], $params['reason']);
  58
  59                 $this->getResult()->setIndexedTagName($r['added'], 'group');
  60                 $this->getResult()->setIndexedTagName($r['removed'], 'group');
  61                 $this->getResult()->addValue(null, $this->getModuleName(), $r);
  62         }
  63
  64         public function mustBePosted() {
  65                 return true;
  66         }
  67
  68         public function isWriteMode() {
  69                 return true;
  70         }
  71
  72         public function getAllowedParams() {
  73                 return array (
  74                         'user' => array(
  75                                 ApiBase :: PARAM_TYPE => 'user'
  76                         ),
  77                         'add' => array(
  78                                 ApiBase :: PARAM_TYPE => User::getAllGroups(),
  79                                 ApiBase :: PARAM_ISMULTI => true
  80                         ),
  81                         'remove' => array(
  82                                 ApiBase :: PARAM_TYPE => User::getAllGroups(),
  83                                 ApiBase :: PARAM_ISMULTI => true
  84                         ),
  85                         'token' => null,
  86                         'reason' => array(
  87                                 ApiBase :: PARAM_DFLT => ''
  88                         )
  89                 );
  90         }
  91
  92         public function getParamDescription() {
  93                 return array (
  94                         'user' => 'User name',
  95                         'add' => 'Add the user to these groups',
  96                         'remove' => 'Remove the user from these groups',
  97                         'token' => 'A userrights token previously retrieved through list=users',
  98                         'reason' => 'Reason for the change',
  99                 );
 100         }
 101
 102         public function getDescription() {
 103                 return array(
 104                         'Add/remove a user to/from groups',
 105                 );
 106         }
 107
 108         protected function getExamples() {
 109                 return array (
 110                         'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
 111                 );
 112         }
 113
 114         public function getVersion() {
 115                 return __CLASS__ . ': $Id$';
 116         }
 117 }