includes/block/BlockRestriction.php

   1 <?php
   2 /**
   3  * Block restriction interface.
   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 namespace MediaWiki\Block;
  24
  25 use MediaWiki\Block\Restriction\NamespaceRestriction;
  26 use MediaWiki\Block\Restriction\PageRestriction;
  27 use MediaWiki\Block\Restriction\Restriction;
  28 use Wikimedia\Rdbms\IResultWrapper;
  29 use Wikimedia\Rdbms\IDatabase;
  30
  31 class BlockRestriction {
  32
  33         /**
  34          * Map of all of the restriction types.
  35          */
  36         private static $types = [
  37                 PageRestriction::TYPE_ID => PageRestriction::class,
  38                 NamespaceRestriction::TYPE_ID => NamespaceRestriction::class,
  39         ];
  40
  41         /**
  42          * Retrieves the restrictions from the database by block id.
  43          *
  44          * @since 1.33
  45          * @param int|array $blockId
  46          * @param IDatabase|null $db
  47          * @return Restriction[]
  48          */
  49         public static function loadByBlockId( $blockId, IDatabase $db = null ) {
  50                 if ( $blockId === null || $blockId === [] ) {
  51                         return [];
  52                 }
  53
  54                 $db = $db ?: wfGetDb( DB_REPLICA );
  55
  56                 $result = $db->select(
  57                         [ 'ipblocks_restrictions', 'page' ],
  58                         [ 'ir_ipb_id', 'ir_type', 'ir_value', 'page_namespace', 'page_title' ],
  59                         [ 'ir_ipb_id' => $blockId ],
  60                         __METHOD__,
  61                         [],
  62                         [ 'page' => [ 'LEFT JOIN', [ 'ir_type' => PageRestriction::TYPE_ID, 'ir_value=page_id' ] ] ]
  63                 );
  64
  65                 return self::resultToRestrictions( $result );
  66         }
  67
  68         /**
  69          * Inserts the restrictions into the database.
  70          *
  71          * @since 1.33
  72          * @param Restriction[] $restrictions
  73          * @return bool
  74          */
  75         public static function insert( array $restrictions ) {
  76                 if ( empty( $restrictions ) ) {
  77                         return false;
  78                 }
  79
  80                 $rows = [];
  81                 foreach ( $restrictions as $restriction ) {
  82                         if ( !$restriction instanceof Restriction ) {
  83                                 continue;
  84                         }
  85                         $rows[] = $restriction->toRow();
  86                 }
  87
  88                 if ( empty( $rows ) ) {
  89                         return false;
  90                 }
  91
  92                 $dbw = wfGetDB( DB_MASTER );
  93
  94                 return $dbw->insert(
  95                         'ipblocks_restrictions',
  96                         $rows,
  97                         __METHOD__,
  98                         [ 'IGNORE' ]
  99                 );
 100         }
 101
 102         /**
 103          * Updates the list of restrictions. This method does not allow removing all
 104          * of the restrictions. To do that, use ::deleteByBlockId().
 105          *
 106          * @since 1.33
 107          * @param Restriction[] $restrictions
 108          * @return bool
 109          */
 110         public static function update( array $restrictions ) {
 111                 $dbw = wfGetDB( DB_MASTER );
 112
 113                 $dbw->startAtomic( __METHOD__ );
 114
 115                 // Organize the restrictions by blockid.
 116                 $restrictionList = self::restrictionsByBlockId( $restrictions );
 117
 118                 // Load the existing restrictions and organize by block id. Any block ids
 119                 // that were passed into this function will be used to load all of the
 120                 // existing restrictions. This list might be the same, or may be completely
 121                 // different.
 122                 $existingList = [];
 123                 $blockIds = array_keys( $restrictionList );
 124                 if ( !empty( $blockIds ) ) {
 125                         $result = $dbw->select(
 126                                 [ 'ipblocks_restrictions' ],
 127                                 [ 'ir_ipb_id', 'ir_type', 'ir_value' ],
 128                                 [ 'ir_ipb_id' => $blockIds ],
 129                                 __METHOD__,
 130                                 [ 'FOR UPDATE' ]
 131                         );
 132
 133                         $existingList = self::restrictionsByBlockId(
 134                                 self::resultToRestrictions( $result )
 135                         );
 136                 }
 137
 138                 $result = true;
 139                 // Perform the actions on a per block-id basis.
 140                 foreach ( $restrictionList as $blockId => $blockRestrictions ) {
 141                         // Insert all of the restrictions first, ignoring ones that already exist.
 142                         $success = self::insert( $blockRestrictions );
 143
 144                         // Update the result. The first false is the result, otherwise, true.
 145                         $result = $success && $result;
 146
 147                         $restrictionsToRemove = self::restrictionsToRemove(
 148                                 $existingList[$blockId] ?? [],
 149                                 $restrictions
 150                         );
 151
 152                         if ( empty( $restrictionsToRemove ) ) {
 153                                 continue;
 154                         }
 155
 156                         $success = self::delete( $restrictionsToRemove );
 157
 158                         // Update the result. The first false is the result, otherwise, true.
 159                         $result = $success && $result;
 160                 }
 161
 162                 $dbw->endAtomic( __METHOD__ );
 163
 164                 return $result;
 165         }
 166
 167         /**
 168          * Updates the list of restrictions by parent id.
 169          *
 170          * @since 1.33
 171          * @param int $parentBlockId
 172          * @param Restriction[] $restrictions
 173          * @return bool
 174          */
 175         public static function updateByParentBlockId( $parentBlockId, array $restrictions ) {
 176                 // If removing all of the restrictions, then just delete them all.
 177                 if ( empty( $restrictions ) ) {
 178                         return self::deleteByParentBlockId( $parentBlockId );
 179                 }
 180
 181                 $parentBlockId = (int)$parentBlockId;
 182
 183                 $db = wfGetDb( DB_MASTER );
 184
 185                 $db->startAtomic( __METHOD__ );
 186
 187                 $blockIds = $db->selectFieldValues(
 188                         'ipblocks',
 189                         'ipb_id',
 190                         [ 'ipb_parent_block_id' => $parentBlockId ],
 191                         __METHOD__,
 192                         [ 'FOR UPDATE' ]
 193                 );
 194
 195                 $result = true;
 196                 foreach ( $blockIds as $id ) {
 197                         $success = self::update( self::setBlockId( $id, $restrictions ) );
 198                         // Update the result. The first false is the result, otherwise, true.
 199                         $result = $success && $result;
 200                 }
 201
 202                 $db->endAtomic( __METHOD__ );
 203
 204                 return $result;
 205         }
 206
 207         /**
 208          * Delete the restrictions.
 209          *
 210          * @since 1.33
 211          * @param Restriction[]|null $restrictions
 212          * @throws MWException
 213          * @return bool
 214          */
 215         public static function delete( array $restrictions ) {
 216                 $dbw = wfGetDB( DB_MASTER );
 217                 $result = true;
 218                 foreach ( $restrictions as $restriction ) {
 219                         if ( !$restriction instanceof Restriction ) {
 220                                 continue;
 221                         }
 222
 223                         $success = $dbw->delete(
 224                                 'ipblocks_restrictions',
 225                                 // The restriction row is made up of a compound primary key. Therefore,
 226                                 // the row and the delete conditions are the same.
 227                                 $restriction->toRow(),
 228                                 __METHOD__
 229                         );
 230                         // Update the result. The first false is the result, otherwise, true.
 231                         $result = $success && $result;
 232                 }
 233
 234                 return $result;
 235         }
 236
 237         /**
 238          * Delete the restrictions by Block ID.
 239          *
 240          * @since 1.33
 241          * @param int|array $blockId
 242          * @throws MWException
 243          * @return bool
 244          */
 245         public static function deleteByBlockId( $blockId ) {
 246                 $dbw = wfGetDB( DB_MASTER );
 247                 return $dbw->delete(
 248                         'ipblocks_restrictions',
 249                         [ 'ir_ipb_id' => $blockId ],
 250                         __METHOD__
 251                 );
 252         }
 253
 254         /**
 255          * Delete the restrictions by Parent Block ID.
 256          *
 257          * @since 1.33
 258          * @param int|array $parentBlockId
 259          * @throws MWException
 260          * @return bool
 261          */
 262         public static function deleteByParentBlockId( $parentBlockId ) {
 263                 $dbw = wfGetDB( DB_MASTER );
 264                 return $dbw->deleteJoin(
 265                         'ipblocks_restrictions',
 266                         'ipblocks',
 267                         'ir_ipb_id',
 268                         'ipb_id',
 269                         [ 'ipb_parent_block_id' => $parentBlockId ],
 270                         __METHOD__
 271                 );
 272         }
 273
 274         /**
 275          * Checks if two arrays of Restrictions are effectively equal. This is a loose
 276          * equality check as the restrictions do not have to contain the same block
 277          * ids.
 278          *
 279          * @since 1.33
 280          * @param Restriction[] $a
 281          * @param Restriction[] $b
 282          * @return bool
 283          */
 284         public static function equals( array $a, array $b ) {
 285                 $filter = function ( $restriction ) {
 286                         return $restriction instanceof Restriction;
 287                 };
 288
 289                 // Ensure that every item in the array is a Restriction. This prevents a
 290                 // fatal error from calling Restriction::getHash if something in the array
 291                 // is not a restriction.
 292                 $a = array_filter( $a, $filter );
 293                 $b = array_filter( $b, $filter );
 294
 295                 $aCount = count( $a );
 296                 $bCount = count( $b );
 297
 298                 // If the count is different, then they are obviously a different set.
 299                 if ( $aCount !== $bCount ) {
 300                         return false;
 301                 }
 302
 303                 // If both sets contain no items, then they are the same set.
 304                 if ( $aCount === 0 && $bCount === 0 ) {
 305                         return true;
 306                 }
 307
 308                 $hasher = function ( $r ) {
 309                         return $r->getHash();
 310                 };
 311
 312                 $aHashes = array_map( $hasher, $a );
 313                 $bHashes = array_map( $hasher, $b );
 314
 315                 sort( $aHashes );
 316                 sort( $bHashes );
 317
 318                 return $aHashes === $bHashes;
 319         }
 320
 321         /**
 322          * Set the blockId on a set of restrictions and return a new set.
 323          *
 324          * @since 1.33
 325          * @param int $blockId
 326          * @param Restriction[] $restrictions
 327          * @return Restriction[]
 328          */
 329         public static function setBlockId( $blockId, array $restrictions ) {
 330                 $blockRestrictions = [];
 331
 332                 foreach ( $restrictions as $restriction ) {
 333                         if ( !$restriction instanceof Restriction ) {
 334                                 continue;
 335                         }
 336
 337                         // Clone the restriction so any references to the current restriction are
 338                         // not suddenly changed to a different blockId.
 339                         $restriction = clone $restriction;
 340                         $restriction->setBlockId( $blockId );
 341
 342                         $blockRestrictions[] = $restriction;
 343                 }
 344
 345                 return $blockRestrictions;
 346         }
 347
 348         /**
 349          * Get the restrictions that should be removed, which are existing
 350          * restrictions that are not in the new list of restrictions.
 351          *
 352          * @param Restriction[] $existing
 353          * @param Restriction[] $new
 354          * @return array
 355          */
 356         private static function restrictionsToRemove( array $existing, array $new ) {
 357                 return array_filter( $existing, function ( $e ) use ( $new ) {
 358                         foreach ( $new as $restriction ) {
 359                                 if ( !$restriction instanceof Restriction ) {
 360                                         continue;
 361                                 }
 362
 363                                 if ( $restriction->equals( $e ) ) {
 364                                         return false;
 365                                 }
 366                         }
 367
 368                         return true;
 369                 } );
 370         }
 371
 372         /**
 373          * Converts an array of restrictions to an associative array of restrictions
 374          * where the keys are the block ids.
 375          *
 376          * @param Restriction[] $restrictions
 377          * @return array
 378          */
 379         private static function restrictionsByBlockId( array $restrictions ) {
 380                 $blockRestrictions = [];
 381
 382                 foreach ( $restrictions as $restriction ) {
 383                         // Ensure that all of the items in the array are restrictions.
 384                         if ( !$restriction instanceof Restriction ) {
 385                                 continue;
 386                         }
 387
 388                         if ( !isset( $blockRestrictions[$restriction->getBlockId()] ) ) {
 389                                 $blockRestrictions[$restriction->getBlockId()] = [];
 390                         }
 391
 392                         $blockRestrictions[$restriction->getBlockId()][] = $restriction;
 393                 }
 394
 395                 return $blockRestrictions;
 396         }
 397
 398         /**
 399          * Convert an Result Wrapper to an array of restrictions.
 400          *
 401          * @param IResultWrapper $result
 402          * @return Restriction[]
 403          */
 404         private static function resultToRestrictions( IResultWrapper $result ) {
 405                 $restrictions = [];
 406                 foreach ( $result as $row ) {
 407                         $restriction = self::rowToRestriction( $row );
 408
 409                         if ( !$restriction ) {
 410                                 continue;
 411                         }
 412
 413                         $restrictions[] = $restriction;
 414                 }
 415
 416                 return $restrictions;
 417         }
 418
 419         /**
 420          * Convert a result row from the database into a restriction object.
 421          *
 422          * @param \stdClass $row
 423          * @return Restriction|null
 424          */
 425         private static function rowToRestriction( \stdClass $row ) {
 426                 if ( array_key_exists( (int)$row->ir_type, self::$types ) ) {
 427                         $class = self::$types[ (int)$row->ir_type ];
 428                         return call_user_func( [ $class, 'newFromRow' ], $row );
 429                 }
 430
 431                 return null;
 432         }
 433 }