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