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\MediaWikiServices;
  26
  27 require_once __DIR__ . '/Maintenance.php';
  28
  29 /**
  30  * Maintenance script to remove cache entries for removed ResourceLoader modules
  31  * from the database.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class CleanupRemovedModules extends Maintenance {
  36
  37         public function __construct() {
  38                 parent::__construct();
  39                 $this->addDescription(
  40                         'Remove cache entries for removed ResourceLoader modules from the database' );
  41                 $this->addOption( 'batchsize', 'Delete rows in batches of this size. Default: 500', false, true );
  42         }
  43
  44         public function execute() {
  45                 $dbw = $this->getDB( DB_MASTER );
  46                 $rl = new ResourceLoader( MediaWikiServices::getInstance()->getMainConfig() );
  47                 $moduleNames = $rl->getModuleNames();
  48                 $moduleList = implode( ', ', array_map( [ $dbw, 'addQuotes' ], $moduleNames ) );
  49                 $limit = max( 1, intval( $this->getOption( 'batchsize', 500 ) ) );
  50
  51                 $this->output( "Cleaning up module_deps table...\n" );
  52                 $i = 1;
  53                 $modDeps = $dbw->tableName( 'module_deps' );
  54                 do {
  55                         // $dbw->delete() doesn't support LIMIT :(
  56                         $where = $moduleList ? "md_module NOT IN ($moduleList)" : '1=1';
  57                         $dbw->query( "DELETE FROM $modDeps WHERE $where LIMIT $limit", __METHOD__ );
  58                         $numRows = $dbw->affectedRows();
  59                         $this->output( "Batch $i: $numRows rows\n" );
  60                         $i++;
  61                         wfWaitForSlaves();
  62                 } while ( $numRows > 0 );
  63                 $this->output( "done\n" );
  64         }
  65 }
  66
  67 $maintClass = "CleanupRemovedModules";
  68 require_once RUN_MAINTENANCE_IF_MAIN;