3 * Remove old objects from the parser cache.
4 * This only works when the parser cache is in an SQL database.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
25 require __DIR__
. '/Maintenance.php';
27 use MediaWiki\MediaWikiServices
;
30 * Maintenance script to remove old objects from the parser cache.
32 * @ingroup Maintenance
34 class PurgeParserCache
extends Maintenance
{
39 function __construct() {
40 parent
::__construct();
41 $this->addDescription( "Remove old objects from the parser cache. " .
42 "This only works when the parser cache is in an SQL database." );
43 $this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
46 'Delete objects created more than this many seconds ago, assuming ' .
47 '$wgParserCacheExpireTime has remained consistent.',
50 $this->addOption( 'msleep', 'Milliseconds to sleep between purge chunks', false, true );
54 global $wgParserCacheExpireTime;
56 $inputDate = $this->getOption( 'expiredate' );
57 $inputAge = $this->getOption( 'age' );
58 if ( $inputDate !== null ) {
59 $date = wfTimestamp( TS_MW
, strtotime( $inputDate ) );
60 } elseif ( $inputAge !== null ) {
61 $date = wfTimestamp( TS_MW
, time() +
$wgParserCacheExpireTime - intval( $inputAge ) );
63 $this->fatalError( "Must specify either --expiredate or --age" );
66 $this->usleep
= 1e3
* $this->getOption( 'msleep', 0 );
68 $english = Language
::factory( 'en' );
69 $this->output( "Deleting objects expiring before " .
70 $english->timeanddate( $date ) . "\n" );
72 $pc = MediaWikiServices
::getInstance()->getParserCache()->getCacheStorage();
73 $success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgressAndWait' ] );
75 $this->fatalError( "\nCannot purge this kind of parser cache." );
77 $this->showProgressAndWait( 100 );
78 $this->output( "\nDone\n" );
81 public function showProgressAndWait( $percent ) {
82 usleep( $this->usleep
); // avoid lag; T150124
84 $percentString = sprintf( "%.2f", $percent );
85 if ( $percentString === $this->lastProgress
) {
88 $this->lastProgress
= $percentString;
90 $stars = floor( $percent / 2 );
91 $this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
92 "$percentString%\r" );
96 $maintClass = 'PurgeParserCache';
97 require_once RUN_MAINTENANCE_IF_MAIN
;