includes/api/ApiUserrights.php

   1 <?php
   2
   3 /**
   4  * API userrights module
   5  *
   6  * Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * @ingroup API
  28  */
  29 class ApiUserrights extends ApiBase {
  30
  31         private $mUser = null;
  32
  33         /**
  34          * Get a UserrightsPage object, or subclass.
  35          * @return UserrightsPage
  36          */
  37         protected function getUserRightsPage() {
  38                 return new UserrightsPage;
  39         }
  40
  41         /**
  42          * Get all available groups.
  43          * @return array
  44          */
  45         protected function getAllGroups() {
  46                 return User::getAllGroups();
  47         }
  48
  49         public function execute() {
  50                 $pUser = $this->getUser();
  51
  52                 // Deny if the user is blocked and doesn't have the full 'userrights' permission.
  53                 // This matches what Special:UserRights does for the web UI.
  54                 if ( $pUser->isBlocked() && !$pUser->isAllowed( 'userrights' ) ) {
  55                         $this->dieBlocked( $pUser->getBlock() );
  56                 }
  57
  58                 $params = $this->extractRequestParams();
  59
  60                 // Figure out expiry times from the input
  61                 // $params['expiry'] is not set in CentralAuth's ApiGlobalUserRights subclass
  62                 if ( isset( $params['expiry'] ) ) {
  63                         $expiry = (array)$params['expiry'];
  64                 } else {
  65                         $expiry = [ 'infinity' ];
  66                 }
  67                 $add = (array)$params['add'];
  68                 if ( !$add ) {
  69                         $expiry = [];
  70                 } elseif ( count( $expiry ) !== count( $add ) ) {
  71                         if ( count( $expiry ) === 1 ) {
  72                                 $expiry = array_fill( 0, count( $add ), $expiry[0] );
  73                         } else {
  74                                 $this->dieWithError( [
  75                                         'apierror-toofewexpiries',
  76                                         count( $expiry ),
  77                                         count( $add )
  78                                 ] );
  79                         }
  80                 }
  81
  82                 // Validate the expiries
  83                 $groupExpiries = [];
  84                 foreach ( $expiry as $index => $expiryValue ) {
  85                         $group = $add[$index];
  86                         $groupExpiries[$group] = UserrightsPage::expiryToTimestamp( $expiryValue );
  87
  88                         if ( $groupExpiries[$group] === false ) {
  89                                 $this->dieWithError( [ 'apierror-invalidexpiry', wfEscapeWikiText( $expiryValue ) ] );
  90                         }
  91
  92                         // not allowed to have things expiring in the past
  93                         if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
  94                                 $this->dieWithError( [ 'apierror-pastexpiry', wfEscapeWikiText( $expiryValue ) ] );
  95                         }
  96                 }
  97
  98                 $user = $this->getUrUser( $params );
  99
 100                 $tags = $params['tags'];
 101
 102                 // Check if user can add tags
 103                 if ( !is_null( $tags ) ) {
 104                         $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $pUser );
 105                         if ( !$ableToTag->isOK() ) {
 106                                 $this->dieStatus( $ableToTag );
 107                         }
 108                 }
 109
 110                 $form = $this->getUserRightsPage();
 111                 $form->setContext( $this->getContext() );
 112                 $r['user'] = $user->getName();
 113                 $r['userid'] = $user->getId();
 114                 list( $r['added'], $r['removed'] ) = $form->doSaveUserGroups(
 115                         $user, (array)$add, (array)$params['remove'],
 116                         $params['reason'], $tags, $groupExpiries
 117                 );
 118
 119                 $result = $this->getResult();
 120                 ApiResult::setIndexedTagName( $r['added'], 'group' );
 121                 ApiResult::setIndexedTagName( $r['removed'], 'group' );
 122                 $result->addValue( null, $this->getModuleName(), $r );
 123         }
 124
 125         /**
 126          * @param array $params
 127          * @return User
 128          */
 129         private function getUrUser( array $params ) {
 130                 if ( $this->mUser !== null ) {
 131                         return $this->mUser;
 132                 }
 133
 134                 $this->requireOnlyOneParameter( $params, 'user', 'userid' );
 135
 136                 $user = isset( $params['user'] ) ? $params['user'] : '#' . $params['userid'];
 137
 138                 $form = $this->getUserRightsPage();
 139                 $form->setContext( $this->getContext() );
 140                 $status = $form->fetchUser( $user );
 141                 if ( !$status->isOK() ) {
 142                         $this->dieStatus( $status );
 143                 }
 144
 145                 $this->mUser = $status->value;
 146
 147                 return $status->value;
 148         }
 149
 150         public function mustBePosted() {
 151                 return true;
 152         }
 153
 154         public function isWriteMode() {
 155                 return true;
 156         }
 157
 158         public function getAllowedParams() {
 159                 $a = [
 160                         'user' => [
 161                                 ApiBase::PARAM_TYPE => 'user',
 162                         ],
 163                         'userid' => [
 164                                 ApiBase::PARAM_TYPE => 'integer',
 165                         ],
 166                         'add' => [
 167                                 ApiBase::PARAM_TYPE => $this->getAllGroups(),
 168                                 ApiBase::PARAM_ISMULTI => true
 169                         ],
 170                         'expiry' => [
 171                                 ApiBase::PARAM_ISMULTI => true,
 172                                 ApiBase::PARAM_ALLOW_DUPLICATES => true,
 173                                 ApiBase::PARAM_DFLT => 'infinite',
 174                         ],
 175                         'remove' => [
 176                                 ApiBase::PARAM_TYPE => $this->getAllGroups(),
 177                                 ApiBase::PARAM_ISMULTI => true
 178                         ],
 179                         'reason' => [
 180                                 ApiBase::PARAM_DFLT => ''
 181                         ],
 182                         'token' => [
 183                                 // Standard definition automatically inserted
 184                                 ApiBase::PARAM_HELP_MSG_APPEND => [ 'api-help-param-token-webui' ],
 185                         ],
 186                         'tags' => [
 187                                 ApiBase::PARAM_TYPE => 'tags',
 188                                 ApiBase::PARAM_ISMULTI => true
 189                         ],
 190                 ];
 191                 // CentralAuth's ApiGlobalUserRights subclass can't handle expiries
 192                 if ( !$this->getUserRightsPage()->canProcessExpiries() ) {
 193                         unset( $a['expiry'] );
 194                 }
 195                 return $a;
 196         }
 197
 198         public function needsToken() {
 199                 return 'userrights';
 200         }
 201
 202         protected function getWebUITokenSalt( array $params ) {
 203                 return $this->getUrUser( $params )->getName();
 204         }
 205
 206         protected function getExamplesMessages() {
 207                 $a = [
 208                         'action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
 209                                 => 'apihelp-userrights-example-user',
 210                         'action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC'
 211                                 => 'apihelp-userrights-example-userid',
 212                 ];
 213                 if ( $this->getUserRightsPage()->canProcessExpiries() ) {
 214                         $a['action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC']
 215                                 = 'apihelp-userrights-example-expiry';
 216                 }
 217                 return $a;
 218         }
 219
 220         public function getHelpUrls() {
 221                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:User_group_membership';
 222         }
 223 }