3 * Blocks and bans object
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 use Wikimedia\Rdbms\Database
;
24 use Wikimedia\Rdbms\IDatabase
;
25 use MediaWiki\Block\BlockRestrictionStore
;
26 use MediaWiki\Block\Restriction\Restriction
;
27 use MediaWiki\Block\Restriction\NamespaceRestriction
;
28 use MediaWiki\Block\Restriction\PageRestriction
;
29 use MediaWiki\MediaWikiServices
;
48 public $mParentBlockId;
60 private $allowUsertalk;
63 private $blockCreateAccount;
65 /** @var User|string */
68 /** @var int Hack for foreign blocking (CentralAuth) */
69 private $forcedTargetID;
72 * @var int Block::TYPE_ constant. After the block has been loaded
73 * from the database, this can only be USER, IP or RANGE.
84 private $isAutoblocking;
86 /** @var string|null */
87 private $systemBlockType;
92 /** @var Restriction[] */
93 private $restrictions;
103 * Create a new block with specified option parameters on a user, IP or IP range.
105 * @param array $options Parameters of the block:
106 * address string|User Target user name, User object, IP address or IP range
107 * user int Override target user ID (for foreign users)
108 * by int User ID of the blocker
109 * reason string Reason of the block
110 * timestamp string The time at which the block comes into effect
111 * auto bool Is this an automatic block?
112 * expiry string Timestamp of expiration of the block or 'infinity'
113 * anonOnly bool Only disallow anonymous actions
114 * createAccount bool Disallow creation of new accounts
115 * enableAutoblock bool Enable automatic blocking
116 * hideName bool Hide the target user name
117 * blockEmail bool Disallow sending emails
118 * allowUsertalk bool Allow the target to edit its own talk page
119 * byText string Username of the blocker (for foreign users)
120 * systemBlock string Indicate that this block is automatically
121 * created by MediaWiki rather than being stored
122 * in the database. Value is a string to return
123 * from self::getSystemBlockType().
124 * sitewide bool Disallow editing all pages and all contribution
125 * actions, except those specifically allowed by
128 * @since 1.26 $options array
130 public function __construct( array $options = [] ) {
140 'createAccount' => false,
141 'enableAutoblock' => false,
143 'blockEmail' => false,
144 'allowUsertalk' => false,
146 'systemBlock' => null,
150 $options +
= $defaults;
152 $this->setTarget( $options['address'] );
154 if ( $this->target
instanceof User
&& $options['user'] ) {
155 # Needed for foreign users
156 $this->forcedTargetID
= $options['user'];
159 if ( $options['by'] ) {
161 $this->setBlocker( User
::newFromId( $options['by'] ) );
164 $this->setBlocker( $options['byText'] );
167 $this->setReason( $options['reason'] );
168 $this->setTimestamp( wfTimestamp( TS_MW
, $options['timestamp'] ) );
169 $this->setExpiry( wfGetDB( DB_REPLICA
)->decodeExpiry( $options['expiry'] ) );
172 $this->mAuto
= (bool)$options['auto'];
173 $this->setHideName( (bool)$options['hideName'] );
174 $this->isHardblock( !$options['anonOnly'] );
175 $this->isAutoblocking( (bool)$options['enableAutoblock'] );
176 $this->isSitewide( (bool)$options['sitewide'] );
177 $this->isEmailBlocked( (bool)$options['blockEmail'] );
178 $this->isCreateAccountBlocked( (bool)$options['createAccount'] );
179 $this->isUsertalkEditAllowed( (bool)$options['allowUsertalk'] );
181 $this->mFromMaster
= false;
182 $this->systemBlockType
= $options['systemBlock'];
186 * Load a block from the block id.
188 * @param int $id Block id to search for
191 public static function newFromID( $id ) {
192 $dbr = wfGetDB( DB_REPLICA
);
193 $blockQuery = self
::getQueryInfo();
194 $res = $dbr->selectRow(
195 $blockQuery['tables'],
196 $blockQuery['fields'],
203 return self
::newFromRow( $res );
210 * Return the list of ipblocks fields that should be selected to create
212 * @deprecated since 1.31, use self::getQueryInfo() instead.
215 public static function selectFields() {
216 global $wgActorTableSchemaMigrationStage;
218 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
219 // If code is using this instead of self::getQueryInfo(), there's a
220 // decent chance it's going to try to directly access
221 // $row->ipb_by or $row->ipb_by_text and we can't give it
222 // useful values here once those aren't being used anymore.
223 throw new BadMethodCallException(
224 'Cannot use ' . __METHOD__
225 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
229 wfDeprecated( __METHOD__
, '1.31' );
235 'ipb_by_actor' => 'NULL',
239 'ipb_create_account',
240 'ipb_enable_autoblock',
244 'ipb_allow_usertalk',
245 'ipb_parent_block_id',
247 ] + CommentStore
::getStore()->getFields( 'ipb_reason' );
251 * Return the tables, fields, and join conditions to be selected to create
252 * a new block object.
254 * @return array With three keys:
255 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
256 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
257 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
259 public static function getQueryInfo() {
260 $commentQuery = CommentStore
::getStore()->getJoin( 'ipb_reason' );
261 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ipb_by' );
263 'tables' => [ 'ipblocks' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
270 'ipb_create_account',
271 'ipb_enable_autoblock',
275 'ipb_allow_usertalk',
276 'ipb_parent_block_id',
278 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
279 'joins' => $commentQuery['joins'] +
$actorQuery['joins'],
284 * Check if two blocks are effectively equal. Doesn't check irrelevant things like
285 * the blocking user or the block timestamp, only things which affect the blocked user
287 * @param Block $block
291 public function equals( Block
$block ) {
293 (string)$this->target
== (string)$block->target
294 && $this->type
== $block->type
295 && $this->mAuto
== $block->mAuto
296 && $this->isHardblock() == $block->isHardblock()
297 && $this->isCreateAccountBlocked() == $block->isCreateAccountBlocked()
298 && $this->getExpiry() == $block->getExpiry()
299 && $this->isAutoblocking() == $block->isAutoblocking()
300 && $this->getHideName() == $block->getHideName()
301 && $this->isEmailBlocked() == $block->isEmailBlocked()
302 && $this->isUsertalkEditAllowed() == $block->isUsertalkEditAllowed()
303 && $this->getReason() == $block->getReason()
304 && $this->isSitewide() == $block->isSitewide()
305 // Block::getRestrictions() may perform a database query, so keep it at
307 && $this->getBlockRestrictionStore()->equals(
308 $this->getRestrictions(), $block->getRestrictions()
314 * Load a block from the database which affects the already-set $this->target:
315 * 1) A block directly on the given user or IP
316 * 2) A rangeblock encompassing the given IP (smallest first)
317 * 3) An autoblock on the given IP
318 * @param User|string|null $vagueTarget Also search for blocks affecting this target. Doesn't
319 * make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.
320 * @throws MWException
321 * @return bool Whether a relevant block was found
323 protected function newLoad( $vagueTarget = null ) {
324 $db = wfGetDB( $this->mFromMaster ? DB_MASTER
: DB_REPLICA
);
326 if ( $this->type
!== null ) {
328 'ipb_address' => [ (string)$this->target
],
331 $conds = [ 'ipb_address' => [] ];
334 # Be aware that the != '' check is explicit, since empty values will be
335 # passed by some callers (T31116)
336 if ( $vagueTarget != '' ) {
337 list( $target, $type ) = self
::parseTarget( $vagueTarget );
339 case self
::TYPE_USER
:
340 # Slightly weird, but who are we to argue?
341 $conds['ipb_address'][] = (string)$target;
345 $conds['ipb_address'][] = (string)$target;
346 $conds[] = self
::getRangeCond( IP
::toHex( $target ) );
347 $conds = $db->makeList( $conds, LIST_OR
);
350 case self
::TYPE_RANGE
:
351 list( $start, $end ) = IP
::parseRange( $target );
352 $conds['ipb_address'][] = (string)$target;
353 $conds[] = self
::getRangeCond( $start, $end );
354 $conds = $db->makeList( $conds, LIST_OR
);
358 throw new MWException( "Tried to load block with invalid type" );
362 $blockQuery = self
::getQueryInfo();
364 $blockQuery['tables'], $blockQuery['fields'], $conds, __METHOD__
, [], $blockQuery['joins']
367 # This result could contain a block on the user, a block on the IP, and a russian-doll
368 # set of rangeblocks. We want to choose the most specific one, so keep a leader board.
371 # Lower will be better
372 $bestBlockScore = 100;
374 foreach ( $res as $row ) {
375 $block = self
::newFromRow( $row );
377 # Don't use expired blocks
378 if ( $block->isExpired() ) {
382 # Don't use anon only blocks on users
383 if ( $this->type
== self
::TYPE_USER
&& !$block->isHardblock() ) {
387 if ( $block->getType() == self
::TYPE_RANGE
) {
388 # This is the number of bits that are allowed to vary in the block, give
389 # or take some floating point errors
390 $end = Wikimedia\base_convert
( $block->getRangeEnd(), 16, 10 );
391 $start = Wikimedia\base_convert
( $block->getRangeStart(), 16, 10 );
392 $size = log( $end - $start +
1, 2 );
394 # Rank a range block covering a single IP equally with a single-IP block
395 $score = self
::TYPE_RANGE
- 1 +
( $size / 128 );
398 $score = $block->getType();
401 if ( $score < $bestBlockScore ) {
402 $bestBlockScore = $score;
407 if ( $bestRow !== null ) {
408 $this->initFromRow( $bestRow );
416 * Get a set of SQL conditions which will select rangeblocks encompassing a given range
417 * @param string $start Hexadecimal IP representation
418 * @param string|null $end Hexadecimal IP representation, or null to use $start = $end
421 public static function getRangeCond( $start, $end = null ) {
422 if ( $end === null ) {
425 # Per T16634, we want to include relevant active rangeblocks; for
426 # rangeblocks, we want to include larger ranges which enclose the given
427 # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
428 # so we can improve performance by filtering on a LIKE clause
429 $chunk = self
::getIpFragment( $start );
430 $dbr = wfGetDB( DB_REPLICA
);
431 $like = $dbr->buildLike( $chunk, $dbr->anyString() );
433 # Fairly hard to make a malicious SQL statement out of hex characters,
434 # but stranger things have happened...
435 $safeStart = $dbr->addQuotes( $start );
436 $safeEnd = $dbr->addQuotes( $end );
438 return $dbr->makeList(
440 "ipb_range_start $like",
441 "ipb_range_start <= $safeStart",
442 "ipb_range_end >= $safeEnd",
449 * Get the component of an IP address which is certain to be the same between an IP
450 * address and a rangeblock containing that IP address.
451 * @param string $hex Hexadecimal IP representation
454 protected static function getIpFragment( $hex ) {
455 global $wgBlockCIDRLimit;
456 if ( substr( $hex, 0, 3 ) == 'v6-' ) {
457 return 'v6-' . substr( substr( $hex, 3 ), 0, floor( $wgBlockCIDRLimit['IPv6'] / 4 ) );
459 return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
464 * Given a database row from the ipblocks table, initialize
466 * @param stdClass $row A row from the ipblocks table
468 protected function initFromRow( $row ) {
469 $this->setTarget( $row->ipb_address
);
470 $this->setBlocker( User
::newFromAnyId(
471 $row->ipb_by
, $row->ipb_by_text
, $row->ipb_by_actor ??
null
474 $this->setTimestamp( wfTimestamp( TS_MW
, $row->ipb_timestamp
) );
475 $this->mAuto
= $row->ipb_auto
;
476 $this->setHideName( $row->ipb_deleted
);
477 $this->mId
= (int)$row->ipb_id
;
478 $this->mParentBlockId
= $row->ipb_parent_block_id
;
480 // I wish I didn't have to do this
481 $db = wfGetDB( DB_REPLICA
);
482 $this->setExpiry( $db->decodeExpiry( $row->ipb_expiry
) );
484 CommentStore
::getStore()
485 // Legacy because $row may have come from self::selectFields()
486 ->getCommentLegacy( $db, 'ipb_reason', $row )->text
489 $this->isHardblock( !$row->ipb_anon_only
);
490 $this->isAutoblocking( $row->ipb_enable_autoblock
);
491 $this->isSitewide( (bool)$row->ipb_sitewide
);
493 $this->isCreateAccountBlocked( $row->ipb_create_account
);
494 $this->isEmailBlocked( $row->ipb_block_email
);
495 $this->isUsertalkEditAllowed( $row->ipb_allow_usertalk
);
499 * Create a new Block object from a database row
500 * @param stdClass $row Row from the ipblocks table
503 public static function newFromRow( $row ) {
505 $block->initFromRow( $row );
510 * Delete the row from the IP blocks table.
512 * @throws MWException
515 public function delete() {
516 if ( wfReadOnly() ) {
520 if ( !$this->getId() ) {
521 throw new MWException( "Block::delete() requires that the mId member be filled\n" );
524 $dbw = wfGetDB( DB_MASTER
);
526 $this->getBlockRestrictionStore()->deleteByParentBlockId( $this->getId() );
527 $dbw->delete( 'ipblocks', [ 'ipb_parent_block_id' => $this->getId() ], __METHOD__
);
529 $this->getBlockRestrictionStore()->deleteByBlockId( $this->getId() );
530 $dbw->delete( 'ipblocks', [ 'ipb_id' => $this->getId() ], __METHOD__
);
532 return $dbw->affectedRows() > 0;
536 * Insert a block into the block table. Will fail if there is a conflicting
537 * block (same name and options) already in the database.
539 * @param IDatabase|null $dbw If you have one available
540 * @return bool|array False on failure, assoc array on success:
541 * ('id' => block ID, 'autoIds' => array of autoblock IDs)
543 public function insert( $dbw = null ) {
544 global $wgBlockDisablesLogin;
546 if ( $this->getSystemBlockType() !== null ) {
547 throw new MWException( 'Cannot insert a system block into the database' );
549 if ( !$this->getBlocker() ||
$this->getBlocker()->getName() === '' ) {
550 throw new MWException( 'Cannot insert a block without a blocker set' );
553 wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
555 if ( $dbw === null ) {
556 $dbw = wfGetDB( DB_MASTER
);
559 self
::purgeExpired();
561 $row = $this->getDatabaseArray( $dbw );
563 $dbw->insert( 'ipblocks', $row, __METHOD__
, [ 'IGNORE' ] );
564 $affected = $dbw->affectedRows();
566 $this->setId( $dbw->insertId() );
567 if ( $this->restrictions
) {
568 $this->getBlockRestrictionStore()->insert( $this->restrictions
);
572 # Don't collide with expired blocks.
573 # Do this after trying to insert to avoid locking.
575 # T96428: The ipb_address index uses a prefix on a field, so
576 # use a standard SELECT + DELETE to avoid annoying gap locks.
577 $ids = $dbw->selectFieldValues( 'ipblocks',
580 'ipb_address' => $row['ipb_address'],
581 'ipb_user' => $row['ipb_user'],
582 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() )
587 $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], __METHOD__
);
588 $this->getBlockRestrictionStore()->deleteByBlockId( $ids );
589 $dbw->insert( 'ipblocks', $row, __METHOD__
, [ 'IGNORE' ] );
590 $affected = $dbw->affectedRows();
591 $this->setId( $dbw->insertId() );
592 if ( $this->restrictions
) {
593 $this->getBlockRestrictionStore()->insert( $this->restrictions
);
599 $auto_ipd_ids = $this->doRetroactiveAutoblock();
601 if ( $wgBlockDisablesLogin && $this->target
instanceof User
) {
602 // Change user login token to force them to be logged out.
603 $this->target
->setToken();
604 $this->target
->saveSettings();
607 return [ 'id' => $this->mId
, 'autoIds' => $auto_ipd_ids ];
614 * Update a block in the DB with new parameters.
615 * The ID field needs to be loaded first.
617 * @return bool|array False on failure, array on success:
618 * ('id' => block ID, 'autoIds' => array of autoblock IDs)
620 public function update() {
621 wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" );
622 $dbw = wfGetDB( DB_MASTER
);
624 $dbw->startAtomic( __METHOD__
);
626 $result = $dbw->update(
628 $this->getDatabaseArray( $dbw ),
629 [ 'ipb_id' => $this->getId() ],
633 // Only update the restrictions if they have been modified.
634 if ( $this->restrictions
!== null ) {
635 // An empty array should remove all of the restrictions.
636 if ( empty( $this->restrictions
) ) {
637 $success = $this->getBlockRestrictionStore()->deleteByBlockId( $this->getId() );
639 $success = $this->getBlockRestrictionStore()->update( $this->restrictions
);
641 // Update the result. The first false is the result, otherwise, true.
642 $result = $result && $success;
645 if ( $this->isAutoblocking() ) {
646 // update corresponding autoblock(s) (T50813)
649 $this->getAutoblockUpdateArray( $dbw ),
650 [ 'ipb_parent_block_id' => $this->getId() ],
654 // Only update the restrictions if they have been modified.
655 if ( $this->restrictions
!== null ) {
656 $this->getBlockRestrictionStore()->updateByParentBlockId( $this->getId(), $this->restrictions
);
659 // autoblock no longer required, delete corresponding autoblock(s)
660 $this->getBlockRestrictionStore()->deleteByParentBlockId( $this->getId() );
663 [ 'ipb_parent_block_id' => $this->getId() ],
668 $dbw->endAtomic( __METHOD__
);
671 $auto_ipd_ids = $this->doRetroactiveAutoblock();
672 return [ 'id' => $this->mId
, 'autoIds' => $auto_ipd_ids ];
679 * Get an array suitable for passing to $dbw->insert() or $dbw->update()
680 * @param IDatabase $dbw
683 protected function getDatabaseArray( IDatabase
$dbw ) {
684 $expiry = $dbw->encodeExpiry( $this->getExpiry() );
686 if ( $this->forcedTargetID
) {
687 $uid = $this->forcedTargetID
;
689 $uid = $this->target
instanceof User ?
$this->target
->getId() : 0;
693 'ipb_address' => (string)$this->target
,
695 'ipb_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
696 'ipb_auto' => $this->mAuto
,
697 'ipb_anon_only' => !$this->isHardblock(),
698 'ipb_create_account' => $this->isCreateAccountBlocked(),
699 'ipb_enable_autoblock' => $this->isAutoblocking(),
700 'ipb_expiry' => $expiry,
701 'ipb_range_start' => $this->getRangeStart(),
702 'ipb_range_end' => $this->getRangeEnd(),
703 'ipb_deleted' => intval( $this->getHideName() ), // typecast required for SQLite
704 'ipb_block_email' => $this->isEmailBlocked(),
705 'ipb_allow_usertalk' => $this->isUsertalkEditAllowed(),
706 'ipb_parent_block_id' => $this->mParentBlockId
,
707 'ipb_sitewide' => $this->isSitewide(),
708 ] + CommentStore
::getStore()->insert( $dbw, 'ipb_reason', $this->getReason() )
709 + ActorMigration
::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
715 * @param IDatabase $dbw
718 protected function getAutoblockUpdateArray( IDatabase
$dbw ) {
720 'ipb_create_account' => $this->isCreateAccountBlocked(),
721 'ipb_deleted' => (int)$this->getHideName(), // typecast required for SQLite
722 'ipb_allow_usertalk' => $this->isUsertalkEditAllowed(),
723 'ipb_sitewide' => $this->isSitewide(),
724 ] + CommentStore
::getStore()->insert( $dbw, 'ipb_reason', $this->getReason() )
725 + ActorMigration
::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
729 * Retroactively autoblocks the last IP used by the user (if it is a user)
730 * blocked by this Block.
732 * @return array Block IDs of retroactive autoblocks made
734 protected function doRetroactiveAutoblock() {
736 # If autoblock is enabled, autoblock the LAST IP(s) used
737 if ( $this->isAutoblocking() && $this->getType() == self
::TYPE_USER
) {
738 wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
740 $continue = Hooks
::run(
741 'PerformRetroactiveAutoblock', [ $this, &$blockIds ] );
744 self
::defaultRetroactiveAutoblock( $this, $blockIds );
751 * Retroactively autoblocks the last IP used by the user (if it is a user)
752 * blocked by this Block. This will use the recentchanges table.
754 * @param Block $block
755 * @param array &$blockIds
757 protected static function defaultRetroactiveAutoblock( Block
$block, array &$blockIds ) {
760 // No IPs are in recentchanges table, so nothing to select
761 if ( !$wgPutIPinRC ) {
765 // Autoblocks only apply to TYPE_USER
766 if ( $block->getType() !== self
::TYPE_USER
) {
769 $target = $block->getTarget(); // TYPE_USER => always a User object
771 $dbr = wfGetDB( DB_REPLICA
);
772 $rcQuery = ActorMigration
::newMigration()->getWhere( $dbr, 'rc_user', $target, false );
774 $options = [ 'ORDER BY' => 'rc_timestamp DESC' ];
776 // Just the last IP used.
777 $options['LIMIT'] = 1;
780 [ 'recentchanges' ] +
$rcQuery['tables'],
788 if ( !$res->numRows() ) {
789 # No results, don't autoblock anything
790 wfDebug( "No IP found to retroactively autoblock\n" );
792 foreach ( $res as $row ) {
794 $id = $block->doAutoblock( $row->rc_ip
);
804 * Checks whether a given IP is on the autoblock whitelist.
805 * TODO: this probably belongs somewhere else, but not sure where...
807 * @param string $ip The IP to check
810 public static function isWhitelistedFromAutoblocks( $ip ) {
811 // Try to get the autoblock_whitelist from the cache, as it's faster
812 // than getting the msg raw and explode()'ing it.
813 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
814 $lines = $cache->getWithSetCallback(
815 $cache->makeKey( 'ip-autoblock', 'whitelist' ),
817 function ( $curValue, &$ttl, array &$setOpts ) {
818 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
820 return explode( "\n",
821 wfMessage( 'autoblock_whitelist' )->inContentLanguage()->plain() );
825 wfDebug( "Checking the autoblock whitelist..\n" );
827 foreach ( $lines as $line ) {
829 if ( substr( $line, 0, 1 ) !== '*' ) {
833 $wlEntry = substr( $line, 1 );
834 $wlEntry = trim( $wlEntry );
836 wfDebug( "Checking $ip against $wlEntry..." );
838 # Is the IP in this range?
839 if ( IP
::isInRange( $ip, $wlEntry ) ) {
840 wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
843 wfDebug( " No match\n" );
851 * Autoblocks the given IP, referring to this Block.
853 * @param string $autoblockIP The IP to autoblock.
854 * @return int|bool Block ID if an autoblock was inserted, false if not.
856 public function doAutoblock( $autoblockIP ) {
857 # If autoblocks are disabled, go away.
858 if ( !$this->isAutoblocking() ) {
862 # Don't autoblock for system blocks
863 if ( $this->getSystemBlockType() !== null ) {
864 throw new MWException( 'Cannot autoblock from a system block' );
867 # Check for presence on the autoblock whitelist.
868 if ( self
::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
872 // Avoid PHP 7.1 warning of passing $this by reference
874 # Allow hooks to cancel the autoblock.
875 if ( !Hooks
::run( 'AbortAutoblock', [ $autoblockIP, &$block ] ) ) {
876 wfDebug( "Autoblock aborted by hook.\n" );
880 # It's okay to autoblock. Go ahead and insert/update the block...
882 # Do not add a *new* block if the IP is already blocked.
883 $ipblock = self
::newFromTarget( $autoblockIP );
885 # Check if the block is an autoblock and would exceed the user block
886 # if renewed. If so, do nothing, otherwise prolong the block time...
887 if ( $ipblock->mAuto
&& // @todo Why not compare $ipblock->mExpiry?
888 $this->getExpiry() > self
::getAutoblockExpiry( $ipblock->getTimestamp() )
890 # Reset block timestamp to now and its expiry to
891 # $wgAutoblockExpiry in the future
892 $ipblock->updateTimestamp();
897 # Make a new block object with the desired properties.
898 $autoblock = new Block
;
899 wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
900 $autoblock->setTarget( $autoblockIP );
901 $autoblock->setBlocker( $this->getBlocker() );
902 $autoblock->setReason(
903 wfMessage( 'autoblocker', $this->getTarget(), $this->getReason() )
904 ->inContentLanguage()->plain()
906 $timestamp = wfTimestampNow();
907 $autoblock->setTimestamp( $timestamp );
908 $autoblock->mAuto
= 1;
909 $autoblock->isCreateAccountBlocked( $this->isCreateAccountBlocked() );
910 # Continue suppressing the name if needed
911 $autoblock->setHideName( $this->getHideName() );
912 $autoblock->isUsertalkEditAllowed( $this->isUsertalkEditAllowed() );
913 $autoblock->mParentBlockId
= $this->mId
;
914 $autoblock->isSitewide( $this->isSitewide() );
915 $autoblock->setRestrictions( $this->getRestrictions() );
917 if ( $this->getExpiry() == 'infinity' ) {
918 # Original block was indefinite, start an autoblock now
919 $autoblock->setExpiry( self
::getAutoblockExpiry( $timestamp ) );
921 # If the user is already blocked with an expiry date, we don't
922 # want to pile on top of that.
923 $autoblock->setExpiry( min( $this->getExpiry(), self
::getAutoblockExpiry( $timestamp ) ) );
926 # Insert the block...
927 $status = $autoblock->insert();
934 * Check if a block has expired. Delete it if it is.
937 public function deleteIfExpired() {
938 if ( $this->isExpired() ) {
939 wfDebug( "Block::deleteIfExpired() -- deleting\n" );
943 wfDebug( "Block::deleteIfExpired() -- not expired\n" );
951 * Has the block expired?
954 public function isExpired() {
955 $timestamp = wfTimestampNow();
956 wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" );
958 if ( !$this->getExpiry() ) {
961 return $timestamp > $this->getExpiry();
966 * Is the block address valid (i.e. not a null string?)
968 * @deprecated since 1.33 No longer needed in core.
971 public function isValid() {
972 wfDeprecated( __METHOD__
, '1.33' );
973 return $this->getTarget() != null;
977 * Update the timestamp on autoblocks.
979 public function updateTimestamp() {
980 if ( $this->mAuto
) {
981 $this->setTimestamp( wfTimestamp() );
982 $this->setExpiry( self
::getAutoblockExpiry( $this->getTimestamp() ) );
984 $dbw = wfGetDB( DB_MASTER
);
985 $dbw->update( 'ipblocks',
987 'ipb_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
988 'ipb_expiry' => $dbw->timestamp( $this->getExpiry() ),
991 'ipb_id' => $this->getId(),
999 * Get the IP address at the start of the range in Hex form
1000 * @throws MWException
1001 * @return string IP in Hex form
1003 public function getRangeStart() {
1004 switch ( $this->type
) {
1005 case self
::TYPE_USER
:
1008 return IP
::toHex( $this->target
);
1009 case self
::TYPE_RANGE
:
1010 list( $start, /*...*/ ) = IP
::parseRange( $this->target
);
1013 throw new MWException( "Block with invalid type" );
1018 * Get the IP address at the end of the range in Hex form
1019 * @throws MWException
1020 * @return string IP in Hex form
1022 public function getRangeEnd() {
1023 switch ( $this->type
) {
1024 case self
::TYPE_USER
:
1027 return IP
::toHex( $this->target
);
1028 case self
::TYPE_RANGE
:
1029 list( /*...*/, $end ) = IP
::parseRange( $this->target
);
1032 throw new MWException( "Block with invalid type" );
1037 * Get the user id of the blocking sysop
1039 * @return int (0 for foreign users)
1041 public function getBy() {
1042 return $this->getBlocker()->getId();
1046 * Get the username of the blocking sysop
1050 public function getByName() {
1051 return $this->getBlocker()->getName();
1058 public function getId() {
1065 * @param int $blockId
1068 private function setId( $blockId ) {
1069 $this->mId
= (int)$blockId;
1071 if ( is_array( $this->restrictions
) ) {
1072 $this->restrictions
= $this->getBlockRestrictionStore()->setBlockId(
1073 $blockId, $this->restrictions
1081 * Get the reason given for creating the block
1086 public function getReason() {
1087 return $this->mReason
;
1091 * Set the reason for creating the block
1094 * @param string $reason
1096 public function setReason( $reason ) {
1097 $this->mReason
= $reason;
1101 * Get whether the block hides the target's username
1104 * @return bool The block hides the username
1106 public function getHideName() {
1107 return $this->mHideName
;
1111 * Set whether ths block hides the target's username
1114 * @param bool $hideName The block hides the username
1116 public function setHideName( $hideName ) {
1117 $this->mHideName
= $hideName;
1121 * Get the system block type, if any
1123 * @return string|null
1125 public function getSystemBlockType() {
1126 return $this->systemBlockType
;
1130 * Get/set a flag determining whether the master is used for reads
1132 * @param bool|null $x
1135 public function fromMaster( $x = null ) {
1136 return wfSetVar( $this->mFromMaster
, $x );
1140 * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range)
1141 * @param bool|null $x
1144 public function isHardblock( $x = null ) {
1145 wfSetVar( $this->isHardblock
, $x );
1147 # You can't *not* hardblock a user
1148 return $this->getType() == self
::TYPE_USER
1150 : $this->isHardblock
;
1154 * @param null|bool $x
1157 public function isAutoblocking( $x = null ) {
1158 wfSetVar( $this->isAutoblocking
, $x );
1160 # You can't put an autoblock on an IP or range as we don't have any history to
1161 # look over to get more IPs from
1162 return $this->getType() == self
::TYPE_USER
1163 ?
$this->isAutoblocking
1168 * Indicates that the block is a sitewide block. This means the user is
1169 * prohibited from editing any page on the site (other than their own talk
1173 * @param null|bool $x
1176 public function isSitewide( $x = null ) {
1177 return wfSetVar( $this->isSitewide
, $x );
1181 * Get or set the flag indicating whether this block blocks the target from
1182 * creating an account. (Note that the flag may be overridden depending on
1186 * @param null|bool $x Value to set (if null, just get the property value)
1187 * @return bool Value of the property
1189 public function isCreateAccountBlocked( $x = null ) {
1190 return wfSetVar( $this->blockCreateAccount
, $x );
1194 * Get or set the flag indicating whether this block blocks the target from
1195 * sending emails. (Note that the flag may be overridden depending on
1199 * @param null|bool $x Value to set (if null, just get the property value)
1200 * @return bool Value of the property
1202 public function isEmailBlocked( $x = null ) {
1203 return wfSetVar( $this->mBlockEmail
, $x );
1207 * Get or set the flag indicating whether this block blocks the target from
1208 * editing their own user talk page. (Note that the flag may be overridden
1209 * depending on global configs.)
1212 * @param null|bool $x Value to set (if null, just get the property value)
1213 * @return bool Value of the property
1215 public function isUsertalkEditAllowed( $x = null ) {
1216 return wfSetVar( $this->allowUsertalk
, $x );
1220 * Determine whether the Block prevents a given right. A right
1221 * may be blacklisted or whitelisted, or determined from a
1222 * property on the Block object. For certain rights, the property
1223 * may be overridden according to global configs.
1226 * @param string $right Right to check
1227 * @return bool|null null if unrecognized right or unset property
1229 public function appliesToRight( $right ) {
1230 $config = RequestContext
::getMain()->getConfig();
1231 $blockDisablesLogin = $config->get( 'BlockDisablesLogin' );
1236 // TODO: fix this case to return proper value
1239 case 'createaccount':
1240 $res = $this->isCreateAccountBlocked();
1243 $res = $this->isEmailBlocked();
1246 // Until T6995 is completed
1247 $res = $this->isSitewide();
1256 if ( !$res && $blockDisablesLogin ) {
1257 // If a block would disable login, then it should
1258 // prevent any right that all users cannot do
1260 $res = $anon->isAllowed( $right ) ?
$res : true;
1267 * Get/set whether the Block prevents a given action
1269 * @deprecated since 1.33, use appliesToRight to determine block
1270 * behaviour, and specific methods to get/set properties
1271 * @param string $action Action to check
1272 * @param bool|null $x Value for set, or null to just get value
1273 * @return bool|null Null for unrecognized rights.
1275 public function prevents( $action, $x = null ) {
1276 $config = RequestContext
::getMain()->getConfig();
1277 $blockDisablesLogin = $config->get( 'BlockDisablesLogin' );
1278 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1281 switch ( $action ) {
1283 # For now... <evil laugh>
1286 case 'createaccount':
1287 $res = wfSetVar( $this->blockCreateAccount
, $x );
1290 $res = wfSetVar( $this->mBlockEmail
, $x );
1293 // Until T6995 is completed
1294 $res = $this->isSitewide();
1296 case 'editownusertalk':
1297 // NOTE: this check is not reliable on partial blocks
1298 // since partially blocked users are always allowed to edit
1299 // their own talk page unless a restriction exists on the
1300 // page or User_talk: namespace
1301 wfSetVar( $this->allowUsertalk
, $x === null ?
null : !$x );
1302 $res = !$this->isUsertalkEditAllowed();
1304 // edit own user talk can be disabled by config
1305 if ( !$blockAllowsUTEdit ) {
1316 if ( !$res && $blockDisablesLogin ) {
1317 // If a block would disable login, then it should
1318 // prevent any action that all users cannot do
1320 $res = $anon->isAllowed( $action ) ?
$res : true;
1327 * Get the block name, but with autoblocked IPs hidden as per standard privacy policy
1328 * @return string Text is escaped
1330 public function getRedactedName() {
1331 if ( $this->mAuto
) {
1332 return Html
::element(
1334 [ 'class' => 'mw-autoblockid' ],
1335 wfMessage( 'autoblockid', $this->mId
)->text()
1338 return htmlspecialchars( $this->getTarget() );
1343 * Get a timestamp of the expiry for autoblocks
1345 * @param string|int $timestamp
1348 public static function getAutoblockExpiry( $timestamp ) {
1349 global $wgAutoblockExpiry;
1351 return wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $timestamp ) +
$wgAutoblockExpiry );
1355 * Purge expired blocks from the ipblocks table
1357 public static function purgeExpired() {
1358 if ( wfReadOnly() ) {
1362 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
1363 wfGetDB( DB_MASTER
),
1365 function ( IDatabase
$dbw, $fname ) {
1366 $ids = $dbw->selectFieldValues( 'ipblocks',
1368 [ 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
1372 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
1373 $blockRestrictionStore->deleteByBlockId( $ids );
1375 $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], $fname );
1382 * Given a target and the target's type, get an existing Block object if possible.
1383 * @param string|User|int $specificTarget A block target, which may be one of several types:
1384 * * A user to block, in which case $target will be a User
1385 * * An IP to block, in which case $target will be a User generated by using
1386 * User::newFromName( $ip, false ) to turn off name validation
1387 * * An IP range, in which case $target will be a String "123.123.123.123/18" etc
1388 * * The ID of an existing block, in the format "#12345" (since pure numbers are valid
1390 * Calling this with a user, IP address or range will not select autoblocks, and will
1391 * only select a block where the targets match exactly (so looking for blocks on
1392 * 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
1393 * @param string|User|int|null $vagueTarget As above, but we will search for *any* block which
1394 * affects that target (so for an IP address, get ranges containing that IP; and also
1395 * get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
1396 * @param bool $fromMaster Whether to use the DB_MASTER database
1397 * @return Block|null (null if no relevant block could be found). The target and type
1398 * of the returned Block will refer to the actual block which was found, which might
1399 * not be the same as the target you gave if you used $vagueTarget!
1401 public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
1402 list( $target, $type ) = self
::parseTarget( $specificTarget );
1403 if ( $type == self
::TYPE_ID ||
$type == self
::TYPE_AUTO
) {
1404 return self
::newFromID( $target );
1406 } elseif ( $target === null && $vagueTarget == '' ) {
1407 # We're not going to find anything useful here
1408 # Be aware that the == '' check is explicit, since empty values will be
1409 # passed by some callers (T31116)
1412 } elseif ( in_array(
1414 [ self
::TYPE_USER
, self
::TYPE_IP
, self
::TYPE_RANGE
, null ] )
1416 $block = new Block();
1417 $block->fromMaster( $fromMaster );
1419 if ( $type !== null ) {
1420 $block->setTarget( $target );
1423 if ( $block->newLoad( $vagueTarget ) ) {
1431 * Get all blocks that match any IP from an array of IP addresses
1433 * @param array $ipChain List of IPs (strings), usually retrieved from the
1434 * X-Forwarded-For header of the request
1435 * @param bool $isAnon Exclude anonymous-only blocks if false
1436 * @param bool $fromMaster Whether to query the master or replica DB
1437 * @return array Array of Blocks
1440 public static function getBlocksForIPList( array $ipChain, $isAnon, $fromMaster = false ) {
1441 if ( $ipChain === [] ) {
1446 $proxyLookup = MediaWikiServices
::getInstance()->getProxyLookup();
1447 foreach ( array_unique( $ipChain ) as $ipaddr ) {
1448 # Discard invalid IP addresses. Since XFF can be spoofed and we do not
1449 # necessarily trust the header given to us, make sure that we are only
1450 # checking for blocks on well-formatted IP addresses (IPv4 and IPv6).
1451 # Do not treat private IP spaces as special as it may be desirable for wikis
1452 # to block those IP ranges in order to stop misbehaving proxies that spoof XFF.
1453 if ( !IP
::isValid( $ipaddr ) ) {
1456 # Don't check trusted IPs (includes local squids which will be in every request)
1457 if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) {
1460 # Check both the original IP (to check against single blocks), as well as build
1461 # the clause to check for rangeblocks for the given IP.
1462 $conds['ipb_address'][] = $ipaddr;
1463 $conds[] = self
::getRangeCond( IP
::toHex( $ipaddr ) );
1466 if ( $conds === [] ) {
1470 if ( $fromMaster ) {
1471 $db = wfGetDB( DB_MASTER
);
1473 $db = wfGetDB( DB_REPLICA
);
1475 $conds = $db->makeList( $conds, LIST_OR
);
1477 $conds = [ $conds, 'ipb_anon_only' => 0 ];
1479 $blockQuery = self
::getQueryInfo();
1480 $rows = $db->select(
1481 $blockQuery['tables'],
1482 array_merge( [ 'ipb_range_start', 'ipb_range_end' ], $blockQuery['fields'] ),
1486 $blockQuery['joins']
1490 foreach ( $rows as $row ) {
1491 $block = self
::newFromRow( $row );
1492 if ( !$block->isExpired() ) {
1501 * From a list of multiple blocks, find the most exact and strongest Block.
1503 * The logic for finding the "best" block is:
1504 * - Blocks that match the block's target IP are preferred over ones in a range
1505 * - Hardblocks are chosen over softblocks that prevent account creation
1506 * - Softblocks that prevent account creation are chosen over other softblocks
1507 * - Other softblocks are chosen over autoblocks
1508 * - If there are multiple exact or range blocks at the same level, the one chosen
1510 * This should be used when $blocks where retrieved from the user's IP address
1511 * and $ipChain is populated from the same IP address information.
1513 * @param array $blocks Array of Block objects
1514 * @param array $ipChain List of IPs (strings). This is used to determine how "close"
1515 * a block is to the server, and if a block matches exactly, or is in a range.
1516 * The order is furthest from the server to nearest e.g., (Browser, proxy1, proxy2,
1518 * @throws MWException
1519 * @return Block|null The "best" block from the list
1521 public static function chooseBlock( array $blocks, array $ipChain ) {
1522 if ( $blocks === [] ) {
1524 } elseif ( count( $blocks ) == 1 ) {
1528 // Sort hard blocks before soft ones and secondarily sort blocks
1529 // that disable account creation before those that don't.
1530 usort( $blocks, function ( Block
$a, Block
$b ) {
1531 $aWeight = (int)$a->isHardblock() . (int)$a->appliesToRight( 'createaccount' );
1532 $bWeight = (int)$b->isHardblock() . (int)$b->appliesToRight( 'createaccount' );
1533 return strcmp( $bWeight, $aWeight ); // highest weight first
1536 $blocksListExact = [
1538 'disable_create' => false,
1542 $blocksListRange = [
1544 'disable_create' => false,
1548 $ipChain = array_reverse( $ipChain );
1550 /** @var Block $block */
1551 foreach ( $blocks as $block ) {
1552 // Stop searching if we have already have a "better" block. This
1553 // is why the order of the blocks matters
1554 if ( !$block->isHardblock() && $blocksListExact['hard'] ) {
1556 } elseif ( !$block->appliesToRight( 'createaccount' ) && $blocksListExact['disable_create'] ) {
1560 foreach ( $ipChain as $checkip ) {
1561 $checkipHex = IP
::toHex( $checkip );
1562 if ( (string)$block->getTarget() === $checkip ) {
1563 if ( $block->isHardblock() ) {
1564 $blocksListExact['hard'] = $blocksListExact['hard'] ?
: $block;
1565 } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1566 $blocksListExact['disable_create'] = $blocksListExact['disable_create'] ?
: $block;
1567 } elseif ( $block->mAuto
) {
1568 $blocksListExact['auto'] = $blocksListExact['auto'] ?
: $block;
1570 $blocksListExact['other'] = $blocksListExact['other'] ?
: $block;
1572 // We found closest exact match in the ip list, so go to the next Block
1574 } elseif ( array_filter( $blocksListExact ) == []
1575 && $block->getRangeStart() <= $checkipHex
1576 && $block->getRangeEnd() >= $checkipHex
1578 if ( $block->isHardblock() ) {
1579 $blocksListRange['hard'] = $blocksListRange['hard'] ?
: $block;
1580 } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1581 $blocksListRange['disable_create'] = $blocksListRange['disable_create'] ?
: $block;
1582 } elseif ( $block->mAuto
) {
1583 $blocksListRange['auto'] = $blocksListRange['auto'] ?
: $block;
1585 $blocksListRange['other'] = $blocksListRange['other'] ?
: $block;
1592 if ( array_filter( $blocksListExact ) == [] ) {
1593 $blocksList = &$blocksListRange;
1595 $blocksList = &$blocksListExact;
1598 $chosenBlock = null;
1599 if ( $blocksList['hard'] ) {
1600 $chosenBlock = $blocksList['hard'];
1601 } elseif ( $blocksList['disable_create'] ) {
1602 $chosenBlock = $blocksList['disable_create'];
1603 } elseif ( $blocksList['other'] ) {
1604 $chosenBlock = $blocksList['other'];
1605 } elseif ( $blocksList['auto'] ) {
1606 $chosenBlock = $blocksList['auto'];
1608 throw new MWException( "Proxy block found, but couldn't be classified." );
1611 return $chosenBlock;
1615 * From an existing Block, get the target and the type of target.
1616 * Note that, except for null, it is always safe to treat the target
1617 * as a string; for User objects this will return User::__toString()
1618 * which in turn gives User::getName().
1620 * @param string|int|User|null $target
1621 * @return array [ User|String|null, Block::TYPE_ constant|null ]
1623 public static function parseTarget( $target ) {
1624 # We may have been through this before
1625 if ( $target instanceof User
) {
1626 if ( IP
::isValid( $target->getName() ) ) {
1627 return [ $target, self
::TYPE_IP
];
1629 return [ $target, self
::TYPE_USER
];
1631 } elseif ( $target === null ) {
1632 return [ null, null ];
1635 $target = trim( $target );
1637 if ( IP
::isValid( $target ) ) {
1638 # We can still create a User if it's an IP address, but we need to turn
1639 # off validation checking (which would exclude IP addresses)
1641 User
::newFromName( IP
::sanitizeIP( $target ), false ),
1645 } elseif ( IP
::isValidRange( $target ) ) {
1646 # Can't create a User from an IP range
1647 return [ IP
::sanitizeRange( $target ), self
::TYPE_RANGE
];
1650 # Consider the possibility that this is not a username at all
1651 # but actually an old subpage (T31797)
1652 if ( strpos( $target, '/' ) !== false ) {
1653 # An old subpage, drill down to the user behind it
1654 $target = explode( '/', $target )[0];
1657 $userObj = User
::newFromName( $target );
1658 if ( $userObj instanceof User
) {
1659 # Note that since numbers are valid usernames, a $target of "12345" will be
1660 # considered a User. If you want to pass a block ID, prepend a hash "#12345",
1661 # since hash characters are not valid in usernames or titles generally.
1662 return [ $userObj, self
::TYPE_USER
];
1664 } elseif ( preg_match( '/^#\d+$/', $target ) ) {
1665 # Autoblock reference in the form "#12345"
1666 return [ substr( $target, 1 ), self
::TYPE_AUTO
];
1670 return [ null, null ];
1675 * Get the type of target for this particular block. Autoblocks have whichever type
1676 * corresponds to their target, so to detect if a block is an autoblock, we have to
1677 * check the mAuto property instead.
1678 * @return int Block::TYPE_ constant, will never be TYPE_ID
1680 public function getType() {
1687 * Get the target and target type for this particular Block. Note that for autoblocks,
1688 * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1689 * in this situation.
1690 * @return array [ User|String, Block::TYPE_ constant ]
1691 * @todo FIXME: This should be an integral part of the Block member variables
1693 public function getTargetAndType() {
1694 return [ $this->getTarget(), $this->getType() ];
1698 * Get the target for this particular Block. Note that for autoblocks,
1699 * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1700 * in this situation.
1701 * @return User|string
1703 public function getTarget() {
1704 return $this->target
;
1708 * Get the block expiry time
1713 public function getExpiry() {
1714 return $this->mExpiry
;
1718 * Set the block expiry time
1721 * @param string $expiry
1723 public function setExpiry( $expiry ) {
1724 $this->mExpiry
= $expiry;
1728 * Get the timestamp indicating when the block was created
1733 public function getTimestamp() {
1734 return $this->mTimestamp
;
1738 * Set the timestamp indicating when the block was created
1741 * @param string $timestamp
1743 public function setTimestamp( $timestamp ) {
1744 $this->mTimestamp
= $timestamp;
1748 * Set the target for this block, and update $this->type accordingly
1749 * @param mixed $target
1751 public function setTarget( $target ) {
1752 list( $this->target
, $this->type
) = self
::parseTarget( $target );
1756 * Get the user who implemented this block
1757 * @return User User object. May name a foreign user.
1759 public function getBlocker() {
1760 return $this->blocker
;
1764 * Set the user who implemented (or will implement) this block
1765 * @param User|string $user Local User object or username string
1767 public function setBlocker( $user ) {
1768 if ( is_string( $user ) ) {
1769 $user = User
::newFromName( $user, false );
1772 if ( $user->isAnon() && User
::isUsableName( $user->getName() ) ) {
1773 throw new InvalidArgumentException(
1774 'Blocker must be a local user or a name that cannot be a local user'
1778 $this->blocker
= $user;
1782 * Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be
1783 * the same as the block's, to a maximum of 24 hours.
1787 * @param WebResponse $response The response on which to set the cookie.
1789 public function setCookie( WebResponse
$response ) {
1790 // Calculate the default expiry time.
1791 $maxExpiryTime = wfTimestamp( TS_MW
, wfTimestamp() +
( 24 * 60 * 60 ) );
1793 // Use the Block's expiry time only if it's less than the default.
1794 $expiryTime = $this->getExpiry();
1795 if ( $expiryTime === 'infinity' ||
$expiryTime > $maxExpiryTime ) {
1796 $expiryTime = $maxExpiryTime;
1799 // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie.
1800 $expiryValue = DateTime
::createFromFormat( 'YmdHis', $expiryTime )->format( 'U' );
1801 $cookieOptions = [ 'httpOnly' => false ];
1802 $cookieValue = $this->getCookieValue();
1803 $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions );
1807 * Unset the 'BlockID' cookie.
1811 * @param WebResponse $response The response on which to unset the cookie.
1813 public static function clearCookie( WebResponse
$response ) {
1814 $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
1818 * Get the BlockID cookie's value for this block. This is usually the block ID concatenated
1819 * with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just
1824 * @return string The block ID, probably concatenated with "!" and the HMAC.
1826 public function getCookieValue() {
1827 $config = RequestContext
::getMain()->getConfig();
1828 $id = $this->getId();
1829 $secretKey = $config->get( 'SecretKey' );
1830 if ( !$secretKey ) {
1831 // If there's no secret key, don't append a HMAC.
1834 $hmac = MWCryptHash
::hmac( $id, $secretKey, false );
1835 $cookieValue = $id . '!' . $hmac;
1836 return $cookieValue;
1840 * Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of
1841 * the ID and a HMAC (see Block::setCookie), but will sometimes only be the ID.
1845 * @param string $cookieValue The string in which to find the ID.
1847 * @return int|null The block ID, or null if the HMAC is present and invalid.
1849 public static function getIdFromCookieValue( $cookieValue ) {
1850 // Extract the ID prefix from the cookie value (may be the whole value, if no bang found).
1851 $bangPos = strpos( $cookieValue, '!' );
1852 $id = ( $bangPos === false ) ?
$cookieValue : substr( $cookieValue, 0, $bangPos );
1853 // Get the site-wide secret key.
1854 $config = RequestContext
::getMain()->getConfig();
1855 $secretKey = $config->get( 'SecretKey' );
1856 if ( !$secretKey ) {
1857 // If there's no secret key, just use the ID as given.
1860 $storedHmac = substr( $cookieValue, $bangPos +
1 );
1861 $calculatedHmac = MWCryptHash
::hmac( $id, $secretKey, false );
1862 if ( $calculatedHmac === $storedHmac ) {
1870 * Get the key and parameters for the corresponding error message.
1873 * @param IContextSource $context
1876 public function getPermissionsError( IContextSource
$context ) {
1877 $params = $this->getBlockErrorParams( $context );
1879 $msg = 'blockedtext';
1880 if ( $this->getSystemBlockType() !== null ) {
1881 $msg = 'systemblockedtext';
1882 } elseif ( $this->mAuto
) {
1883 $msg = 'autoblockedtext';
1884 } elseif ( !$this->isSitewide() ) {
1885 $msg = 'blockedtext-partial';
1888 array_unshift( $params, $msg );
1894 * Get block information used in different block error messages
1897 * @param IContextSource $context
1900 public function getBlockErrorParams( IContextSource
$context ) {
1901 $blocker = $this->getBlocker();
1902 if ( $blocker instanceof User
) { // local user
1903 $blockerUserpage = $blocker->getUserPage();
1904 $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
1905 } else { // foreign user
1909 $reason = $this->getReason();
1910 if ( $reason == '' ) {
1911 $reason = $context->msg( 'blockednoreason' )->text();
1914 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1915 * This could be a username, an IP range, or a single IP. */
1916 $intended = $this->getTarget();
1917 $systemBlockType = $this->getSystemBlockType();
1918 $lang = $context->getLanguage();
1923 $context->getRequest()->getIP(),
1925 $systemBlockType ??
$this->getId(),
1926 $lang->formatExpiry( $this->getExpiry() ),
1928 $lang->userTimeAndDate( $this->getTimestamp(), $context->getUser() ),
1935 * Getting the restrictions will perform a database query if the restrictions
1936 * are not already loaded.
1939 * @return Restriction[]
1941 public function getRestrictions() {
1942 if ( $this->restrictions
=== null ) {
1943 // If the block id has not been set, then do not attempt to load the
1945 if ( !$this->mId
) {
1948 $this->restrictions
= $this->getBlockRestrictionStore()->loadByBlockId( $this->mId
);
1951 return $this->restrictions
;
1958 * @param Restriction[] $restrictions
1961 public function setRestrictions( array $restrictions ) {
1962 $this->restrictions
= array_filter( $restrictions, function ( $restriction ) {
1963 return $restriction instanceof Restriction
;
1970 * Determine whether the block allows the user to edit their own
1971 * user talk page. This is done separately from Block::appliesToRight
1972 * because there is no right for editing one's own user talk page
1973 * and because the user's talk page needs to be passed into the
1974 * Block object, which is unaware of the user.
1976 * The ipb_allow_usertalk flag (which corresponds to the property
1977 * allowUsertalk) is used on sitewide blocks and partial blocks
1978 * that contain a namespace restriction on the user talk namespace,
1979 * but do not contain a page restriction on the user's talk page.
1980 * For all other (i.e. most) partial blocks, the flag is ignored,
1981 * and the user can always edit their user talk page unless there
1982 * is a page restriction on their user talk page, in which case
1983 * they can never edit it. (Ideally the flag would be stored as
1984 * null in these cases, but the database field isn't nullable.)
1986 * This method does not validate that the passed in talk page belongs to the
1987 * block target since the target (an IP) might not be the same as the user's
1988 * talk page (if they are logged in).
1991 * @param Title|null $usertalk The user's user talk page. If null,
1992 * and if the target is a User, the target's userpage is used
1993 * @return bool The user can edit their talk page
1995 public function appliesToUsertalk( Title
$usertalk = null ) {
1997 if ( $this->target
instanceof User
) {
1998 $usertalk = $this->target
->getTalkPage();
2000 throw new InvalidArgumentException(
2001 '$usertalk must be provided if block target is not a user/IP'
2006 if ( $usertalk->getNamespace() !== NS_USER_TALK
) {
2007 throw new InvalidArgumentException(
2008 '$usertalk must be a user talk page'
2012 if ( !$this->isSitewide() ) {
2013 if ( $this->appliesToPage( $usertalk->getArticleID() ) ) {
2016 if ( !$this->appliesToNamespace( NS_USER_TALK
) ) {
2021 // This is a type of block which uses the ipb_allow_usertalk
2022 // flag. The flag can still be overridden by global configs.
2023 $config = RequestContext
::getMain()->getConfig();
2024 if ( !$config->get( 'BlockAllowsUTEdit' ) ) {
2027 return !$this->isUsertalkEditAllowed();
2031 * Checks if a block applies to a particular title
2033 * This check does not consider whether `$this->isUsertalkEditAllowed`
2034 * returns false, as the identity of the user making the hypothetical edit
2035 * isn't known here (particularly in the case of IP hardblocks, range
2036 * blocks, and auto-blocks).
2038 * @param Title $title
2041 public function appliesToTitle( Title
$title ) {
2042 if ( $this->isSitewide() ) {
2046 $restrictions = $this->getRestrictions();
2047 foreach ( $restrictions as $restriction ) {
2048 if ( $restriction->matches( $title ) ) {
2057 * Checks if a block applies to a particular namespace
2064 public function appliesToNamespace( $ns ) {
2065 if ( $this->isSitewide() ) {
2069 // Blocks do not apply to virtual namespaces.
2074 $restriction = $this->findRestriction( NamespaceRestriction
::TYPE
, $ns );
2076 return (bool)$restriction;
2080 * Checks if a block applies to a particular page
2082 * This check does not consider whether `$this->isUsertalkEditAllowed`
2083 * returns false, as the identity of the user making the hypothetical edit
2084 * isn't known here (particularly in the case of IP hardblocks, range
2085 * blocks, and auto-blocks).
2089 * @param int $pageId
2092 public function appliesToPage( $pageId ) {
2093 if ( $this->isSitewide() ) {
2097 // If the pageId is not over zero, the block cannot apply to it.
2098 if ( $pageId <= 0 ) {
2102 $restriction = $this->findRestriction( PageRestriction
::TYPE
, $pageId );
2104 return (bool)$restriction;
2108 * Find Restriction by type and value.
2110 * @param string $type
2112 * @return Restriction|null
2114 private function findRestriction( $type, $value ) {
2115 $restrictions = $this->getRestrictions();
2116 foreach ( $restrictions as $restriction ) {
2117 if ( $restriction->getType() !== $type ) {
2121 if ( $restriction->getValue() === $value ) {
2122 return $restriction;
2130 * Check if the block should be tracked with a cookie.
2133 * @param bool $isAnon The user is logged out
2134 * @return bool The block should be tracked with a cookie
2136 public function shouldTrackWithCookie( $isAnon ) {
2137 $config = RequestContext
::getMain()->getConfig();
2138 switch ( $this->getType() ) {
2140 case self
::TYPE_RANGE
:
2141 return $isAnon && $config->get( 'CookieSetOnIpBlock' );
2142 case self
::TYPE_USER
:
2143 return !$isAnon && $config->get( 'CookieSetOnAutoblock' ) && $this->isAutoblocking();
2150 * Check if the block prevents a user from resetting their password
2153 * @return bool The block blocks password reset
2155 public function appliesToPasswordReset() {
2156 switch ( $this->getSystemBlockType() ) {
2158 case 'global-block':
2159 return $this->isCreateAccountBlocked();
2163 case 'wgSoftBlockRanges':
2171 * Get a BlockRestrictionStore instance
2173 * @return BlockRestrictionStore
2175 private function getBlockRestrictionStore() : BlockRestrictionStore
{
2176 return MediaWikiServices
::getInstance()->getBlockRestrictionStore();