maintenance/purgeParserCache.php

   1 <?php
   2 /**
   3  * Remove old objects from the parser cache.
   4  * This only works when the parser cache is in an SQL database.
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 require __DIR__ . '/Maintenance.php';
  26
  27 /**
  28  * Maintenance script to remove old objects from the parser cache.
  29  *
  30  * @ingroup Maintenance
  31  */
  32 class PurgeParserCache extends Maintenance {
  33         public $lastProgress;
  34
  35         private $usleep = 0;
  36
  37         function __construct() {
  38                 parent::__construct();
  39                 $this->addDescription( "Remove old objects from the parser cache. " .
  40                         "This only works when the parser cache is in an SQL database." );
  41                 $this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
  42                 $this->addOption(
  43                         'age',
  44                         'Delete objects created more than this many seconds ago, assuming ' .
  45                                 '$wgParserCacheExpireTime has remained consistent.',
  46                         false,
  47                         true );
  48                 $this->addOption( 'msleep', 'Milliseconds to sleep between purge chunks', false, true );
  49         }
  50
  51         function execute() {
  52                 global $wgParserCacheExpireTime;
  53
  54                 $inputDate = $this->getOption( 'expiredate' );
  55                 $inputAge = $this->getOption( 'age' );
  56                 if ( $inputDate !== null ) {
  57                         $date = wfTimestamp( TS_MW, strtotime( $inputDate ) );
  58                 } elseif ( $inputAge !== null ) {
  59                         $date = wfTimestamp( TS_MW, time() + $wgParserCacheExpireTime - intval( $inputAge ) );
  60                 } else {
  61                         $this->error( "Must specify either --expiredate or --age", 1 );
  62                         return;
  63                 }
  64                 $this->usleep = 1e3 * $this->getOption( 'msleep', 0 );
  65
  66                 $english = Language::factory( 'en' );
  67                 $this->output( "Deleting objects expiring before " .
  68                         $english->timeanddate( $date ) . "\n" );
  69
  70                 $pc = wfGetParserCacheStorage();
  71                 $success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgressAndWait' ] );
  72                 if ( !$success ) {
  73                         $this->error( "\nCannot purge this kind of parser cache.", 1 );
  74                 }
  75                 $this->showProgressAndWait( 100 );
  76                 $this->output( "\nDone\n" );
  77         }
  78
  79         public function showProgressAndWait( $percent ) {
  80                 usleep( $this->usleep ); // avoid lag; T150124
  81
  82                 $percentString = sprintf( "%.2f", $percent );
  83                 if ( $percentString === $this->lastProgress ) {
  84                         return;
  85                 }
  86                 $this->lastProgress = $percentString;
  87
  88                 $stars = floor( $percent / 2 );
  89                 $this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
  90                         "$percentString%\r" );
  91         }
  92 }
  93
  94 $maintClass = 'PurgeParserCache';
  95 require_once RUN_MAINTENANCE_IF_MAIN;