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
110 lines
3.3 KiB
PHP
110 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Remove broken, unparseable titles in the watchlist table.
|
|
*
|
|
* Usage: php cleanupWatchlist.php [--fix]
|
|
* Options:
|
|
* --fix Actually remove entries; without will only report.
|
|
*
|
|
* Copyright © 2005,2006 Brooke Vibber <bvibber@wikimedia.org>
|
|
* https://www.mediawiki.org/
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @author Brooke Vibber <bvibber@wikimedia.org>
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
use MediaWiki\MainConfigNames;
|
|
use MediaWiki\Title\Title;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/TableCleanup.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script to remove broken, unparseable titles in the watchlist table.
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class CleanupWatchlist extends TableCleanup {
|
|
protected $defaultParams = [
|
|
'table' => 'watchlist',
|
|
'index' => [ 'wl_id' ],
|
|
'conds' => [],
|
|
'callback' => 'processRow'
|
|
];
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Script to remove broken, unparseable titles in the Watchlist' );
|
|
$this->addOption( 'fix', 'Actually remove entries; without will only report.' );
|
|
}
|
|
|
|
public function execute() {
|
|
if ( !$this->hasOption( 'fix' ) ) {
|
|
$this->output( "Dry run only: use --fix to enable updates\n" );
|
|
}
|
|
parent::execute();
|
|
}
|
|
|
|
protected function processRow( $row ) {
|
|
$current = Title::makeTitle( $row->wl_namespace, $row->wl_title );
|
|
$display = $current->getPrefixedText();
|
|
$verified = $this->getServiceContainer()->getContentLanguage()->normalize( $display );
|
|
$title = Title::newFromText( $verified );
|
|
|
|
if ( $row->wl_user == 0 || $title === null || !$title->equals( $current ) ) {
|
|
$this->output( "invalid watch by {$row->wl_user} for "
|
|
. "({$row->wl_namespace}, \"{$row->wl_title}\")\n" );
|
|
$updated = $this->removeWatch( $row );
|
|
$this->progress( $updated );
|
|
|
|
return;
|
|
}
|
|
$this->progress( 0 );
|
|
}
|
|
|
|
private function removeWatch( $row ) {
|
|
if ( !$this->dryrun && $this->hasOption( 'fix' ) ) {
|
|
$dbw = $this->getPrimaryDB();
|
|
$dbw->newDeleteQueryBuilder()
|
|
->deleteFrom( 'watchlist' )
|
|
->where( [ 'wl_id' => $row->wl_id ] )
|
|
->caller( __METHOD__ )
|
|
->execute();
|
|
if ( $this->getConfig()->get( MainConfigNames::WatchlistExpiry ) ) {
|
|
$dbw->newDeleteQueryBuilder()
|
|
->deleteFrom( 'watchlist_expiry' )
|
|
->where( [ 'we_item' => $row->wl_id ] )
|
|
->caller( __METHOD__ )
|
|
->execute();
|
|
}
|
|
|
|
$this->output( "- removed\n" );
|
|
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = CleanupWatchlist::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|