X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/Block.php diff --git a/includes/Block.php b/includes/Block.php index 7c5f0ddd..5a4c43e6 100644 --- a/includes/Block.php +++ b/includes/Block.php @@ -1,382 +1,467 @@ mId = 0; - # Expand valid IPv6 addresses - $address = IP::sanitizeIP( $address ); - $this->mAddress = $address; - $this->mUser = $user; - $this->mBy = $by; - $this->mReason = $reason; - $this->mTimestamp = wfTimestamp( TS_MW, $timestamp ); - $this->mAuto = $auto; - $this->mAnonOnly = $anonOnly; - $this->mCreateAccount = $createAccount; - $this->mExpiry = self::decodeExpiry( $expiry ); - $this->mEnableAutoblock = $enableAutoblock; - $this->mHideName = $hideName; - $this->mBlockEmail = $blockEmail; - $this->mAllowUsertalk = $allowUsertalk; - $this->mForUpdate = false; - $this->mFromMaster = false; - $this->mByName = $byName; - $this->mAngryAutoblock = false; - $this->initialiseRange(); - } + /** @var string */ + public $mReason; + + /** @var string */ + public $mTimestamp; + + /** @var bool */ + public $mAuto; + + /** @var string */ + public $mExpiry; + + /** @var bool */ + public $mHideName; + + /** @var int */ + public $mParentBlockId; + + /** @var int */ + private $mId; + + /** @var bool */ + private $mFromMaster; + + /** @var bool */ + private $mBlockEmail; + + /** @var bool */ + private $mDisableUsertalk; + + /** @var bool */ + private $mCreateAccount; + + /** @var User|string */ + private $target; + + /** @var int Hack for foreign blocking (CentralAuth) */ + private $forcedTargetID; + + /** @var int Block::TYPE_ constant. Can only be USER, IP or RANGE internally */ + private $type; + + /** @var User */ + private $blocker; + + /** @var bool */ + private $isHardblock; + + /** @var bool */ + private $isAutoblocking; + + /** @var string|null */ + private $systemBlockType; + + # TYPE constants + const TYPE_USER = 1; + const TYPE_IP = 2; + const TYPE_RANGE = 3; + const TYPE_AUTO = 4; + const TYPE_ID = 5; /** - * Load a block from the database, using either the IP address or - * user ID. Tries the user ID first, and if that doesn't work, tries - * the address. + * Create a new block with specified parameters on a user, IP or IP range. + * + * @param array $options Parameters of the block: + * address string|User Target user name, User object, IP address or IP range + * user int Override target user ID (for foreign users) + * by int User ID of the blocker + * reason string Reason of the block + * timestamp string The time at which the block comes into effect + * auto bool Is this an automatic block? + * expiry string Timestamp of expiration of the block or 'infinity' + * anonOnly bool Only disallow anonymous actions + * createAccount bool Disallow creation of new accounts + * enableAutoblock bool Enable automatic blocking + * hideName bool Hide the target user name + * blockEmail bool Disallow sending emails + * allowUsertalk bool Allow the target to edit its own talk page + * byText string Username of the blocker (for foreign users) + * systemBlock string Indicate that this block is automatically + * created by MediaWiki rather than being stored + * in the database. Value is a string to return + * from self::getSystemBlockType(). * - * @param $address String: IP address of user/anon - * @param $user Integer: user id of user - * @param $killExpired Boolean: delete expired blocks on load - * @return Block Object + * @since 1.26 accepts $options array instead of individual parameters; order + * of parameters above reflects the original order */ - public static function newFromDB( $address, $user = 0, $killExpired = true ) { - $block = new Block; - $block->load( $address, $user, $killExpired ); + function __construct( $options = [] ) { + $defaults = [ + 'address' => '', + 'user' => null, + 'by' => null, + 'reason' => '', + 'timestamp' => '', + 'auto' => false, + 'expiry' => '', + 'anonOnly' => false, + 'createAccount' => false, + 'enableAutoblock' => false, + 'hideName' => false, + 'blockEmail' => false, + 'allowUsertalk' => false, + 'byText' => '', + 'systemBlock' => null, + ]; + + if ( func_num_args() > 1 || !is_array( $options ) ) { + $options = array_combine( + array_slice( array_keys( $defaults ), 0, func_num_args() ), + func_get_args() + ); + wfDeprecated( __METHOD__ . ' with multiple arguments', '1.26' ); + } - if ( $block->isValid() ) { - return $block; + $options += $defaults; + + $this->setTarget( $options['address'] ); + + if ( $this->target instanceof User && $options['user'] ) { + # Needed for foreign users + $this->forcedTargetID = $options['user']; + } + + if ( $options['by'] ) { + # Local user + $this->setBlocker( User::newFromId( $options['by'] ) ); } else { - return null; + # Foreign user + $this->setBlocker( $options['byText'] ); } + + $this->mReason = $options['reason']; + $this->mTimestamp = wfTimestamp( TS_MW, $options['timestamp'] ); + $this->mExpiry = wfGetDB( DB_REPLICA )->decodeExpiry( $options['expiry'] ); + + # Boolean settings + $this->mAuto = (bool)$options['auto']; + $this->mHideName = (bool)$options['hideName']; + $this->isHardblock( !$options['anonOnly'] ); + $this->isAutoblocking( (bool)$options['enableAutoblock'] ); + + # Prevention measures + $this->prevents( 'sendemail', (bool)$options['blockEmail'] ); + $this->prevents( 'editownusertalk', !$options['allowUsertalk'] ); + $this->prevents( 'createaccount', (bool)$options['createAccount'] ); + + $this->mFromMaster = false; + $this->systemBlockType = $options['systemBlock']; } /** * Load a blocked user from their block id. * - * @param $id Integer: Block id to search for - * @return Block object + * @param int $id Block id to search for + * @return Block|null */ public static function newFromID( $id ) { - $dbr = wfGetDB( DB_SLAVE ); - $res = $dbr->resultObject( $dbr->select( 'ipblocks', '*', - array( 'ipb_id' => $id ), __METHOD__ ) ); - $block = new Block; - - if ( $block->loadFromResult( $res ) ) { - return $block; + $dbr = wfGetDB( DB_REPLICA ); + $res = $dbr->selectRow( + 'ipblocks', + self::selectFields(), + [ 'ipb_id' => $id ], + __METHOD__ + ); + if ( $res ) { + return self::newFromRow( $res ); } else { return null; } } /** - * Check if two blocks are effectively equal + * Return the list of ipblocks fields that should be selected to create + * a new block. + * @todo Deprecate this in favor of a method that returns tables and joins + * as well, and use CommentStore::getJoin(). + * @return array + */ + public static function selectFields() { + return [ + 'ipb_id', + 'ipb_address', + 'ipb_by', + 'ipb_by_text', + 'ipb_timestamp', + 'ipb_auto', + 'ipb_anon_only', + 'ipb_create_account', + 'ipb_enable_autoblock', + 'ipb_expiry', + 'ipb_deleted', + 'ipb_block_email', + 'ipb_allow_usertalk', + 'ipb_parent_block_id', + ] + CommentStore::newKey( 'ipb_reason' )->getFields(); + } + + /** + * Check if two blocks are effectively equal. Doesn't check irrelevant things like + * the blocking user or the block timestamp, only things which affect the blocked user + * + * @param Block $block * - * @return Boolean + * @return bool */ public function equals( Block $block ) { return ( - $this->mAddress == $block->mAddress - && $this->mUser == $block->mUser + (string)$this->target == (string)$block->target + && $this->type == $block->type && $this->mAuto == $block->mAuto - && $this->mAnonOnly == $block->mAnonOnly - && $this->mCreateAccount == $block->mCreateAccount + && $this->isHardblock() == $block->isHardblock() + && $this->prevents( 'createaccount' ) == $block->prevents( 'createaccount' ) && $this->mExpiry == $block->mExpiry - && $this->mEnableAutoblock == $block->mEnableAutoblock + && $this->isAutoblocking() == $block->isAutoblocking() && $this->mHideName == $block->mHideName - && $this->mBlockEmail == $block->mBlockEmail - && $this->mAllowUsertalk == $block->mAllowUsertalk + && $this->prevents( 'sendemail' ) == $block->prevents( 'sendemail' ) + && $this->prevents( 'editownusertalk' ) == $block->prevents( 'editownusertalk' ) && $this->mReason == $block->mReason ); } /** - * Clear all member variables in the current object. Does not clear - * the block from the DB. - */ - public function clear() { - $this->mAddress = $this->mReason = $this->mTimestamp = ''; - $this->mId = $this->mAnonOnly = $this->mCreateAccount = - $this->mEnableAutoblock = $this->mAuto = $this->mUser = - $this->mBy = $this->mHideName = $this->mBlockEmail = $this->mAllowUsertalk = 0; - $this->mByName = false; - } - - /** - * Get the DB object and set the reference parameter to the select options. - * The options array will contain FOR UPDATE if appropriate. - * - * @param $options Array - * @return Database + * Load a block from the database which affects the already-set $this->target: + * 1) A block directly on the given user or IP + * 2) A rangeblock encompassing the given IP (smallest first) + * 3) An autoblock on the given IP + * @param User|string $vagueTarget Also search for blocks affecting this target. Doesn't + * make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups. + * @throws MWException + * @return bool Whether a relevant block was found */ - protected function &getDBOptions( &$options ) { - global $wgAntiLockFlags; + protected function newLoad( $vagueTarget = null ) { + $db = wfGetDB( $this->mFromMaster ? DB_MASTER : DB_REPLICA ); - if ( $this->mForUpdate || $this->mFromMaster ) { - $db = wfGetDB( DB_MASTER ); - if ( !$this->mForUpdate || ( $wgAntiLockFlags & ALF_NO_BLOCK_LOCK ) ) { - $options = array(); - } else { - $options = array( 'FOR UPDATE' ); - } + if ( $this->type !== null ) { + $conds = [ + 'ipb_address' => [ (string)$this->target ], + ]; } else { - $db = wfGetDB( DB_SLAVE ); - $options = array(); + $conds = [ 'ipb_address' => [] ]; } - return $db; - } + # Be aware that the != '' check is explicit, since empty values will be + # passed by some callers (T31116) + if ( $vagueTarget != '' ) { + list( $target, $type ) = self::parseTarget( $vagueTarget ); + switch ( $type ) { + case self::TYPE_USER: + # Slightly weird, but who are we to argue? + $conds['ipb_address'][] = (string)$target; + break; + + case self::TYPE_IP: + $conds['ipb_address'][] = (string)$target; + $conds[] = self::getRangeCond( IP::toHex( $target ) ); + $conds = $db->makeList( $conds, LIST_OR ); + break; + + case self::TYPE_RANGE: + list( $start, $end ) = IP::parseRange( $target ); + $conds['ipb_address'][] = (string)$target; + $conds[] = self::getRangeCond( $start, $end ); + $conds = $db->makeList( $conds, LIST_OR ); + break; + + default: + throw new MWException( "Tried to load block with invalid type" ); + } + } - /** - * Get a block from the DB, with either the given address or the given username - * - * @param $address string The IP address of the user, or blank to skip IP blocks - * @param $user int The user ID, or zero for anonymous users - * @param $killExpired bool Whether to delete expired rows while loading - * @return Boolean: the user is blocked from editing - * - */ - public function load( $address = '', $user = 0, $killExpired = true ) { - wfDebug( "Block::load: '$address', '$user', $killExpired\n" ); + $res = $db->select( 'ipblocks', self::selectFields(), $conds, __METHOD__ ); - $options = array(); - $db = $this->getDBOptions( $options ); + # This result could contain a block on the user, a block on the IP, and a russian-doll + # set of rangeblocks. We want to choose the most specific one, so keep a leader board. + $bestRow = null; - if ( 0 == $user && $address === '' ) { - # Invalid user specification, not blocked - $this->clear(); + # Lower will be better + $bestBlockScore = 100; - return false; - } + # This is begging for $this = $bestBlock, but that's not allowed in PHP :( + $bestBlockPreventsEdit = null; - # Try user block - if ( $user ) { - $res = $db->resultObject( $db->select( 'ipblocks', '*', array( 'ipb_user' => $user ), - __METHOD__, $options ) ); + foreach ( $res as $row ) { + $block = self::newFromRow( $row ); - if ( $this->loadFromResult( $res, $killExpired ) ) { - return true; + # Don't use expired blocks + if ( $block->isExpired() ) { + continue; } - } - # Try IP block - # TODO: improve performance by merging this query with the autoblock one - # Slightly tricky while handling killExpired as well - if ( $address !== '' ) { - $conds = array( 'ipb_address' => $address, 'ipb_auto' => 0 ); - $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) ); - - if ( $this->loadFromResult( $res, $killExpired ) ) { - if ( $user && $this->mAnonOnly ) { - # Block is marked anon-only - # Whitelist this IP address against autoblocks and range blocks - # (but not account creation blocks -- bug 13611) - if ( !$this->mCreateAccount ) { - $this->clear(); - } - - return false; - } else { - return true; - } + # Don't use anon only blocks on users + if ( $this->type == self::TYPE_USER && !$block->isHardblock() ) { + continue; } - } - # Try range block - if ( $this->loadRange( $address, $killExpired, $user ) ) { - if ( $user && $this->mAnonOnly ) { - # Respect account creation blocks on logged-in users -- bug 13611 - if ( !$this->mCreateAccount ) { - $this->clear(); - } - - return false; - } else { - return true; - } - } + if ( $block->getType() == self::TYPE_RANGE ) { + # This is the number of bits that are allowed to vary in the block, give + # or take some floating point errors + $end = Wikimedia\base_convert( $block->getRangeEnd(), 16, 10 ); + $start = Wikimedia\base_convert( $block->getRangeStart(), 16, 10 ); + $size = log( $end - $start + 1, 2 ); - # Try autoblock - if ( $address ) { - $conds = array( 'ipb_address' => $address, 'ipb_auto' => 1 ); + # This has the nice property that a /32 block is ranked equally with a + # single-IP block, which is exactly what it is... + $score = self::TYPE_RANGE - 1 + ( $size / 128 ); - if ( $user ) { - $conds['ipb_anon_only'] = 0; + } else { + $score = $block->getType(); } - $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) ); - - if ( $this->loadFromResult( $res, $killExpired ) ) { - return true; + if ( $score < $bestBlockScore ) { + $bestBlockScore = $score; + $bestRow = $row; + $bestBlockPreventsEdit = $block->prevents( 'edit' ); } } - # Give up - $this->clear(); - return false; + if ( $bestRow !== null ) { + $this->initFromRow( $bestRow ); + $this->prevents( 'edit', $bestBlockPreventsEdit ); + return true; + } else { + return false; + } } /** - * Fill in member variables from a result wrapper - * - * @param $res ResultWrapper: row from the ipblocks table - * @param $killExpired Boolean: whether to delete expired rows while loading - * @return Boolean + * Get a set of SQL conditions which will select rangeblocks encompassing a given range + * @param string $start Hexadecimal IP representation + * @param string $end Hexadecimal IP representation, or null to use $start = $end + * @return string */ - protected function loadFromResult( ResultWrapper $res, $killExpired = true ) { - $ret = false; - - if ( 0 != $res->numRows() ) { - # Get first block - $row = $res->fetchObject(); - $this->initFromRow( $row ); - - if ( $killExpired ) { - # If requested, delete expired rows - do { - $killed = $this->deleteIfExpired(); - if ( $killed ) { - $row = $res->fetchObject(); - if ( $row ) { - $this->initFromRow( $row ); - } - } - } while ( $killed && $row ); - - # If there were any left after the killing finished, return true - if ( $row ) { - $ret = true; - } - } else { - $ret = true; - } + public static function getRangeCond( $start, $end = null ) { + if ( $end === null ) { + $end = $start; } - $res->free(); - - return $ret; + # Per T16634, we want to include relevant active rangeblocks; for + # rangeblocks, we want to include larger ranges which enclose the given + # range. We know that all blocks must be smaller than $wgBlockCIDRLimit, + # so we can improve performance by filtering on a LIKE clause + $chunk = self::getIpFragment( $start ); + $dbr = wfGetDB( DB_REPLICA ); + $like = $dbr->buildLike( $chunk, $dbr->anyString() ); + + # Fairly hard to make a malicious SQL statement out of hex characters, + # but stranger things have happened... + $safeStart = $dbr->addQuotes( $start ); + $safeEnd = $dbr->addQuotes( $end ); + + return $dbr->makeList( + [ + "ipb_range_start $like", + "ipb_range_start <= $safeStart", + "ipb_range_end >= $safeEnd", + ], + LIST_AND + ); } /** - * Search the database for any range blocks matching the given address, and - * load the row if one is found. - * - * @param $address String: IP address range - * @param $killExpired Boolean: whether to delete expired rows while loading - * @param $user Integer: if not 0, then sets ipb_anon_only - * @return Boolean + * Get the component of an IP address which is certain to be the same between an IP + * address and a rangeblock containing that IP address. + * @param string $hex Hexadecimal IP representation + * @return string */ - public function loadRange( $address, $killExpired = true, $user = 0 ) { - $iaddr = IP::toHex( $address ); - - if ( $iaddr === false ) { - # Invalid address - return false; - } - - # Only scan ranges which start in this /16, this improves search speed - # Blocks should not cross a /16 boundary. - $range = substr( $iaddr, 0, 4 ); - - $options = array(); - $db = $this->getDBOptions( $options ); - $conds = array( - 'ipb_range_start' . $db->buildLike( $range, $db->anyString() ), - "ipb_range_start <= '$iaddr'", - "ipb_range_end >= '$iaddr'" - ); - - if ( $user ) { - $conds['ipb_anon_only'] = 0; + protected static function getIpFragment( $hex ) { + global $wgBlockCIDRLimit; + if ( substr( $hex, 0, 3 ) == 'v6-' ) { + return 'v6-' . substr( substr( $hex, 3 ), 0, floor( $wgBlockCIDRLimit['IPv6'] / 4 ) ); + } else { + return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) ); } - - $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) ); - $success = $this->loadFromResult( $res, $killExpired ); - - return $success; } /** * Given a database row from the ipblocks table, initialize * member variables - * - * @param $row ResultWrapper: a row from the ipblocks table + * @param stdClass $row A row from the ipblocks table */ - public function initFromRow( $row ) { - $this->mAddress = $row->ipb_address; - $this->mReason = $row->ipb_reason; + protected function initFromRow( $row ) { + $this->setTarget( $row->ipb_address ); + if ( $row->ipb_by ) { // local user + $this->setBlocker( User::newFromId( $row->ipb_by ) ); + } else { // foreign user + $this->setBlocker( $row->ipb_by_text ); + } + $this->mTimestamp = wfTimestamp( TS_MW, $row->ipb_timestamp ); - $this->mUser = $row->ipb_user; - $this->mBy = $row->ipb_by; $this->mAuto = $row->ipb_auto; - $this->mAnonOnly = $row->ipb_anon_only; - $this->mCreateAccount = $row->ipb_create_account; - $this->mEnableAutoblock = $row->ipb_enable_autoblock; - $this->mBlockEmail = $row->ipb_block_email; - $this->mAllowUsertalk = $row->ipb_allow_usertalk; $this->mHideName = $row->ipb_deleted; - $this->mId = $row->ipb_id; - $this->mExpiry = self::decodeExpiry( $row->ipb_expiry ); - - if ( isset( $row->user_name ) ) { - $this->mByName = $row->user_name; - } else { - $this->mByName = $row->ipb_by_text; - } - - $this->mRangeStart = $row->ipb_range_start; - $this->mRangeEnd = $row->ipb_range_end; + $this->mId = (int)$row->ipb_id; + $this->mParentBlockId = $row->ipb_parent_block_id; + + // I wish I didn't have to do this + $db = wfGetDB( DB_REPLICA ); + $this->mExpiry = $db->decodeExpiry( $row->ipb_expiry ); + $this->mReason = CommentStore::newKey( 'ipb_reason' ) + // Legacy because $row probably came from self::selectFields() + ->getCommentLegacy( $db, $row )->text; + + $this->isHardblock( !$row->ipb_anon_only ); + $this->isAutoblocking( $row->ipb_enable_autoblock ); + + $this->prevents( 'createaccount', $row->ipb_create_account ); + $this->prevents( 'sendemail', $row->ipb_block_email ); + $this->prevents( 'editownusertalk', !$row->ipb_allow_usertalk ); } /** - * Once $mAddress has been set, get the range they came from. - * Wrapper for IP::parseRange + * Create a new Block object from a database row + * @param stdClass $row Row from the ipblocks table + * @return Block */ - protected function initialiseRange() { - $this->mRangeStart = ''; - $this->mRangeEnd = ''; - - if ( $this->mUser == 0 ) { - list( $this->mRangeStart, $this->mRangeEnd ) = IP::parseRange( $this->mAddress ); - } + public static function newFromRow( $row ) { + $block = new Block; + $block->initFromRow( $row ); + return $block; } /** * Delete the row from the IP blocks table. * - * @return Boolean + * @throws MWException + * @return bool */ public function delete() { if ( wfReadOnly() ) { return false; } - if ( !$this->mId ) { - throw new MWException( "Block::delete() now requires that the mId member be filled\n" ); + if ( !$this->getId() ) { + throw new MWException( "Block::delete() requires that the mId member be filled\n" ); } $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'ipblocks', array( 'ipb_id' => $this->mId ), __METHOD__ ); + $dbw->delete( 'ipblocks', [ 'ipb_parent_block_id' => $this->getId() ], __METHOD__ ); + $dbw->delete( 'ipblocks', [ 'ipb_id' => $this->getId() ], __METHOD__ ); return $dbw->affectedRows() > 0; } @@ -385,155 +470,227 @@ class Block { * Insert a block into the block table. Will fail if there is a conflicting * block (same name and options) already in the database. * - * @return Boolean: whether or not the insertion was successful. + * @param IDatabase $dbw If you have one available + * @return bool|array False on failure, assoc array on success: + * ('id' => block ID, 'autoIds' => array of autoblock IDs) */ public function insert( $dbw = null ) { + global $wgBlockDisablesLogin; + + if ( $this->getSystemBlockType() !== null ) { + throw new MWException( 'Cannot insert a system block into the database' ); + } + wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" ); - if ( $dbw === null ) + if ( $dbw === null ) { $dbw = wfGetDB( DB_MASTER ); + } - $this->validateBlockParams(); - $this->initialiseRange(); + # Periodic purge via commit hooks + if ( mt_rand( 0, 9 ) == 0 ) { + self::purgeExpired(); + } - # Don't collide with expired blocks - Block::purgeExpired(); + $row = $this->getDatabaseArray( $dbw ); - $ipb_id = $dbw->nextSequenceValue( 'ipblocks_ipb_id_seq' ); - $dbw->insert( - 'ipblocks', - array( - 'ipb_id' => $ipb_id, - 'ipb_address' => $this->mAddress, - 'ipb_user' => $this->mUser, - 'ipb_by' => $this->mBy, - 'ipb_by_text' => $this->mByName, - 'ipb_reason' => $this->mReason, - 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ), - 'ipb_auto' => $this->mAuto, - 'ipb_anon_only' => $this->mAnonOnly, - 'ipb_create_account' => $this->mCreateAccount, - 'ipb_enable_autoblock' => $this->mEnableAutoblock, - 'ipb_expiry' => self::encodeExpiry( $this->mExpiry, $dbw ), - 'ipb_range_start' => $this->mRangeStart, - 'ipb_range_end' => $this->mRangeEnd, - 'ipb_deleted' => intval( $this->mHideName ), // typecast required for SQLite - 'ipb_block_email' => $this->mBlockEmail, - 'ipb_allow_usertalk' => $this->mAllowUsertalk - ), - 'Block::insert', - array( 'IGNORE' ) - ); + $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] ); $affected = $dbw->affectedRows(); + $this->mId = $dbw->insertId(); + + # Don't collide with expired blocks. + # Do this after trying to insert to avoid locking. + if ( !$affected ) { + # T96428: The ipb_address index uses a prefix on a field, so + # use a standard SELECT + DELETE to avoid annoying gap locks. + $ids = $dbw->selectFieldValues( 'ipblocks', + 'ipb_id', + [ + 'ipb_address' => $row['ipb_address'], + 'ipb_user' => $row['ipb_user'], + 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) + ], + __METHOD__ + ); + if ( $ids ) { + $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], __METHOD__ ); + $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] ); + $affected = $dbw->affectedRows(); + $this->mId = $dbw->insertId(); + } + } + + if ( $affected ) { + $auto_ipd_ids = $this->doRetroactiveAutoblock(); + + if ( $wgBlockDisablesLogin && $this->target instanceof User ) { + // Change user login token to force them to be logged out. + $this->target->setToken(); + $this->target->saveSettings(); + } - if ( $affected ) - $this->doRetroactiveAutoblock(); + return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ]; + } - return (bool)$affected; + return false; } /** * Update a block in the DB with new parameters. * The ID field needs to be loaded first. + * + * @return bool|array False on failure, array on success: + * ('id' => block ID, 'autoIds' => array of autoblock IDs) */ public function update() { wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" ); $dbw = wfGetDB( DB_MASTER ); - $this->validateBlockParams(); + $dbw->startAtomic( __METHOD__ ); $dbw->update( 'ipblocks', - array( - 'ipb_user' => $this->mUser, - 'ipb_by' => $this->mBy, - 'ipb_by_text' => $this->mByName, - 'ipb_reason' => $this->mReason, - 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ), - 'ipb_auto' => $this->mAuto, - 'ipb_anon_only' => $this->mAnonOnly, - 'ipb_create_account' => $this->mCreateAccount, - 'ipb_enable_autoblock' => $this->mEnableAutoblock, - 'ipb_expiry' => self::encodeExpiry( $this->mExpiry, $dbw ), - 'ipb_range_start' => $this->mRangeStart, - 'ipb_range_end' => $this->mRangeEnd, - 'ipb_deleted' => $this->mHideName, - 'ipb_block_email' => $this->mBlockEmail, - 'ipb_allow_usertalk' => $this->mAllowUsertalk - ), - array( 'ipb_id' => $this->mId ), - 'Block::update' + $this->getDatabaseArray( $dbw ), + [ 'ipb_id' => $this->getId() ], + __METHOD__ ); - return $dbw->affectedRows(); + $affected = $dbw->affectedRows(); + + if ( $this->isAutoblocking() ) { + // update corresponding autoblock(s) (T50813) + $dbw->update( + 'ipblocks', + $this->getAutoblockUpdateArray( $dbw ), + [ 'ipb_parent_block_id' => $this->getId() ], + __METHOD__ + ); + } else { + // autoblock no longer required, delete corresponding autoblock(s) + $dbw->delete( + 'ipblocks', + [ 'ipb_parent_block_id' => $this->getId() ], + __METHOD__ + ); + } + + $dbw->endAtomic( __METHOD__ ); + + if ( $affected ) { + $auto_ipd_ids = $this->doRetroactiveAutoblock(); + return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ]; + } + + return false; } /** - * Make sure all the proper members are set to sane values - * before adding/updating a block + * Get an array suitable for passing to $dbw->insert() or $dbw->update() + * @param IDatabase $dbw + * @return array */ - protected function validateBlockParams() { - # Unset ipb_anon_only for user blocks, makes no sense - if ( $this->mUser ) { - $this->mAnonOnly = 0; - } + protected function getDatabaseArray( IDatabase $dbw ) { + $expiry = $dbw->encodeExpiry( $this->mExpiry ); - # Unset ipb_enable_autoblock for IP blocks, makes no sense - if ( !$this->mUser ) { - $this->mEnableAutoblock = 0; + if ( $this->forcedTargetID ) { + $uid = $this->forcedTargetID; + } else { + $uid = $this->target instanceof User ? $this->target->getId() : 0; } - # bug 18860: non-anon-only IP blocks should be allowed to block email - if ( !$this->mUser && $this->mAnonOnly ) { - $this->mBlockEmail = 0; - } + $a = [ + 'ipb_address' => (string)$this->target, + 'ipb_user' => $uid, + 'ipb_by' => $this->getBy(), + 'ipb_by_text' => $this->getByName(), + 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ), + 'ipb_auto' => $this->mAuto, + 'ipb_anon_only' => !$this->isHardblock(), + 'ipb_create_account' => $this->prevents( 'createaccount' ), + 'ipb_enable_autoblock' => $this->isAutoblocking(), + 'ipb_expiry' => $expiry, + 'ipb_range_start' => $this->getRangeStart(), + 'ipb_range_end' => $this->getRangeEnd(), + 'ipb_deleted' => intval( $this->mHideName ), // typecast required for SQLite + 'ipb_block_email' => $this->prevents( 'sendemail' ), + 'ipb_allow_usertalk' => !$this->prevents( 'editownusertalk' ), + 'ipb_parent_block_id' => $this->mParentBlockId + ] + CommentStore::newKey( 'ipb_reason' )->insert( $dbw, $this->mReason ); + + return $a; + } - if ( !$this->mByName ) { - if ( $this->mBy ) { - $this->mByName = User::whoIs( $this->mBy ); - } else { - global $wgUser; - $this->mByName = $wgUser->getName(); + /** + * @param IDatabase $dbw + * @return array + */ + protected function getAutoblockUpdateArray( IDatabase $dbw ) { + return [ + 'ipb_by' => $this->getBy(), + 'ipb_by_text' => $this->getByName(), + 'ipb_create_account' => $this->prevents( 'createaccount' ), + 'ipb_deleted' => (int)$this->mHideName, // typecast required for SQLite + 'ipb_allow_usertalk' => !$this->prevents( 'editownusertalk' ), + ] + CommentStore::newKey( 'ipb_reason' )->insert( $dbw, $this->mReason ); + } + + /** + * Retroactively autoblocks the last IP used by the user (if it is a user) + * blocked by this Block. + * + * @return array Block IDs of retroactive autoblocks made + */ + protected function doRetroactiveAutoblock() { + $blockIds = []; + # If autoblock is enabled, autoblock the LAST IP(s) used + if ( $this->isAutoblocking() && $this->getType() == self::TYPE_USER ) { + wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" ); + + $continue = Hooks::run( + 'PerformRetroactiveAutoblock', [ $this, &$blockIds ] ); + + if ( $continue ) { + self::defaultRetroactiveAutoblock( $this, $blockIds ); } } + return $blockIds; } /** * Retroactively autoblocks the last IP used by the user (if it is a user) - * blocked by this Block. + * blocked by this Block. This will use the recentchanges table. * - * @return Boolean: whether or not a retroactive autoblock was made. + * @param Block $block + * @param array &$blockIds */ - public function doRetroactiveAutoblock() { - $dbr = wfGetDB( DB_SLAVE ); - # If autoblock is enabled, autoblock the LAST IP used - # - stolen shamelessly from CheckUser_body.php + protected static function defaultRetroactiveAutoblock( Block $block, array &$blockIds ) { + global $wgPutIPinRC; - if ( $this->mEnableAutoblock && $this->mUser ) { - wfDebug( "Doing retroactive autoblocks for " . $this->mAddress . "\n" ); + // No IPs are in recentchanges table, so nothing to select + if ( !$wgPutIPinRC ) { + return; + } - $options = array( 'ORDER BY' => 'rc_timestamp DESC' ); - $conds = array( 'rc_user_text' => $this->mAddress ); + $dbr = wfGetDB( DB_REPLICA ); - if ( $this->mAngryAutoblock ) { - // Block any IP used in the last 7 days. Up to five IPs. - $conds[] = 'rc_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( time() - ( 7 * 86400 ) ) ); - $options['LIMIT'] = 5; - } else { - // Just the last IP used. - $options['LIMIT'] = 1; - } + $options = [ 'ORDER BY' => 'rc_timestamp DESC' ]; + $conds = [ 'rc_user_text' => (string)$block->getTarget() ]; - $res = $dbr->select( 'recentchanges', array( 'rc_ip' ), $conds, - __METHOD__ , $options ); + // Just the last IP used. + $options['LIMIT'] = 1; - if ( !$dbr->numRows( $res ) ) { - # No results, don't autoblock anything - wfDebug( "No IP found to retroactively autoblock\n" ); - } else { - foreach ( $res as $row ) { - if ( $row->rc_ip ) { - $this->doAutoblock( $row->rc_ip ); + $res = $dbr->select( 'recentchanges', [ 'rc_ip' ], $conds, + __METHOD__, $options ); + + if ( !$res->numRows() ) { + # No results, don't autoblock anything + wfDebug( "No IP found to retroactively autoblock\n" ); + } else { + foreach ( $res as $row ) { + if ( $row->rc_ip ) { + $id = $block->doAutoblock( $row->rc_ip ); + if ( $id ) { + $blockIds[] = $id; } } } @@ -542,21 +699,25 @@ class Block { /** * Checks whether a given IP is on the autoblock whitelist. + * TODO: this probably belongs somewhere else, but not sure where... * - * @param $ip String: The IP to check - * @return Boolean + * @param string $ip The IP to check + * @return bool */ public static function isWhitelistedFromAutoblocks( $ip ) { - global $wgMemc; - // Try to get the autoblock_whitelist from the cache, as it's faster // than getting the msg raw and explode()'ing it. - $key = wfMemcKey( 'ipb', 'autoblock', 'whitelist' ); - $lines = $wgMemc->get( $key ); - if ( !$lines ) { - $lines = explode( "\n", wfMsgForContentNoTrans( 'autoblock_whitelist' ) ); - $wgMemc->set( $key, $lines, 3600 * 24 ); - } + $cache = MediaWikiServices::getInstance()->getMainWANObjectCache(); + $lines = $cache->getWithSetCallback( + $cache->makeKey( 'ipb', 'autoblock', 'whitelist' ), + $cache::TTL_DAY, + function ( $curValue, &$ttl, array &$setOpts ) { + $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) ); + + return explode( "\n", + wfMessage( 'autoblock_whitelist' )->inContentLanguage()->plain() ); + } + ); wfDebug( "Checking the autoblock whitelist..\n" ); @@ -586,83 +747,87 @@ class Block { /** * Autoblocks the given IP, referring to this Block. * - * @param $autoblockIP String: the IP to autoblock. - * @param $justInserted Boolean: the main block was just inserted - * @return Boolean: whether or not an autoblock was inserted. + * @param string $autoblockIP The IP to autoblock. + * @return int|bool Block ID if an autoblock was inserted, false if not. */ - public function doAutoblock( $autoblockIP, $justInserted = false ) { + public function doAutoblock( $autoblockIP ) { # If autoblocks are disabled, go away. - if ( !$this->mEnableAutoblock ) { - return; + if ( !$this->isAutoblocking() ) { + return false; } - # Check for presence on the autoblock whitelist - if ( Block::isWhitelistedFromAutoblocks( $autoblockIP ) ) { - return; + # Don't autoblock for system blocks + if ( $this->getSystemBlockType() !== null ) { + throw new MWException( 'Cannot autoblock from a system block' ); } - # # Allow hooks to cancel the autoblock. - if ( !wfRunHooks( 'AbortAutoblock', array( $autoblockIP, &$this ) ) ) { + # Check for presence on the autoblock whitelist. + if ( self::isWhitelistedFromAutoblocks( $autoblockIP ) ) { + return false; + } + + // Avoid PHP 7.1 warning of passing $this by reference + $block = $this; + # Allow hooks to cancel the autoblock. + if ( !Hooks::run( 'AbortAutoblock', [ $autoblockIP, &$block ] ) ) { wfDebug( "Autoblock aborted by hook.\n" ); return false; } - # It's okay to autoblock. Go ahead and create/insert the block. + # It's okay to autoblock. Go ahead and insert/update the block... - $ipblock = Block::newFromDB( $autoblockIP ); + # Do not add a *new* block if the IP is already blocked. + $ipblock = self::newFromTarget( $autoblockIP ); if ( $ipblock ) { - # If the user is already blocked. Then check if the autoblock would - # exceed the user block. If it would exceed, then do nothing, else - # prolong block time - if ( $this->mExpiry && - ( $this->mExpiry < Block::getAutoblockExpiry( $ipblock->mTimestamp ) ) + # Check if the block is an autoblock and would exceed the user block + # if renewed. If so, do nothing, otherwise prolong the block time... + if ( $ipblock->mAuto && // @todo Why not compare $ipblock->mExpiry? + $this->mExpiry > self::getAutoblockExpiry( $ipblock->mTimestamp ) ) { - return; - } - - # Just update the timestamp - if ( !$justInserted ) { + # Reset block timestamp to now and its expiry to + # $wgAutoblockExpiry in the future $ipblock->updateTimestamp(); } + return false; + } - return; - } else { - $ipblock = new Block; - } - - # Make a new block object with the desired properties - wfDebug( "Autoblocking {$this->mAddress}@" . $autoblockIP . "\n" ); - $ipblock->mAddress = $autoblockIP; - $ipblock->mUser = 0; - $ipblock->mBy = $this->mBy; - $ipblock->mByName = $this->mByName; - $ipblock->mReason = wfMsgForContent( 'autoblocker', $this->mAddress, $this->mReason ); - $ipblock->mTimestamp = wfTimestampNow(); - $ipblock->mAuto = 1; - $ipblock->mCreateAccount = $this->mCreateAccount; + # Make a new block object with the desired properties. + $autoblock = new Block; + wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" ); + $autoblock->setTarget( $autoblockIP ); + $autoblock->setBlocker( $this->getBlocker() ); + $autoblock->mReason = wfMessage( 'autoblocker', $this->getTarget(), $this->mReason ) + ->inContentLanguage()->plain(); + $timestamp = wfTimestampNow(); + $autoblock->mTimestamp = $timestamp; + $autoblock->mAuto = 1; + $autoblock->prevents( 'createaccount', $this->prevents( 'createaccount' ) ); # Continue suppressing the name if needed - $ipblock->mHideName = $this->mHideName; - $ipblock->mAllowUsertalk = $this->mAllowUsertalk; + $autoblock->mHideName = $this->mHideName; + $autoblock->prevents( 'editownusertalk', $this->prevents( 'editownusertalk' ) ); + $autoblock->mParentBlockId = $this->mId; - # If the user is already blocked with an expiry date, we don't - # want to pile on top of that! - if ( $this->mExpiry ) { - $ipblock->mExpiry = min( $this->mExpiry, Block::getAutoblockExpiry( $this->mTimestamp ) ); + if ( $this->mExpiry == 'infinity' ) { + # Original block was indefinite, start an autoblock now + $autoblock->mExpiry = self::getAutoblockExpiry( $timestamp ); } else { - $ipblock->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp ); + # If the user is already blocked with an expiry date, we don't + # want to pile on top of that. + $autoblock->mExpiry = min( $this->mExpiry, self::getAutoblockExpiry( $timestamp ) ); } - # Insert it - return $ipblock->insert(); + # Insert the block... + $status = $autoblock->insert(); + return $status + ? $status['id'] + : false; } /** * Check if a block has expired. Delete it if it is. - * @return Boolean + * @return bool */ public function deleteIfExpired() { - wfProfileIn( __METHOD__ ); - if ( $this->isExpired() ) { wfDebug( "Block::deleteIfExpired() -- deleting\n" ); $this->delete(); @@ -672,30 +837,30 @@ class Block { $retVal = false; } - wfProfileOut( __METHOD__ ); return $retVal; } /** * Has the block expired? - * @return Boolean + * @return bool */ public function isExpired() { - wfDebug( "Block::isExpired() checking current " . wfTimestampNow() . " vs $this->mExpiry\n" ); + $timestamp = wfTimestampNow(); + wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" ); if ( !$this->mExpiry ) { return false; } else { - return wfTimestampNow() > $this->mExpiry; + return $timestamp > $this->mExpiry; } } /** * Is the block address valid (i.e. not a null string?) - * @return Boolean + * @return bool */ public function isValid() { - return $this->mAddress != ''; + return $this->getTarget() != null; } /** @@ -704,98 +869,198 @@ class Block { public function updateTimestamp() { if ( $this->mAuto ) { $this->mTimestamp = wfTimestamp(); - $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp ); + $this->mExpiry = self::getAutoblockExpiry( $this->mTimestamp ); $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'ipblocks', - array( /* SET */ + [ /* SET */ 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ), 'ipb_expiry' => $dbw->timestamp( $this->mExpiry ), - ), array( /* WHERE */ - 'ipb_address' => $this->mAddress - ), 'Block::updateTimestamp' + ], + [ /* WHERE */ + 'ipb_id' => $this->getId(), + ], + __METHOD__ ); } } + /** + * Get the IP address at the start of the range in Hex form + * @throws MWException + * @return string IP in Hex form + */ + public function getRangeStart() { + switch ( $this->type ) { + case self::TYPE_USER: + return ''; + case self::TYPE_IP: + return IP::toHex( $this->target ); + case self::TYPE_RANGE: + list( $start, /*...*/ ) = IP::parseRange( $this->target ); + return $start; + default: + throw new MWException( "Block with invalid type" ); + } + } + + /** + * Get the IP address at the end of the range in Hex form + * @throws MWException + * @return string IP in Hex form + */ + public function getRangeEnd() { + switch ( $this->type ) { + case self::TYPE_USER: + return ''; + case self::TYPE_IP: + return IP::toHex( $this->target ); + case self::TYPE_RANGE: + list( /*...*/, $end ) = IP::parseRange( $this->target ); + return $end; + default: + throw new MWException( "Block with invalid type" ); + } + } + /** * Get the user id of the blocking sysop * - * @return Integer + * @return int (0 for foreign users) */ public function getBy() { - return $this->mBy; + $blocker = $this->getBlocker(); + return ( $blocker instanceof User ) + ? $blocker->getId() + : 0; } /** * Get the username of the blocking sysop * - * @return String + * @return string */ public function getByName() { - return $this->mByName; + $blocker = $this->getBlocker(); + return ( $blocker instanceof User ) + ? $blocker->getName() + : (string)$blocker; // username } /** - * Get/set the SELECT ... FOR UPDATE flag + * Get the block ID + * @return int */ - public function forUpdate( $x = null ) { - return wfSetVar( $this->mForUpdate, $x ); + public function getId() { + return $this->mId; + } + + /** + * Get the system block type, if any + * @since 1.29 + * @return string|null + */ + public function getSystemBlockType() { + return $this->systemBlockType; } /** * Get/set a flag determining whether the master is used for reads + * + * @param bool|null $x + * @return bool */ public function fromMaster( $x = null ) { return wfSetVar( $this->mFromMaster, $x ); } /** - * Get the block name, but with autoblocked IPs hidden as per standard privacy policy - * @return String + * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range) + * @param bool|null $x + * @return bool */ - public function getRedactedName() { - if ( $this->mAuto ) { - return '#' . $this->mId; - } else { - return $this->mAddress; - } + public function isHardblock( $x = null ) { + wfSetVar( $this->isHardblock, $x ); + + # You can't *not* hardblock a user + return $this->getType() == self::TYPE_USER + ? true + : $this->isHardblock; } /** - * Encode expiry for DB + * @param null|bool $x + * @return bool + */ + public function isAutoblocking( $x = null ) { + wfSetVar( $this->isAutoblocking, $x ); + + # You can't put an autoblock on an IP or range as we don't have any history to + # look over to get more IPs from + return $this->getType() == self::TYPE_USER + ? $this->isAutoblocking + : false; + } + + /** + * Get/set whether the Block prevents a given action * - * @param $expiry String: timestamp for expiry, or - * @param $db Database object - * @return String + * @param string $action Action to check + * @param bool|null $x Value for set, or null to just get value + * @return bool|null Null for unrecognized rights. */ - public static function encodeExpiry( $expiry, $db ) { - if ( $expiry == '' || $expiry == Block::infinity() ) { - return Block::infinity(); - } else { - return $db->timestamp( $expiry ); + public function prevents( $action, $x = null ) { + global $wgBlockDisablesLogin; + $res = null; + switch ( $action ) { + case 'edit': + # For now... + $res = true; + break; + case 'createaccount': + $res = wfSetVar( $this->mCreateAccount, $x ); + break; + case 'sendemail': + $res = wfSetVar( $this->mBlockEmail, $x ); + break; + case 'editownusertalk': + $res = wfSetVar( $this->mDisableUsertalk, $x ); + break; + case 'read': + $res = false; + break; } + if ( !$res && $wgBlockDisablesLogin ) { + // If a block would disable login, then it should + // prevent any action that all users cannot do + $anon = new User; + $res = $anon->isAllowed( $action ) ? $res : true; + } + + return $res; } /** - * Decode expiry which has come from the DB - * - * @param $expiry String: Database expiry format - * @param $timestampType Requested timestamp format - * @return String + * Get the block name, but with autoblocked IPs hidden as per standard privacy policy + * @return string Text is escaped */ - public static function decodeExpiry( $expiry, $timestampType = TS_MW ) { - if ( $expiry == '' || $expiry == Block::infinity() ) { - return Block::infinity(); + public function getRedactedName() { + if ( $this->mAuto ) { + return Html::rawElement( + 'span', + [ 'class' => 'mw-autoblockid' ], + wfMessage( 'autoblockid', $this->mId ) + ); } else { - return wfTimestamp( $timestampType, $expiry ); + return htmlspecialchars( $this->getTarget() ); } } /** * Get a timestamp of the expiry for autoblocks * - * @return String + * @param string|int $timestamp + * @return string */ public static function getAutoblockExpiry( $timestamp ) { global $wgAutoblockExpiry; @@ -804,119 +1069,511 @@ class Block { } /** - * Gets rid of uneeded numbers in quad-dotted/octet IP strings - * For example, 127.111.113.151/24 -> 127.111.113.0/24 - * @param $range String: IP address to normalize - * @return string + * Purge expired blocks from the ipblocks table */ - public static function normaliseRange( $range ) { - $parts = explode( '/', $range ); - if ( count( $parts ) == 2 ) { - // IPv6 - if ( IP::isIPv6( $range ) && $parts[1] >= 64 && $parts[1] <= 128 ) { - $bits = $parts[1]; - $ipint = IP::toUnsigned( $parts[0] ); - # Native 32 bit functions WON'T work here!!! - # Convert to a padded binary number - $network = wfBaseConvert( $ipint, 10, 2, 128 ); - # Truncate the last (128-$bits) bits and replace them with zeros - $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT ); - # Convert back to an integer - $network = wfBaseConvert( $network, 2, 10 ); - # Reform octet address - $newip = IP::toOctet( $network ); - $range = "$newip/{$parts[1]}"; - } // IPv4 - elseif ( IP::isIPv4( $range ) && $parts[1] >= 16 && $parts[1] <= 32 ) { - $shift = 32 - $parts[1]; - $ipint = IP::toUnsigned( $parts[0] ); - $ipint = $ipint >> $shift << $shift; - $newip = long2ip( $ipint ); - $range = "$newip/{$parts[1]}"; - } + public static function purgeExpired() { + if ( wfReadOnly() ) { + return; } - return $range; + DeferredUpdates::addUpdate( new AtomicSectionUpdate( + wfGetDB( DB_MASTER ), + __METHOD__, + function ( IDatabase $dbw, $fname ) { + $dbw->delete( + 'ipblocks', + [ 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ], + $fname + ); + } + ) ); } /** - * Purge expired blocks from the ipblocks table + * Given a target and the target's type, get an existing Block object if possible. + * @param string|User|int $specificTarget A block target, which may be one of several types: + * * A user to block, in which case $target will be a User + * * An IP to block, in which case $target will be a User generated by using + * User::newFromName( $ip, false ) to turn off name validation + * * An IP range, in which case $target will be a String "123.123.123.123/18" etc + * * The ID of an existing block, in the format "#12345" (since pure numbers are valid + * usernames + * Calling this with a user, IP address or range will not select autoblocks, and will + * only select a block where the targets match exactly (so looking for blocks on + * 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32) + * @param string|User|int $vagueTarget As above, but we will search for *any* block which + * affects that target (so for an IP address, get ranges containing that IP; and also + * get any relevant autoblocks). Leave empty or blank to skip IP-based lookups. + * @param bool $fromMaster Whether to use the DB_MASTER database + * @return Block|null (null if no relevant block could be found). The target and type + * of the returned Block will refer to the actual block which was found, which might + * not be the same as the target you gave if you used $vagueTarget! */ - public static function purgeExpired() { - $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'ipblocks', array( 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), __METHOD__ ); + public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) { + list( $target, $type ) = self::parseTarget( $specificTarget ); + if ( $type == self::TYPE_ID || $type == self::TYPE_AUTO ) { + return self::newFromID( $target ); + + } elseif ( $target === null && $vagueTarget == '' ) { + # We're not going to find anything useful here + # Be aware that the == '' check is explicit, since empty values will be + # passed by some callers (T31116) + return null; + + } elseif ( in_array( + $type, + [ self::TYPE_USER, self::TYPE_IP, self::TYPE_RANGE, null ] ) + ) { + $block = new Block(); + $block->fromMaster( $fromMaster ); + + if ( $type !== null ) { + $block->setTarget( $target ); + } + + if ( $block->newLoad( $vagueTarget ) ) { + return $block; + } + } + return null; } /** - * Get a value to insert into expiry field of the database when infinite expiry - * is desired. In principle this could be DBMS-dependant, but currently all - * supported DBMS's support the string "infinity", so we just use that. + * Get all blocks that match any IP from an array of IP addresses * - * @return String + * @param array $ipChain List of IPs (strings), usually retrieved from the + * X-Forwarded-For header of the request + * @param bool $isAnon Exclude anonymous-only blocks if false + * @param bool $fromMaster Whether to query the master or replica DB + * @return array Array of Blocks + * @since 1.22 */ - public static function infinity() { - # This is a special keyword for timestamps in PostgreSQL, and - # works with CHAR(14) as well because "i" sorts after all numbers. + public static function getBlocksForIPList( array $ipChain, $isAnon, $fromMaster = false ) { + if ( !count( $ipChain ) ) { + return []; + } + + $conds = []; + $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup(); + foreach ( array_unique( $ipChain ) as $ipaddr ) { + # Discard invalid IP addresses. Since XFF can be spoofed and we do not + # necessarily trust the header given to us, make sure that we are only + # checking for blocks on well-formatted IP addresses (IPv4 and IPv6). + # Do not treat private IP spaces as special as it may be desirable for wikis + # to block those IP ranges in order to stop misbehaving proxies that spoof XFF. + if ( !IP::isValid( $ipaddr ) ) { + continue; + } + # Don't check trusted IPs (includes local squids which will be in every request) + if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) { + continue; + } + # Check both the original IP (to check against single blocks), as well as build + # the clause to check for rangeblocks for the given IP. + $conds['ipb_address'][] = $ipaddr; + $conds[] = self::getRangeCond( IP::toHex( $ipaddr ) ); + } + + if ( !count( $conds ) ) { + return []; + } + + if ( $fromMaster ) { + $db = wfGetDB( DB_MASTER ); + } else { + $db = wfGetDB( DB_REPLICA ); + } + $conds = $db->makeList( $conds, LIST_OR ); + if ( !$isAnon ) { + $conds = [ $conds, 'ipb_anon_only' => 0 ]; + } + $selectFields = array_merge( + [ 'ipb_range_start', 'ipb_range_end' ], + self::selectFields() + ); + $rows = $db->select( 'ipblocks', + $selectFields, + $conds, + __METHOD__ + ); - # BEGIN DatabaseMssql hack - # Since MSSQL doesn't recognize the infinity keyword, set date manually. - # TO-DO: Refactor for better DB portability and remove magic date - $dbr = wfGetDB( DB_SLAVE ); - if ( $dbr->getType() == 'mssql' ) { - return '3000-01-31 00:00:00.000'; + $blocks = []; + foreach ( $rows as $row ) { + $block = self::newFromRow( $row ); + if ( !$block->isExpired() ) { + $blocks[] = $block; + } } - # End DatabaseMssql hack - return 'infinity'; + return $blocks; } /** - * Convert a DB-encoded expiry into a real string that humans can read. + * From a list of multiple blocks, find the most exact and strongest Block. + * + * The logic for finding the "best" block is: + * - Blocks that match the block's target IP are preferred over ones in a range + * - Hardblocks are chosen over softblocks that prevent account creation + * - Softblocks that prevent account creation are chosen over other softblocks + * - Other softblocks are chosen over autoblocks + * - If there are multiple exact or range blocks at the same level, the one chosen + * is random + * This should be used when $blocks where retrieved from the user's IP address + * and $ipChain is populated from the same IP address information. * - * @param $encoded_expiry String: Database encoded expiry time - * @return Html-escaped String + * @param array $blocks Array of Block objects + * @param array $ipChain List of IPs (strings). This is used to determine how "close" + * a block is to the server, and if a block matches exactly, or is in a range. + * The order is furthest from the server to nearest e.g., (Browser, proxy1, proxy2, + * local-squid, ...) + * @throws MWException + * @return Block|null The "best" block from the list */ - public static function formatExpiry( $encoded_expiry ) { - static $msg = null; + public static function chooseBlock( array $blocks, array $ipChain ) { + if ( !count( $blocks ) ) { + return null; + } elseif ( count( $blocks ) == 1 ) { + return $blocks[0]; + } + + // Sort hard blocks before soft ones and secondarily sort blocks + // that disable account creation before those that don't. + usort( $blocks, function ( Block $a, Block $b ) { + $aWeight = (int)$a->isHardblock() . (int)$a->prevents( 'createaccount' ); + $bWeight = (int)$b->isHardblock() . (int)$b->prevents( 'createaccount' ); + return strcmp( $bWeight, $aWeight ); // highest weight first + } ); + + $blocksListExact = [ + 'hard' => false, + 'disable_create' => false, + 'other' => false, + 'auto' => false + ]; + $blocksListRange = [ + 'hard' => false, + 'disable_create' => false, + 'other' => false, + 'auto' => false + ]; + $ipChain = array_reverse( $ipChain ); + + /** @var Block $block */ + foreach ( $blocks as $block ) { + // Stop searching if we have already have a "better" block. This + // is why the order of the blocks matters + if ( !$block->isHardblock() && $blocksListExact['hard'] ) { + break; + } elseif ( !$block->prevents( 'createaccount' ) && $blocksListExact['disable_create'] ) { + break; + } + + foreach ( $ipChain as $checkip ) { + $checkipHex = IP::toHex( $checkip ); + if ( (string)$block->getTarget() === $checkip ) { + if ( $block->isHardblock() ) { + $blocksListExact['hard'] = $blocksListExact['hard'] ?: $block; + } elseif ( $block->prevents( 'createaccount' ) ) { + $blocksListExact['disable_create'] = $blocksListExact['disable_create'] ?: $block; + } elseif ( $block->mAuto ) { + $blocksListExact['auto'] = $blocksListExact['auto'] ?: $block; + } else { + $blocksListExact['other'] = $blocksListExact['other'] ?: $block; + } + // We found closest exact match in the ip list, so go to the next Block + break; + } elseif ( array_filter( $blocksListExact ) == [] + && $block->getRangeStart() <= $checkipHex + && $block->getRangeEnd() >= $checkipHex + ) { + if ( $block->isHardblock() ) { + $blocksListRange['hard'] = $blocksListRange['hard'] ?: $block; + } elseif ( $block->prevents( 'createaccount' ) ) { + $blocksListRange['disable_create'] = $blocksListRange['disable_create'] ?: $block; + } elseif ( $block->mAuto ) { + $blocksListRange['auto'] = $blocksListRange['auto'] ?: $block; + } else { + $blocksListRange['other'] = $blocksListRange['other'] ?: $block; + } + break; + } + } + } + + if ( array_filter( $blocksListExact ) == [] ) { + $blocksList = &$blocksListRange; + } else { + $blocksList = &$blocksListExact; + } + + $chosenBlock = null; + if ( $blocksList['hard'] ) { + $chosenBlock = $blocksList['hard']; + } elseif ( $blocksList['disable_create'] ) { + $chosenBlock = $blocksList['disable_create']; + } elseif ( $blocksList['other'] ) { + $chosenBlock = $blocksList['other']; + } elseif ( $blocksList['auto'] ) { + $chosenBlock = $blocksList['auto']; + } else { + throw new MWException( "Proxy block found, but couldn't be classified." ); + } - if ( is_null( $msg ) ) { - $msg = array(); - $keys = array( 'infiniteblock', 'expiringblock' ); + return $chosenBlock; + } - foreach ( $keys as $key ) { - $msg[$key] = wfMsgHtml( $key ); + /** + * From an existing Block, get the target and the type of target. + * Note that, except for null, it is always safe to treat the target + * as a string; for User objects this will return User::__toString() + * which in turn gives User::getName(). + * + * @param string|int|User|null $target + * @return array [ User|String|null, Block::TYPE_ constant|null ] + */ + public static function parseTarget( $target ) { + # We may have been through this before + if ( $target instanceof User ) { + if ( IP::isValid( $target->getName() ) ) { + return [ $target, self::TYPE_IP ]; + } else { + return [ $target, self::TYPE_USER ]; } + } elseif ( $target === null ) { + return [ null, null ]; + } + + $target = trim( $target ); + + if ( IP::isValid( $target ) ) { + # We can still create a User if it's an IP address, but we need to turn + # off validation checking (which would exclude IP addresses) + return [ + User::newFromName( IP::sanitizeIP( $target ), false ), + self::TYPE_IP + ]; + + } elseif ( IP::isValidRange( $target ) ) { + # Can't create a User from an IP range + return [ IP::sanitizeRange( $target ), self::TYPE_RANGE ]; } - $expiry = Block::decodeExpiry( $encoded_expiry ); - if ( $expiry == 'infinity' ) { - $expirystr = $msg['infiniteblock']; + # Consider the possibility that this is not a username at all + # but actually an old subpage (bug #29797) + if ( strpos( $target, '/' ) !== false ) { + # An old subpage, drill down to the user behind it + $target = explode( '/', $target )[0]; + } + + $userObj = User::newFromName( $target ); + if ( $userObj instanceof User ) { + # Note that since numbers are valid usernames, a $target of "12345" will be + # considered a User. If you want to pass a block ID, prepend a hash "#12345", + # since hash characters are not valid in usernames or titles generally. + return [ $userObj, self::TYPE_USER ]; + + } elseif ( preg_match( '/^#\d+$/', $target ) ) { + # Autoblock reference in the form "#12345" + return [ substr( $target, 1 ), self::TYPE_AUTO ]; + } else { - global $wgLang; - $expiredatestr = htmlspecialchars( $wgLang->date( $expiry, true ) ); - $expiretimestr = htmlspecialchars( $wgLang->time( $expiry, true ) ); - $expirystr = wfMsgReplaceArgs( $msg['expiringblock'], array( $expiredatestr, $expiretimestr ) ); + # WTF? + return [ null, null ]; + } + } + + /** + * Get the type of target for this particular block + * @return int Block::TYPE_ constant, will never be TYPE_ID + */ + public function getType() { + return $this->mAuto + ? self::TYPE_AUTO + : $this->type; + } + + /** + * Get the target and target type for this particular Block. Note that for autoblocks, + * this returns the unredacted name; frontend functions need to call $block->getRedactedName() + * in this situation. + * @return array [ User|String, Block::TYPE_ constant ] + * @todo FIXME: This should be an integral part of the Block member variables + */ + public function getTargetAndType() { + return [ $this->getTarget(), $this->getType() ]; + } + + /** + * Get the target for this particular Block. Note that for autoblocks, + * this returns the unredacted name; frontend functions need to call $block->getRedactedName() + * in this situation. + * @return User|string + */ + public function getTarget() { + return $this->target; + } + + /** + * @since 1.19 + * + * @return mixed|string + */ + public function getExpiry() { + return $this->mExpiry; + } + + /** + * Set the target for this block, and update $this->type accordingly + * @param mixed $target + */ + public function setTarget( $target ) { + list( $this->target, $this->type ) = self::parseTarget( $target ); + } + + /** + * Get the user who implemented this block + * @return User|string Local User object or string for a foreign user + */ + public function getBlocker() { + return $this->blocker; + } + + /** + * Set the user who implemented (or will implement) this block + * @param User|string $user Local User object or username string for foreign users + */ + public function setBlocker( $user ) { + $this->blocker = $user; + } + + /** + * Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be + * the same as the block's, to a maximum of 24 hours. + * + * @since 1.29 + * + * @param WebResponse $response The response on which to set the cookie. + */ + public function setCookie( WebResponse $response ) { + // Calculate the default expiry time. + $maxExpiryTime = wfTimestamp( TS_MW, wfTimestamp() + ( 24 * 60 * 60 ) ); + + // Use the Block's expiry time only if it's less than the default. + $expiryTime = $this->getExpiry(); + if ( $expiryTime === 'infinity' || $expiryTime > $maxExpiryTime ) { + $expiryTime = $maxExpiryTime; } - return $expirystr; + // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie. + $expiryValue = DateTime::createFromFormat( 'YmdHis', $expiryTime )->format( 'U' ); + $cookieOptions = [ 'httpOnly' => false ]; + $cookieValue = $this->getCookieValue(); + $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions ); + } + + /** + * Unset the 'BlockID' cookie. + * + * @since 1.29 + * + * @param WebResponse $response The response on which to unset the cookie. + */ + public static function clearCookie( WebResponse $response ) { + $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] ); + } + + /** + * Get the BlockID cookie's value for this block. This is usually the block ID concatenated + * with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just + * be the block ID. + * + * @since 1.29 + * + * @return string The block ID, probably concatenated with "!" and the HMAC. + */ + public function getCookieValue() { + $config = RequestContext::getMain()->getConfig(); + $id = $this->getId(); + $secretKey = $config->get( 'SecretKey' ); + if ( !$secretKey ) { + // If there's no secret key, don't append a HMAC. + return $id; + } + $hmac = MWCryptHash::hmac( $id, $secretKey, false ); + $cookieValue = $id . '!' . $hmac; + return $cookieValue; } /** - * Convert a typed-in expiry time into something we can put into the database. - * @param $expiry_input String: whatever was typed into the form - * @return String: more database friendly + * Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of + * the ID and a HMAC (see Block::setCookie), but will sometimes only be the ID. + * + * @since 1.29 + * + * @param string $cookieValue The string in which to find the ID. + * + * @return int|null The block ID, or null if the HMAC is present and invalid. */ - public static function parseExpiryInput( $expiry_input ) { - if ( $expiry_input == 'infinite' || $expiry_input == 'indefinite' ) { - $expiry = 'infinity'; + public static function getIdFromCookieValue( $cookieValue ) { + // Extract the ID prefix from the cookie value (may be the whole value, if no bang found). + $bangPos = strpos( $cookieValue, '!' ); + $id = ( $bangPos === false ) ? $cookieValue : substr( $cookieValue, 0, $bangPos ); + // Get the site-wide secret key. + $config = RequestContext::getMain()->getConfig(); + $secretKey = $config->get( 'SecretKey' ); + if ( !$secretKey ) { + // If there's no secret key, just use the ID as given. + return $id; + } + $storedHmac = substr( $cookieValue, $bangPos + 1 ); + $calculatedHmac = MWCryptHash::hmac( $id, $secretKey, false ); + if ( $calculatedHmac === $storedHmac ) { + return $id; } else { - $expiry = strtotime( $expiry_input ); + return null; + } + } - if ( $expiry < 0 || $expiry === false ) { - return false; - } + /** + * Get the key and parameters for the corresponding error message. + * + * @since 1.22 + * @param IContextSource $context + * @return array + */ + public function getPermissionsError( IContextSource $context ) { + $blocker = $this->getBlocker(); + if ( $blocker instanceof User ) { // local user + $blockerUserpage = $blocker->getUserPage(); + $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]"; + } else { // foreign user + $link = $blocker; + } + + $reason = $this->mReason; + if ( $reason == '' ) { + $reason = $context->msg( 'blockednoreason' )->text(); } - return $expiry; + /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked. + * This could be a username, an IP range, or a single IP. */ + $intended = $this->getTarget(); + + $systemBlockType = $this->getSystemBlockType(); + + $lang = $context->getLanguage(); + return [ + $systemBlockType !== null + ? 'systemblockedtext' + : ( $this->mAuto ? 'autoblockedtext' : 'blockedtext' ), + $link, + $reason, + $context->getRequest()->getIP(), + $this->getByName(), + $systemBlockType !== null ? $systemBlockType : $this->getId(), + $lang->formatExpiry( $this->mExpiry ), + (string)$intended, + $lang->userTimeAndDate( $this->mTimestamp, $context->getUser() ), + ]; } }