e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
51 lines
1.4 KiB
PHP
51 lines
1.4 KiB
PHP
<?php
|
|
/**
|
|
* Purge expired watchlist items, looping through 500 at a time.
|
|
*/
|
|
|
|
use MediaWiki\MainConfigNames;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
class PurgeExpiredWatchlistItems extends Maintenance {
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Removes expired items from the watchlist and watchlist_expiry tables.' );
|
|
$this->setBatchSize( 500 );
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function execute() {
|
|
// Make sure watchlist expiring is enabled.
|
|
if ( !$this->getServiceContainer()->getMainConfig()->get( MainConfigNames::WatchlistExpiry ) ) {
|
|
$this->error( "Watchlist expiry is not enabled. Set `\$wgWatchlistExpiry = true;` to enable." );
|
|
return false;
|
|
}
|
|
|
|
// Loop through 500 entries at a time and delete them.
|
|
$watchedItemStore = $this->getServiceContainer()->getWatchedItemStore();
|
|
$count = $watchedItemStore->countExpired();
|
|
$this->output( $count . " expired watchlist entries found.\n" );
|
|
if ( $count === 0 ) {
|
|
// None found to delete.
|
|
return true;
|
|
}
|
|
while ( $watchedItemStore->countExpired() > 0 ) {
|
|
$watchedItemStore->removeExpired( $this->getBatchSize(), true );
|
|
}
|
|
|
|
// Report success.
|
|
$this->output( "All expired entries purged.\n" );
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = PurgeExpiredWatchlistItems::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|