HTML 2???
[lhc/web/wiklou.git] / includes / api / ApiBlock.php
index d8121b5..351ac6b 100644 (file)
@@ -1,10 +1,10 @@
 <?php
-
-/*
+/**
+ *
+ *
  * Created on Sep 4, 2007
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
-}
-
 /**
 * API module that facilitates the blocking of users. Requires API write mode
 * to be enabled.
@@ -35,11 +32,8 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiBlock extends ApiBase {
 
-       /**
-        * Std ctor.
-        */
        public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
+               parent::__construct( $main, $action );
        }
 
        /**
@@ -49,78 +43,111 @@ class ApiBlock extends ApiBase {
         * of success. If it fails, the result will specify the nature of the error.
         */
        public function execute() {
-               global $wgUser, $wgBlockAllowsUTEdit;
+               $user = $this->getUser();
                $params = $this->extractRequestParams();
 
-               if ( $params['gettoken'] )
-               {
-                       $res['blocktoken'] = $wgUser->editToken();
+               if ( $params['gettoken'] ) {
+                       $res['blocktoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
                        $this->getResult()->addValue( null, $this->getModuleName(), $res );
                        return;
                }
 
-               if ( is_null( $params['user'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
-               if ( is_null( $params['token'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'token' ) );
-               if ( !$wgUser->matchEditToken( $params['token'] ) )
-                       $this->dieUsageMsg( array( 'sessionfailure' ) );
-               if ( !$wgUser->isAllowed( 'block' ) )
-                       $this->dieUsageMsg( array( 'cantblock' ) );
-               if ( $params['hidename'] && !$wgUser->isAllowed( 'hideuser' ) )
-                       $this->dieUsageMsg( array( 'canthide' ) );
-               if ( $params['noemail'] && !IPBlockForm::canBlockEmail( $wgUser ) )
-                       $this->dieUsageMsg( array( 'cantblock-email' ) );
-
-               $form = new IPBlockForm( '' );
-               $form->BlockAddress = $params['user'];
-               $form->BlockReason = ( is_null( $params['reason'] ) ? '' : $params['reason'] );
-               $form->BlockReasonList = 'other';
-               $form->BlockExpiry = ( $params['expiry'] == 'never' ? 'infinite' : $params['expiry'] );
-               $form->BlockOther = '';
-               $form->BlockAnonOnly = $params['anononly'];
-               $form->BlockCreateAccount = $params['nocreate'];
-               $form->BlockEnableAutoblock = $params['autoblock'];
-               $form->BlockEmail = $params['noemail'];
-               $form->BlockHideName = $params['hidename'];
-               $form->BlockAllowUsertalk = $params['allowusertalk'] && $wgBlockAllowsUTEdit;
-               $form->BlockReblock = $params['reblock'];
-
-               $userID = $expiry = null;
-               $retval = $form->doBlock( $userID, $expiry );
-               if ( count( $retval ) )
+               if ( !$user->isAllowed( 'block' ) ) {
+                       $this->dieUsageMsg( 'cantblock' );
+               }
+               # bug 15810: blocked admins should have limited access here
+               if ( $user->isBlocked() ) {
+                       $status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
+                       if ( $status !== true ) {
+                               $this->dieUsageMsg( array( $status ) );
+                       }
+               }
+               if ( $params['hidename'] && !$user->isAllowed( 'hideuser' ) ) {
+                       $this->dieUsageMsg( 'canthide' );
+               }
+               if ( $params['noemail'] && !SpecialBlock::canBlockEmail( $user ) ) {
+                       $this->dieUsageMsg( 'cantblock-email' );
+               }
+
+               $data = array(
+                       'Target' => $params['user'],
+                       'Reason' => array(
+                               is_null( $params['reason'] ) ? '' : $params['reason'],
+                               'other',
+                               is_null( $params['reason'] ) ? '' : $params['reason']
+                       ),
+                       'Expiry' => $params['expiry'] == 'never' ? 'infinite' : $params['expiry'],
+                       'HardBlock' => !$params['anononly'],
+                       'CreateAccount' => $params['nocreate'],
+                       'AutoBlock' => $params['autoblock'],
+                       'DisableEmail' => $params['noemail'],
+                       'HideUser' => $params['hidename'],
+                       'DisableUTEdit' => !$params['allowusertalk'],
+                       'AlreadyBlocked' => $params['reblock'],
+                       'Watch' => $params['watchuser'],
+                       'Confirm' => true,
+               );
+
+               $retval = SpecialBlock::processForm( $data, $this->getContext() );
+               if ( $retval !== true ) {
                        // We don't care about multiple errors, just report one of them
                        $this->dieUsageMsg( $retval );
+               }
 
+               list( $target, /*...*/ ) = SpecialBlock::getTargetAndType( $params['user'] );
                $res['user'] = $params['user'];
-               $res['userID'] = intval( $userID );
-               $res['expiry'] = ( $expiry == Block::infinity() ? 'infinite' : wfTimestamp( TS_ISO_8601, $expiry ) );
+               $res['userID'] = $target instanceof User ? $target->getId() : 0;
+
+               $block = Block::newFromTarget( $target );
+               if( $block instanceof Block ){
+                       $res['expiry'] = $block->mExpiry == wfGetDB( DB_SLAVE )->getInfinity()
+                               ? 'infinite'
+                               : wfTimestamp( TS_ISO_8601, $block->mExpiry );
+               } else {
+                       # should be unreachable
+                       $res['expiry'] = '';
+               }
+
                $res['reason'] = $params['reason'];
-               if ( $params['anononly'] )
+               if ( $params['anononly'] ) {
                        $res['anononly'] = '';
-               if ( $params['nocreate'] )
+               }
+               if ( $params['nocreate'] ) {
                        $res['nocreate'] = '';
-               if ( $params['autoblock'] )
+               }
+               if ( $params['autoblock'] ) {
                        $res['autoblock'] = '';
-               if ( $params['noemail'] )
+               }
+               if ( $params['noemail'] ) {
                        $res['noemail'] = '';
-               if ( $params['hidename'] )
+               }
+               if ( $params['hidename'] ) {
                        $res['hidename'] = '';
-               if ( $params['allowusertalk'] )
+               }
+               if ( $params['allowusertalk'] ) {
                        $res['allowusertalk'] = '';
+               }
+               if ( $params['watchuser'] ) {
+                       $res['watchuser'] = '';
+               }
 
                $this->getResult()->addValue( null, $this->getModuleName(), $res );
        }
 
-       public function mustBePosted() { return true; }
+       public function mustBePosted() {
+               return true;
+       }
 
        public function isWriteMode() {
                return true;
        }
 
        public function getAllowedParams() {
-               return array (
-                       'user' => null,
+               return array(
+                       'user' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'token' => null,
                        'gettoken' => false,
                        'expiry' => 'never',
@@ -132,11 +159,12 @@ class ApiBlock extends ApiBase {
                        'hidename' => false,
                        'allowusertalk' => false,
                        'reblock' => false,
+                       'watchuser' => false,
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'user' => 'Username, IP address or IP range you want to block',
                        'token' => 'A block token previously obtained through the gettoken parameter or prop=info',
                        'gettoken' => 'If set, a block token will be returned, and no other action will be taken',
@@ -149,33 +177,43 @@ class ApiBlock extends ApiBase {
                        'hidename' => 'Hide the username from the block log. (Requires the "hideuser" right.)',
                        'allowusertalk' => 'Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)',
                        'reblock' => 'If the user is already blocked, overwrite the existing block',
+                       'watchuser' => 'Watch the user/IP\'s user and talk pages',
                );
        }
 
        public function getDescription() {
-               return array(
-                       'Block a user.'
-               );
+               return 'Block a user';
        }
-       
+
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'user' ),
-                       array( 'missingparam', 'token' ),
-                       array( 'sessionfailure' ),
                        array( 'cantblock' ),
                        array( 'canthide' ),
                        array( 'cantblock-email' ),
-        ) );
+                       array( 'ipbblocked' ),
+                       array( 'ipbnounblockself' ),
+               ) );
+       }
+
+       public function needsToken() {
+               return true;
        }
 
-       protected function getExamples() {
-               return array (
+       public function getTokenSalt() {
+               return '';
+       }
+
+       public function getExamples() {
+               return array(
                        'api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike',
-                       'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail'
+                       'api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail='
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Block';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }