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