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 require_once __DIR__ . '/Maintenance.php';
  26
  27 /**
  28  * Maintenance script to remove cache entries for removed ResourceLoader modules
  29  * from the database.
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class CleanupRemovedModules extends Maintenance {
  34
  35         public function __construct() {
  36                 parent::__construct();
  37                 $this->mDescription = 'Remove cache entries for removed ResourceLoader modules from the database';
  38                 $this->addOption( 'batchsize', 'Delete rows in batches of this size. Default: 500', false, true );
  39                 $this->addOption(
  40                         'max-slave-lag',
  41                         'If the slave lag exceeds this many seconds, wait until it drops below this value. '
  42                                 . 'Default: 5',
  43                         false,
  44                         true
  45                 );
  46         }
  47
  48         public function execute() {
  49                 $dbw = wfGetDB( DB_MASTER );
  50                 $rl = new ResourceLoader( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) );
  51                 $moduleNames = $rl->getModuleNames();
  52                 $moduleList = implode( ', ', array_map( array( $dbw, 'addQuotes' ), $moduleNames ) );
  53                 $limit = max( 1, intval( $this->getOption( 'batchsize', 500 ) ) );
  54                 $maxlag = intval( $this->getOption( 'max-slave-lag', 5 ) );
  55
  56                 $this->output( "Cleaning up module_deps table...\n" );
  57                 $i = 1;
  58                 $modDeps = $dbw->tableName( 'module_deps' );
  59                 do {
  60                         // $dbw->delete() doesn't support LIMIT :(
  61                         $where = $moduleList ? "md_module NOT IN ($moduleList)" : '1=1';
  62                         $dbw->query( "DELETE FROM $modDeps WHERE $where LIMIT $limit", __METHOD__ );
  63                         $numRows = $dbw->affectedRows();
  64                         $this->output( "Batch $i: $numRows rows\n" );
  65                         $i++;
  66                         wfWaitForSlaves( $maxlag );
  67                 } while ( $numRows > 0 );
  68                 $this->output( "done\n" );
  69
  70                 $this->output( "Cleaning up msg_resource table...\n" );
  71                 $i = 1;
  72
  73                 $mrRes = $dbw->tableName( 'msg_resource' );
  74                 do {
  75                         $where = $moduleList ? "mr_resource NOT IN ($moduleList)" : '1=1';
  76                         $dbw->query( "DELETE FROM $mrRes WHERE $where LIMIT $limit", __METHOD__ );
  77                         $numRows = $dbw->affectedRows();
  78                         $this->output( "Batch $i: $numRows rows\n" );
  79                         $i++;
  80                         wfWaitForSlaves( $maxlag );
  81                 } while ( $numRows > 0 );
  82                 $this->output( "done\n" );
  83
  84                 $this->output( "Cleaning up msg_resource_links table...\n" );
  85                 $i = 1;
  86                 $msgResLinks = $dbw->tableName( 'msg_resource_links' );
  87                 do {
  88                         $where = $moduleList ? "mrl_resource NOT IN ($moduleList)" : '1=1';
  89                         $dbw->query( "DELETE FROM $msgResLinks WHERE $where LIMIT $limit", __METHOD__ );
  90                         $numRows = $dbw->affectedRows();
  91                         $this->output( "Batch $i: $numRows rows\n" );
  92                         $i++;
  93                         wfWaitForSlaves( $maxlag );
  94                 } while ( $numRows > 0 );
  95                 $this->output( "done\n" );
  96         }
  97 }
  98
  99 $maintClass = "CleanupRemovedModules";
 100 require_once RUN_MAINTENANCE_IF_MAIN;