includes/api/ApiUserrights.php

   1 <?php
   2
   3 /**
   4  *
   5  *
   6  * Created on Mar 24, 2009
   7  *
   8  * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@gmail.com
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  *
  25  * @file
  26  */
  27
  28 if ( !defined( 'MEDIAWIKI' ) ) {
  29         // Eclipse helper - will be ignored in production
  30         require_once( "ApiBase.php" );
  31 }
  32
  33 /**
  34  * @ingroup API
  35  */
  36 class ApiUserrights extends ApiBase {
  37
  38         public function __construct( $main, $action ) {
  39                 parent::__construct( $main, $action );
  40         }
  41
  42         private $mUser = null;
  43
  44         public function execute() {
  45                 $params = $this->extractRequestParams();
  46
  47                 $user = $this->getUser();
  48
  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'] );
  55
  56                 $result = $this->getResult();
  57                 $result->setIndexedTagName( $r['added'], 'group' );
  58                 $result->setIndexedTagName( $r['removed'], 'group' );
  59                 $result->addValue( null, $this->getModuleName(), $r );
  60         }
  61
  62         /**
  63          * @return User
  64          */
  65         private function getUser() {
  66                 if ( $this->mUser !== null ) {
  67                         return $this->mUser;
  68                 }
  69
  70                 $params = $this->extractRequestParams();
  71
  72                 $form = new UserrightsPage;
  73                 $status = $form->fetchUser( $params['user'] );
  74                 if ( !$status->isOK() ) {
  75                         $errors = $status->getErrorsArray();
  76                         $this->dieUsageMsg( $errors[0] );
  77                 } else {
  78                         $user = $status->value;
  79                 }
  80
  81                 $this->mUser = $user;
  82                 return $user;
  83         }
  84
  85         public function mustBePosted() {
  86                 return true;
  87         }
  88
  89         public function isWriteMode() {
  90                 return true;
  91         }
  92
  93         public function getAllowedParams() {
  94                 return array (
  95                         'user' => array(
  96                                 ApiBase::PARAM_TYPE => 'string',
  97                                 ApiBase::PARAM_REQUIRED => true
  98                         ),
  99                         'add' => array(
 100                                 ApiBase::PARAM_TYPE => User::getAllGroups(),
 101                                 ApiBase::PARAM_ISMULTI => true
 102                         ),
 103                         'remove' => array(
 104                                 ApiBase::PARAM_TYPE => User::getAllGroups(),
 105                                 ApiBase::PARAM_ISMULTI => true
 106                         ),
 107                         'token' => null,
 108                         'reason' => array(
 109                                 ApiBase::PARAM_DFLT => ''
 110                         )
 111                 );
 112         }
 113
 114         public function getParamDescription() {
 115                 return array(
 116                         'user' => 'User name',
 117                         'add' => 'Add the user to these groups',
 118                         'remove' => 'Remove the user from these groups',
 119                         'token' => 'A userrights token previously retrieved through list=users',
 120                         'reason' => 'Reason for the change',
 121                 );
 122         }
 123
 124         public function getDescription() {
 125                 return 'Add/remove a user to/from groups';
 126         }
 127
 128         public function needsToken() {
 129                 return true;
 130         }
 131
 132         public function getTokenSalt() {
 133                 return $this->getUser()->getName();
 134         }
 135
 136         public function getExamples() {
 137                 return array(
 138                         'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
 139                 );
 140         }
 141
 142         public function getHelpUrls() {
 143                 return 'http://www.mediawiki.org/wiki/API:User_group_membership';
 144         }
 145
 146         public function getVersion() {
 147                 return __CLASS__ . ': $Id$';
 148         }
 149 }