3 * Class for blocks stored in the database.
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.
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.
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
23 namespace MediaWiki\Block
;
27 use BadMethodCallException
;
35 use MediaWiki\Block\Restriction\NamespaceRestriction
;
36 use MediaWiki\Block\Restriction\PageRestriction
;
37 use MediaWiki\Block\Restriction\Restriction
;
38 use MediaWiki\MediaWikiServices
;
46 use Wikimedia\Rdbms\Database
;
47 use Wikimedia\Rdbms\IDatabase
;
50 * A DatabaseBlock (unlike a SystemBlock) is stored in the database, may
51 * give rise to autoblocks and may be tracked with cookies. Such blocks
52 * are more customizable than system blocks: they may be hardblocks, and
53 * they may be sitewide or partial.
55 * @since 1.34 Renamed from Block.
57 class DatabaseBlock
extends AbstractBlock
{
62 public $mParentBlockId;
70 /** @var int Hack for foreign blocking (CentralAuth) */
71 private $forcedTargetID;
77 private $isAutoblocking;
79 /** @var Restriction[] */
80 private $restrictions;
83 * Create a new block with specified option parameters on a user, IP or IP range.
85 * @param array $options Parameters of the block:
86 * user int Override target user ID (for foreign users)
87 * auto bool Is this an automatic block?
88 * expiry string Timestamp of expiration of the block or 'infinity'
89 * anonOnly bool Only disallow anonymous actions
90 * createAccount bool Disallow creation of new accounts
91 * enableAutoblock bool Enable automatic blocking
92 * hideName bool Hide the target user name
93 * blockEmail bool Disallow sending emails
94 * allowUsertalk bool Allow the target to edit its own talk page
95 * sitewide bool Disallow editing all pages and all contribution
96 * actions, except those specifically allowed by
99 * @since 1.26 $options array
101 public function __construct( array $options = [] ) {
102 parent
::__construct( $options );
109 'createAccount' => false,
110 'enableAutoblock' => false,
112 'blockEmail' => false,
113 'allowUsertalk' => false,
117 $options +
= $defaults;
119 if ( $this->target
instanceof User
&& $options['user'] ) {
120 # Needed for foreign users
121 $this->forcedTargetID
= $options['user'];
124 $this->setExpiry( wfGetDB( DB_REPLICA
)->decodeExpiry( $options['expiry'] ) );
127 $this->mAuto
= (bool)$options['auto'];
128 $this->setHideName( (bool)$options['hideName'] );
129 $this->isHardblock( !$options['anonOnly'] );
130 $this->isAutoblocking( (bool)$options['enableAutoblock'] );
131 $this->isSitewide( (bool)$options['sitewide'] );
132 $this->isEmailBlocked( (bool)$options['blockEmail'] );
133 $this->isCreateAccountBlocked( (bool)$options['createAccount'] );
134 $this->isUsertalkEditAllowed( (bool)$options['allowUsertalk'] );
136 $this->mFromMaster
= false;
140 * Load a block from the block id.
142 * @param int $id id to search for
143 * @return DatabaseBlock|null
145 public static function newFromID( $id ) {
146 $dbr = wfGetDB( DB_REPLICA
);
147 $blockQuery = self
::getQueryInfo();
148 $res = $dbr->selectRow(
149 $blockQuery['tables'],
150 $blockQuery['fields'],
157 return self
::newFromRow( $res );
164 * Return the list of ipblocks fields that should be selected to create
166 * @deprecated since 1.31, use self::getQueryInfo() instead.
169 public static function selectFields() {
170 global $wgActorTableSchemaMigrationStage;
172 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
173 // If code is using this instead of self::getQueryInfo(), there's a
174 // decent chance it's going to try to directly access
175 // $row->ipb_by or $row->ipb_by_text and we can't give it
176 // useful values here once those aren't being used anymore.
177 throw new BadMethodCallException(
178 'Cannot use ' . __METHOD__
179 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
183 wfDeprecated( __METHOD__
, '1.31' );
189 'ipb_by_actor' => 'NULL',
193 'ipb_create_account',
194 'ipb_enable_autoblock',
198 'ipb_allow_usertalk',
199 'ipb_parent_block_id',
201 ] + CommentStore
::getStore()->getFields( 'ipb_reason' );
205 * Return the tables, fields, and join conditions to be selected to create
206 * a new block object.
208 * @return array With three keys:
209 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
210 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
211 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
213 public static function getQueryInfo() {
214 $commentQuery = CommentStore
::getStore()->getJoin( 'ipb_reason' );
215 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ipb_by' );
217 'tables' => [ 'ipblocks' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
224 'ipb_create_account',
225 'ipb_enable_autoblock',
229 'ipb_allow_usertalk',
230 'ipb_parent_block_id',
232 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
233 'joins' => $commentQuery['joins'] +
$actorQuery['joins'],
238 * Check if two blocks are effectively equal. Doesn't check irrelevant things like
239 * the blocking user or the block timestamp, only things which affect the blocked user
241 * @param DatabaseBlock $block
244 public function equals( DatabaseBlock
$block ) {
246 (string)$this->target
== (string)$block->target
247 && $this->type
== $block->type
248 && $this->mAuto
== $block->mAuto
249 && $this->isHardblock() == $block->isHardblock()
250 && $this->isCreateAccountBlocked() == $block->isCreateAccountBlocked()
251 && $this->getExpiry() == $block->getExpiry()
252 && $this->isAutoblocking() == $block->isAutoblocking()
253 && $this->getHideName() == $block->getHideName()
254 && $this->isEmailBlocked() == $block->isEmailBlocked()
255 && $this->isUsertalkEditAllowed() == $block->isUsertalkEditAllowed()
256 && $this->getReason() == $block->getReason()
257 && $this->isSitewide() == $block->isSitewide()
258 // DatabaseBlock::getRestrictions() may perform a database query, so
259 // keep it at the end.
260 && $this->getBlockRestrictionStore()->equals(
261 $this->getRestrictions(), $block->getRestrictions()
267 * Load a block from the database which affects the already-set $this->target:
268 * 1) A block directly on the given user or IP
269 * 2) A rangeblock encompassing the given IP (smallest first)
270 * 3) An autoblock on the given IP
271 * @param User|string|null $vagueTarget Also search for blocks affecting this target. Doesn't
272 * make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.
273 * @throws MWException
274 * @return bool Whether a relevant block was found
276 protected function newLoad( $vagueTarget = null ) {
277 $db = wfGetDB( $this->mFromMaster ? DB_MASTER
: DB_REPLICA
);
279 if ( $this->type
!== null ) {
281 'ipb_address' => [ (string)$this->target
],
284 $conds = [ 'ipb_address' => [] ];
287 # Be aware that the != '' check is explicit, since empty values will be
288 # passed by some callers (T31116)
289 if ( $vagueTarget != '' ) {
290 list( $target, $type ) = self
::parseTarget( $vagueTarget );
292 case self
::TYPE_USER
:
293 # Slightly weird, but who are we to argue?
294 $conds['ipb_address'][] = (string)$target;
298 $conds['ipb_address'][] = (string)$target;
299 $conds[] = self
::getRangeCond( IP
::toHex( $target ) );
300 $conds = $db->makeList( $conds, LIST_OR
);
303 case self
::TYPE_RANGE
:
304 list( $start, $end ) = IP
::parseRange( $target );
305 $conds['ipb_address'][] = (string)$target;
306 $conds[] = self
::getRangeCond( $start, $end );
307 $conds = $db->makeList( $conds, LIST_OR
);
311 throw new MWException( "Tried to load block with invalid type" );
315 $blockQuery = self
::getQueryInfo();
317 $blockQuery['tables'], $blockQuery['fields'], $conds, __METHOD__
, [], $blockQuery['joins']
320 # This result could contain a block on the user, a block on the IP, and a russian-doll
321 # set of rangeblocks. We want to choose the most specific one, so keep a leader board.
324 # Lower will be better
325 $bestBlockScore = 100;
327 foreach ( $res as $row ) {
328 $block = self
::newFromRow( $row );
330 # Don't use expired blocks
331 if ( $block->isExpired() ) {
335 # Don't use anon only blocks on users
336 if ( $this->type
== self
::TYPE_USER
&& !$block->isHardblock() ) {
340 if ( $block->getType() == self
::TYPE_RANGE
) {
341 # This is the number of bits that are allowed to vary in the block, give
342 # or take some floating point errors
343 $target = $block->getTarget();
344 $max = IP
::isIPv6( $target ) ?
128 : 32;
345 list( $network, $bits ) = IP
::parseCIDR( $target );
346 $size = $max - $bits;
348 # Rank a range block covering a single IP equally with a single-IP block
349 $score = self
::TYPE_RANGE
- 1 +
( $size / $max );
352 $score = $block->getType();
355 if ( $score < $bestBlockScore ) {
356 $bestBlockScore = $score;
361 if ( $bestRow !== null ) {
362 $this->initFromRow( $bestRow );
370 * Get a set of SQL conditions which will select rangeblocks encompassing a given range
371 * @param string $start Hexadecimal IP representation
372 * @param string|null $end Hexadecimal IP representation, or null to use $start = $end
375 public static function getRangeCond( $start, $end = null ) {
376 if ( $end === null ) {
379 # Per T16634, we want to include relevant active rangeblocks; for
380 # rangeblocks, we want to include larger ranges which enclose the given
381 # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
382 # so we can improve performance by filtering on a LIKE clause
383 $chunk = self
::getIpFragment( $start );
384 $dbr = wfGetDB( DB_REPLICA
);
385 $like = $dbr->buildLike( $chunk, $dbr->anyString() );
387 # Fairly hard to make a malicious SQL statement out of hex characters,
388 # but stranger things have happened...
389 $safeStart = $dbr->addQuotes( $start );
390 $safeEnd = $dbr->addQuotes( $end );
392 return $dbr->makeList(
394 "ipb_range_start $like",
395 "ipb_range_start <= $safeStart",
396 "ipb_range_end >= $safeEnd",
403 * Get the component of an IP address which is certain to be the same between an IP
404 * address and a rangeblock containing that IP address.
405 * @param string $hex Hexadecimal IP representation
408 protected static function getIpFragment( $hex ) {
409 global $wgBlockCIDRLimit;
410 if ( substr( $hex, 0, 3 ) == 'v6-' ) {
411 return 'v6-' . substr( substr( $hex, 3 ), 0, floor( $wgBlockCIDRLimit['IPv6'] / 4 ) );
413 return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
418 * Given a database row from the ipblocks table, initialize
420 * @param stdClass $row A row from the ipblocks table
422 protected function initFromRow( $row ) {
423 $this->setTarget( $row->ipb_address
);
424 $this->setBlocker( User
::newFromAnyId(
425 $row->ipb_by
, $row->ipb_by_text
, $row->ipb_by_actor ??
null
428 $this->setTimestamp( wfTimestamp( TS_MW
, $row->ipb_timestamp
) );
429 $this->mAuto
= $row->ipb_auto
;
430 $this->setHideName( $row->ipb_deleted
);
431 $this->mId
= (int)$row->ipb_id
;
432 $this->mParentBlockId
= $row->ipb_parent_block_id
;
434 // I wish I didn't have to do this
435 $db = wfGetDB( DB_REPLICA
);
436 $this->setExpiry( $db->decodeExpiry( $row->ipb_expiry
) );
438 CommentStore
::getStore()
439 // Legacy because $row may have come from self::selectFields()
440 ->getCommentLegacy( $db, 'ipb_reason', $row )->text
443 $this->isHardblock( !$row->ipb_anon_only
);
444 $this->isAutoblocking( $row->ipb_enable_autoblock
);
445 $this->isSitewide( (bool)$row->ipb_sitewide
);
447 $this->isCreateAccountBlocked( $row->ipb_create_account
);
448 $this->isEmailBlocked( $row->ipb_block_email
);
449 $this->isUsertalkEditAllowed( $row->ipb_allow_usertalk
);
453 * Create a new DatabaseBlock object from a database row
454 * @param stdClass $row Row from the ipblocks table
455 * @return DatabaseBlock
457 public static function newFromRow( $row ) {
458 $block = new DatabaseBlock
;
459 $block->initFromRow( $row );
464 * Delete the row from the IP blocks table.
466 * @throws MWException
469 public function delete() {
470 if ( wfReadOnly() ) {
474 if ( !$this->getId() ) {
475 throw new MWException(
476 __METHOD__
. " requires that the mId member be filled\n"
480 $dbw = wfGetDB( DB_MASTER
);
482 $this->getBlockRestrictionStore()->deleteByParentBlockId( $this->getId() );
483 $dbw->delete( 'ipblocks', [ 'ipb_parent_block_id' => $this->getId() ], __METHOD__
);
485 $this->getBlockRestrictionStore()->deleteByBlockId( $this->getId() );
486 $dbw->delete( 'ipblocks', [ 'ipb_id' => $this->getId() ], __METHOD__
);
488 return $dbw->affectedRows() > 0;
492 * Insert a block into the block table. Will fail if there is a conflicting
493 * block (same name and options) already in the database.
495 * @param IDatabase|null $dbw If you have one available
496 * @return bool|array False on failure, assoc array on success:
497 * ('id' => block ID, 'autoIds' => array of autoblock IDs)
499 public function insert( $dbw = null ) {
500 global $wgBlockDisablesLogin;
502 if ( !$this->getBlocker() ||
$this->getBlocker()->getName() === '' ) {
503 throw new MWException( 'Cannot insert a block without a blocker set' );
506 wfDebug( __METHOD__
. "; timestamp {$this->mTimestamp}\n" );
508 if ( $dbw === null ) {
509 $dbw = wfGetDB( DB_MASTER
);
512 self
::purgeExpired();
514 $row = $this->getDatabaseArray( $dbw );
516 $dbw->insert( 'ipblocks', $row, __METHOD__
, [ 'IGNORE' ] );
517 $affected = $dbw->affectedRows();
519 $this->setId( $dbw->insertId() );
520 if ( $this->restrictions
) {
521 $this->getBlockRestrictionStore()->insert( $this->restrictions
);
525 # Don't collide with expired blocks.
526 # Do this after trying to insert to avoid locking.
528 # T96428: The ipb_address index uses a prefix on a field, so
529 # use a standard SELECT + DELETE to avoid annoying gap locks.
530 $ids = $dbw->selectFieldValues( 'ipblocks',
533 'ipb_address' => $row['ipb_address'],
534 'ipb_user' => $row['ipb_user'],
535 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() )
540 $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], __METHOD__
);
541 $this->getBlockRestrictionStore()->deleteByBlockId( $ids );
542 $dbw->insert( 'ipblocks', $row, __METHOD__
, [ 'IGNORE' ] );
543 $affected = $dbw->affectedRows();
544 $this->setId( $dbw->insertId() );
545 if ( $this->restrictions
) {
546 $this->getBlockRestrictionStore()->insert( $this->restrictions
);
552 $auto_ipd_ids = $this->doRetroactiveAutoblock();
554 if ( $wgBlockDisablesLogin && $this->target
instanceof User
) {
555 // Change user login token to force them to be logged out.
556 $this->target
->setToken();
557 $this->target
->saveSettings();
560 return [ 'id' => $this->mId
, 'autoIds' => $auto_ipd_ids ];
567 * Update a block in the DB with new parameters.
568 * The ID field needs to be loaded first.
570 * @return bool|array False on failure, array on success:
571 * ('id' => block ID, 'autoIds' => array of autoblock IDs)
573 public function update() {
574 wfDebug( __METHOD__
. "; timestamp {$this->mTimestamp}\n" );
575 $dbw = wfGetDB( DB_MASTER
);
577 $dbw->startAtomic( __METHOD__
);
579 $result = $dbw->update(
581 $this->getDatabaseArray( $dbw ),
582 [ 'ipb_id' => $this->getId() ],
586 // Only update the restrictions if they have been modified.
587 if ( $this->restrictions
!== null ) {
588 // An empty array should remove all of the restrictions.
589 if ( empty( $this->restrictions
) ) {
590 $success = $this->getBlockRestrictionStore()->deleteByBlockId( $this->getId() );
592 $success = $this->getBlockRestrictionStore()->update( $this->restrictions
);
594 // Update the result. The first false is the result, otherwise, true.
595 $result = $result && $success;
598 if ( $this->isAutoblocking() ) {
599 // update corresponding autoblock(s) (T50813)
602 $this->getAutoblockUpdateArray( $dbw ),
603 [ 'ipb_parent_block_id' => $this->getId() ],
607 // Only update the restrictions if they have been modified.
608 if ( $this->restrictions
!== null ) {
609 $this->getBlockRestrictionStore()->updateByParentBlockId( $this->getId(), $this->restrictions
);
612 // autoblock no longer required, delete corresponding autoblock(s)
613 $this->getBlockRestrictionStore()->deleteByParentBlockId( $this->getId() );
616 [ 'ipb_parent_block_id' => $this->getId() ],
621 $dbw->endAtomic( __METHOD__
);
624 $auto_ipd_ids = $this->doRetroactiveAutoblock();
625 return [ 'id' => $this->mId
, 'autoIds' => $auto_ipd_ids ];
632 * Get an array suitable for passing to $dbw->insert() or $dbw->update()
633 * @param IDatabase $dbw
636 protected function getDatabaseArray( IDatabase
$dbw ) {
637 $expiry = $dbw->encodeExpiry( $this->getExpiry() );
639 if ( $this->forcedTargetID
) {
640 $uid = $this->forcedTargetID
;
642 $uid = $this->target
instanceof User ?
$this->target
->getId() : 0;
646 'ipb_address' => (string)$this->target
,
648 'ipb_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
649 'ipb_auto' => $this->mAuto
,
650 'ipb_anon_only' => !$this->isHardblock(),
651 'ipb_create_account' => $this->isCreateAccountBlocked(),
652 'ipb_enable_autoblock' => $this->isAutoblocking(),
653 'ipb_expiry' => $expiry,
654 'ipb_range_start' => $this->getRangeStart(),
655 'ipb_range_end' => $this->getRangeEnd(),
656 'ipb_deleted' => intval( $this->getHideName() ), // typecast required for SQLite
657 'ipb_block_email' => $this->isEmailBlocked(),
658 'ipb_allow_usertalk' => $this->isUsertalkEditAllowed(),
659 'ipb_parent_block_id' => $this->mParentBlockId
,
660 'ipb_sitewide' => $this->isSitewide(),
661 ] + CommentStore
::getStore()->insert( $dbw, 'ipb_reason', $this->getReason() )
662 + ActorMigration
::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
668 * @param IDatabase $dbw
671 protected function getAutoblockUpdateArray( IDatabase
$dbw ) {
673 'ipb_create_account' => $this->isCreateAccountBlocked(),
674 'ipb_deleted' => (int)$this->getHideName(), // typecast required for SQLite
675 'ipb_allow_usertalk' => $this->isUsertalkEditAllowed(),
676 'ipb_sitewide' => $this->isSitewide(),
677 ] + CommentStore
::getStore()->insert( $dbw, 'ipb_reason', $this->getReason() )
678 + ActorMigration
::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
682 * Retroactively autoblocks the last IP used by the user (if it is a user)
683 * blocked by this block.
685 * @return array IDs of retroactive autoblocks made
687 protected function doRetroactiveAutoblock() {
689 # If autoblock is enabled, autoblock the LAST IP(s) used
690 if ( $this->isAutoblocking() && $this->getType() == self
::TYPE_USER
) {
691 wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
693 $continue = Hooks
::run(
694 'PerformRetroactiveAutoblock', [ $this, &$blockIds ] );
697 self
::defaultRetroactiveAutoblock( $this, $blockIds );
704 * Retroactively autoblocks the last IP used by the user (if it is a user)
705 * blocked by this block. This will use the recentchanges table.
707 * @param DatabaseBlock $block
708 * @param array &$blockIds
710 protected static function defaultRetroactiveAutoblock( DatabaseBlock
$block, array &$blockIds ) {
713 // No IPs are in recentchanges table, so nothing to select
714 if ( !$wgPutIPinRC ) {
718 // Autoblocks only apply to TYPE_USER
719 if ( $block->getType() !== self
::TYPE_USER
) {
722 $target = $block->getTarget(); // TYPE_USER => always a User object
724 $dbr = wfGetDB( DB_REPLICA
);
725 $rcQuery = ActorMigration
::newMigration()->getWhere( $dbr, 'rc_user', $target, false );
727 $options = [ 'ORDER BY' => 'rc_timestamp DESC' ];
729 // Just the last IP used.
730 $options['LIMIT'] = 1;
733 [ 'recentchanges' ] +
$rcQuery['tables'],
741 if ( !$res->numRows() ) {
742 # No results, don't autoblock anything
743 wfDebug( "No IP found to retroactively autoblock\n" );
745 foreach ( $res as $row ) {
747 $id = $block->doAutoblock( $row->rc_ip
);
757 * Checks whether a given IP is on the autoblock whitelist.
758 * TODO: this probably belongs somewhere else, but not sure where...
760 * @param string $ip The IP to check
763 public static function isWhitelistedFromAutoblocks( $ip ) {
764 // Try to get the autoblock_whitelist from the cache, as it's faster
765 // than getting the msg raw and explode()'ing it.
766 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
767 $lines = $cache->getWithSetCallback(
768 $cache->makeKey( 'ip-autoblock', 'whitelist' ),
770 function ( $curValue, &$ttl, array &$setOpts ) {
771 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
773 return explode( "\n",
774 wfMessage( 'autoblock_whitelist' )->inContentLanguage()->plain() );
778 wfDebug( "Checking the autoblock whitelist..\n" );
780 foreach ( $lines as $line ) {
782 if ( substr( $line, 0, 1 ) !== '*' ) {
786 $wlEntry = substr( $line, 1 );
787 $wlEntry = trim( $wlEntry );
789 wfDebug( "Checking $ip against $wlEntry..." );
791 # Is the IP in this range?
792 if ( IP
::isInRange( $ip, $wlEntry ) ) {
793 wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
796 wfDebug( " No match\n" );
804 * Autoblocks the given IP, referring to this block.
806 * @param string $autoblockIP The IP to autoblock.
807 * @return int|bool ID if an autoblock was inserted, false if not.
809 public function doAutoblock( $autoblockIP ) {
810 # If autoblocks are disabled, go away.
811 if ( !$this->isAutoblocking() ) {
815 # Check for presence on the autoblock whitelist.
816 if ( self
::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
820 // Avoid PHP 7.1 warning of passing $this by reference
822 # Allow hooks to cancel the autoblock.
823 if ( !Hooks
::run( 'AbortAutoblock', [ $autoblockIP, &$block ] ) ) {
824 wfDebug( "Autoblock aborted by hook.\n" );
828 # It's okay to autoblock. Go ahead and insert/update the block...
830 # Do not add a *new* block if the IP is already blocked.
831 $ipblock = self
::newFromTarget( $autoblockIP );
833 # Check if the block is an autoblock and would exceed the user block
834 # if renewed. If so, do nothing, otherwise prolong the block time...
835 if ( $ipblock->mAuto
&& // @todo Why not compare $ipblock->mExpiry?
836 $this->getExpiry() > self
::getAutoblockExpiry( $ipblock->getTimestamp() )
838 # Reset block timestamp to now and its expiry to
839 # $wgAutoblockExpiry in the future
840 $ipblock->updateTimestamp();
845 # Make a new block object with the desired properties.
846 $autoblock = new DatabaseBlock
;
847 wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
848 $autoblock->setTarget( $autoblockIP );
849 $autoblock->setBlocker( $this->getBlocker() );
850 $autoblock->setReason(
851 wfMessage( 'autoblocker', $this->getTarget(), $this->getReason() )
852 ->inContentLanguage()->plain()
854 $timestamp = wfTimestampNow();
855 $autoblock->setTimestamp( $timestamp );
856 $autoblock->mAuto
= 1;
857 $autoblock->isCreateAccountBlocked( $this->isCreateAccountBlocked() );
858 # Continue suppressing the name if needed
859 $autoblock->setHideName( $this->getHideName() );
860 $autoblock->isUsertalkEditAllowed( $this->isUsertalkEditAllowed() );
861 $autoblock->mParentBlockId
= $this->mId
;
862 $autoblock->isSitewide( $this->isSitewide() );
863 $autoblock->setRestrictions( $this->getRestrictions() );
865 if ( $this->getExpiry() == 'infinity' ) {
866 # Original block was indefinite, start an autoblock now
867 $autoblock->setExpiry( self
::getAutoblockExpiry( $timestamp ) );
869 # If the user is already blocked with an expiry date, we don't
870 # want to pile on top of that.
871 $autoblock->setExpiry( min( $this->getExpiry(), self
::getAutoblockExpiry( $timestamp ) ) );
874 # Insert the block...
875 $status = $autoblock->insert();
882 * Check if a block has expired. Delete it if it is.
885 public function deleteIfExpired() {
886 if ( $this->isExpired() ) {
887 wfDebug( __METHOD__
. " -- deleting\n" );
891 wfDebug( __METHOD__
. " -- not expired\n" );
899 * Has the block expired?
902 public function isExpired() {
903 $timestamp = wfTimestampNow();
904 wfDebug( __METHOD__
. " checking current " . $timestamp . " vs $this->mExpiry\n" );
906 if ( !$this->getExpiry() ) {
909 return $timestamp > $this->getExpiry();
914 * Is the block address valid (i.e. not a null string?)
916 * @deprecated since 1.33 No longer needed in core.
919 public function isValid() {
920 wfDeprecated( __METHOD__
, '1.33' );
921 return $this->getTarget() != null;
925 * Update the timestamp on autoblocks.
927 public function updateTimestamp() {
928 if ( $this->mAuto
) {
929 $this->setTimestamp( wfTimestamp() );
930 $this->setExpiry( self
::getAutoblockExpiry( $this->getTimestamp() ) );
932 $dbw = wfGetDB( DB_MASTER
);
933 $dbw->update( 'ipblocks',
935 'ipb_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
936 'ipb_expiry' => $dbw->timestamp( $this->getExpiry() ),
939 'ipb_id' => $this->getId(),
947 * Get the IP address at the start of the range in Hex form
948 * @throws MWException
949 * @return string IP in Hex form
951 public function getRangeStart() {
952 switch ( $this->type
) {
953 case self
::TYPE_USER
:
956 return IP
::toHex( $this->target
);
957 case self
::TYPE_RANGE
:
958 list( $start, /*...*/ ) = IP
::parseRange( $this->target
);
961 throw new MWException( "Block with invalid type" );
966 * Get the IP address at the end of the range in Hex form
967 * @throws MWException
968 * @return string IP in Hex form
970 public function getRangeEnd() {
971 switch ( $this->type
) {
972 case self
::TYPE_USER
:
975 return IP
::toHex( $this->target
);
976 case self
::TYPE_RANGE
:
977 list( /*...*/, $end ) = IP
::parseRange( $this->target
);
980 throw new MWException( "Block with invalid type" );
987 public function getId() {
994 * @param int $blockId
997 private function setId( $blockId ) {
998 $this->mId
= (int)$blockId;
1000 if ( is_array( $this->restrictions
) ) {
1001 $this->restrictions
= $this->getBlockRestrictionStore()->setBlockId(
1002 $blockId, $this->restrictions
1010 * Get/set a flag determining whether the master is used for reads
1012 * @param bool|null $x
1015 public function fromMaster( $x = null ) {
1016 return wfSetVar( $this->mFromMaster
, $x );
1020 * Get/set whether the block is a hardblock (affects logged-in users on a given IP/range)
1021 * @param bool|null $x
1024 public function isHardblock( $x = null ) {
1025 wfSetVar( $this->isHardblock
, $x );
1027 # You can't *not* hardblock a user
1028 return $this->getType() == self
::TYPE_USER
1030 : $this->isHardblock
;
1034 * @param null|bool $x
1037 public function isAutoblocking( $x = null ) {
1038 wfSetVar( $this->isAutoblocking
, $x );
1040 # You can't put an autoblock on an IP or range as we don't have any history to
1041 # look over to get more IPs from
1042 return $this->getType() == self
::TYPE_USER
1043 ?
$this->isAutoblocking
1048 * Get the block name, but with autoblocked IPs hidden as per standard privacy policy
1049 * @return string Text is escaped
1051 public function getRedactedName() {
1052 if ( $this->mAuto
) {
1053 return Html
::element(
1055 [ 'class' => 'mw-autoblockid' ],
1056 wfMessage( 'autoblockid', $this->mId
)->text()
1059 return htmlspecialchars( $this->getTarget() );
1064 * Get a timestamp of the expiry for autoblocks
1066 * @param string|int $timestamp
1069 public static function getAutoblockExpiry( $timestamp ) {
1070 global $wgAutoblockExpiry;
1072 return wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $timestamp ) +
$wgAutoblockExpiry );
1076 * Purge expired blocks from the ipblocks table
1078 public static function purgeExpired() {
1079 if ( wfReadOnly() ) {
1083 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
1084 wfGetDB( DB_MASTER
),
1086 function ( IDatabase
$dbw, $fname ) {
1087 $ids = $dbw->selectFieldValues( 'ipblocks',
1089 [ 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
1093 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
1094 $blockRestrictionStore->deleteByBlockId( $ids );
1096 $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], $fname );
1103 * Given a target and the target's type, get an existing block object if possible.
1104 * @param string|User|int $specificTarget A block target, which may be one of several types:
1105 * * A user to block, in which case $target will be a User
1106 * * An IP to block, in which case $target will be a User generated by using
1107 * User::newFromName( $ip, false ) to turn off name validation
1108 * * An IP range, in which case $target will be a String "123.123.123.123/18" etc
1109 * * The ID of an existing block, in the format "#12345" (since pure numbers are valid
1111 * Calling this with a user, IP address or range will not select autoblocks, and will
1112 * only select a block where the targets match exactly (so looking for blocks on
1113 * 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
1114 * @param string|User|int|null $vagueTarget As above, but we will search for *any* block which
1115 * affects that target (so for an IP address, get ranges containing that IP; and also
1116 * get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
1117 * @param bool $fromMaster Whether to use the DB_MASTER database
1118 * @return DatabaseBlock|null (null if no relevant block could be found). The target and type
1119 * of the returned block will refer to the actual block which was found, which might
1120 * not be the same as the target you gave if you used $vagueTarget!
1122 public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
1123 list( $target, $type ) = self
::parseTarget( $specificTarget );
1124 if ( $type == self
::TYPE_ID ||
$type == self
::TYPE_AUTO
) {
1125 return self
::newFromID( $target );
1127 } elseif ( $target === null && $vagueTarget == '' ) {
1128 # We're not going to find anything useful here
1129 # Be aware that the == '' check is explicit, since empty values will be
1130 # passed by some callers (T31116)
1133 } elseif ( in_array(
1135 [ self
::TYPE_USER
, self
::TYPE_IP
, self
::TYPE_RANGE
, null ] )
1137 $block = new DatabaseBlock();
1138 $block->fromMaster( $fromMaster );
1140 if ( $type !== null ) {
1141 $block->setTarget( $target );
1144 if ( $block->newLoad( $vagueTarget ) ) {
1152 * Get all blocks that match any IP from an array of IP addresses
1154 * @param array $ipChain List of IPs (strings), usually retrieved from the
1155 * X-Forwarded-For header of the request
1156 * @param bool $isAnon Exclude anonymous-only blocks if false
1157 * @param bool $fromMaster Whether to query the master or replica DB
1158 * @return array Array of Blocks
1161 public static function getBlocksForIPList( array $ipChain, $isAnon, $fromMaster = false ) {
1162 if ( $ipChain === [] ) {
1167 $proxyLookup = MediaWikiServices
::getInstance()->getProxyLookup();
1168 foreach ( array_unique( $ipChain ) as $ipaddr ) {
1169 # Discard invalid IP addresses. Since XFF can be spoofed and we do not
1170 # necessarily trust the header given to us, make sure that we are only
1171 # checking for blocks on well-formatted IP addresses (IPv4 and IPv6).
1172 # Do not treat private IP spaces as special as it may be desirable for wikis
1173 # to block those IP ranges in order to stop misbehaving proxies that spoof XFF.
1174 if ( !IP
::isValid( $ipaddr ) ) {
1177 # Don't check trusted IPs (includes local CDNs which will be in every request)
1178 if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) {
1181 # Check both the original IP (to check against single blocks), as well as build
1182 # the clause to check for rangeblocks for the given IP.
1183 $conds['ipb_address'][] = $ipaddr;
1184 $conds[] = self
::getRangeCond( IP
::toHex( $ipaddr ) );
1187 if ( $conds === [] ) {
1191 if ( $fromMaster ) {
1192 $db = wfGetDB( DB_MASTER
);
1194 $db = wfGetDB( DB_REPLICA
);
1196 $conds = $db->makeList( $conds, LIST_OR
);
1198 $conds = [ $conds, 'ipb_anon_only' => 0 ];
1200 $blockQuery = self
::getQueryInfo();
1201 $rows = $db->select(
1202 $blockQuery['tables'],
1203 array_merge( [ 'ipb_range_start', 'ipb_range_end' ], $blockQuery['fields'] ),
1207 $blockQuery['joins']
1211 foreach ( $rows as $row ) {
1212 $block = self
::newFromRow( $row );
1213 if ( !$block->isExpired() ) {
1222 * From a list of multiple blocks, find the most exact and strongest block.
1224 * The logic for finding the "best" block is:
1225 * - Blocks that match the block's target IP are preferred over ones in a range
1226 * - Hardblocks are chosen over softblocks that prevent account creation
1227 * - Softblocks that prevent account creation are chosen over other softblocks
1228 * - Other softblocks are chosen over autoblocks
1229 * - If there are multiple exact or range blocks at the same level, the one chosen
1231 * This should be used when $blocks were retrieved from the user's IP address
1232 * and $ipChain is populated from the same IP address information.
1234 * @param array $blocks Array of DatabaseBlock objects
1235 * @param array $ipChain List of IPs (strings). This is used to determine how "close"
1236 * a block is to the server, and if a block matches exactly, or is in a range.
1237 * The order is furthest from the server to nearest e.g., (Browser, proxy1, proxy2,
1239 * @throws MWException
1240 * @return DatabaseBlock|null The "best" block from the list
1242 public static function chooseBlock( array $blocks, array $ipChain ) {
1243 if ( $blocks === [] ) {
1245 } elseif ( count( $blocks ) == 1 ) {
1249 // Sort hard blocks before soft ones and secondarily sort blocks
1250 // that disable account creation before those that don't.
1251 usort( $blocks, function ( DatabaseBlock
$a, DatabaseBlock
$b ) {
1252 $aWeight = (int)$a->isHardblock() . (int)$a->appliesToRight( 'createaccount' );
1253 $bWeight = (int)$b->isHardblock() . (int)$b->appliesToRight( 'createaccount' );
1254 return strcmp( $bWeight, $aWeight ); // highest weight first
1257 $blocksListExact = [
1259 'disable_create' => false,
1263 $blocksListRange = [
1265 'disable_create' => false,
1269 $ipChain = array_reverse( $ipChain );
1271 foreach ( $blocks as $block ) {
1272 // Stop searching if we have already have a "better" block. This
1273 // is why the order of the blocks matters
1274 if ( !$block->isHardblock() && $blocksListExact['hard'] ) {
1276 } elseif ( !$block->appliesToRight( 'createaccount' ) && $blocksListExact['disable_create'] ) {
1280 foreach ( $ipChain as $checkip ) {
1281 $checkipHex = IP
::toHex( $checkip );
1282 if ( (string)$block->getTarget() === $checkip ) {
1283 if ( $block->isHardblock() ) {
1284 $blocksListExact['hard'] = $blocksListExact['hard'] ?
: $block;
1285 } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1286 $blocksListExact['disable_create'] = $blocksListExact['disable_create'] ?
: $block;
1287 } elseif ( $block->mAuto
) {
1288 $blocksListExact['auto'] = $blocksListExact['auto'] ?
: $block;
1290 $blocksListExact['other'] = $blocksListExact['other'] ?
: $block;
1292 // We found closest exact match in the ip list, so go to the next block
1294 } elseif ( array_filter( $blocksListExact ) == []
1295 && $block->getRangeStart() <= $checkipHex
1296 && $block->getRangeEnd() >= $checkipHex
1298 if ( $block->isHardblock() ) {
1299 $blocksListRange['hard'] = $blocksListRange['hard'] ?
: $block;
1300 } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1301 $blocksListRange['disable_create'] = $blocksListRange['disable_create'] ?
: $block;
1302 } elseif ( $block->mAuto
) {
1303 $blocksListRange['auto'] = $blocksListRange['auto'] ?
: $block;
1305 $blocksListRange['other'] = $blocksListRange['other'] ?
: $block;
1312 if ( array_filter( $blocksListExact ) == [] ) {
1313 $blocksList = &$blocksListRange;
1315 $blocksList = &$blocksListExact;
1318 $chosenBlock = null;
1319 if ( $blocksList['hard'] ) {
1320 $chosenBlock = $blocksList['hard'];
1321 } elseif ( $blocksList['disable_create'] ) {
1322 $chosenBlock = $blocksList['disable_create'];
1323 } elseif ( $blocksList['other'] ) {
1324 $chosenBlock = $blocksList['other'];
1325 } elseif ( $blocksList['auto'] ) {
1326 $chosenBlock = $blocksList['auto'];
1328 throw new MWException( "Proxy block found, but couldn't be classified." );
1331 return $chosenBlock;
1337 * Autoblocks have whichever type corresponds to their target, so to detect if a block is an
1338 * autoblock, we have to check the mAuto property instead.
1340 public function getType() {
1343 : parent
::getType();
1347 * Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be
1348 * the same as the block's, to a maximum of 24 hours.
1352 * @param WebResponse $response The response on which to set the cookie.
1354 public function setCookie( WebResponse
$response ) {
1355 // Calculate the default expiry time.
1356 $maxExpiryTime = wfTimestamp( TS_MW
, wfTimestamp() +
( 24 * 60 * 60 ) );
1358 // Use the block's expiry time only if it's less than the default.
1359 $expiryTime = $this->getExpiry();
1360 if ( $expiryTime === 'infinity' ||
$expiryTime > $maxExpiryTime ) {
1361 $expiryTime = $maxExpiryTime;
1364 // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie.
1365 $expiryValue = DateTime
::createFromFormat( 'YmdHis', $expiryTime )->format( 'U' );
1366 $cookieOptions = [ 'httpOnly' => false ];
1367 $cookieValue = $this->getCookieValue();
1368 $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions );
1372 * Unset the 'BlockID' cookie.
1376 * @param WebResponse $response The response on which to unset the cookie.
1378 public static function clearCookie( WebResponse
$response ) {
1379 $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
1383 * Get the BlockID cookie's value for this block. This is usually the block ID concatenated
1384 * with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just
1389 * @return string The block ID, probably concatenated with "!" and the HMAC.
1391 public function getCookieValue() {
1392 $config = RequestContext
::getMain()->getConfig();
1393 $id = $this->getId();
1394 $secretKey = $config->get( 'SecretKey' );
1395 if ( !$secretKey ) {
1396 // If there's no secret key, don't append a HMAC.
1399 $hmac = MWCryptHash
::hmac( $id, $secretKey, false );
1400 $cookieValue = $id . '!' . $hmac;
1401 return $cookieValue;
1405 * Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of
1406 * the ID and a HMAC (see DatabaseBlock::setCookie), but will sometimes only be the ID.
1410 * @param string $cookieValue The string in which to find the ID.
1412 * @return int|null The block ID, or null if the HMAC is present and invalid.
1414 public static function getIdFromCookieValue( $cookieValue ) {
1415 // Extract the ID prefix from the cookie value (may be the whole value, if no bang found).
1416 $bangPos = strpos( $cookieValue, '!' );
1417 $id = ( $bangPos === false ) ?
$cookieValue : substr( $cookieValue, 0, $bangPos );
1418 // Get the site-wide secret key.
1419 $config = RequestContext
::getMain()->getConfig();
1420 $secretKey = $config->get( 'SecretKey' );
1421 if ( !$secretKey ) {
1422 // If there's no secret key, just use the ID as given.
1425 $storedHmac = substr( $cookieValue, $bangPos +
1 );
1426 $calculatedHmac = MWCryptHash
::hmac( $id, $secretKey, false );
1427 if ( $calculatedHmac === $storedHmac ) {
1437 * Build different messages for autoblocks and partial blocks.
1439 public function getPermissionsError( IContextSource
$context ) {
1440 $params = $this->getBlockErrorParams( $context );
1442 $msg = 'blockedtext';
1443 if ( $this->mAuto
) {
1444 $msg = 'autoblockedtext';
1445 } elseif ( !$this->isSitewide() ) {
1446 $msg = 'blockedtext-partial';
1449 array_unshift( $params, $msg );
1457 * Getting the restrictions will perform a database query if the restrictions
1458 * are not already loaded.
1461 * @return Restriction[]
1463 public function getRestrictions() {
1464 if ( $this->restrictions
=== null ) {
1465 // If the block id has not been set, then do not attempt to load the
1467 if ( !$this->mId
) {
1470 $this->restrictions
= $this->getBlockRestrictionStore()->loadByBlockId( $this->mId
);
1473 return $this->restrictions
;
1480 * @param Restriction[] $restrictions
1483 public function setRestrictions( array $restrictions ) {
1484 $this->restrictions
= array_filter( $restrictions, function ( $restriction ) {
1485 return $restriction instanceof Restriction
;
1494 public function appliesToTitle( Title
$title ) {
1495 if ( $this->isSitewide() ) {
1499 $restrictions = $this->getRestrictions();
1500 foreach ( $restrictions as $restriction ) {
1501 if ( $restriction->matches( $title ) ) {
1512 public function appliesToNamespace( $ns ) {
1513 if ( $this->isSitewide() ) {
1517 // Blocks do not apply to virtual namespaces.
1522 $restriction = $this->findRestriction( NamespaceRestriction
::TYPE
, $ns );
1524 return (bool)$restriction;
1530 public function appliesToPage( $pageId ) {
1531 if ( $this->isSitewide() ) {
1535 // If the pageId is not over zero, the block cannot apply to it.
1536 if ( $pageId <= 0 ) {
1540 $restriction = $this->findRestriction( PageRestriction
::TYPE
, $pageId );
1542 return (bool)$restriction;
1546 * Find Restriction by type and value.
1548 * @param string $type
1550 * @return Restriction|null
1552 private function findRestriction( $type, $value ) {
1553 $restrictions = $this->getRestrictions();
1554 foreach ( $restrictions as $restriction ) {
1555 if ( $restriction->getType() !== $type ) {
1559 if ( $restriction->getValue() === $value ) {
1560 return $restriction;
1570 public function shouldTrackWithCookie( $isAnon ) {
1571 $config = RequestContext
::getMain()->getConfig();
1572 switch ( $this->getType() ) {
1574 case self
::TYPE_RANGE
:
1575 return $isAnon && $config->get( 'CookieSetOnIpBlock' );
1576 case self
::TYPE_USER
:
1577 return !$isAnon && $config->get( 'CookieSetOnAutoblock' ) && $this->isAutoblocking();
1584 * Get a BlockRestrictionStore instance
1586 * @return BlockRestrictionStore
1588 private function getBlockRestrictionStore() : BlockRestrictionStore
{
1589 return MediaWikiServices
::getInstance()->getBlockRestrictionStore();
1594 * @deprecated since 1.34
1596 class_alias( DatabaseBlock
::class, 'Block' );