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