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 /**
  29  * @ingroup API
  30  */
  31 class ApiUserrights extends ApiBase {
  32
  33         private $mUser = null;
  34
  35         public function execute() {
  36                 $params = $this->extractRequestParams();
  37
  38                 $user = $this->getUrUser();
  39
  40                 $form = new UserrightsPage;
  41                 $form->setContext( $this->getContext() );
  42                 $r['user'] = $user->getName();
  43                 $r['userid'] = $user->getId();
  44                 list( $r['added'], $r['removed'] ) =
  45                         $form->doSaveUserGroups(
  46                                 $user, (array)$params['add'],
  47                                 (array)$params['remove'], $params['reason'] );
  48
  49                 $result = $this->getResult();
  50                 $result->setIndexedTagName( $r['added'], 'group' );
  51                 $result->setIndexedTagName( $r['removed'], 'group' );
  52                 $result->addValue( null, $this->getModuleName(), $r );
  53         }
  54
  55         /**
  56          * @return User
  57          */
  58         private function getUrUser() {
  59                 if ( $this->mUser !== null ) {
  60                         return $this->mUser;
  61                 }
  62
  63                 $params = $this->extractRequestParams();
  64
  65                 $form = new UserrightsPage;
  66                 $form->setContext( $this->getContext() );
  67                 $status = $form->fetchUser( $params['user'] );
  68                 if ( !$status->isOK() ) {
  69                         $errors = $status->getErrorsArray();
  70                         $this->dieUsageMsg( $errors[0] );
  71                 } else {
  72                         $user = $status->value;
  73                 }
  74
  75                 $this->mUser = $user;
  76                 return $user;
  77         }
  78
  79         public function mustBePosted() {
  80                 return true;
  81         }
  82
  83         public function isWriteMode() {
  84                 return true;
  85         }
  86
  87         public function getAllowedParams() {
  88                 return array(
  89                         'user' => array(
  90                                 ApiBase::PARAM_TYPE => 'string',
  91                                 ApiBase::PARAM_REQUIRED => true
  92                         ),
  93                         'add' => array(
  94                                 ApiBase::PARAM_TYPE => User::getAllGroups(),
  95                                 ApiBase::PARAM_ISMULTI => true
  96                         ),
  97                         'remove' => array(
  98                                 ApiBase::PARAM_TYPE => User::getAllGroups(),
  99                                 ApiBase::PARAM_ISMULTI => true
 100                         ),
 101                         'token' => array(
 102                                 ApiBase::PARAM_TYPE => 'string',
 103                                 ApiBase::PARAM_REQUIRED => true
 104                         ),
 105                         'reason' => array(
 106                                 ApiBase::PARAM_DFLT => ''
 107                         )
 108                 );
 109         }
 110
 111         public function getParamDescription() {
 112                 return array(
 113                         'user' => 'User name',
 114                         'add' => 'Add the user to these groups',
 115                         'remove' => 'Remove the user from these groups',
 116                         'token' => 'A userrights token previously retrieved through list=users',
 117                         'reason' => 'Reason for the change',
 118                 );
 119         }
 120
 121         public function getDescription() {
 122                 return 'Add/remove a user to/from groups';
 123         }
 124
 125         public function needsToken() {
 126                 return true;
 127         }
 128
 129         public function getTokenSalt() {
 130                 return $this->getUrUser()->getName();
 131         }
 132
 133         public function getExamples() {
 134                 return array(
 135                         'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
 136                 );
 137         }
 138
 139         public function getHelpUrls() {
 140                 return 'https://www.mediawiki.org/wiki/API:User_group_membership';
 141         }
 142 }