purgeParserCache.php

Go to the documentation of this file.

<?php
require __DIR__ . '/Maintenance.php';
 
use MediaWiki\MediaWikiServices;
 
class PurgeParserCache extends Maintenance {
    public $lastProgress;
 
    private $usleep = 0;
 
    public function __construct() {
        parent::__construct();
        $this->addDescription( "Remove old objects from the parser cache. " .
            "This only works when the parser cache is in an SQL database." );
        $this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
        $this->addOption(
            'age',
            'Delete objects created more than this many seconds ago, assuming ' .
                '$wgParserCacheExpireTime has remained consistent.',
            false,
            true );
        $this->addOption( 'msleep', 'Milliseconds to sleep between purge chunks', false, true );
    }
 
    public function execute() {
        global $wgParserCacheExpireTime;
 
        $inputDate = $this->getOption( 'expiredate' );
        $inputAge = $this->getOption( 'age' );
        if ( $inputDate !== null ) {
            $date = wfTimestamp( TS_MW, strtotime( $inputDate ) );
        } elseif ( $inputAge !== null ) {
            $date = wfTimestamp( TS_MW, time() + $wgParserCacheExpireTime - intval( $inputAge ) );
        } else {
            $this->fatalError( "Must specify either --expiredate or --age" );
            return;
        }
        $this->usleep = 1e3 * $this->getOption( 'msleep', 0 );
 
        $english = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( 'en' );
        $this->output( "Deleting objects expiring before " .
            $english->timeanddate( $date ) . "\n" );
 
        $pc = MediaWikiServices::getInstance()->getParserCache()->getCacheStorage();
        $success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgressAndWait' ] );
        if ( !$success ) {
            $this->fatalError( "\nCannot purge this kind of parser cache." );
        }
        $this->showProgressAndWait( 100 );
        $this->output( "\nDone\n" );
    }
 
    public function showProgressAndWait( $percent ) {
        // avoid lag; T150124
        usleep( $this->usleep );
 
        $percentString = sprintf( "%.2f", $percent );
        if ( $percentString === $this->lastProgress ) {
            return;
        }
        $this->lastProgress = $percentString;
 
        $stars = floor( $percent / 2 );
        $this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
            "$percentString%\r" );
    }
}
 
$maintClass = PurgeParserCache::class;
require_once RUN_MAINTENANCE_IF_MAIN;