includes/Block.php

   1 <?php
   2 /**
   3  * Blocks and bans object
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use Wikimedia\Rdbms\Database;
  24 use Wikimedia\Rdbms\IDatabase;
  25 use MediaWiki\Block\BlockRestriction;
  26 use MediaWiki\Block\Restriction\Restriction;
  27 use MediaWiki\Block\Restriction\NamespaceRestriction;
  28 use MediaWiki\Block\Restriction\PageRestriction;
  29 use MediaWiki\MediaWikiServices;
  30
  31 class Block {
  32         /** @var string */
  33         public $mReason;
  34
  35         /** @var string */
  36         public $mTimestamp;
  37
  38         /** @var bool */
  39         public $mAuto;
  40
  41         /** @var string */
  42         public $mExpiry;
  43
  44         /** @var bool */
  45         public $mHideName;
  46
  47         /** @var int */
  48         public $mParentBlockId;
  49
  50         /** @var int */
  51         private $mId;
  52
  53         /** @var bool */
  54         private $mFromMaster;
  55
  56         /** @var bool */
  57         private $mBlockEmail;
  58
  59         /** @var bool */
  60         private $allowUsertalk;
  61
  62         /** @var bool */
  63         private $blockCreateAccount;
  64
  65         /** @var User|string */
  66         private $target;
  67
  68         /** @var int Hack for foreign blocking (CentralAuth) */
  69         private $forcedTargetID;
  70
  71         /**
  72          * @var int Block::TYPE_ constant. After the block has been loaded
  73          * from the database, this can only be USER, IP or RANGE.
  74          */
  75         private $type;
  76
  77         /** @var User */
  78         private $blocker;
  79
  80         /** @var bool */
  81         private $isHardblock;
  82
  83         /** @var bool */
  84         private $isAutoblocking;
  85
  86         /** @var string|null */
  87         private $systemBlockType;
  88
  89         /** @var bool */
  90         private $isSitewide;
  91
  92         /** @var Restriction[] */
  93         private $restrictions;
  94
  95         # TYPE constants
  96         const TYPE_USER = 1;
  97         const TYPE_IP = 2;
  98         const TYPE_RANGE = 3;
  99         const TYPE_AUTO = 4;
 100         const TYPE_ID = 5;
 101
 102         /**
 103          * Create a new block with specified parameters on a user, IP or IP range.
 104          *
 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
 126          *                          other block flags
 127          *
 128          * @since 1.26 accepts $options array instead of individual parameters; order
 129          * of parameters above reflects the original order
 130          */
 131         function __construct( $options = [] ) {
 132                 $defaults = [
 133                         'address'         => '',
 134                         'user'            => null,
 135                         'by'              => null,
 136                         'reason'          => '',
 137                         'timestamp'       => '',
 138                         'auto'            => false,
 139                         'expiry'          => '',
 140                         'anonOnly'        => false,
 141                         'createAccount'   => false,
 142                         'enableAutoblock' => false,
 143                         'hideName'        => false,
 144                         'blockEmail'      => false,
 145                         'allowUsertalk'   => false,
 146                         'byText'          => '',
 147                         'systemBlock'     => null,
 148                         'sitewide'        => true,
 149                 ];
 150
 151                 $options += $defaults;
 152
 153                 $this->setTarget( $options['address'] );
 154
 155                 if ( $this->target instanceof User && $options['user'] ) {
 156                         # Needed for foreign users
 157                         $this->forcedTargetID = $options['user'];
 158                 }
 159
 160                 if ( $options['by'] ) {
 161                         # Local user
 162                         $this->setBlocker( User::newFromId( $options['by'] ) );
 163                 } else {
 164                         # Foreign user
 165                         $this->setBlocker( $options['byText'] );
 166                 }
 167
 168                 $this->mReason = $options['reason'];
 169                 $this->mTimestamp = wfTimestamp( TS_MW, $options['timestamp'] );
 170                 $this->mExpiry = wfGetDB( DB_REPLICA )->decodeExpiry( $options['expiry'] );
 171
 172                 # Boolean settings
 173                 $this->mAuto = (bool)$options['auto'];
 174                 $this->mHideName = (bool)$options['hideName'];
 175                 $this->isHardblock( !$options['anonOnly'] );
 176                 $this->isAutoblocking( (bool)$options['enableAutoblock'] );
 177                 $this->isSitewide( (bool)$options['sitewide'] );
 178                 $this->isEmailBlocked( (bool)$options['blockEmail'] );
 179                 $this->isCreateAccountBlocked( (bool)$options['createAccount'] );
 180                 $this->isUsertalkEditAllowed( (bool)$options['allowUsertalk'] );
 181
 182                 $this->mFromMaster = false;
 183                 $this->systemBlockType = $options['systemBlock'];
 184         }
 185
 186         /**
 187          * Load a block from the block id.
 188          *
 189          * @param int $id Block id to search for
 190          * @return Block|null
 191          */
 192         public static function newFromID( $id ) {
 193                 $dbr = wfGetDB( DB_REPLICA );
 194                 $blockQuery = self::getQueryInfo();
 195                 $res = $dbr->selectRow(
 196                         $blockQuery['tables'],
 197                         $blockQuery['fields'],
 198                         [ 'ipb_id' => $id ],
 199                         __METHOD__,
 200                         [],
 201                         $blockQuery['joins']
 202                 );
 203                 if ( $res ) {
 204                         return self::newFromRow( $res );
 205                 } else {
 206                         return null;
 207                 }
 208         }
 209
 210         /**
 211          * Return the list of ipblocks fields that should be selected to create
 212          * a new block.
 213          * @deprecated since 1.31, use self::getQueryInfo() instead.
 214          * @return array
 215          */
 216         public static function selectFields() {
 217                 global $wgActorTableSchemaMigrationStage;
 218
 219                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
 220                         // If code is using this instead of self::getQueryInfo(), there's a
 221                         // decent chance it's going to try to directly access
 222                         // $row->ipb_by or $row->ipb_by_text and we can't give it
 223                         // useful values here once those aren't being used anymore.
 224                         throw new BadMethodCallException(
 225                                 'Cannot use ' . __METHOD__
 226                                         . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
 227                         );
 228                 }
 229
 230                 wfDeprecated( __METHOD__, '1.31' );
 231                 return [
 232                         'ipb_id',
 233                         'ipb_address',
 234                         'ipb_by',
 235                         'ipb_by_text',
 236                         'ipb_by_actor' => 'NULL',
 237                         'ipb_timestamp',
 238                         'ipb_auto',
 239                         'ipb_anon_only',
 240                         'ipb_create_account',
 241                         'ipb_enable_autoblock',
 242                         'ipb_expiry',
 243                         'ipb_deleted',
 244                         'ipb_block_email',
 245                         'ipb_allow_usertalk',
 246                         'ipb_parent_block_id',
 247                         'ipb_sitewide',
 248                 ] + CommentStore::getStore()->getFields( 'ipb_reason' );
 249         }
 250
 251         /**
 252          * Return the tables, fields, and join conditions to be selected to create
 253          * a new block object.
 254          * @since 1.31
 255          * @return array With three keys:
 256          *   - tables: (string[]) to include in the `$table` to `IDatabase->select()`
 257          *   - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
 258          *   - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
 259          */
 260         public static function getQueryInfo() {
 261                 $commentQuery = CommentStore::getStore()->getJoin( 'ipb_reason' );
 262                 $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
 263                 return [
 264                         'tables' => [ 'ipblocks' ] + $commentQuery['tables'] + $actorQuery['tables'],
 265                         'fields' => [
 266                                 'ipb_id',
 267                                 'ipb_address',
 268                                 'ipb_timestamp',
 269                                 'ipb_auto',
 270                                 'ipb_anon_only',
 271                                 'ipb_create_account',
 272                                 'ipb_enable_autoblock',
 273                                 'ipb_expiry',
 274                                 'ipb_deleted',
 275                                 'ipb_block_email',
 276                                 'ipb_allow_usertalk',
 277                                 'ipb_parent_block_id',
 278                                 'ipb_sitewide',
 279                         ] + $commentQuery['fields'] + $actorQuery['fields'],
 280                         'joins' => $commentQuery['joins'] + $actorQuery['joins'],
 281                 ];
 282         }
 283
 284         /**
 285          * Check if two blocks are effectively equal.  Doesn't check irrelevant things like
 286          * the blocking user or the block timestamp, only things which affect the blocked user
 287          *
 288          * @param Block $block
 289          *
 290          * @return bool
 291          */
 292         public function equals( Block $block ) {
 293                 return (
 294                         (string)$this->target == (string)$block->target
 295                         && $this->type == $block->type
 296                         && $this->mAuto == $block->mAuto
 297                         && $this->isHardblock() == $block->isHardblock()
 298                         && $this->isCreateAccountBlocked() == $block->isCreateAccountBlocked()
 299                         && $this->mExpiry == $block->mExpiry
 300                         && $this->isAutoblocking() == $block->isAutoblocking()
 301                         && $this->mHideName == $block->mHideName
 302                         && $this->isEmailBlocked() == $block->isEmailBlocked()
 303                         && $this->isUsertalkEditAllowed() == $block->isUsertalkEditAllowed()
 304                         && $this->mReason == $block->mReason
 305                         && $this->isSitewide() == $block->isSitewide()
 306                         // Block::getRestrictions() may perform a database query, so keep it at
 307                         // the end.
 308                         && BlockRestriction::equals( $this->getRestrictions(), $block->getRestrictions() )
 309                 );
 310         }
 311
 312         /**
 313          * Load a block from the database which affects the already-set $this->target:
 314          *     1) A block directly on the given user or IP
 315          *     2) A rangeblock encompassing the given IP (smallest first)
 316          *     3) An autoblock on the given IP
 317          * @param User|string|null $vagueTarget Also search for blocks affecting this target.  Doesn't
 318          *     make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.
 319          * @throws MWException
 320          * @return bool Whether a relevant block was found
 321          */
 322         protected function newLoad( $vagueTarget = null ) {
 323                 $db = wfGetDB( $this->mFromMaster ? DB_MASTER : DB_REPLICA );
 324
 325                 if ( $this->type !== null ) {
 326                         $conds = [
 327                                 'ipb_address' => [ (string)$this->target ],
 328                         ];
 329                 } else {
 330                         $conds = [ 'ipb_address' => [] ];
 331                 }
 332
 333                 # Be aware that the != '' check is explicit, since empty values will be
 334                 # passed by some callers (T31116)
 335                 if ( $vagueTarget != '' ) {
 336                         list( $target, $type ) = self::parseTarget( $vagueTarget );
 337                         switch ( $type ) {
 338                                 case self::TYPE_USER:
 339                                         # Slightly weird, but who are we to argue?
 340                                         $conds['ipb_address'][] = (string)$target;
 341                                         break;
 342
 343                                 case self::TYPE_IP:
 344                                         $conds['ipb_address'][] = (string)$target;
 345                                         $conds[] = self::getRangeCond( IP::toHex( $target ) );
 346                                         $conds = $db->makeList( $conds, LIST_OR );
 347                                         break;
 348
 349                                 case self::TYPE_RANGE:
 350                                         list( $start, $end ) = IP::parseRange( $target );
 351                                         $conds['ipb_address'][] = (string)$target;
 352                                         $conds[] = self::getRangeCond( $start, $end );
 353                                         $conds = $db->makeList( $conds, LIST_OR );
 354                                         break;
 355
 356                                 default:
 357                                         throw new MWException( "Tried to load block with invalid type" );
 358                         }
 359                 }
 360
 361                 $blockQuery = self::getQueryInfo();
 362                 $res = $db->select(
 363                         $blockQuery['tables'], $blockQuery['fields'], $conds, __METHOD__, [], $blockQuery['joins']
 364                 );
 365
 366                 # This result could contain a block on the user, a block on the IP, and a russian-doll
 367                 # set of rangeblocks.  We want to choose the most specific one, so keep a leader board.
 368                 $bestRow = null;
 369
 370                 # Lower will be better
 371                 $bestBlockScore = 100;
 372
 373                 foreach ( $res as $row ) {
 374                         $block = self::newFromRow( $row );
 375
 376                         # Don't use expired blocks
 377                         if ( $block->isExpired() ) {
 378                                 continue;
 379                         }
 380
 381                         # Don't use anon only blocks on users
 382                         if ( $this->type == self::TYPE_USER && !$block->isHardblock() ) {
 383                                 continue;
 384                         }
 385
 386                         if ( $block->getType() == self::TYPE_RANGE ) {
 387                                 # This is the number of bits that are allowed to vary in the block, give
 388                                 # or take some floating point errors
 389                                 $end = Wikimedia\base_convert( $block->getRangeEnd(), 16, 10 );
 390                                 $start = Wikimedia\base_convert( $block->getRangeStart(), 16, 10 );
 391                                 $size = log( $end - $start + 1, 2 );
 392
 393                                 # This has the nice property that a /32 block is ranked equally with a
 394                                 # single-IP block, which is exactly what it is...
 395                                 $score = self::TYPE_RANGE - 1 + ( $size / 128 );
 396
 397                         } else {
 398                                 $score = $block->getType();
 399                         }
 400
 401                         if ( $score < $bestBlockScore ) {
 402                                 $bestBlockScore = $score;
 403                                 $bestRow = $row;
 404                         }
 405                 }
 406
 407                 if ( $bestRow !== null ) {
 408                         $this->initFromRow( $bestRow );
 409                         return true;
 410                 } else {
 411                         return false;
 412                 }
 413         }
 414
 415         /**
 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
 419          * @return string
 420          */
 421         public static function getRangeCond( $start, $end = null ) {
 422                 if ( $end === null ) {
 423                         $end = $start;
 424                 }
 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() );
 432
 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 );
 437
 438                 return $dbr->makeList(
 439                         [
 440                                 "ipb_range_start $like",
 441                                 "ipb_range_start <= $safeStart",
 442                                 "ipb_range_end >= $safeEnd",
 443                         ],
 444                         LIST_AND
 445                 );
 446         }
 447
 448         /**
 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
 452          * @return string
 453          */
 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 ) );
 458                 } else {
 459                         return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
 460                 }
 461         }
 462
 463         /**
 464          * Given a database row from the ipblocks table, initialize
 465          * member variables
 466          * @param stdClass $row A row from the ipblocks table
 467          */
 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
 472                 ) );
 473
 474                 $this->mTimestamp = wfTimestamp( TS_MW, $row->ipb_timestamp );
 475                 $this->mAuto = $row->ipb_auto;
 476                 $this->mHideName = $row->ipb_deleted;
 477                 $this->mId = (int)$row->ipb_id;
 478                 $this->mParentBlockId = $row->ipb_parent_block_id;
 479
 480                 // I wish I didn't have to do this
 481                 $db = wfGetDB( DB_REPLICA );
 482                 $this->mExpiry = $db->decodeExpiry( $row->ipb_expiry );
 483                 $this->mReason = CommentStore::getStore()
 484                         // Legacy because $row may have come from self::selectFields()
 485                         ->getCommentLegacy( $db, 'ipb_reason', $row )->text;
 486
 487                 $this->isHardblock( !$row->ipb_anon_only );
 488                 $this->isAutoblocking( $row->ipb_enable_autoblock );
 489                 $this->isSitewide( (bool)$row->ipb_sitewide );
 490
 491                 $this->isCreateAccountBlocked( $row->ipb_create_account );
 492                 $this->isEmailBlocked( $row->ipb_block_email );
 493                 $this->isUsertalkEditAllowed( $row->ipb_allow_usertalk );
 494         }
 495
 496         /**
 497          * Create a new Block object from a database row
 498          * @param stdClass $row Row from the ipblocks table
 499          * @return Block
 500          */
 501         public static function newFromRow( $row ) {
 502                 $block = new Block;
 503                 $block->initFromRow( $row );
 504                 return $block;
 505         }
 506
 507         /**
 508          * Delete the row from the IP blocks table.
 509          *
 510          * @throws MWException
 511          * @return bool
 512          */
 513         public function delete() {
 514                 if ( wfReadOnly() ) {
 515                         return false;
 516                 }
 517
 518                 if ( !$this->getId() ) {
 519                         throw new MWException( "Block::delete() requires that the mId member be filled\n" );
 520                 }
 521
 522                 $dbw = wfGetDB( DB_MASTER );
 523
 524                 BlockRestriction::deleteByParentBlockId( $this->getId() );
 525                 $dbw->delete( 'ipblocks', [ 'ipb_parent_block_id' => $this->getId() ], __METHOD__ );
 526
 527                 BlockRestriction::deleteByBlockId( $this->getId() );
 528                 $dbw->delete( 'ipblocks', [ 'ipb_id' => $this->getId() ], __METHOD__ );
 529
 530                 return $dbw->affectedRows() > 0;
 531         }
 532
 533         /**
 534          * Insert a block into the block table. Will fail if there is a conflicting
 535          * block (same name and options) already in the database.
 536          *
 537          * @param IDatabase|null $dbw If you have one available
 538          * @return bool|array False on failure, assoc array on success:
 539          *      ('id' => block ID, 'autoIds' => array of autoblock IDs)
 540          */
 541         public function insert( $dbw = null ) {
 542                 global $wgBlockDisablesLogin;
 543
 544                 if ( $this->getSystemBlockType() !== null ) {
 545                         throw new MWException( 'Cannot insert a system block into the database' );
 546                 }
 547                 if ( !$this->getBlocker() || $this->getBlocker()->getName() === '' ) {
 548                         throw new MWException( 'Cannot insert a block without a blocker set' );
 549                 }
 550
 551                 wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
 552
 553                 if ( $dbw === null ) {
 554                         $dbw = wfGetDB( DB_MASTER );
 555                 }
 556
 557                 self::purgeExpired();
 558
 559                 $row = $this->getDatabaseArray( $dbw );
 560
 561                 $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] );
 562                 $affected = $dbw->affectedRows();
 563                 if ( $affected ) {
 564                         $this->setId( $dbw->insertId() );
 565                         if ( $this->restrictions ) {
 566                                 BlockRestriction::insert( $this->restrictions );
 567                         }
 568                 }
 569
 570                 # Don't collide with expired blocks.
 571                 # Do this after trying to insert to avoid locking.
 572                 if ( !$affected ) {
 573                         # T96428: The ipb_address index uses a prefix on a field, so
 574                         # use a standard SELECT + DELETE to avoid annoying gap locks.
 575                         $ids = $dbw->selectFieldValues( 'ipblocks',
 576                                 'ipb_id',
 577                                 [
 578                                         'ipb_address' => $row['ipb_address'],
 579                                         'ipb_user' => $row['ipb_user'],
 580                                         'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() )
 581                                 ],
 582                                 __METHOD__
 583                         );
 584                         if ( $ids ) {
 585                                 $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], __METHOD__ );
 586                                 BlockRestriction::deleteByBlockId( $ids );
 587                                 $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] );
 588                                 $affected = $dbw->affectedRows();
 589                                 $this->setId( $dbw->insertId() );
 590                                 if ( $this->restrictions ) {
 591                                         BlockRestriction::insert( $this->restrictions );
 592                                 }
 593                         }
 594                 }
 595
 596                 if ( $affected ) {
 597                         $auto_ipd_ids = $this->doRetroactiveAutoblock();
 598
 599                         if ( $wgBlockDisablesLogin && $this->target instanceof User ) {
 600                                 // Change user login token to force them to be logged out.
 601                                 $this->target->setToken();
 602                                 $this->target->saveSettings();
 603                         }
 604
 605                         return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ];
 606                 }
 607
 608                 return false;
 609         }
 610
 611         /**
 612          * Update a block in the DB with new parameters.
 613          * The ID field needs to be loaded first.
 614          *
 615          * @return bool|array False on failure, array on success:
 616          *   ('id' => block ID, 'autoIds' => array of autoblock IDs)
 617          */
 618         public function update() {
 619                 wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" );
 620                 $dbw = wfGetDB( DB_MASTER );
 621
 622                 $dbw->startAtomic( __METHOD__ );
 623
 624                 $result = $dbw->update(
 625                         'ipblocks',
 626                         $this->getDatabaseArray( $dbw ),
 627                         [ 'ipb_id' => $this->getId() ],
 628                         __METHOD__
 629                 );
 630
 631                 // Only update the restrictions if they have been modified.
 632                 if ( $this->restrictions !== null ) {
 633                         // An empty array should remove all of the restrictions.
 634                         if ( empty( $this->restrictions ) ) {
 635                                 $success = BlockRestriction::deleteByBlockId( $this->getId() );
 636                         } else {
 637                                 $success = BlockRestriction::update( $this->restrictions );
 638                         }
 639                         // Update the result. The first false is the result, otherwise, true.
 640                         $result = $result && $success;
 641                 }
 642
 643                 if ( $this->isAutoblocking() ) {
 644                         // update corresponding autoblock(s) (T50813)
 645                         $dbw->update(
 646                                 'ipblocks',
 647                                 $this->getAutoblockUpdateArray( $dbw ),
 648                                 [ 'ipb_parent_block_id' => $this->getId() ],
 649                                 __METHOD__
 650                         );
 651
 652                         // Only update the restrictions if they have been modified.
 653                         if ( $this->restrictions !== null ) {
 654                                 BlockRestriction::updateByParentBlockId( $this->getId(), $this->restrictions );
 655                         }
 656                 } else {
 657                         // autoblock no longer required, delete corresponding autoblock(s)
 658                         BlockRestriction::deleteByParentBlockId( $this->getId() );
 659                         $dbw->delete(
 660                                 'ipblocks',
 661                                 [ 'ipb_parent_block_id' => $this->getId() ],
 662                                 __METHOD__
 663                         );
 664                 }
 665
 666                 $dbw->endAtomic( __METHOD__ );
 667
 668                 if ( $result ) {
 669                         $auto_ipd_ids = $this->doRetroactiveAutoblock();
 670                         return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ];
 671                 }
 672
 673                 return $result;
 674         }
 675
 676         /**
 677          * Get an array suitable for passing to $dbw->insert() or $dbw->update()
 678          * @param IDatabase $dbw
 679          * @return array
 680          */
 681         protected function getDatabaseArray( IDatabase $dbw ) {
 682                 $expiry = $dbw->encodeExpiry( $this->mExpiry );
 683
 684                 if ( $this->forcedTargetID ) {
 685                         $uid = $this->forcedTargetID;
 686                 } else {
 687                         $uid = $this->target instanceof User ? $this->target->getId() : 0;
 688                 }
 689
 690                 $a = [
 691                         'ipb_address'          => (string)$this->target,
 692                         'ipb_user'             => $uid,
 693                         'ipb_timestamp'        => $dbw->timestamp( $this->mTimestamp ),
 694                         'ipb_auto'             => $this->mAuto,
 695                         'ipb_anon_only'        => !$this->isHardblock(),
 696                         'ipb_create_account'   => $this->isCreateAccountBlocked(),
 697                         'ipb_enable_autoblock' => $this->isAutoblocking(),
 698                         'ipb_expiry'           => $expiry,
 699                         'ipb_range_start'      => $this->getRangeStart(),
 700                         'ipb_range_end'        => $this->getRangeEnd(),
 701                         'ipb_deleted'          => intval( $this->mHideName ), // typecast required for SQLite
 702                         'ipb_block_email'      => $this->isEmailBlocked(),
 703                         'ipb_allow_usertalk'   => $this->isUsertalkEditAllowed(),
 704                         'ipb_parent_block_id'  => $this->mParentBlockId,
 705                         'ipb_sitewide'         => $this->isSitewide(),
 706                 ] + CommentStore::getStore()->insert( $dbw, 'ipb_reason', $this->mReason )
 707                         + ActorMigration::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
 708
 709                 return $a;
 710         }
 711
 712         /**
 713          * @param IDatabase $dbw
 714          * @return array
 715          */
 716         protected function getAutoblockUpdateArray( IDatabase $dbw ) {
 717                 return [
 718                         'ipb_create_account'   => $this->isCreateAccountBlocked(),
 719                         'ipb_deleted'          => (int)$this->mHideName, // typecast required for SQLite
 720                         'ipb_allow_usertalk'   => $this->isUsertalkEditAllowed(),
 721                         'ipb_sitewide'         => $this->isSitewide(),
 722                 ] + CommentStore::getStore()->insert( $dbw, 'ipb_reason', $this->mReason )
 723                         + ActorMigration::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
 724         }
 725
 726         /**
 727          * Retroactively autoblocks the last IP used by the user (if it is a user)
 728          * blocked by this Block.
 729          *
 730          * @return array Block IDs of retroactive autoblocks made
 731          */
 732         protected function doRetroactiveAutoblock() {
 733                 $blockIds = [];
 734                 # If autoblock is enabled, autoblock the LAST IP(s) used
 735                 if ( $this->isAutoblocking() && $this->getType() == self::TYPE_USER ) {
 736                         wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
 737
 738                         $continue = Hooks::run(
 739                                 'PerformRetroactiveAutoblock', [ $this, &$blockIds ] );
 740
 741                         if ( $continue ) {
 742                                 self::defaultRetroactiveAutoblock( $this, $blockIds );
 743                         }
 744                 }
 745                 return $blockIds;
 746         }
 747
 748         /**
 749          * Retroactively autoblocks the last IP used by the user (if it is a user)
 750          * blocked by this Block. This will use the recentchanges table.
 751          *
 752          * @param Block $block
 753          * @param array &$blockIds
 754          */
 755         protected static function defaultRetroactiveAutoblock( Block $block, array &$blockIds ) {
 756                 global $wgPutIPinRC;
 757
 758                 // No IPs are in recentchanges table, so nothing to select
 759                 if ( !$wgPutIPinRC ) {
 760                         return;
 761                 }
 762
 763                 // Autoblocks only apply to TYPE_USER
 764                 if ( $block->getType() !== self::TYPE_USER ) {
 765                         return;
 766                 }
 767                 $target = $block->getTarget(); // TYPE_USER => always a User object
 768
 769                 $dbr = wfGetDB( DB_REPLICA );
 770                 $rcQuery = ActorMigration::newMigration()->getWhere( $dbr, 'rc_user', $target, false );
 771
 772                 $options = [ 'ORDER BY' => 'rc_timestamp DESC' ];
 773
 774                 // Just the last IP used.
 775                 $options['LIMIT'] = 1;
 776
 777                 $res = $dbr->select(
 778                         [ 'recentchanges' ] + $rcQuery['tables'],
 779                         [ 'rc_ip' ],
 780                         $rcQuery['conds'],
 781                         __METHOD__,
 782                         $options,
 783                         $rcQuery['joins']
 784                 );
 785
 786                 if ( !$res->numRows() ) {
 787                         # No results, don't autoblock anything
 788                         wfDebug( "No IP found to retroactively autoblock\n" );
 789                 } else {
 790                         foreach ( $res as $row ) {
 791                                 if ( $row->rc_ip ) {
 792                                         $id = $block->doAutoblock( $row->rc_ip );
 793                                         if ( $id ) {
 794                                                 $blockIds[] = $id;
 795                                         }
 796                                 }
 797                         }
 798                 }
 799         }
 800
 801         /**
 802          * Checks whether a given IP is on the autoblock whitelist.
 803          * TODO: this probably belongs somewhere else, but not sure where...
 804          *
 805          * @param string $ip The IP to check
 806          * @return bool
 807          */
 808         public static function isWhitelistedFromAutoblocks( $ip ) {
 809                 // Try to get the autoblock_whitelist from the cache, as it's faster
 810                 // than getting the msg raw and explode()'ing it.
 811                 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
 812                 $lines = $cache->getWithSetCallback(
 813                         $cache->makeKey( 'ip-autoblock', 'whitelist' ),
 814                         $cache::TTL_DAY,
 815                         function ( $curValue, &$ttl, array &$setOpts ) {
 816                                 $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
 817
 818                                 return explode( "\n",
 819                                         wfMessage( 'autoblock_whitelist' )->inContentLanguage()->plain() );
 820                         }
 821                 );
 822
 823                 wfDebug( "Checking the autoblock whitelist..\n" );
 824
 825                 foreach ( $lines as $line ) {
 826                         # List items only
 827                         if ( substr( $line, 0, 1 ) !== '*' ) {
 828                                 continue;
 829                         }
 830
 831                         $wlEntry = substr( $line, 1 );
 832                         $wlEntry = trim( $wlEntry );
 833
 834                         wfDebug( "Checking $ip against $wlEntry..." );
 835
 836                         # Is the IP in this range?
 837                         if ( IP::isInRange( $ip, $wlEntry ) ) {
 838                                 wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
 839                                 return true;
 840                         } else {
 841                                 wfDebug( " No match\n" );
 842                         }
 843                 }
 844
 845                 return false;
 846         }
 847
 848         /**
 849          * Autoblocks the given IP, referring to this Block.
 850          *
 851          * @param string $autoblockIP The IP to autoblock.
 852          * @return int|bool Block ID if an autoblock was inserted, false if not.
 853          */
 854         public function doAutoblock( $autoblockIP ) {
 855                 # If autoblocks are disabled, go away.
 856                 if ( !$this->isAutoblocking() ) {
 857                         return false;
 858                 }
 859
 860                 # Don't autoblock for system blocks
 861                 if ( $this->getSystemBlockType() !== null ) {
 862                         throw new MWException( 'Cannot autoblock from a system block' );
 863                 }
 864
 865                 # Check for presence on the autoblock whitelist.
 866                 if ( self::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
 867                         return false;
 868                 }
 869
 870                 // Avoid PHP 7.1 warning of passing $this by reference
 871                 $block = $this;
 872                 # Allow hooks to cancel the autoblock.
 873                 if ( !Hooks::run( 'AbortAutoblock', [ $autoblockIP, &$block ] ) ) {
 874                         wfDebug( "Autoblock aborted by hook.\n" );
 875                         return false;
 876                 }
 877
 878                 # It's okay to autoblock. Go ahead and insert/update the block...
 879
 880                 # Do not add a *new* block if the IP is already blocked.
 881                 $ipblock = self::newFromTarget( $autoblockIP );
 882                 if ( $ipblock ) {
 883                         # Check if the block is an autoblock and would exceed the user block
 884                         # if renewed. If so, do nothing, otherwise prolong the block time...
 885                         if ( $ipblock->mAuto && // @todo Why not compare $ipblock->mExpiry?
 886                                 $this->mExpiry > self::getAutoblockExpiry( $ipblock->mTimestamp )
 887                         ) {
 888                                 # Reset block timestamp to now and its expiry to
 889                                 # $wgAutoblockExpiry in the future
 890                                 $ipblock->updateTimestamp();
 891                         }
 892                         return false;
 893                 }
 894
 895                 # Make a new block object with the desired properties.
 896                 $autoblock = new Block;
 897                 wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
 898                 $autoblock->setTarget( $autoblockIP );
 899                 $autoblock->setBlocker( $this->getBlocker() );
 900                 $autoblock->mReason = wfMessage( 'autoblocker', $this->getTarget(), $this->mReason )
 901                         ->inContentLanguage()->plain();
 902                 $timestamp = wfTimestampNow();
 903                 $autoblock->mTimestamp = $timestamp;
 904                 $autoblock->mAuto = 1;
 905                 $autoblock->isCreateAccountBlocked( $this->isCreateAccountBlocked() );
 906                 # Continue suppressing the name if needed
 907                 $autoblock->mHideName = $this->mHideName;
 908                 $autoblock->isUsertalkEditAllowed( $this->isUsertalkEditAllowed() );
 909                 $autoblock->mParentBlockId = $this->mId;
 910                 $autoblock->isSitewide( $this->isSitewide() );
 911                 $autoblock->setRestrictions( $this->getRestrictions() );
 912
 913                 if ( $this->mExpiry == 'infinity' ) {
 914                         # Original block was indefinite, start an autoblock now
 915                         $autoblock->mExpiry = self::getAutoblockExpiry( $timestamp );
 916                 } else {
 917                         # If the user is already blocked with an expiry date, we don't
 918                         # want to pile on top of that.
 919                         $autoblock->mExpiry = min( $this->mExpiry, self::getAutoblockExpiry( $timestamp ) );
 920                 }
 921
 922                 # Insert the block...
 923                 $status = $autoblock->insert();
 924                 return $status
 925                         ? $status['id']
 926                         : false;
 927         }
 928
 929         /**
 930          * Check if a block has expired. Delete it if it is.
 931          * @return bool
 932          */
 933         public function deleteIfExpired() {
 934                 if ( $this->isExpired() ) {
 935                         wfDebug( "Block::deleteIfExpired() -- deleting\n" );
 936                         $this->delete();
 937                         $retVal = true;
 938                 } else {
 939                         wfDebug( "Block::deleteIfExpired() -- not expired\n" );
 940                         $retVal = false;
 941                 }
 942
 943                 return $retVal;
 944         }
 945
 946         /**
 947          * Has the block expired?
 948          * @return bool
 949          */
 950         public function isExpired() {
 951                 $timestamp = wfTimestampNow();
 952                 wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" );
 953
 954                 if ( !$this->mExpiry ) {
 955                         return false;
 956                 } else {
 957                         return $timestamp > $this->mExpiry;
 958                 }
 959         }
 960
 961         /**
 962          * Is the block address valid (i.e. not a null string?)
 963          * @return bool
 964          */
 965         public function isValid() {
 966                 return $this->getTarget() != null;
 967         }
 968
 969         /**
 970          * Update the timestamp on autoblocks.
 971          */
 972         public function updateTimestamp() {
 973                 if ( $this->mAuto ) {
 974                         $this->mTimestamp = wfTimestamp();
 975                         $this->mExpiry = self::getAutoblockExpiry( $this->mTimestamp );
 976
 977                         $dbw = wfGetDB( DB_MASTER );
 978                         $dbw->update( 'ipblocks',
 979                                 [ /* SET */
 980                                         'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ),
 981                                         'ipb_expiry' => $dbw->timestamp( $this->mExpiry ),
 982                                 ],
 983                                 [ /* WHERE */
 984                                         'ipb_id' => $this->getId(),
 985                                 ],
 986                                 __METHOD__
 987                         );
 988                 }
 989         }
 990
 991         /**
 992          * Get the IP address at the start of the range in Hex form
 993          * @throws MWException
 994          * @return string IP in Hex form
 995          */
 996         public function getRangeStart() {
 997                 switch ( $this->type ) {
 998                         case self::TYPE_USER:
 999                                 return '';
1000                         case self::TYPE_IP:
1001                                 return IP::toHex( $this->target );
1002                         case self::TYPE_RANGE:
1003                                 list( $start, /*...*/ ) = IP::parseRange( $this->target );
1004                                 return $start;
1005                         default:
1006                                 throw new MWException( "Block with invalid type" );
1007                 }
1008         }
1009
1010         /**
1011          * Get the IP address at the end of the range in Hex form
1012          * @throws MWException
1013          * @return string IP in Hex form
1014          */
1015         public function getRangeEnd() {
1016                 switch ( $this->type ) {
1017                         case self::TYPE_USER:
1018                                 return '';
1019                         case self::TYPE_IP:
1020                                 return IP::toHex( $this->target );
1021                         case self::TYPE_RANGE:
1022                                 list( /*...*/, $end ) = IP::parseRange( $this->target );
1023                                 return $end;
1024                         default:
1025                                 throw new MWException( "Block with invalid type" );
1026                 }
1027         }
1028
1029         /**
1030          * Get the user id of the blocking sysop
1031          *
1032          * @return int (0 for foreign users)
1033          */
1034         public function getBy() {
1035                 return $this->getBlocker()->getId();
1036         }
1037
1038         /**
1039          * Get the username of the blocking sysop
1040          *
1041          * @return string
1042          */
1043         public function getByName() {
1044                 return $this->getBlocker()->getName();
1045         }
1046
1047         /**
1048          * Get the block ID
1049          * @return int
1050          */
1051         public function getId() {
1052                 return $this->mId;
1053         }
1054
1055         /**
1056          * Set the block ID
1057          *
1058          * @param int $blockId
1059          * @return int
1060          */
1061         private function setId( $blockId ) {
1062                 $this->mId = (int)$blockId;
1063
1064                 if ( is_array( $this->restrictions ) ) {
1065                         $this->restrictions = BlockRestriction::setBlockId( $blockId, $this->restrictions );
1066                 }
1067
1068                 return $this;
1069         }
1070
1071         /**
1072          * Get the system block type, if any
1073          * @since 1.29
1074          * @return string|null
1075          */
1076         public function getSystemBlockType() {
1077                 return $this->systemBlockType;
1078         }
1079
1080         /**
1081          * Get/set a flag determining whether the master is used for reads
1082          *
1083          * @param bool|null $x
1084          * @return bool
1085          */
1086         public function fromMaster( $x = null ) {
1087                 return wfSetVar( $this->mFromMaster, $x );
1088         }
1089
1090         /**
1091          * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range)
1092          * @param bool|null $x
1093          * @return bool
1094          */
1095         public function isHardblock( $x = null ) {
1096                 wfSetVar( $this->isHardblock, $x );
1097
1098                 # You can't *not* hardblock a user
1099                 return $this->getType() == self::TYPE_USER
1100                         ? true
1101                         : $this->isHardblock;
1102         }
1103
1104         /**
1105          * @param null|bool $x
1106          * @return bool
1107          */
1108         public function isAutoblocking( $x = null ) {
1109                 wfSetVar( $this->isAutoblocking, $x );
1110
1111                 # You can't put an autoblock on an IP or range as we don't have any history to
1112                 # look over to get more IPs from
1113                 return $this->getType() == self::TYPE_USER
1114                         ? $this->isAutoblocking
1115                         : false;
1116         }
1117
1118         /**
1119          * Indicates that the block is a sitewide block. This means the user is
1120          * prohibited from editing any page on the site (other than their own talk
1121          * page).
1122          *
1123          * @since 1.33
1124          * @param null|bool $x
1125          * @return bool
1126          */
1127         public function isSitewide( $x = null ) {
1128                 return wfSetVar( $this->isSitewide, $x );
1129         }
1130
1131         /**
1132          * Get or set the flag indicating whether this block blocks the target from
1133          * creating an account. (Note that the flag may be overridden depending on
1134          * global configs.)
1135          *
1136          * @since 1.33
1137          * @param null|bool $x Value to set (if null, just get the property value)
1138          * @return bool Value of the property
1139          */
1140         public function isCreateAccountBlocked( $x = null ) {
1141                 return wfSetVar( $this->blockCreateAccount, $x );
1142         }
1143
1144         /**
1145          * Get or set the flag indicating whether this block blocks the target from
1146          * sending emails. (Note that the flag may be overridden depending on
1147          * global configs.)
1148          *
1149          * @since 1.33
1150          * @param null|bool $x Value to set (if null, just get the property value)
1151          * @return bool Value of the property
1152          */
1153         public function isEmailBlocked( $x = null ) {
1154                 return wfSetVar( $this->mBlockEmail, $x );
1155         }
1156
1157         /**
1158          * Get or set the flag indicating whether this block blocks the target from
1159          * editing their own user talk page. (Note that the flag may be overridden
1160          * depending on global configs.)
1161          *
1162          * @since 1.33
1163          * @param null|bool $x Value to set (if null, just get the property value)
1164          * @return bool Value of the property
1165          */
1166         public function isUsertalkEditAllowed( $x = null ) {
1167                 return wfSetVar( $this->allowUsertalk, $x );
1168         }
1169
1170         /**
1171          * Determine whether the Block prevents a given right. A right
1172          * may be blacklisted or whitelisted, or determined from a
1173          * property on the Block object. For certain rights, the property
1174          * may be overridden according to global configs.
1175          *
1176          * @since 1.33
1177          * @param string $right Right to check
1178          * @return bool|null null if unrecognized right or unset property
1179          */
1180         public function appliesToRight( $right ) {
1181                 $config = RequestContext::getMain()->getConfig();
1182                 $blockDisablesLogin = $config->get( 'BlockDisablesLogin' );
1183
1184                 $res = null;
1185                 switch ( $right ) {
1186                         case 'edit':
1187                                 // TODO: fix this case to return proper value
1188                                 $res = true;
1189                                 break;
1190                         case 'createaccount':
1191                                 $res = $this->isCreateAccountBlocked();
1192                                 break;
1193                         case 'sendemail':
1194                                 $res = $this->isEmailBlocked();
1195                                 break;
1196                         case 'upload':
1197                                 // Until T6995 is completed
1198                                 $res = $this->isSitewide();
1199                                 break;
1200                         case 'read':
1201                                 $res = false;
1202                                 break;
1203                         case 'purge':
1204                                 $res = false;
1205                                 break;
1206                 }
1207                 if ( !$res && $blockDisablesLogin ) {
1208                         // If a block would disable login, then it should
1209                         // prevent any right that all users cannot do
1210                         $anon = new User;
1211                         $res = $anon->isAllowed( $right ) ? $res : true;
1212                 }
1213
1214                 return $res;
1215         }
1216
1217         /**
1218          * Get/set whether the Block prevents a given action
1219          *
1220          * @deprecated since 1.33, use appliesToRight to determine block
1221          *  behaviour, and specific methods to get/set properties
1222          * @param string $action Action to check
1223          * @param bool|null $x Value for set, or null to just get value
1224          * @return bool|null Null for unrecognized rights.
1225          */
1226         public function prevents( $action, $x = null ) {
1227                 $config = RequestContext::getMain()->getConfig();
1228                 $blockDisablesLogin = $config->get( 'BlockDisablesLogin' );
1229                 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1230
1231                 $res = null;
1232                 switch ( $action ) {
1233                         case 'edit':
1234                                 # For now... <evil laugh>
1235                                 $res = true;
1236                                 break;
1237                         case 'createaccount':
1238                                 $res = wfSetVar( $this->blockCreateAccount, $x );
1239                                 break;
1240                         case 'sendemail':
1241                                 $res = wfSetVar( $this->mBlockEmail, $x );
1242                                 break;
1243                         case 'upload':
1244                                 // Until T6995 is completed
1245                                 $res = $this->isSitewide();
1246                                 break;
1247                         case 'editownusertalk':
1248                                 // NOTE: this check is not reliable on partial blocks
1249                                 // since partially blocked users are always allowed to edit
1250                                 // their own talk page unless a restriction exists on the
1251                                 // page or User_talk: namespace
1252                                 wfSetVar( $this->allowUsertalk, $x === null ? null : !$x );
1253                                 $res = !$this->isUserTalkEditAllowed();
1254
1255                                 // edit own user talk can be disabled by config
1256                                 if ( !$blockAllowsUTEdit ) {
1257                                         $res = true;
1258                                 }
1259                                 break;
1260                         case 'read':
1261                                 $res = false;
1262                                 break;
1263                         case 'purge':
1264                                 $res = false;
1265                                 break;
1266                 }
1267                 if ( !$res && $blockDisablesLogin ) {
1268                         // If a block would disable login, then it should
1269                         // prevent any action that all users cannot do
1270                         $anon = new User;
1271                         $res = $anon->isAllowed( $action ) ? $res : true;
1272                 }
1273
1274                 return $res;
1275         }
1276
1277         /**
1278          * Get the block name, but with autoblocked IPs hidden as per standard privacy policy
1279          * @return string Text is escaped
1280          */
1281         public function getRedactedName() {
1282                 if ( $this->mAuto ) {
1283                         return Html::element(
1284                                 'span',
1285                                 [ 'class' => 'mw-autoblockid' ],
1286                                 wfMessage( 'autoblockid', $this->mId )->text()
1287                         );
1288                 } else {
1289                         return htmlspecialchars( $this->getTarget() );
1290                 }
1291         }
1292
1293         /**
1294          * Get a timestamp of the expiry for autoblocks
1295          *
1296          * @param string|int $timestamp
1297          * @return string
1298          */
1299         public static function getAutoblockExpiry( $timestamp ) {
1300                 global $wgAutoblockExpiry;
1301
1302                 return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
1303         }
1304
1305         /**
1306          * Purge expired blocks from the ipblocks table
1307          */
1308         public static function purgeExpired() {
1309                 if ( wfReadOnly() ) {
1310                         return;
1311                 }
1312
1313                 DeferredUpdates::addUpdate( new AutoCommitUpdate(
1314                         wfGetDB( DB_MASTER ),
1315                         __METHOD__,
1316                         function ( IDatabase $dbw, $fname ) {
1317                                 $ids = $dbw->selectFieldValues( 'ipblocks',
1318                                         'ipb_id',
1319                                         [ 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
1320                                         $fname
1321                                 );
1322                                 if ( $ids ) {
1323                                         BlockRestriction::deleteByBlockId( $ids );
1324                                         $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], $fname );
1325                                 }
1326                         }
1327                 ) );
1328         }
1329
1330         /**
1331          * Given a target and the target's type, get an existing Block object if possible.
1332          * @param string|User|int $specificTarget A block target, which may be one of several types:
1333          *     * A user to block, in which case $target will be a User
1334          *     * An IP to block, in which case $target will be a User generated by using
1335          *       User::newFromName( $ip, false ) to turn off name validation
1336          *     * An IP range, in which case $target will be a String "123.123.123.123/18" etc
1337          *     * The ID of an existing block, in the format "#12345" (since pure numbers are valid
1338          *       usernames
1339          *     Calling this with a user, IP address or range will not select autoblocks, and will
1340          *     only select a block where the targets match exactly (so looking for blocks on
1341          *     1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
1342          * @param string|User|int|null $vagueTarget As above, but we will search for *any* block which
1343          *     affects that target (so for an IP address, get ranges containing that IP; and also
1344          *     get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
1345          * @param bool $fromMaster Whether to use the DB_MASTER database
1346          * @return Block|null (null if no relevant block could be found).  The target and type
1347          *     of the returned Block will refer to the actual block which was found, which might
1348          *     not be the same as the target you gave if you used $vagueTarget!
1349          */
1350         public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
1351                 list( $target, $type ) = self::parseTarget( $specificTarget );
1352                 if ( $type == self::TYPE_ID || $type == self::TYPE_AUTO ) {
1353                         return self::newFromID( $target );
1354
1355                 } elseif ( $target === null && $vagueTarget == '' ) {
1356                         # We're not going to find anything useful here
1357                         # Be aware that the == '' check is explicit, since empty values will be
1358                         # passed by some callers (T31116)
1359                         return null;
1360
1361                 } elseif ( in_array(
1362                         $type,
1363                         [ self::TYPE_USER, self::TYPE_IP, self::TYPE_RANGE, null ] )
1364                 ) {
1365                         $block = new Block();
1366                         $block->fromMaster( $fromMaster );
1367
1368                         if ( $type !== null ) {
1369                                 $block->setTarget( $target );
1370                         }
1371
1372                         if ( $block->newLoad( $vagueTarget ) ) {
1373                                 return $block;
1374                         }
1375                 }
1376                 return null;
1377         }
1378
1379         /**
1380          * Get all blocks that match any IP from an array of IP addresses
1381          *
1382          * @param array $ipChain List of IPs (strings), usually retrieved from the
1383          *     X-Forwarded-For header of the request
1384          * @param bool $isAnon Exclude anonymous-only blocks if false
1385          * @param bool $fromMaster Whether to query the master or replica DB
1386          * @return array Array of Blocks
1387          * @since 1.22
1388          */
1389         public static function getBlocksForIPList( array $ipChain, $isAnon, $fromMaster = false ) {
1390                 if ( $ipChain === [] ) {
1391                         return [];
1392                 }
1393
1394                 $conds = [];
1395                 $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
1396                 foreach ( array_unique( $ipChain ) as $ipaddr ) {
1397                         # Discard invalid IP addresses. Since XFF can be spoofed and we do not
1398                         # necessarily trust the header given to us, make sure that we are only
1399                         # checking for blocks on well-formatted IP addresses (IPv4 and IPv6).
1400                         # Do not treat private IP spaces as special as it may be desirable for wikis
1401                         # to block those IP ranges in order to stop misbehaving proxies that spoof XFF.
1402                         if ( !IP::isValid( $ipaddr ) ) {
1403                                 continue;
1404                         }
1405                         # Don't check trusted IPs (includes local squids which will be in every request)
1406                         if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) {
1407                                 continue;
1408                         }
1409                         # Check both the original IP (to check against single blocks), as well as build
1410                         # the clause to check for rangeblocks for the given IP.
1411                         $conds['ipb_address'][] = $ipaddr;
1412                         $conds[] = self::getRangeCond( IP::toHex( $ipaddr ) );
1413                 }
1414
1415                 if ( $conds === [] ) {
1416                         return [];
1417                 }
1418
1419                 if ( $fromMaster ) {
1420                         $db = wfGetDB( DB_MASTER );
1421                 } else {
1422                         $db = wfGetDB( DB_REPLICA );
1423                 }
1424                 $conds = $db->makeList( $conds, LIST_OR );
1425                 if ( !$isAnon ) {
1426                         $conds = [ $conds, 'ipb_anon_only' => 0 ];
1427                 }
1428                 $blockQuery = self::getQueryInfo();
1429                 $rows = $db->select(
1430                         $blockQuery['tables'],
1431                         array_merge( [ 'ipb_range_start', 'ipb_range_end' ], $blockQuery['fields'] ),
1432                         $conds,
1433                         __METHOD__,
1434                         [],
1435                         $blockQuery['joins']
1436                 );
1437
1438                 $blocks = [];
1439                 foreach ( $rows as $row ) {
1440                         $block = self::newFromRow( $row );
1441                         if ( !$block->isExpired() ) {
1442                                 $blocks[] = $block;
1443                         }
1444                 }
1445
1446                 return $blocks;
1447         }
1448
1449         /**
1450          * From a list of multiple blocks, find the most exact and strongest Block.
1451          *
1452          * The logic for finding the "best" block is:
1453          *  - Blocks that match the block's target IP are preferred over ones in a range
1454          *  - Hardblocks are chosen over softblocks that prevent account creation
1455          *  - Softblocks that prevent account creation are chosen over other softblocks
1456          *  - Other softblocks are chosen over autoblocks
1457          *  - If there are multiple exact or range blocks at the same level, the one chosen
1458          *    is random
1459          * This should be used when $blocks where retrieved from the user's IP address
1460          * and $ipChain is populated from the same IP address information.
1461          *
1462          * @param array $blocks Array of Block objects
1463          * @param array $ipChain List of IPs (strings). This is used to determine how "close"
1464          *     a block is to the server, and if a block matches exactly, or is in a range.
1465          *     The order is furthest from the server to nearest e.g., (Browser, proxy1, proxy2,
1466          *     local-squid, ...)
1467          * @throws MWException
1468          * @return Block|null The "best" block from the list
1469          */
1470         public static function chooseBlock( array $blocks, array $ipChain ) {
1471                 if ( $blocks === [] ) {
1472                         return null;
1473                 } elseif ( count( $blocks ) == 1 ) {
1474                         return $blocks[0];
1475                 }
1476
1477                 // Sort hard blocks before soft ones and secondarily sort blocks
1478                 // that disable account creation before those that don't.
1479                 usort( $blocks, function ( Block $a, Block $b ) {
1480                         $aWeight = (int)$a->isHardblock() . (int)$a->appliesToRight( 'createaccount' );
1481                         $bWeight = (int)$b->isHardblock() . (int)$b->appliesToRight( 'createaccount' );
1482                         return strcmp( $bWeight, $aWeight ); // highest weight first
1483                 } );
1484
1485                 $blocksListExact = [
1486                         'hard' => false,
1487                         'disable_create' => false,
1488                         'other' => false,
1489                         'auto' => false
1490                 ];
1491                 $blocksListRange = [
1492                         'hard' => false,
1493                         'disable_create' => false,
1494                         'other' => false,
1495                         'auto' => false
1496                 ];
1497                 $ipChain = array_reverse( $ipChain );
1498
1499                 /** @var Block $block */
1500                 foreach ( $blocks as $block ) {
1501                         // Stop searching if we have already have a "better" block. This
1502                         // is why the order of the blocks matters
1503                         if ( !$block->isHardblock() && $blocksListExact['hard'] ) {
1504                                 break;
1505                         } elseif ( !$block->appliesToRight( 'createaccount' ) && $blocksListExact['disable_create'] ) {
1506                                 break;
1507                         }
1508
1509                         foreach ( $ipChain as $checkip ) {
1510                                 $checkipHex = IP::toHex( $checkip );
1511                                 if ( (string)$block->getTarget() === $checkip ) {
1512                                         if ( $block->isHardblock() ) {
1513                                                 $blocksListExact['hard'] = $blocksListExact['hard'] ?: $block;
1514                                         } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1515                                                 $blocksListExact['disable_create'] = $blocksListExact['disable_create'] ?: $block;
1516                                         } elseif ( $block->mAuto ) {
1517                                                 $blocksListExact['auto'] = $blocksListExact['auto'] ?: $block;
1518                                         } else {
1519                                                 $blocksListExact['other'] = $blocksListExact['other'] ?: $block;
1520                                         }
1521                                         // We found closest exact match in the ip list, so go to the next Block
1522                                         break;
1523                                 } elseif ( array_filter( $blocksListExact ) == []
1524                                         && $block->getRangeStart() <= $checkipHex
1525                                         && $block->getRangeEnd() >= $checkipHex
1526                                 ) {
1527                                         if ( $block->isHardblock() ) {
1528                                                 $blocksListRange['hard'] = $blocksListRange['hard'] ?: $block;
1529                                         } elseif ( $block->appliesToRight( 'createaccount' ) ) {
1530                                                 $blocksListRange['disable_create'] = $blocksListRange['disable_create'] ?: $block;
1531                                         } elseif ( $block->mAuto ) {
1532                                                 $blocksListRange['auto'] = $blocksListRange['auto'] ?: $block;
1533                                         } else {
1534                                                 $blocksListRange['other'] = $blocksListRange['other'] ?: $block;
1535                                         }
1536                                         break;
1537                                 }
1538                         }
1539                 }
1540
1541                 if ( array_filter( $blocksListExact ) == [] ) {
1542                         $blocksList = &$blocksListRange;
1543                 } else {
1544                         $blocksList = &$blocksListExact;
1545                 }
1546
1547                 $chosenBlock = null;
1548                 if ( $blocksList['hard'] ) {
1549                         $chosenBlock = $blocksList['hard'];
1550                 } elseif ( $blocksList['disable_create'] ) {
1551                         $chosenBlock = $blocksList['disable_create'];
1552                 } elseif ( $blocksList['other'] ) {
1553                         $chosenBlock = $blocksList['other'];
1554                 } elseif ( $blocksList['auto'] ) {
1555                         $chosenBlock = $blocksList['auto'];
1556                 } else {
1557                         throw new MWException( "Proxy block found, but couldn't be classified." );
1558                 }
1559
1560                 return $chosenBlock;
1561         }
1562
1563         /**
1564          * From an existing Block, get the target and the type of target.
1565          * Note that, except for null, it is always safe to treat the target
1566          * as a string; for User objects this will return User::__toString()
1567          * which in turn gives User::getName().
1568          *
1569          * @param string|int|User|null $target
1570          * @return array [ User|String|null, Block::TYPE_ constant|null ]
1571          */
1572         public static function parseTarget( $target ) {
1573                 # We may have been through this before
1574                 if ( $target instanceof User ) {
1575                         if ( IP::isValid( $target->getName() ) ) {
1576                                 return [ $target, self::TYPE_IP ];
1577                         } else {
1578                                 return [ $target, self::TYPE_USER ];
1579                         }
1580                 } elseif ( $target === null ) {
1581                         return [ null, null ];
1582                 }
1583
1584                 $target = trim( $target );
1585
1586                 if ( IP::isValid( $target ) ) {
1587                         # We can still create a User if it's an IP address, but we need to turn
1588                         # off validation checking (which would exclude IP addresses)
1589                         return [
1590                                 User::newFromName( IP::sanitizeIP( $target ), false ),
1591                                 self::TYPE_IP
1592                         ];
1593
1594                 } elseif ( IP::isValidRange( $target ) ) {
1595                         # Can't create a User from an IP range
1596                         return [ IP::sanitizeRange( $target ), self::TYPE_RANGE ];
1597                 }
1598
1599                 # Consider the possibility that this is not a username at all
1600                 # but actually an old subpage (T31797)
1601                 if ( strpos( $target, '/' ) !== false ) {
1602                         # An old subpage, drill down to the user behind it
1603                         $target = explode( '/', $target )[0];
1604                 }
1605
1606                 $userObj = User::newFromName( $target );
1607                 if ( $userObj instanceof User ) {
1608                         # Note that since numbers are valid usernames, a $target of "12345" will be
1609                         # considered a User.  If you want to pass a block ID, prepend a hash "#12345",
1610                         # since hash characters are not valid in usernames or titles generally.
1611                         return [ $userObj, self::TYPE_USER ];
1612
1613                 } elseif ( preg_match( '/^#\d+$/', $target ) ) {
1614                         # Autoblock reference in the form "#12345"
1615                         return [ substr( $target, 1 ), self::TYPE_AUTO ];
1616
1617                 } else {
1618                         # WTF?
1619                         return [ null, null ];
1620                 }
1621         }
1622
1623         /**
1624          * Get the type of target for this particular block. Autoblocks have whichever type
1625          * corresponds to their target, so to detect if a block is an autoblock, we have to
1626          * check the mAuto property instead.
1627          * @return int Block::TYPE_ constant, will never be TYPE_ID
1628          */
1629         public function getType() {
1630                 return $this->mAuto
1631                         ? self::TYPE_AUTO
1632                         : $this->type;
1633         }
1634
1635         /**
1636          * Get the target and target type for this particular Block.  Note that for autoblocks,
1637          * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1638          * in this situation.
1639          * @return array [ User|String, Block::TYPE_ constant ]
1640          * @todo FIXME: This should be an integral part of the Block member variables
1641          */
1642         public function getTargetAndType() {
1643                 return [ $this->getTarget(), $this->getType() ];
1644         }
1645
1646         /**
1647          * Get the target for this particular Block.  Note that for autoblocks,
1648          * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1649          * in this situation.
1650          * @return User|string
1651          */
1652         public function getTarget() {
1653                 return $this->target;
1654         }
1655
1656         /**
1657          * @since 1.19
1658          *
1659          * @return mixed|string
1660          */
1661         public function getExpiry() {
1662                 return $this->mExpiry;
1663         }
1664
1665         /**
1666          * Set the target for this block, and update $this->type accordingly
1667          * @param mixed $target
1668          */
1669         public function setTarget( $target ) {
1670                 list( $this->target, $this->type ) = self::parseTarget( $target );
1671         }
1672
1673         /**
1674          * Get the user who implemented this block
1675          * @return User User object. May name a foreign user.
1676          */
1677         public function getBlocker() {
1678                 return $this->blocker;
1679         }
1680
1681         /**
1682          * Set the user who implemented (or will implement) this block
1683          * @param User|string $user Local User object or username string
1684          */
1685         public function setBlocker( $user ) {
1686                 if ( is_string( $user ) ) {
1687                         $user = User::newFromName( $user, false );
1688                 }
1689
1690                 if ( $user->isAnon() && User::isUsableName( $user->getName() ) ) {
1691                         throw new InvalidArgumentException(
1692                                 'Blocker must be a local user or a name that cannot be a local user'
1693                         );
1694                 }
1695
1696                 $this->blocker = $user;
1697         }
1698
1699         /**
1700          * Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be
1701          * the same as the block's, to a maximum of 24 hours.
1702          *
1703          * @since 1.29
1704          *
1705          * @param WebResponse $response The response on which to set the cookie.
1706          */
1707         public function setCookie( WebResponse $response ) {
1708                 // Calculate the default expiry time.
1709                 $maxExpiryTime = wfTimestamp( TS_MW, wfTimestamp() + ( 24 * 60 * 60 ) );
1710
1711                 // Use the Block's expiry time only if it's less than the default.
1712                 $expiryTime = $this->getExpiry();
1713                 if ( $expiryTime === 'infinity' || $expiryTime > $maxExpiryTime ) {
1714                         $expiryTime = $maxExpiryTime;
1715                 }
1716
1717                 // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie.
1718                 $expiryValue = DateTime::createFromFormat( 'YmdHis', $expiryTime )->format( 'U' );
1719                 $cookieOptions = [ 'httpOnly' => false ];
1720                 $cookieValue = $this->getCookieValue();
1721                 $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions );
1722         }
1723
1724         /**
1725          * Unset the 'BlockID' cookie.
1726          *
1727          * @since 1.29
1728          *
1729          * @param WebResponse $response The response on which to unset the cookie.
1730          */
1731         public static function clearCookie( WebResponse $response ) {
1732                 $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
1733         }
1734
1735         /**
1736          * Get the BlockID cookie's value for this block. This is usually the block ID concatenated
1737          * with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just
1738          * be the block ID.
1739          *
1740          * @since 1.29
1741          *
1742          * @return string The block ID, probably concatenated with "!" and the HMAC.
1743          */
1744         public function getCookieValue() {
1745                 $config = RequestContext::getMain()->getConfig();
1746                 $id = $this->getId();
1747                 $secretKey = $config->get( 'SecretKey' );
1748                 if ( !$secretKey ) {
1749                         // If there's no secret key, don't append a HMAC.
1750                         return $id;
1751                 }
1752                 $hmac = MWCryptHash::hmac( $id, $secretKey, false );
1753                 $cookieValue = $id . '!' . $hmac;
1754                 return $cookieValue;
1755         }
1756
1757         /**
1758          * Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of
1759          * the ID and a HMAC (see Block::setCookie), but will sometimes only be the ID.
1760          *
1761          * @since 1.29
1762          *
1763          * @param string $cookieValue The string in which to find the ID.
1764          *
1765          * @return int|null The block ID, or null if the HMAC is present and invalid.
1766          */
1767         public static function getIdFromCookieValue( $cookieValue ) {
1768                 // Extract the ID prefix from the cookie value (may be the whole value, if no bang found).
1769                 $bangPos = strpos( $cookieValue, '!' );
1770                 $id = ( $bangPos === false ) ? $cookieValue : substr( $cookieValue, 0, $bangPos );
1771                 // Get the site-wide secret key.
1772                 $config = RequestContext::getMain()->getConfig();
1773                 $secretKey = $config->get( 'SecretKey' );
1774                 if ( !$secretKey ) {
1775                         // If there's no secret key, just use the ID as given.
1776                         return $id;
1777                 }
1778                 $storedHmac = substr( $cookieValue, $bangPos + 1 );
1779                 $calculatedHmac = MWCryptHash::hmac( $id, $secretKey, false );
1780                 if ( $calculatedHmac === $storedHmac ) {
1781                         return $id;
1782                 } else {
1783                         return null;
1784                 }
1785         }
1786
1787         /**
1788          * Get the key and parameters for the corresponding error message.
1789          *
1790          * @since 1.22
1791          * @param IContextSource $context
1792          * @return array
1793          */
1794         public function getPermissionsError( IContextSource $context ) {
1795                 $params = $this->getBlockErrorParams( $context );
1796
1797                 $msg = 'blockedtext';
1798                 if ( $this->getSystemBlockType() !== null ) {
1799                         $msg = 'systemblockedtext';
1800                 } elseif ( $this->mAuto ) {
1801                         $msg = 'autoblockedtext';
1802                 } elseif ( !$this->isSitewide() ) {
1803                         $msg = 'blockedtext-partial';
1804                 }
1805
1806                 array_unshift( $params, $msg );
1807
1808                 return $params;
1809         }
1810
1811         /**
1812          * Get block information used in different block error messages
1813          *
1814          * @since 1.33
1815          * @param IContextSource $context
1816          * @return array
1817          */
1818         public function getBlockErrorParams( IContextSource $context ) {
1819                 $blocker = $this->getBlocker();
1820                 if ( $blocker instanceof User ) { // local user
1821                         $blockerUserpage = $blocker->getUserPage();
1822                         $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
1823                 } else { // foreign user
1824                         $link = $blocker;
1825                 }
1826
1827                 $reason = $this->mReason;
1828                 if ( $reason == '' ) {
1829                         $reason = $context->msg( 'blockednoreason' )->text();
1830                 }
1831
1832                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1833                  * This could be a username, an IP range, or a single IP. */
1834                 $intended = $this->getTarget();
1835                 $systemBlockType = $this->getSystemBlockType();
1836                 $lang = $context->getLanguage();
1837
1838                 return [
1839                         $link,
1840                         $reason,
1841                         $context->getRequest()->getIP(),
1842                         $this->getByName(),
1843                         $systemBlockType ?? $this->getId(),
1844                         $lang->formatExpiry( $this->mExpiry ),
1845                         (string)$intended,
1846                         $lang->userTimeAndDate( $this->mTimestamp, $context->getUser() ),
1847                 ];
1848         }
1849
1850         /**
1851          * Get Restrictions.
1852          *
1853          * Getting the restrictions will perform a database query if the restrictions
1854          * are not already loaded.
1855          *
1856          * @since 1.33
1857          * @return Restriction[]
1858          */
1859         public function getRestrictions() {
1860                 if ( $this->restrictions === null ) {
1861                         // If the block id has not been set, then do not attempt to load the
1862                         // restrictions.
1863                         if ( !$this->mId ) {
1864                                 return [];
1865                         }
1866                         $this->restrictions = BlockRestriction::loadByBlockId( $this->mId );
1867                 }
1868
1869                 return $this->restrictions;
1870         }
1871
1872         /**
1873          * Set Restrictions.
1874          *
1875          * @since 1.33
1876          * @param Restriction[] $restrictions
1877          * @return self
1878          */
1879         public function setRestrictions( array $restrictions ) {
1880                 $this->restrictions = array_filter( $restrictions, function ( $restriction ) {
1881                         return $restriction instanceof Restriction;
1882                 } );
1883
1884                 return $this;
1885         }
1886
1887         /**
1888          * Determine whether the block allows the user to edit their own
1889          * user talk page. This is done separately from Block::appliesToRight
1890          * because there is no right for editing one's own user talk page
1891          * and because the user's talk page needs to be passed into the
1892          * Block object, which is unaware of the user.
1893          *
1894          * The ipb_allow_usertalk flag (which corresponds to the property
1895          * allowUsertalk) is used on sitewide blocks and partial blocks
1896          * that contain a namespace restriction on the user talk namespace,
1897          * but do not contain a page restriction on the user's talk page.
1898          * For all other (i.e. most) partial blocks, the flag is ignored,
1899          * and the user can always edit their user talk page unless there
1900          * is a page restriction on their user talk page, in which case
1901          * they can never edit it. (Ideally the flag would be stored as
1902          * null in these cases, but the database field isn't nullable.)
1903          *
1904          * This method does not validate that the passed in talk page belongs to the
1905          * block target since the target (an IP) might not be the same as the user's
1906          * talk page (if they are logged in).
1907          *
1908          * @since 1.33
1909          * @param Title|null $usertalk The user's user talk page. If null,
1910          *  and if the target is a User, the target's userpage is used
1911          * @return bool The user can edit their talk page
1912          */
1913         public function appliesToUsertalk( Title $usertalk = null ) {
1914                 if ( !$usertalk ) {
1915                         if ( $this->target instanceof User ) {
1916                                 $usertalk = $this->target->getTalkPage();
1917                         } else {
1918                                 throw new InvalidArgumentException(
1919                                         '$usertalk must be provided if block target is not a user/IP'
1920                                 );
1921                         }
1922                 }
1923
1924                 if ( $usertalk->getNamespace() !== NS_USER_TALK ) {
1925                         throw new InvalidArgumentException(
1926                                 '$usertalk must be a user talk page'
1927                         );
1928                 }
1929
1930                 if ( !$this->isSitewide() ) {
1931                         if ( $this->appliesToPage( $usertalk->getArticleID() ) ) {
1932                                 return true;
1933                         }
1934                         if ( !$this->appliesToNamespace( NS_USER_TALK ) ) {
1935                                 return false;
1936                         }
1937                 }
1938
1939                 // This is a type of block which uses the ipb_allow_usertalk
1940                 // flag. The flag can still be overridden by global configs.
1941                 $config = RequestContext::getMain()->getConfig();
1942                 if ( !$config->get( 'BlockAllowsUTEdit' ) ) {
1943                         return true;
1944                 }
1945                 return !$this->isUsertalkEditAllowed();
1946         }
1947
1948         /**
1949          * Checks if a block applies to a particular title
1950          *
1951          * This check does not consider whether `$this->isUsertalkEditAllowed`
1952          * returns false, as the identity of the user making the hypothetical edit
1953          * isn't known here (particularly in the case of IP hardblocks, range
1954          * blocks, and auto-blocks).
1955          *
1956          * @param Title $title
1957          * @return bool
1958          */
1959         public function appliesToTitle( Title $title ) {
1960                 if ( $this->isSitewide() ) {
1961                         return true;
1962                 }
1963
1964                 $restrictions = $this->getRestrictions();
1965                 foreach ( $restrictions as $restriction ) {
1966                         if ( $restriction->matches( $title ) ) {
1967                                 return true;
1968                         }
1969                 }
1970
1971                 return false;
1972         }
1973
1974         /**
1975          * Checks if a block applies to a particular namespace
1976          *
1977          * @since 1.33
1978          *
1979          * @param int $ns
1980          * @return bool
1981          */
1982         public function appliesToNamespace( $ns ) {
1983                 if ( $this->isSitewide() ) {
1984                         return true;
1985                 }
1986
1987                 // Blocks do not apply to virtual namespaces.
1988                 if ( $ns < 0 ) {
1989                         return false;
1990                 }
1991
1992                 $restriction = $this->findRestriction( NamespaceRestriction::TYPE, $ns );
1993
1994                 return (bool)$restriction;
1995         }
1996
1997         /**
1998          * Checks if a block applies to a particular page
1999          *
2000          * This check does not consider whether `$this->isUsertalkEditAllowed`
2001          * returns false, as the identity of the user making the hypothetical edit
2002          * isn't known here (particularly in the case of IP hardblocks, range
2003          * blocks, and auto-blocks).
2004          *
2005          * @since 1.33
2006          *
2007          * @param int $pageId
2008          * @return bool
2009          */
2010         public function appliesToPage( $pageId ) {
2011                 if ( $this->isSitewide() ) {
2012                         return true;
2013                 }
2014
2015                 // If the pageId is not over zero, the block cannot apply to it.
2016                 if ( $pageId <= 0 ) {
2017                         return false;
2018                 }
2019
2020                 $restriction = $this->findRestriction( PageRestriction::TYPE, $pageId );
2021
2022                 return (bool)$restriction;
2023         }
2024
2025         /**
2026          * Find Restriction by type and value.
2027          *
2028          * @param string $type
2029          * @param int $value
2030          * @return Restriction|null
2031          */
2032         private function findRestriction( $type, $value ) {
2033                 $restrictions = $this->getRestrictions();
2034                 foreach ( $restrictions as $restriction ) {
2035                         if ( $restriction->getType() !== $type ) {
2036                                 continue;
2037                         }
2038
2039                         if ( $restriction->getValue() === $value ) {
2040                                 return $restriction;
2041                         }
2042                 }
2043
2044                 return null;
2045         }
2046 }