MediaWiki 1.30.2-scripts

[autoinstalls/mediawiki.git] / maintenance / cleanupWatchlist.php

diff --git a/maintenance/cleanupWatchlist.php b/maintenance/cleanupWatchlist.php
index bfc3a1e284d26c7b0868cfca1814b41411fe1c4c..9728ac5ded89eb75118647e88c6b030ab9eb1ab4 100644 (file)
--- a/maintenance/cleanupWatchlist.php
+++ b/maintenance/cleanupWatchlist.php
@@ -1,13 +1,13 @@
 <?php
-/*
- * Script to remove broken, unparseable titles in the Watchlist.
+/**
+ * Remove broken, unparseable titles in the watchlist table.
  *
  * Usage: php cleanupWatchlist.php [--fix]
  * Options:
  *   --fix  Actually remove entries; without will only report.
  *
- * Copyright (C) 2005,2006 Brion Vibber <brion@pobox.com>
- * http://www.mediawiki.org/
+ * Copyright © 2005,2006 Brion Vibber <brion@pobox.com>
+ * 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
@@ -29,49 +29,71 @@
  * @ingroup Maintenance
  */
 
-require_once( 'commandLine.inc' );
-require_once( 'cleanupTable.inc' );
+require_once __DIR__ . '/cleanupTable.inc';
 
 /**
+ * Maintenance script to remove broken, unparseable titles in the watchlist table.
+ *
  * @ingroup Maintenance
  */
 class WatchlistCleanup extends TableCleanup {
-       function __construct( $dryrun = false ) {
-               parent::__construct( 'watchlist', $dryrun );
+       protected $defaultParams = [
+               'table' => 'watchlist',
+               'index' => [ 'wl_user', 'wl_namespace', 'wl_title' ],
+               '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.' );
+       }
+
+       function execute() {
+               if ( !$this->hasOption( 'fix' ) ) {
+                       $this->output( "Dry run only: use --fix to enable updates\n" );
+               }
+               parent::execute();
        }
 
-       function processPage( $row ) {
+       protected function processRow( $row ) {
+               global $wgContLang;
                $current = Title::makeTitle( $row->wl_namespace, $row->wl_title );
                $display = $current->getPrefixedText();
-
-               $verified = UtfNormal::cleanUp( $display );
-
+               $verified = $wgContLang->normalize( $display );
                $title = Title::newFromText( $verified );
 
-               if( $row->wl_user == 0 || is_null( $title ) || !$title->equals( $current ) ) {
-                       $this->log( "invalid watch by {$row->wl_user} for ({$row->wl_namespace}, \"{$row->wl_title}\")" );
-                       $this->removeWatch( $row );
-                       return $this->progress( 1 );
-               }
+               if ( $row->wl_user == 0 || is_null( $title ) || !$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 );
        }
-       
-       function removeWatch( $row ) {
-               if( !$this->dryrun ) {
-                       $dbw = wfGetDB( DB_MASTER );
-                       $dbw->delete( 'watchlist', array(
-                               'wl_user'      => $row->wl_user,
+
+       private function removeWatch( $row ) {
+               if ( !$this->dryrun && $this->hasOption( 'fix' ) ) {
+                       $dbw = $this->getDB( DB_MASTER );
+                       $dbw->delete(
+                               'watchlist', [
+                               'wl_user' => $row->wl_user,
                                'wl_namespace' => $row->wl_namespace,
-                               'wl_title'     => $row->wl_title ),
-                       __METHOD__ );
-                       $this->log( '- removed' );
+                               'wl_title' => $row->wl_title ],
+                               __METHOD__
+                       );
+
+                       $this->output( "- removed\n" );
+
+                       return 1;
+               } else {
+                       return 0;
                }
        }
 }
 
-$wgUser->setName( 'Conversion script' );
-$caps = new WatchlistCleanup( !isset( $options['fix'] ) );
-$caps->cleanup();
-
-
+$maintClass = "WatchlistCleanup";
+require_once RUN_MAINTENANCE_IF_MAIN;