includes/specials/SpecialUnblock.php

   1 <?php
   2 /**
   3  * Implements Special:Unblock
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * A special page for unblocking users
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialUnblock extends SpecialPage {
  30
  31         protected $target;
  32         protected $type;
  33         protected $block;
  34
  35         public function __construct() {
  36                 parent::__construct( 'Unblock', 'block' );
  37         }
  38
  39         public function execute( $par ) {
  40                 $this->checkPermissions();
  41                 $this->checkReadOnly();
  42
  43                 list( $this->target, $this->type ) = SpecialBlock::getTargetAndType( $par, $this->getRequest() );
  44                 $this->block = Block::newFromTarget( $this->target );
  45                 if ( $this->target instanceof User ) {
  46                         # Set the 'relevant user' in the skin, so it displays links like Contributions,
  47                         # User logs, UserRights, etc.
  48                         $this->getSkin()->setRelevantUser( $this->target );
  49                 }
  50
  51                 $this->setHeaders();
  52                 $this->outputHeader();
  53
  54                 $out = $this->getOutput();
  55                 $out->setPageTitle( $this->msg( 'unblockip' ) );
  56                 $out->addModules( 'mediawiki.special' );
  57
  58                 $form = new HTMLForm( $this->getFields(), $this->getContext() );
  59                 $form->setWrapperLegendMsg( 'unblockip' );
  60                 $form->setSubmitCallback( array( __CLASS__, 'processUIUnblock' ) );
  61                 $form->setSubmitTextMsg( 'ipusubmit' );
  62                 $form->addPreText( $this->msg( 'unblockiptext' )->parseAsBlock() );
  63
  64                 if ( $form->show() ) {
  65                         switch ( $this->type ) {
  66                                 case Block::TYPE_USER:
  67                                 case Block::TYPE_IP:
  68                                         $out->addWikiMsg( 'unblocked', wfEscapeWikiText( $this->target ) );
  69                                         break;
  70                                 case Block::TYPE_RANGE:
  71                                         $out->addWikiMsg( 'unblocked-range', wfEscapeWikiText( $this->target ) );
  72                                         break;
  73                                 case Block::TYPE_ID:
  74                                 case Block::TYPE_AUTO:
  75                                         $out->addWikiMsg( 'unblocked-id', wfEscapeWikiText( $this->target ) );
  76                                         break;
  77                         }
  78                 }
  79         }
  80
  81         protected function getFields() {
  82                 $fields = array(
  83                         'Target' => array(
  84                                 'type' => 'text',
  85                                 'label-message' => 'ipaddressorusername',
  86                                 'autofocus' => true,
  87                                 'size' => '45',
  88                                 'required' => true,
  89                         ),
  90                         'Name' => array(
  91                                 'type' => 'info',
  92                                 'label-message' => 'ipaddressorusername',
  93                         ),
  94                         'Reason' => array(
  95                                 'type' => 'text',
  96                                 'label-message' => 'ipbreason',
  97                         )
  98                 );
  99
 100                 if ( $this->block instanceof Block ) {
 101                         list( $target, $type ) = $this->block->getTargetAndType();
 102
 103                         # Autoblocks are logged as "autoblock #123 because the IP was recently used by
 104                         # User:Foo, and we've just got any block, auto or not, that applies to a target
 105                         # the user has specified.  Someone could be fishing to connect IPs to autoblocks,
 106                         # so don't show any distinction between unblocked IPs and autoblocked IPs
 107                         if ( $type == Block::TYPE_AUTO && $this->type == Block::TYPE_IP ) {
 108                                 $fields['Target']['default'] = $this->target;
 109                                 unset( $fields['Name'] );
 110                         } else {
 111                                 $fields['Target']['default'] = $target;
 112                                 $fields['Target']['type'] = 'hidden';
 113                                 switch ( $type ) {
 114                                         case Block::TYPE_USER:
 115                                         case Block::TYPE_IP:
 116                                                 $fields['Name']['default'] = Linker::link(
 117                                                         $target->getUserPage(),
 118                                                         $target->getName()
 119                                                 );
 120                                                 $fields['Name']['raw'] = true;
 121                                                 break;
 122
 123                                         case Block::TYPE_RANGE:
 124                                                 $fields['Name']['default'] = $target;
 125                                                 break;
 126
 127                                         case Block::TYPE_AUTO:
 128                                                 $fields['Name']['default'] = $this->block->getRedactedName();
 129                                                 $fields['Name']['raw'] = true;
 130                                                 # Don't expose the real target of the autoblock
 131                                                 $fields['Target']['default'] = "#{$this->target}";
 132                                                 break;
 133                                 }
 134                                 // target is hidden, so the reason is the first element
 135                                 $fields['Target']['autofocus'] = false;
 136                                 $fields['Reason']['autofocus'] = true;
 137                         }
 138                 } else {
 139                         $fields['Target']['default'] = $this->target;
 140                         unset( $fields['Name'] );
 141                 }
 142
 143                 return $fields;
 144         }
 145
 146         /**
 147          * Submit callback for an HTMLForm object
 148          * @param array $data
 149          * @param HTMLForm $form
 150          * @return array|bool Array(message key, parameters)
 151          */
 152         public static function processUIUnblock( array $data, HTMLForm $form ) {
 153                 return self::processUnblock( $data, $form->getContext() );
 154         }
 155
 156         /**
 157          * Process the form
 158          *
 159          * @param array $data
 160          * @param IContextSource $context
 161          * @throws ErrorPageError
 162          * @return array|bool Array(message key, parameters) on failure, True on success
 163          */
 164         public static function processUnblock( array $data, IContextSource $context ) {
 165                 $performer = $context->getUser();
 166                 $target = $data['Target'];
 167                 $block = Block::newFromTarget( $data['Target'] );
 168
 169                 if ( !$block instanceof Block ) {
 170                         return array( array( 'ipb_cant_unblock', $target ) );
 171                 }
 172
 173                 # bug 15810: blocked admins should have limited access here.  This
 174                 # won't allow sysops to remove autoblocks on themselves, but they
 175                 # should have ipblock-exempt anyway
 176                 $status = SpecialBlock::checkUnblockSelf( $target, $performer );
 177                 if ( $status !== true ) {
 178                         throw new ErrorPageError( 'badaccess', $status );
 179                 }
 180
 181                 # If the specified IP is a single address, and the block is a range block, don't
 182                 # unblock the whole range.
 183                 list( $target, $type ) = SpecialBlock::getTargetAndType( $target );
 184                 if ( $block->getType() == Block::TYPE_RANGE && $type == Block::TYPE_IP ) {
 185                         $range = $block->getTarget();
 186
 187                         return array( array( 'ipb_blocked_as_range', $target, $range ) );
 188                 }
 189
 190                 # If the name was hidden and the blocking user cannot hide
 191                 # names, then don't allow any block removals...
 192                 if ( !$performer->isAllowed( 'hideuser' ) && $block->mHideName ) {
 193                         return array( 'unblock-hideuser' );
 194                 }
 195
 196                 # Delete block
 197                 if ( !$block->delete() ) {
 198                         return array( 'ipb_cant_unblock', htmlspecialchars( $block->getTarget() ) );
 199                 }
 200
 201                 # Unset _deleted fields as needed
 202                 if ( $block->mHideName ) {
 203                         # Something is deeply FUBAR if this is not a User object, but who knows?
 204                         $id = $block->getTarget() instanceof User
 205                                 ? $block->getTarget()->getID()
 206                                 : User::idFromName( $block->getTarget() );
 207
 208                         RevisionDeleteUser::unsuppressUserName( $block->getTarget(), $id );
 209                 }
 210
 211                 # Redact the name (IP address) for autoblocks
 212                 if ( $block->getType() == Block::TYPE_AUTO ) {
 213                         $page = Title::makeTitle( NS_USER, '#' . $block->getId() );
 214                 } else {
 215                         $page = $block->getTarget() instanceof User
 216                                 ? $block->getTarget()->getUserpage()
 217                                 : Title::makeTitle( NS_USER, $block->getTarget() );
 218                 }
 219
 220                 # Make log entry
 221                 $log = new LogPage( 'block' );
 222                 $log->addEntry( 'unblock', $page, $data['Reason'], array(), $performer );
 223
 224                 return true;
 225         }
 226
 227         protected function getGroupName() {
 228                 return 'users';
 229         }
 230 }