maintenance/cleanupRemovedModules.php

   1 <?php
   2 /**
   3  * Remove cache entries for removed ResourceLoader modules from the database.
   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  * @ingroup Maintenance
  22  * @author Roan Kattouw
  23  */
  24
  25 use MediaWiki\Maintenance\Maintenance;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 // @codeCoverageIgnoreStart
  29 require_once __DIR__ . '/Maintenance.php';
  30 // @codeCoverageIgnoreEnd
  31
  32 /**
  33  * Maintenance script to remove cache entries for removed ResourceLoader modules
  34  * from the database.
  35  *
  36  * @ingroup Maintenance
  37  */
  38 class CleanupRemovedModules extends Maintenance {
  39
  40         public function __construct() {
  41                 parent::__construct();
  42                 $this->addDescription(
  43                         'Remove cache entries for removed ResourceLoader modules from the database' );
  44                 $this->setBatchSize( 500 );
  45         }
  46
  47         public function execute() {
  48                 $this->output( "Cleaning up module_deps table...\n" );
  49
  50                 $dbw = $this->getPrimaryDB();
  51                 $rl = $this->getServiceContainer()->getResourceLoader();
  52                 $moduleNames = $rl->getModuleNames();
  53                 $res = $dbw->newSelectQueryBuilder()
  54                         ->select( [ 'md_module', 'md_skin' ] )
  55                         ->from( 'module_deps' )
  56                         ->where( $moduleNames ? $dbw->expr( 'md_module', '!=', $moduleNames ) : [] )
  57                         ->caller( __METHOD__ )
  58                         ->fetchResultSet();
  59                 $rows = iterator_to_array( $res, false );
  60
  61                 $modDeps = $dbw->tableName( 'module_deps' );
  62                 $i = 1;
  63                 foreach ( array_chunk( $rows, $this->getBatchSize() ) as $chunk ) {
  64                         // WHERE ( mod=A AND skin=A ) OR ( mod=A AND skin=B) ..
  65                         $conds = array_map( static function ( stdClass $row ) use ( $dbw ) {
  66                                 return $dbw->makeList( (array)$row, IDatabase::LIST_AND );
  67                         }, $chunk );
  68                         $conds = $dbw->makeList( $conds, IDatabase::LIST_OR );
  69
  70                         $this->beginTransaction( $dbw, __METHOD__ );
  71                         $dbw->query( "DELETE FROM $modDeps WHERE $conds", __METHOD__ );
  72                         $numRows = $dbw->affectedRows();
  73                         $this->output( "Batch $i: $numRows rows\n" );
  74                         $this->commitTransaction( $dbw, __METHOD__ );
  75
  76                         $i++;
  77                 }
  78
  79                 $this->output( "Done\n" );
  80         }
  81 }
  82
  83 // @codeCoverageIgnoreStart
  84 $maintClass = CleanupRemovedModules::class;
  85 require_once RUN_MAINTENANCE_IF_MAIN;
  86 // @codeCoverageIgnoreEnd