includes/api/ApiUnblock.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 7, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * API module that facilitates the unblocking of users. Requires API write mode
  29  * to be enabled.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiUnblock extends ApiBase {
  34
  35         /**
  36          * Unblocks the specified user or provides the reason the unblock failed.
  37          */
  38         public function execute() {
  39                 $user = $this->getUser();
  40                 $params = $this->extractRequestParams();
  41
  42                 if ( is_null( $params['id'] ) && is_null( $params['user'] ) ) {
  43                         $this->dieUsageMsg( 'unblock-notarget' );
  44                 }
  45                 if ( !is_null( $params['id'] ) && !is_null( $params['user'] ) ) {
  46                         $this->dieUsageMsg( 'unblock-idanduser' );
  47                 }
  48
  49                 if ( !$user->isAllowed( 'block' ) ) {
  50                         $this->dieUsageMsg( 'cantunblock' );
  51                 }
  52                 # bug 15810: blocked admins should have limited access here
  53                 if ( $user->isBlocked() ) {
  54                         $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
  55                         if ( $status !== true ) {
  56                                 $msg = $this->parseMsg( $status );
  57                                 $this->dieUsage(
  58                                         $msg['info'],
  59                                         $msg['code'],
  60                                         0,
  61                                         [ 'blockinfo' => ApiQueryUserInfo::getBlockInfo( $user->getBlock() ) ]
  62                                 );
  63                         }
  64                 }
  65
  66                 // Check if user can add tags
  67                 if ( !is_null( $params['tags'] ) ) {
  68                         $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
  69                         if ( !$ableToTag->isOK() ) {
  70                                 $this->dieStatus( $ableToTag );
  71                         }
  72                 }
  73
  74                 $data = [
  75                         'Target' => is_null( $params['id'] ) ? $params['user'] : "#{$params['id']}",
  76                         'Reason' => $params['reason'],
  77                         'Tags' => $params['tags']
  78                 ];
  79                 $block = Block::newFromTarget( $data['Target'] );
  80                 $retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
  81                 if ( $retval !== true ) {
  82                         $this->dieUsageMsg( $retval[0] );
  83                 }
  84
  85                 $res['id'] = $block->getId();
  86                 $target = $block->getType() == Block::TYPE_AUTO ? '' : $block->getTarget();
  87                 $res['user'] = $target instanceof User ? $target->getName() : $target;
  88                 $res['userid'] = $target instanceof User ? $target->getId() : 0;
  89                 $res['reason'] = $params['reason'];
  90                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
  91         }
  92
  93         public function mustBePosted() {
  94                 return true;
  95         }
  96
  97         public function isWriteMode() {
  98                 return true;
  99         }
 100
 101         public function getAllowedParams() {
 102                 return [
 103                         'id' => [
 104                                 ApiBase::PARAM_TYPE => 'integer',
 105                         ],
 106                         'user' => null,
 107                         'reason' => '',
 108                         'tags' => [
 109                                 ApiBase::PARAM_TYPE => 'tags',
 110                                 ApiBase::PARAM_ISMULTI => true,
 111                         ],
 112                 ];
 113         }
 114
 115         public function needsToken() {
 116                 return 'csrf';
 117         }
 118
 119         protected function getExamplesMessages() {
 120                 return [
 121                         'action=unblock&id=105'
 122                                 => 'apihelp-unblock-example-id',
 123                         'action=unblock&user=Bob&reason=Sorry%20Bob'
 124                                 => 'apihelp-unblock-example-user',
 125                 ];
 126         }
 127
 128         public function getHelpUrls() {
 129                 return 'https://www.mediawiki.org/wiki/API:Block';
 130         }
 131 }