wiki.techinc.nl/maintenance/cleanupRemovedModules.php
Chad Horohoe 26505b170a Fix concern raised by Brion in r74108 (but has really existed since the maintenance rewrite). Right now, including a maintenance script causes it to execute. This is bad when you want to reuse the particular class but not have it start executing all by itself.
Until now, we relied on setting MW_NO_SETUP which was a) hacky, b) irreversable, and c) likely to be forgotten if you didn't use one of the wrappers like runChild().

Instead, move the freaky magic to doMaintenance and have *it* check if it's in a specific call stack that indicates this is being run from the file scope and should be executed. Rename DO_MAINTENANCE to RUN_MAINTENANCE_IF_MAIN so it's nice and clear what magic happens behind the require_once().
2011-01-13 22:58:55 +00:00

89 lines
3.2 KiB
PHP

<?php
/**
* Maintenance script to remove cache entries for removed ResourceLoader modules
* from the database
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @author Roan Kattouw
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
class CleanupRemovedModules extends Maintenance {
public function __construct() {
parent::__construct();
$this->mDescription = 'Remove cache entries for removed ResourceLoader modules from the database';
$this->addOption( 'batchsize', 'Delete rows in batches of this size. Default: 500', false, true );
$this->addOption( 'max-slave-lag', 'If the slave lag exceeds this many seconds, wait until it drops below this value. Default: 5', false, true );
}
public function execute() {
$dbw = wfGetDB( DB_MASTER );
$rl = new ResourceLoader();
$moduleNames = $rl->getModuleNames();
$moduleList = implode( ', ', array_map( array( $dbw, 'addQuotes' ), $moduleNames ) );
$limit = max( 1, intval( $this->getOption( 'batchsize', 500 ) ) );
$maxlag = intval( $this->getOption( 'max-slave-lag', 5 ) );
$this->output( "Cleaning up module_deps table...\n" );
$i = 1;
$modDeps = $dbw->tableName( 'module_deps' );
do {
// $dbw->delete() doesn't support LIMIT :(
$where = $moduleList ? "md_module NOT IN ($moduleList)" : '1=1';
$dbw->query( "DELETE FROM $modDeps WHERE $where LIMIT $limit", __METHOD__ );
$numRows = $dbw->affectedRows();
$this->output( "Batch $i: $numRows rows\n" );
$i++;
wfWaitForSlaves( $maxlag );
} while( $numRows > 0 );
$this->output( "done\n" );
$this->output( "Cleaning up msg_resource table...\n" );
$i = 1;
$mrRes = $dbw->tableName( 'msg_resource' );
do {
$where = $moduleList ? "mr_resource NOT IN ($moduleList)" : '1=1';
$dbw->query( "DELETE FROM $mrRes WHERE $where LIMIT $limit", __METHOD__ );
$numRows = $dbw->affectedRows();
$this->output( "Batch $i: $numRows rows\n" );
$i++;
wfWaitForSlaves( $maxlag );
} while( $numRows > 0 );
$this->output( "done\n" );
$this->output( "Cleaning up msg_resource_links table...\n" );
$i = 1;
$msgResLinks = $dbw->tableName( 'msg_resource_links' );
do {
$where = $moduleList ? "mrl_resource NOT IN ($moduleList)" : '1=1';
$dbw->query( "DELETE FROM $msgResLinks WHERE $where LIMIT $limit", __METHOD__ );
$numRows = $dbw->affectedRows();
$this->output( "Batch $i: $numRows rows\n" );
$i++;
wfWaitForSlaves( $maxlag );
} while( $numRows > 0 );
$this->output( "done\n" );
}
}
$maintClass = "CleanupRemovedModules";
require_once( RUN_MAINTENANCE_IF_MAIN );