maintenance/purgeRecentChanges.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\Maintenance\Maintenance;
  22
  23 // @codeCoverageIgnoreStart
  24 require_once __DIR__ . '/Maintenance.php';
  25 // @codeCoverageIgnoreEnd
  26
  27 /**
  28  * Purge rows from the recentchanges table older than wgRCMaxAge.
  29  *
  30  * Useful to run on wikis which are infrequently edited and therefore RecentChangesUpdateJob
  31  * may not be run frequently enough.
  32  *
  33  * @ingroup RecentChanges
  34  * @ingroup Maintenance
  35  * @since 1.43
  36  */
  37 class PurgeRecentChanges extends Maintenance {
  38         public function __construct() {
  39                 parent::__construct();
  40                 $this->addDescription( 'Purge rows from the recentchanges table which are older than wgRCMaxAge.' );
  41         }
  42
  43         public function execute() {
  44                 // Run directly instead of pushing to the job queue, so that the script will exit only once the
  45                 // purge is complete. If a job is already running to do the purge, then the script will exit early.
  46                 // However, this is fine because a purge is already in progress.
  47                 $recentChangesPruneJob = RecentChangesUpdateJob::newPurgeJob();
  48                 $recentChangesPruneJob->run();
  49                 $this->output( "Finished purging data from recentchanges.\n" );
  50         }
  51 }
  52
  53 // @codeCoverageIgnoreStart
  54 $maintClass = PurgeRecentChanges::class;
  55 require_once RUN_MAINTENANCE_IF_MAIN;
  56 // @codeCoverageIgnoreEnd