includes/Block.php

   1 <?php
   2 /**
   3  * Blocks and bans object
   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  */
  22 class Block {
  23         /* public*/ var $mReason, $mTimestamp, $mAuto, $mExpiry, $mHideName;
  24
  25         protected
  26                 $mId,
  27                 $mFromMaster,
  28
  29                 $mBlockEmail,
  30                 $mDisableUsertalk,
  31                 $mCreateAccount;
  32
  33         /// @var User|String
  34         protected $target;
  35
  36         /// @var Block::TYPE_ constant.  Can only be USER, IP or RANGE internally
  37         protected $type;
  38
  39         /// @var User
  40         protected $blocker;
  41
  42         /// @var Bool
  43         protected $isHardblock = true;
  44
  45         /// @var Bool
  46         protected $isAutoblocking = true;
  47
  48         # TYPE constants
  49         const TYPE_USER = 1;
  50         const TYPE_IP = 2;
  51         const TYPE_RANGE = 3;
  52         const TYPE_AUTO = 4;
  53         const TYPE_ID = 5;
  54
  55         /**
  56          * Constructor
  57          * @todo FIXME: Don't know what the best format to have for this constructor is, but fourteen
  58          * optional parameters certainly isn't it.
  59          */
  60         function __construct( $address = '', $user = 0, $by = 0, $reason = '',
  61                 $timestamp = 0, $auto = 0, $expiry = '', $anonOnly = 0, $createAccount = 0, $enableAutoblock = 0,
  62                 $hideName = 0, $blockEmail = 0, $allowUsertalk = 0, $byText = '' )
  63         {
  64                 if( $timestamp === 0 ){
  65                         $timestamp = wfTimestampNow();
  66                 }
  67
  68                 if( count( func_get_args() ) > 0 ){
  69                         # Soon... :D
  70                         # wfDeprecated( __METHOD__ . " with arguments" );
  71                 }
  72
  73                 $this->setTarget( $address );
  74                 if ( $by ) { // local user
  75                         $this->setBlocker( User::newFromID( $by ) );
  76                 } else { // foreign user
  77                         $this->setBlocker( $byText );
  78                 }
  79                 $this->mReason = $reason;
  80                 $this->mTimestamp = wfTimestamp( TS_MW, $timestamp );
  81                 $this->mAuto = $auto;
  82                 $this->isHardblock( !$anonOnly );
  83                 $this->prevents( 'createaccount', $createAccount );
  84                 if ( $expiry == 'infinity' || $expiry == wfGetDB( DB_SLAVE )->getInfinity() ) {
  85                         $this->mExpiry = 'infinity';
  86                 } else {
  87                         $this->mExpiry = wfTimestamp( TS_MW, $expiry );
  88                 }
  89                 $this->isAutoblocking( $enableAutoblock );
  90                 $this->mHideName = $hideName;
  91                 $this->prevents( 'sendemail', $blockEmail );
  92                 $this->prevents( 'editownusertalk', !$allowUsertalk );
  93
  94                 $this->mFromMaster = false;
  95         }
  96
  97         /**
  98          * Load a block from the database, using either the IP address or
  99          * user ID. Tries the user ID first, and if that doesn't work, tries
 100          * the address.
 101          *
 102          * @param $address String: IP address of user/anon
 103          * @param $user Integer: user id of user
 104          * @return Block Object
 105          * @deprecated since 1.18
 106          */
 107         public static function newFromDB( $address, $user = 0 ) {
 108                 return self::newFromTarget( User::whoIs( $user ), $address );
 109         }
 110
 111         /**
 112          * Load a blocked user from their block id.
 113          *
 114          * @param $id Integer: Block id to search for
 115          * @return Block object or null
 116          */
 117         public static function newFromID( $id ) {
 118                 $dbr = wfGetDB( DB_SLAVE );
 119                 $res = $dbr->selectRow(
 120                         'ipblocks',
 121                         '*',
 122                         array( 'ipb_id' => $id ),
 123                         __METHOD__
 124                 );
 125                 if ( $res ) {
 126                         return Block::newFromRow( $res );
 127                 } else {
 128                         return null;
 129                 }
 130         }
 131
 132         /**
 133          * Check if two blocks are effectively equal.  Doesn't check irrelevant things like
 134          * the blocking user or the block timestamp, only things which affect the blocked user   *
 135          *
 136          * @param $block Block
 137          *
 138          * @return bool
 139          */
 140         public function equals( Block $block ) {
 141                 return (
 142                         (string)$this->target == (string)$block->target
 143                         && $this->type == $block->type
 144                         && $this->mAuto == $block->mAuto
 145                         && $this->isHardblock() == $block->isHardblock()
 146                         && $this->prevents( 'createaccount' ) == $block->prevents( 'createaccount' )
 147                         && $this->mExpiry == $block->mExpiry
 148                         && $this->isAutoblocking() == $block->isAutoblocking()
 149                         && $this->mHideName == $block->mHideName
 150                         && $this->prevents( 'sendemail' ) == $block->prevents( 'sendemail' )
 151                         && $this->prevents( 'editownusertalk' ) == $block->prevents( 'editownusertalk' )
 152                         && $this->mReason == $block->mReason
 153                 );
 154         }
 155
 156         /**
 157          * Clear all member variables in the current object. Does not clear
 158          * the block from the DB.
 159          * @deprecated since 1.18
 160          */
 161         public function clear() {
 162                 # Noop
 163         }
 164
 165         /**
 166          * Get a block from the DB, with either the given address or the given username
 167          *
 168          * @param $address string The IP address of the user, or blank to skip IP blocks
 169          * @param $user int The user ID, or zero for anonymous users
 170          * @return Boolean: the user is blocked from editing
 171          * @deprecated since 1.18
 172          */
 173         public function load( $address = '', $user = 0 ) {
 174                 wfDeprecated( __METHOD__ );
 175                 if( $user ){
 176                         $username = User::whoIs( $user );
 177                         $block = self::newFromTarget( $username, $address );
 178                 } else {
 179                         $block = self::newFromTarget( null, $address );
 180                 }
 181
 182                 if( $block instanceof Block ){
 183                         # This is mildly evil, but hey, it's B/C :D
 184                         foreach( $block as $variable => $value ){
 185                                 $this->$variable = $value;
 186                         }
 187                         return true;
 188                 } else {
 189                         return false;
 190                 }
 191         }
 192
 193         /**
 194          * Load a block from the database which affects the already-set $this->target:
 195          *     1) A block directly on the given user or IP
 196          *     2) A rangeblock encompasing the given IP (smallest first)
 197          *     3) An autoblock on the given IP
 198          * @param $vagueTarget User|String also search for blocks affecting this target.  Doesn't
 199          *     make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.
 200          * @return Bool whether a relevant block was found
 201          */
 202         protected function newLoad( $vagueTarget = null ) {
 203                 $db = wfGetDB( $this->mFromMaster ? DB_MASTER : DB_SLAVE );
 204
 205                 if( $this->type !== null ){
 206                         $conds = array(
 207                                 'ipb_address' => array( (string)$this->target ),
 208                         );
 209                 } else {
 210                         $conds = array( 'ipb_address' => array() );
 211                 }
 212
 213                 # Be aware that the != '' check is explicit, since empty values will be
 214                 # passed by some callers (bug 29116)
 215                 if( $vagueTarget != ''){
 216                         list( $target, $type ) = self::parseTarget( $vagueTarget );
 217                         switch( $type ) {
 218                                 case self::TYPE_USER:
 219                                         # Slightly wierd, but who are we to argue?
 220                                         $conds['ipb_address'][] = (string)$target;
 221                                         break;
 222
 223                                 case self::TYPE_IP:
 224                                         $conds['ipb_address'][] = (string)$target;
 225                                         $conds[] = self::getRangeCond( IP::toHex( $target ) );
 226                                         $conds = $db->makeList( $conds, LIST_OR );
 227                                         break;
 228
 229                                 case self::TYPE_RANGE:
 230                                         list( $start, $end ) = IP::parseRange( $target );
 231                                         $conds['ipb_address'][] = (string)$target;
 232                                         $conds[] = self::getRangeCond( $start, $end );
 233                                         $conds = $db->makeList( $conds, LIST_OR );
 234                                         break;
 235
 236                                 default:
 237                                         throw new MWException( "Tried to load block with invalid type" );
 238                         }
 239                 }
 240
 241                 $res = $db->select( 'ipblocks', '*', $conds, __METHOD__ );
 242
 243                 # This result could contain a block on the user, a block on the IP, and a russian-doll
 244                 # set of rangeblocks.  We want to choose the most specific one, so keep a leader board.
 245                 $bestRow = null;
 246
 247                 # Lower will be better
 248                 $bestBlockScore = 100;
 249
 250                 # This is begging for $this = $bestBlock, but that's not allowed in PHP :(
 251                 $bestBlockPreventsEdit = null;
 252
 253                 foreach( $res as $row ){
 254                         $block = Block::newFromRow( $row );
 255
 256                         # Don't use expired blocks
 257                         if( $block->deleteIfExpired() ){
 258                                 continue;
 259                         }
 260
 261                         # Don't use anon only blocks on users
 262                         if( $this->type == self::TYPE_USER && !$block->isHardblock() ){
 263                                 continue;
 264                         }
 265
 266                         if( $block->getType() == self::TYPE_RANGE ){
 267                                 # This is the number of bits that are allowed to vary in the block, give
 268                                 # or take some floating point errors
 269                                 $end = wfBaseconvert( $block->getRangeEnd(), 16, 10 );
 270                                 $start = wfBaseconvert( $block->getRangeStart(), 16, 10 );
 271                                 $size = log( $end - $start + 1, 2 );
 272
 273                                 # This has the nice property that a /32 block is ranked equally with a
 274                                 # single-IP block, which is exactly what it is...
 275                                 $score = self::TYPE_RANGE  - 1 + ( $size / 128 );
 276
 277                         } else {
 278                                 $score = $block->getType();
 279                         }
 280
 281                         if( $score < $bestBlockScore ){
 282                                 $bestBlockScore = $score;
 283                                 $bestRow = $row;
 284                                 $bestBlockPreventsEdit = $block->prevents( 'edit' );
 285                         }
 286                 }
 287
 288                 if( $bestRow !== null ){
 289                         $this->initFromRow( $bestRow );
 290                         $this->prevents( 'edit', $bestBlockPreventsEdit );
 291                         return true;
 292                 } else {
 293                         return false;
 294                 }
 295         }
 296
 297         /**
 298          * Get a set of SQL conditions which will select rangeblocks encompasing a given range
 299          * @param $start String Hexadecimal IP representation
 300          * @param $end String Hexadecimal IP represenation, or null to use $start = $end
 301          * @return String
 302          */
 303         public static function getRangeCond( $start, $end = null ) {
 304                 if ( $end === null ) {
 305                         $end = $start;
 306                 }
 307                 # Per bug 14634, we want to include relevant active rangeblocks; for
 308                 # rangeblocks, we want to include larger ranges which enclose the given
 309                 # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
 310                 # so we can improve performance by filtering on a LIKE clause
 311                 $chunk = self::getIpFragment( $start );
 312                 $dbr = wfGetDB( DB_SLAVE );
 313                 $like = $dbr->buildLike( $chunk, $dbr->anyString() );
 314
 315                 # Fairly hard to make a malicious SQL statement out of hex characters,
 316                 # but stranger things have happened...
 317                 $safeStart = $dbr->addQuotes( $start );
 318                 $safeEnd = $dbr->addQuotes( $end );
 319
 320                 return $dbr->makeList(
 321                         array(
 322                                 "ipb_range_start $like",
 323                                 "ipb_range_start <= $safeStart",
 324                                 "ipb_range_end >= $safeEnd",
 325                         ),
 326                         LIST_AND
 327                 );
 328         }
 329
 330         /**
 331          * Get the component of an IP address which is certain to be the same between an IP
 332          * address and a rangeblock containing that IP address.
 333          * @param  $hex String Hexadecimal IP representation
 334          * @return String
 335          */
 336         protected static function getIpFragment( $hex ) {
 337                 global $wgBlockCIDRLimit;
 338                 if ( substr( $hex, 0, 3 ) == 'v6-' ) {
 339                         return 'v6-' . substr( substr( $hex, 3 ), 0,  floor( $wgBlockCIDRLimit['IPv6'] / 4 ) );
 340                 } else {
 341                         return substr( $hex, 0,  floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
 342                 }
 343         }
 344
 345         /**
 346          * Given a database row from the ipblocks table, initialize
 347          * member variables
 348          * @param $row ResultWrapper: a row from the ipblocks table
 349          */
 350         protected function initFromRow( $row ) {
 351                 $this->setTarget( $row->ipb_address );
 352                 if ( $row->ipb_by ) { // local user
 353                         $this->setBlocker( User::newFromID( $row->ipb_by ) );
 354                 } else { // foreign user
 355                         $this->setBlocker( $row->ipb_by_text );
 356                 }
 357
 358                 $this->mReason = $row->ipb_reason;
 359                 $this->mTimestamp = wfTimestamp( TS_MW, $row->ipb_timestamp );
 360                 $this->mAuto = $row->ipb_auto;
 361                 $this->mHideName = $row->ipb_deleted;
 362                 $this->mId = $row->ipb_id;
 363
 364                 // I wish I didn't have to do this
 365                 $db = wfGetDB( DB_SLAVE );
 366                 if ( $row->ipb_expiry == $db->getInfinity() ) {
 367                         $this->mExpiry = 'infinity';
 368                 } else {
 369                         $this->mExpiry = wfTimestamp( TS_MW, $row->ipb_expiry );
 370                 }
 371
 372                 $this->isHardblock( !$row->ipb_anon_only );
 373                 $this->isAutoblocking( $row->ipb_enable_autoblock );
 374
 375                 $this->prevents( 'createaccount', $row->ipb_create_account );
 376                 $this->prevents( 'sendemail', $row->ipb_block_email );
 377                 $this->prevents( 'editownusertalk', !$row->ipb_allow_usertalk );
 378         }
 379
 380         /**
 381          * Create a new Block object from a database row
 382          * @param  $row ResultWrapper row from the ipblocks table
 383          * @return Block
 384          */
 385         public static function newFromRow( $row ){
 386                 $block = new Block;
 387                 $block->initFromRow( $row );
 388                 return $block;
 389         }
 390
 391         /**
 392          * Delete the row from the IP blocks table.
 393          *
 394          * @return Boolean
 395          */
 396         public function delete() {
 397                 if ( wfReadOnly() ) {
 398                         return false;
 399                 }
 400
 401                 if ( !$this->getId() ) {
 402                         throw new MWException( "Block::delete() requires that the mId member be filled\n" );
 403                 }
 404
 405                 $dbw = wfGetDB( DB_MASTER );
 406                 $dbw->delete( 'ipblocks', array( 'ipb_id' => $this->getId() ), __METHOD__ );
 407
 408                 return $dbw->affectedRows() > 0;
 409         }
 410
 411         /**
 412          * Insert a block into the block table. Will fail if there is a conflicting
 413          * block (same name and options) already in the database.
 414          *
 415          * @param $dbw DatabaseBase if you have one available
 416          * @return mixed: false on failure, assoc array on success:
 417          *      ('id' => block ID, 'autoIds' => array of autoblock IDs)
 418          */
 419         public function insert( $dbw = null ) {
 420                 wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
 421
 422                 if ( $dbw === null ) {
 423                         $dbw = wfGetDB( DB_MASTER );
 424                 }
 425
 426                 # Don't collide with expired blocks
 427                 Block::purgeExpired();
 428
 429                 $dbw->insert(
 430                         'ipblocks',
 431                         $this->getDatabaseArray(),
 432                         __METHOD__,
 433                         array( 'IGNORE' )
 434                 );
 435                 $affected = $dbw->affectedRows();
 436                 $this->mId = $dbw->insertId();
 437
 438                 if ( $affected ) {
 439                         $auto_ipd_ids = $this->doRetroactiveAutoblock();
 440                         return array( 'id' => $this->mId, 'autoIds' => $auto_ipd_ids );
 441                 }
 442
 443                 return false;
 444         }
 445
 446         /**
 447          * Update a block in the DB with new parameters.
 448          * The ID field needs to be loaded first.
 449          *
 450          * @return Int number of affected rows, which should probably be 1 or something's
 451          *     gone slightly awry
 452          */
 453         public function update() {
 454                 wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" );
 455                 $dbw = wfGetDB( DB_MASTER );
 456
 457                 $dbw->update(
 458                         'ipblocks',
 459                         $this->getDatabaseArray( $dbw ),
 460                         array( 'ipb_id' => $this->getId() ),
 461                         __METHOD__
 462                 );
 463
 464                 return $dbw->affectedRows();
 465         }
 466
 467         /**
 468          * Get an array suitable for passing to $dbw->insert() or $dbw->update()
 469          * @param $db DatabaseBase
 470          * @return Array
 471          */
 472         protected function getDatabaseArray( $db = null ){
 473                 if( !$db ){
 474                         $db = wfGetDB( DB_SLAVE );
 475                 }
 476                 $expiry = $db->encodeExpiry( $this->mExpiry );
 477
 478                 $a = array(
 479                         'ipb_address'          => (string)$this->target,
 480                         'ipb_user'             => $this->target instanceof User ? $this->target->getID() : 0,
 481                         'ipb_by'               => $this->getBy(),
 482                         'ipb_by_text'          => $this->getByName(),
 483                         'ipb_reason'           => $this->mReason,
 484                         'ipb_timestamp'        => $db->timestamp( $this->mTimestamp ),
 485                         'ipb_auto'             => $this->mAuto,
 486                         'ipb_anon_only'        => !$this->isHardblock(),
 487                         'ipb_create_account'   => $this->prevents( 'createaccount' ),
 488                         'ipb_enable_autoblock' => $this->isAutoblocking(),
 489                         'ipb_expiry'           => $expiry,
 490                         'ipb_range_start'      => $this->getRangeStart(),
 491                         'ipb_range_end'        => $this->getRangeEnd(),
 492                         'ipb_deleted'          => intval( $this->mHideName ), // typecast required for SQLite
 493                         'ipb_block_email'      => $this->prevents( 'sendemail' ),
 494                         'ipb_allow_usertalk'   => !$this->prevents( 'editownusertalk' )
 495                 );
 496
 497                 return $a;
 498         }
 499
 500         /**
 501          * Retroactively autoblocks the last IP used by the user (if it is a user)
 502          * blocked by this Block.
 503          *
 504          * @return Array: block IDs of retroactive autoblocks made
 505          */
 506         protected function doRetroactiveAutoblock() {
 507                 $blockIds = array();
 508                 # If autoblock is enabled, autoblock the LAST IP(s) used
 509                 if ( $this->isAutoblocking() && $this->getType() == self::TYPE_USER ) {
 510                         wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
 511
 512                         $continue = wfRunHooks(
 513                                 'PerformRetroactiveAutoblock', array( $this, &$blockIds ) );
 514
 515                         if ( $continue ) {
 516                                 self::defaultRetroactiveAutoblock( $this, $blockIds );
 517                         }
 518                 }
 519                 return $blockIds;
 520         }
 521
 522         /**
 523          * Retroactively autoblocks the last IP used by the user (if it is a user)
 524          * blocked by this Block. This will use the recentchanges table.
 525          *
 526          * @param Block $block
 527          * @param Array &$blockIds
 528          * @return Array: block IDs of retroactive autoblocks made
 529          */
 530         protected static function defaultRetroactiveAutoblock( Block $block, array &$blockIds ) {
 531                 $dbr = wfGetDB( DB_SLAVE );
 532
 533                 $options = array( 'ORDER BY' => 'rc_timestamp DESC' );
 534                 $conds = array( 'rc_user_text' => (string)$block->getTarget() );
 535
 536                 // Just the last IP used.
 537                 $options['LIMIT'] = 1;
 538
 539                 $res = $dbr->select( 'recentchanges', array( 'rc_ip' ), $conds,
 540                         __METHOD__ ,  $options );
 541
 542                 if ( !$dbr->numRows( $res ) ) {
 543                         # No results, don't autoblock anything
 544                         wfDebug( "No IP found to retroactively autoblock\n" );
 545                 } else {
 546                         foreach ( $res as $row ) {
 547                                 if ( $row->rc_ip ) {
 548                                         $id = $block->doAutoblock( $row->rc_ip );
 549                                         if ( $id ) $blockIds[] = $id;
 550                                 }
 551                         }
 552                 }
 553         }
 554
 555         /**
 556          * Checks whether a given IP is on the autoblock whitelist.
 557          * TODO: this probably belongs somewhere else, but not sure where...
 558          *
 559          * @param $ip String: The IP to check
 560          * @return Boolean
 561          */
 562         public static function isWhitelistedFromAutoblocks( $ip ) {
 563                 global $wgMemc;
 564
 565                 // Try to get the autoblock_whitelist from the cache, as it's faster
 566                 // than getting the msg raw and explode()'ing it.
 567                 $key = wfMemcKey( 'ipb', 'autoblock', 'whitelist' );
 568                 $lines = $wgMemc->get( $key );
 569                 if ( !$lines ) {
 570                         $lines = explode( "\n", wfMsgForContentNoTrans( 'autoblock_whitelist' ) );
 571                         $wgMemc->set( $key, $lines, 3600 * 24 );
 572                 }
 573
 574                 wfDebug( "Checking the autoblock whitelist..\n" );
 575
 576                 foreach ( $lines as $line ) {
 577                         # List items only
 578                         if ( substr( $line, 0, 1 ) !== '*' ) {
 579                                 continue;
 580                         }
 581
 582                         $wlEntry = substr( $line, 1 );
 583                         $wlEntry = trim( $wlEntry );
 584
 585                         wfDebug( "Checking $ip against $wlEntry..." );
 586
 587                         # Is the IP in this range?
 588                         if ( IP::isInRange( $ip, $wlEntry ) ) {
 589                                 wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
 590                                 return true;
 591                         } else {
 592                                 wfDebug( " No match\n" );
 593                         }
 594                 }
 595
 596                 return false;
 597         }
 598
 599         /**
 600          * Autoblocks the given IP, referring to this Block.
 601          *
 602          * @param $autoblockIP String: the IP to autoblock.
 603          * @return mixed: block ID if an autoblock was inserted, false if not.
 604          */
 605         public function doAutoblock( $autoblockIP ) {
 606                 # If autoblocks are disabled, go away.
 607                 if ( !$this->isAutoblocking() ) {
 608                         return false;
 609                 }
 610
 611                 # Check for presence on the autoblock whitelist.
 612                 if ( self::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
 613                         return false;
 614                 }
 615
 616                 # Allow hooks to cancel the autoblock.
 617                 if ( !wfRunHooks( 'AbortAutoblock', array( $autoblockIP, &$this ) ) ) {
 618                         wfDebug( "Autoblock aborted by hook.\n" );
 619                         return false;
 620                 }
 621
 622                 # It's okay to autoblock. Go ahead and insert/update the block...
 623
 624                 # Do not add a *new* block if the IP is already blocked.
 625                 $ipblock = Block::newFromTarget( $autoblockIP );
 626                 if ( $ipblock ) {
 627                         # Check if the block is an autoblock and would exceed the user block
 628                         # if renewed. If so, do nothing, otherwise prolong the block time...
 629                         if ( $ipblock->mAuto && // @TODO: why not compare $ipblock->mExpiry?
 630                                 $this->mExpiry > Block::getAutoblockExpiry( $ipblock->mTimestamp )
 631                         ) {
 632                                 # Reset block timestamp to now and its expiry to
 633                                 # $wgAutoblockExpiry in the future
 634                                 $ipblock->updateTimestamp();
 635                         }
 636                         return false;
 637                 }
 638
 639                 # Make a new block object with the desired properties.
 640                 $autoblock = new Block;
 641                 wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
 642                 $autoblock->setTarget( $autoblockIP );
 643                 $autoblock->setBlocker( $this->getBlocker() );
 644                 $autoblock->mReason = wfMsgForContent( 'autoblocker', $this->getTarget(), $this->mReason );
 645                 $timestamp = wfTimestampNow();
 646                 $autoblock->mTimestamp = $timestamp;
 647                 $autoblock->mAuto = 1;
 648                 $autoblock->prevents( 'createaccount', $this->prevents( 'createaccount' ) );
 649                 # Continue suppressing the name if needed
 650                 $autoblock->mHideName = $this->mHideName;
 651                 $autoblock->prevents( 'editownusertalk', $this->prevents( 'editownusertalk' ) );
 652
 653                 if ( $this->mExpiry == 'infinity' ) {
 654                         # Original block was indefinite, start an autoblock now
 655                         $autoblock->mExpiry = Block::getAutoblockExpiry( $timestamp );
 656                 } else {
 657                         # If the user is already blocked with an expiry date, we don't
 658                         # want to pile on top of that.
 659                         $autoblock->mExpiry = min( $this->mExpiry, Block::getAutoblockExpiry( $timestamp ) );
 660                 }
 661
 662                 # Insert the block...
 663                 $status = $autoblock->insert();
 664                 return $status
 665                         ? $status['id']
 666                         : false;
 667         }
 668
 669         /**
 670          * Check if a block has expired. Delete it if it is.
 671          * @return Boolean
 672          */
 673         public function deleteIfExpired() {
 674                 wfProfileIn( __METHOD__ );
 675
 676                 if ( $this->isExpired() ) {
 677                         wfDebug( "Block::deleteIfExpired() -- deleting\n" );
 678                         $this->delete();
 679                         $retVal = true;
 680                 } else {
 681                         wfDebug( "Block::deleteIfExpired() -- not expired\n" );
 682                         $retVal = false;
 683                 }
 684
 685                 wfProfileOut( __METHOD__ );
 686                 return $retVal;
 687         }
 688
 689         /**
 690          * Has the block expired?
 691          * @return Boolean
 692          */
 693         public function isExpired() {
 694                 $timestamp = wfTimestampNow();
 695                 wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" );
 696
 697                 if ( !$this->mExpiry ) {
 698                         return false;
 699                 } else {
 700                         return $timestamp > $this->mExpiry;
 701                 }
 702         }
 703
 704         /**
 705          * Is the block address valid (i.e. not a null string?)
 706          * @return Boolean
 707          */
 708         public function isValid() {
 709                 return $this->getTarget() != null;
 710         }
 711
 712         /**
 713          * Update the timestamp on autoblocks.
 714          */
 715         public function updateTimestamp() {
 716                 if ( $this->mAuto ) {
 717                         $this->mTimestamp = wfTimestamp();
 718                         $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
 719
 720                         $dbw = wfGetDB( DB_MASTER );
 721                         $dbw->update( 'ipblocks',
 722                                 array( /* SET */
 723                                         'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ),
 724                                         'ipb_expiry' => $dbw->timestamp( $this->mExpiry ),
 725                                 ),
 726                                 array( /* WHERE */
 727                                         'ipb_address' => (string)$this->getTarget()
 728                                 ),
 729                                 __METHOD__
 730                         );
 731                 }
 732         }
 733
 734         /**
 735          * Get the IP address at the start of the range in Hex form
 736          * @return String IP in Hex form
 737          */
 738         public function getRangeStart() {
 739                 switch( $this->type ) {
 740                         case self::TYPE_USER:
 741                                 return '';
 742                         case self::TYPE_IP:
 743                                 return IP::toHex( $this->target );
 744                         case self::TYPE_RANGE:
 745                                 list( $start, /*...*/ ) = IP::parseRange( $this->target );
 746                                 return $start;
 747                         default: throw new MWException( "Block with invalid type" );
 748                 }
 749         }
 750
 751         /**
 752          * Get the IP address at the start of the range in Hex form
 753          * @return String IP in Hex form
 754          */
 755         public function getRangeEnd() {
 756                 switch( $this->type ) {
 757                         case self::TYPE_USER:
 758                                 return '';
 759                         case self::TYPE_IP:
 760                                 return IP::toHex( $this->target );
 761                         case self::TYPE_RANGE:
 762                                 list( /*...*/, $end ) = IP::parseRange( $this->target );
 763                                 return $end;
 764                         default: throw new MWException( "Block with invalid type" );
 765                 }
 766         }
 767
 768         /**
 769          * Get the user id of the blocking sysop
 770          *
 771          * @return Integer (0 for foreign users)
 772          */
 773         public function getBy() {
 774                 $blocker = $this->getBlocker();
 775                 return ( $blocker instanceof User )
 776                         ? $blocker->getId()
 777                         : 0;
 778         }
 779
 780         /**
 781          * Get the username of the blocking sysop
 782          *
 783          * @return String
 784          */
 785         public function getByName() {
 786                 $blocker = $this->getBlocker();
 787                 return ( $blocker instanceof User )
 788                         ? $blocker->getName()
 789                         : (string)$blocker; // username
 790         }
 791
 792         /**
 793          * Get the block ID
 794          * @return int
 795          */
 796         public function getId() {
 797                 return $this->mId;
 798         }
 799
 800         /**
 801          * Get/set the SELECT ... FOR UPDATE flag
 802          * @deprecated since 1.18
 803          *
 804          * @param $x Bool
 805          */
 806         public function forUpdate( $x = null ) {
 807                 # noop
 808         }
 809
 810         /**
 811          * Get/set a flag determining whether the master is used for reads
 812          *
 813          * @param $x Bool
 814          * @return Bool
 815          */
 816         public function fromMaster( $x = null ) {
 817                 return wfSetVar( $this->mFromMaster, $x );
 818         }
 819
 820         /**
 821          * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range
 822          * @param $x Bool
 823          * @return  Bool
 824          */
 825         public function isHardblock( $x = null ) {
 826                 wfSetVar( $this->isHardblock, $x );
 827
 828                 # You can't *not* hardblock a user
 829                 return $this->getType() == self::TYPE_USER
 830                         ? true
 831                         : $this->isHardblock;
 832         }
 833
 834         public function isAutoblocking( $x = null ) {
 835                 wfSetVar( $this->isAutoblocking, $x );
 836
 837                 # You can't put an autoblock on an IP or range as we don't have any history to
 838                 # look over to get more IPs from
 839                 return $this->getType() == self::TYPE_USER
 840                         ? $this->isAutoblocking
 841                         : false;
 842         }
 843
 844         /**
 845          * Get/set whether the Block prevents a given action
 846          * @param $action String
 847          * @param $x Bool
 848          * @return Bool
 849          */
 850         public function prevents( $action, $x = null ) {
 851                 switch( $action ) {
 852                         case 'edit':
 853                                 # For now... <evil laugh>
 854                                 return true;
 855
 856                         case 'createaccount':
 857                                 return wfSetVar( $this->mCreateAccount, $x );
 858
 859                         case 'sendemail':
 860                                 return wfSetVar( $this->mBlockEmail, $x );
 861
 862                         case 'editownusertalk':
 863                                 return wfSetVar( $this->mDisableUsertalk, $x );
 864
 865                         default:
 866                                 return null;
 867                 }
 868         }
 869
 870         /**
 871          * Get the block name, but with autoblocked IPs hidden as per standard privacy policy
 872          * @return String, text is escaped
 873          */
 874         public function getRedactedName() {
 875                 if ( $this->mAuto ) {
 876                         return Html::rawElement(
 877                                 'span',
 878                                 array( 'class' => 'mw-autoblockid' ),
 879                                 wfMessage( 'autoblockid', $this->mId )
 880                         );
 881                 } else {
 882                         return htmlspecialchars( $this->getTarget() );
 883                 }
 884         }
 885
 886         /**
 887          * Encode expiry for DB
 888          *
 889          * @param $expiry String: timestamp for expiry, or
 890          * @param $db Database object
 891          * @return String
 892          * @deprecated since 1.18; use $dbw->encodeExpiry() instead
 893          */
 894         public static function encodeExpiry( $expiry, $db ) {
 895                 return $db->encodeExpiry( $expiry );
 896         }
 897
 898         /**
 899          * Decode expiry which has come from the DB
 900          *
 901          * @param $expiry String: Database expiry format
 902          * @param $timestampType Int Requested timestamp format
 903          * @return String
 904          * @deprecated since 1.18; use $wgLang->formatExpiry() instead
 905          */
 906         public static function decodeExpiry( $expiry, $timestampType = TS_MW ) {
 907                 global $wgContLang;
 908                 return $wgContLang->formatExpiry( $expiry, $timestampType );
 909         }
 910
 911         /**
 912          * Get a timestamp of the expiry for autoblocks
 913          *
 914          * @param $timestamp String|Int
 915          * @return String
 916          */
 917         public static function getAutoblockExpiry( $timestamp ) {
 918                 global $wgAutoblockExpiry;
 919
 920                 return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
 921         }
 922
 923         /**
 924          * Gets rid of uneeded numbers in quad-dotted/octet IP strings
 925          * For example, 127.111.113.151/24 -> 127.111.113.0/24
 926          * @param $range String: IP address to normalize
 927          * @return string
 928          * @deprecated since 1.18, call IP::sanitizeRange() directly
 929          */
 930         public static function normaliseRange( $range ) {
 931                 return IP::sanitizeRange( $range );
 932         }
 933
 934         /**
 935          * Purge expired blocks from the ipblocks table
 936          */
 937         public static function purgeExpired() {
 938                 $dbw = wfGetDB( DB_MASTER );
 939                 $dbw->delete( 'ipblocks',
 940                         array( 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), __METHOD__ );
 941         }
 942
 943         /**
 944          * Get a value to insert into expiry field of the database when infinite expiry
 945          * is desired
 946          * @deprecated since 1.18, call $dbr->getInfinity() directly
 947          * @return String
 948          */
 949         public static function infinity() {
 950                 return wfGetDB( DB_SLAVE )->getInfinity();
 951         }
 952
 953         /**
 954          * Convert a DB-encoded expiry into a real string that humans can read.
 955          *
 956          * @param $encoded_expiry String: Database encoded expiry time
 957          * @return Html-escaped String
 958          * @deprecated since 1.18; use $wgLang->formatExpiry() instead
 959          */
 960         public static function formatExpiry( $encoded_expiry ) {
 961                 global $wgContLang;
 962                 static $msg = null;
 963
 964                 if ( is_null( $msg ) ) {
 965                         $msg = array();
 966                         $keys = array( 'infiniteblock', 'expiringblock' );
 967
 968                         foreach ( $keys as $key ) {
 969                                 $msg[$key] = wfMsgHtml( $key );
 970                         }
 971                 }
 972
 973                 $expiry = $wgContLang->formatExpiry( $encoded_expiry, TS_MW );
 974                 if ( $expiry == wfGetDB( DB_SLAVE )->getInfinity() ) {
 975                         $expirystr = $msg['infiniteblock'];
 976                 } else {
 977                         global $wgLang;
 978                         $expiredatestr = htmlspecialchars( $wgLang->date( $expiry, true ) );
 979                         $expiretimestr = htmlspecialchars( $wgLang->time( $expiry, true ) );
 980                         $expirystr = wfMsgReplaceArgs( $msg['expiringblock'], array( $expiredatestr, $expiretimestr ) );
 981                 }
 982
 983                 return $expirystr;
 984         }
 985
 986         /**
 987          * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
 988          * ("24 May 2034"), into an absolute timestamp we can put into the database.
 989          * @param $expiry String: whatever was typed into the form
 990          * @return String: timestamp or "infinity" string for th DB implementation
 991          * @deprecated since 1.18 moved to SpecialBlock::parseExpiryInput()
 992          */
 993         public static function parseExpiryInput( $expiry ) {
 994                 wfDeprecated( __METHOD__ );
 995                 return SpecialBlock::parseExpiryInput( $expiry );
 996         }
 997
 998         /**
 999          * Given a target and the target's type, get an existing Block object if possible.
1000          * @param $specificTarget String|User|Int a block target, which may be one of several types:
1001          *     * A user to block, in which case $target will be a User
1002          *     * An IP to block, in which case $target will be a User generated by using
1003          *       User::newFromName( $ip, false ) to turn off name validation
1004          *     * An IP range, in which case $target will be a String "123.123.123.123/18" etc
1005          *     * The ID of an existing block, in the format "#12345" (since pure numbers are valid
1006          *       usernames
1007          *     Calling this with a user, IP address or range will not select autoblocks, and will
1008          *     only select a block where the targets match exactly (so looking for blocks on
1009          *     1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
1010          * @param $vagueTarget String|User|Int as above, but we will search for *any* block which
1011          *     affects that target (so for an IP address, get ranges containing that IP; and also
1012          *     get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
1013          * @param $fromMaster Bool whether to use the DB_MASTER database
1014          * @return Block|null (null if no relevant block could be found).  The target and type
1015          *     of the returned Block will refer to the actual block which was found, which might
1016          *     not be the same as the target you gave if you used $vagueTarget!
1017          */
1018         public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
1019
1020                 list( $target, $type ) = self::parseTarget( $specificTarget );
1021                 if( $type == Block::TYPE_ID || $type == Block::TYPE_AUTO ){
1022                         return Block::newFromID( $target );
1023
1024                 } elseif( $target === null && $vagueTarget == '' ){
1025                         # We're not going to find anything useful here
1026                         # Be aware that the == '' check is explicit, since empty values will be
1027                         # passed by some callers (bug 29116)
1028                         return null;
1029
1030                 } elseif( in_array( $type, array( Block::TYPE_USER, Block::TYPE_IP, Block::TYPE_RANGE, null ) ) ) {
1031                         $block = new Block();
1032                         $block->fromMaster( $fromMaster );
1033
1034                         if( $type !== null ){
1035                                 $block->setTarget( $target );
1036                         }
1037
1038                         if( $block->newLoad( $vagueTarget ) ){
1039                                 return $block;
1040                         } else {
1041                                 return null;
1042                         }
1043                 } else {
1044                         return null;
1045                 }
1046         }
1047
1048         /**
1049          * From an existing Block, get the target and the type of target.  Note that it is
1050          * always safe to treat the target as a string; for User objects this will return
1051          * User::__toString() which in turn gives User::getName().
1052          *
1053          * @param $target String|Int|User
1054          * @return array( User|String, Block::TYPE_ constant )
1055          */
1056         public static function parseTarget( $target ) {
1057                 $target = trim( $target );
1058
1059                 # We may have been through this before
1060                 if( $target instanceof User ){
1061                         if( IP::isValid( $target->getName() ) ){
1062                                 return array( $target, self::TYPE_IP );
1063                         } else {
1064                                 return array( $target, self::TYPE_USER );
1065                         }
1066                 } elseif( $target === null ){
1067                         return array( null, null );
1068                 }
1069
1070                 if ( IP::isValid( $target ) ) {
1071                         # We can still create a User if it's an IP address, but we need to turn
1072                         # off validation checking (which would exclude IP addresses)
1073                         return array(
1074                                 User::newFromName( IP::sanitizeIP( $target ), false ),
1075                                 Block::TYPE_IP
1076                         );
1077
1078                 } elseif ( IP::isValidBlock( $target ) ) {
1079                         # Can't create a User from an IP range
1080                         return array( IP::sanitizeRange( $target ), Block::TYPE_RANGE );
1081                 }
1082
1083                 # Consider the possibility that this is not a username at all
1084                 # but actually an old subpage (bug #29797)
1085                 if( strpos( $target, '/' ) !== false ){
1086                         # An old subpage, drill down to the user behind it
1087                         $parts = explode( '/', $target );
1088                         $target = $parts[0];
1089                 }
1090
1091                 $userObj = User::newFromName( $target );
1092                 if ( $userObj instanceof User ) {
1093                         # Note that since numbers are valid usernames, a $target of "12345" will be
1094                         # considered a User.  If you want to pass a block ID, prepend a hash "#12345",
1095                         # since hash characters are not valid in usernames or titles generally.
1096                         return array( $userObj, Block::TYPE_USER );
1097
1098                 } elseif ( preg_match( '/^#\d+$/', $target ) ) {
1099                         # Autoblock reference in the form "#12345"
1100                         return array( substr( $target, 1 ), Block::TYPE_AUTO );
1101
1102                 } else {
1103                         # WTF?
1104                         return array( null, null );
1105                 }
1106         }
1107
1108         /**
1109          * Get the type of target for this particular block
1110          * @return Block::TYPE_ constant, will never be TYPE_ID
1111          */
1112         public function getType() {
1113                 return $this->mAuto
1114                         ? self::TYPE_AUTO
1115                         : $this->type;
1116         }
1117
1118         /**
1119          * Get the target and target type for this particular Block.  Note that for autoblocks,
1120          * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1121          * in this situation.
1122          * @return array( User|String, Block::TYPE_ constant )
1123          * @todo FIXME: This should be an integral part of the Block member variables
1124          */
1125         public function getTargetAndType() {
1126                 return array( $this->getTarget(), $this->getType() );
1127         }
1128
1129         /**
1130          * Get the target for this particular Block.  Note that for autoblocks,
1131          * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1132          * in this situation.
1133          * @return User|String
1134          */
1135         public function getTarget() {
1136                 return $this->target;
1137         }
1138
1139         /**
1140          * Set the target for this block, and update $this->type accordingly
1141          * @param $target Mixed
1142          */
1143         public function setTarget( $target ){
1144                 list( $this->target, $this->type ) = self::parseTarget( $target );
1145         }
1146
1147         /**
1148          * Get the user who implemented this block
1149          * @return User|string Local User object or string for a foreign user
1150          */
1151         public function getBlocker(){
1152                 return $this->blocker;
1153         }
1154
1155         /**
1156          * Set the user who implemented (or will implement) this block
1157          * @param $user User|string Local User object or username string for foriegn users
1158          */
1159         public function setBlocker( $user ){
1160                 $this->blocker = $user;
1161         }
1162 }