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  * @ingroup API
  32  */
  33 class ApiUserrights extends ApiBase {
  34
  35         public function __construct( $main, $action ) {
  36                 parent :: __construct( $main, $action );
  37         }
  38
  39         public function execute() {
  40                 $params = $this->extractRequestParams();
  41
  42                 // User already validated in call to getTokenSalt from Main
  43                 $form = new UserrightsPage;
  44                 $user = $form->fetchUser( $params['user'] );
  45
  46                 $r['user'] = $user->getName();
  47                 list( $r['added'], $r['removed'] ) =
  48                         $form->doSaveUserGroups(
  49                                 $user, (array)$params['add'],
  50                                 (array)$params['remove'], $params['reason'] );
  51
  52                 $this->getResult()->setIndexedTagName( $r['added'], 'group' );
  53                 $this->getResult()->setIndexedTagName( $r['removed'], 'group' );
  54                 $this->getResult()->addValue( null, $this->getModuleName(), $r );
  55         }
  56
  57         public function mustBePosted() {
  58                 return true;
  59         }
  60
  61         public function isWriteMode() {
  62                 return true;
  63         }
  64
  65         public function getAllowedParams() {
  66                 return array (
  67                         'user' => null,
  68                         'add' => array(
  69                                 ApiBase :: PARAM_TYPE => User::getAllGroups(),
  70                                 ApiBase :: PARAM_ISMULTI => true
  71                         ),
  72                         'remove' => array(
  73                                 ApiBase :: PARAM_TYPE => User::getAllGroups(),
  74                                 ApiBase :: PARAM_ISMULTI => true
  75                         ),
  76                         'token' => null,
  77                         'reason' => array(
  78                                 ApiBase :: PARAM_DFLT => ''
  79                         )
  80                 );
  81         }
  82
  83         public function getParamDescription() {
  84                 return array (
  85                         'user' => 'User name',
  86                         'add' => 'Add the user to these groups',
  87                         'remove' => 'Remove the user from these groups',
  88                         'token' => 'A userrights token previously retrieved through list=users',
  89                         'reason' => 'Reason for the change',
  90                 );
  91         }
  92
  93         public function getDescription() {
  94                 return array(
  95                         'Add/remove a user to/from groups',
  96                 );
  97         }
  98
  99     public function getPossibleErrors() {
 100                 return array_merge( parent::getPossibleErrors(), array(
 101                         array( 'missingparam', 'user' ),
 102         ) );
 103         }
 104
 105         public function needsToken() {
 106                 return true;
 107         }
 108
 109         public function getTokenSalt() {
 110                 $params = $this->extractRequestParams();
 111                 if ( is_null( $params['user'] ) )
 112                         $this->dieUsageMsg( array( 'missingparam', 'user' ) );
 113
 114                 $form = new UserrightsPage;
 115                 $user = $form->fetchUser( $params['user'] );
 116                 if ( $user instanceof WikiErrorMsg )
 117                         $this->dieUsageMsg( array_merge(
 118                                 (array)$user->getMessageKey(), $user->getMessageArgs() ) );
 119
 120                 return $user->getName();
 121         }
 122
 123         protected function getExamples() {
 124                 return array (
 125                         'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
 126                 );
 127         }
 128
 129         public function getVersion() {
 130                 return __CLASS__ . ': $Id: ApiUserrights.php 74217 2010-10-03 15:53:07Z reedy $';
 131         }
 132 }