* (bug 4147) Added cleanupWatchlist.php to clear out bogus watchlist entries

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index eb2a94a..8829e76 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -603,6 +603,7 @@ fully support the editing toolbar, but was found to be too confusing.
 * (bug 4828) Fix genitive month-name variable for cs, pl, uk
 * (bug 4842) Fix 'show number of watching users' with enhanced RC
 * (bug 4889) Fix image talk namespace for Tamil
+* (bug 4147) Added cleanupWatchlist.php to clear out bogus watchlist entries
 
 
 === Caveats ===

diff --git a/maintenance/cleanupWatchlist.php b/maintenance/cleanupWatchlist.php
new file mode 100644 (file)
index 0000000..1a1d574
--- /dev/null
+++ b/maintenance/cleanupWatchlist.php
@@ -0,0 +1,141 @@
+<?php
+/*
+ * Script to remove broken, unparseable titles in the Watchlist.
+ *
+ * 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/
+ *
+ * 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.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @author Brion Vibber <brion at pobox.com>
+ * @package MediaWiki
+ * @subpackage maintenance
+ */
+
+$options = array( 'fix' );
+
+require_once( 'commandLine.inc' );
+require_once( 'FiveUpgrade.inc' );
+
+class WatchlistCleanup extends FiveUpgrade {
+       function WatchlistCleanup( $dryrun = false ) {
+               parent::FiveUpgrade();
+
+               $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
+               $this->dryrun = $dryrun;
+       }
+
+       function cleanup() {
+               $this->runTable( 'watchlist',
+                       '',
+                       array( &$this, 'processEntry' ) );
+       }
+
+       function init( $count, $table ) {
+               $this->processed = 0;
+               $this->updated = 0;
+               $this->count = $count;
+               $this->startTime = wfTime();
+               $this->table = $table;
+       }
+
+       function progress( $updated ) {
+               $this->updated += $updated;
+               $this->processed++;
+               if( $this->processed % 100 != 0 ) {
+                       return;
+               }
+               $portion = $this->processed / $this->count;
+               $updateRate = $this->updated / $this->processed;
+
+               $now = wfTime();
+               $delta = $now - $this->startTime;
+               $estimatedTotalTime = $delta / $portion;
+               $eta = $this->startTime + $estimatedTotalTime;
+
+               global $wgDBname;
+               printf( "%s %s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
+                       $wgDBname,
+                       wfTimestamp( TS_DB, intval( $now ) ),
+                       $portion * 100.0,
+                       $this->table,
+                       wfTimestamp( TS_DB, intval( $eta ) ),
+                       $this->processed,
+                       $this->count,
+                       $this->processed / $delta,
+                       $updateRate * 100.0 );
+               flush();
+       }
+
+       function runTable( $table, $where, $callback ) {
+               $fname = 'WatchlistCleanup::runTable';
+
+               $count = $this->dbw->selectField( $table, 'count(*)', '', $fname );
+               $this->init( $count, 'watchlist' );
+               $this->log( "Processing $table..." );
+
+               $tableName = $this->dbr->tableName( $table );
+               $sql = "SELECT * FROM $tableName $where";
+               $result = $this->dbr->query( $sql, $fname );
+
+               while( $row = $this->dbr->fetchObject( $result ) ) {
+                       $updated = call_user_func( $callback, $row );
+               }
+               $this->log( "Finished $table... $this->updated of $this->processed rows updated" );
+               $this->dbr->freeResult( $result );
+       }
+
+       function processEntry( $row ) {
+               global $wgContLang;
+
+               $current = Title::makeTitle( $row->wl_namespace, $row->wl_title );
+               $display = $current->getPrefixedText();
+
+               $verified = UtfNormal::cleanUp( $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 );
+               }
+
+               $this->progress( 0 );
+       }
+       
+       function removeWatch( $row ) {
+               if( !$this->dryrun) {
+                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw->delete( 'watchlist', array(
+                               'wl_user'      => $row->wl_user,
+                               'wl_namespace' => $row->wl_namespace,
+                               'wl_title'     => $row->wl_title ),
+                       'WatchlistCleanup::removeWatch' );
+                       $this->log( '- removed' );
+               }
+       }
+}
+
+$wgUser->setName( 'Conversion script' );
+$caps = new WatchlistCleanup( !isset( $options['fix'] ) );
+$caps->cleanup();
+
+?>