getBools doesn't exist in Translate anymore
[lhc/web/wiklou.git] / maintenance / userDupes.inc
index 00c4e34..be45a11 100644 (file)
@@ -1,33 +1,55 @@
 <?php
-# Copyright (C) 2005 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * Helper class for update.php and upgrade1_5.php.
+ *
+ * Copyright © 2005 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance
+ */
 
 /**
  * Look for duplicate user table entries and optionally prune them.
+ *
+ * This is still used by our MysqlUpdater at:
+ * includes/installer/MysqlUpdater.php
+ *
+ * @ingroup Maintenance
  */
 class UserDupes {
-       var $db;
-       var $reassigned;
-       var $trimmed;
-       var $failed;
+       private $db;
+       private $reassigned;
+       private $trimmed;
+       private $failed;
+       private $outputCallback;
+
+       function __construct( &$database, $outputCallback ) {
+               $this->db = $database;
+               $this->outputCallback = $outputCallback;
+       }
 
-       function UserDupes( &$database ) {
-               $this->db =& $database;
+       /**
+        * Output some text via the output callback provided
+        * @param $str String Text to print
+        */
+       private function out( $str ) {
+               call_user_func( $this->outputCallback, $str );
        }
 
        /**
@@ -36,10 +58,9 @@ class UserDupes {
         * @return bool
         */
        function hasUniqueIndex() {
-               $fname = 'UserDupes::hasUniqueIndex';
-               $info = $this->db->indexInfo( 'user', 'user_name', $fname );
-               if( !$info ) {
-                       echo "WARNING: doesn't seem to have user_name index at all!\n";
+               $info = $this->db->indexInfo( 'user', 'user_name', __METHOD__ );
+               if ( !$info ) {
+                       $this->out( "WARNING: doesn't seem to have user_name index at all!\n" );
                        return false;
                }
 
@@ -74,60 +95,60 @@ class UserDupes {
         * not requested. (If doing resolution, edits may be reassigned.)
         * Status information will be echo'd to stdout.
         *
-        * @param bool $doDelete pass true to actually remove things
-        *                       from the database; false to just check.
+        * @param $doDelete bool: pass true to actually remove things
+        *                  from the database; false to just check.
         * @return bool
         */
        function checkDupes( $doDelete = false ) {
-               if( $this->hasUniqueIndex() ) {
-                       echo wfWikiID()." already has a unique index on its user table.\n";
+               if ( $this->hasUniqueIndex() ) {
+                       echo wfWikiID() . " already has a unique index on its user table.\n";
                        return true;
                }
 
                $this->lock();
 
-               echo "Checking for duplicate accounts...\n";
+               $this->out( "Checking for duplicate accounts...\n" );
                $dupes = $this->getDupes();
                $count = count( $dupes );
 
-               echo "Found $count accounts with duplicate records on ".wfWikiID().".\n";
+               $this->out( "Found $count accounts with duplicate records on " . wfWikiID() . ".\n" );
                $this->trimmed    = 0;
                $this->reassigned = 0;
                $this->failed     = 0;
-               foreach( $dupes as $name ) {
+               foreach ( $dupes as $name ) {
                        $this->examine( $name, $doDelete );
                }
 
                $this->unlock();
 
-               echo "\n";
+               $this->out( "\n" );
 
-               if( $this->reassigned > 0 ) {
-                       if( $doDelete ) {
-                               echo "$this->reassigned duplicate accounts had edits reassigned to a canonical record id.\n";
+               if ( $this->reassigned > 0 ) {
+                       if ( $doDelete ) {
+                               $this->out( "$this->reassigned duplicate accounts had edits reassigned to a canonical record id.\n" );
                        } else {
-                               echo "$this->reassigned duplicate accounts need to have edits reassigned.\n";
+                               $this->out( "$this->reassigned duplicate accounts need to have edits reassigned.\n" );
                        }
                }
 
-               if( $this->trimmed > 0 ) {
-                       if( $doDelete ) {
-                               echo "$this->trimmed duplicate user records were deleted from ".wfWikiID().".\n";
+               if ( $this->trimmed > 0 ) {
+                       if ( $doDelete ) {
+                               $this->out( "$this->trimmed duplicate user records were deleted from " . wfWikiID() . ".\n" );
                        } else {
-                               echo "$this->trimmed duplicate user accounts were found on ".wfWikiID()." which can be removed safely.\n";
+                               $this->out( "$this->trimmed duplicate user accounts were found on " . wfWikiID() . " which can be removed safely.\n" );
                        }
                }
 
-               if( $this->failed > 0 ) {
-                       echo "Something terribly awry; $this->failed duplicate accounts were not removed.\n";
+               if ( $this->failed > 0 ) {
+                       $this->out( "Something terribly awry; $this->failed duplicate accounts were not removed.\n" );
                        return false;
                }
 
-               if( $this->trimmed == 0 || $doDelete ) {
-                       echo "It is now safe to apply the unique index on user_name.\n";
+               if ( $this->trimmed == 0 || $doDelete ) {
+                       $this->out( "It is now safe to apply the unique index on user_name.\n" );
                        return true;
                } else {
-                       echo "Run this script again with the --fix option to automatically delete them.\n";
+                       $this->out( "Run this script again with the --fix option to automatically delete them.\n" );
                        return false;
                }
        }
@@ -137,8 +158,7 @@ class UserDupes {
         * @access private
         */
        function lock() {
-               $fname = 'UserDupes::lock';
-               if( $this->newSchema() ) {
+               if ( $this->newSchema() ) {
                        $set = array( 'user', 'revision' );
                } else {
                        $set = array( 'user', 'cur', 'old' );
@@ -146,7 +166,7 @@ class UserDupes {
                $names = array_map( array( $this, 'lockTable' ), $set );
                $tables = implode( ',', $names );
 
-               $this->db->query( "LOCK TABLES $tables", $fname );
+               $this->db->query( "LOCK TABLES $tables", __METHOD__ );
        }
 
        function lockTable( $table ) {
@@ -158,15 +178,14 @@ class UserDupes {
         * @access private
         */
        function newSchema() {
-               return class_exists( 'Revision' );
+               return MWInit::classExists( 'Revision' );
        }
 
        /**
         * @access private
         */
        function unlock() {
-               $fname = 'UserDupes::unlock';
-               $this->db->query( "UNLOCK TABLES", $fname );
+               $this->db->query( "UNLOCK TABLES", __METHOD__ );
        }
 
        /**
@@ -175,20 +194,17 @@ class UserDupes {
         * @access private
         */
        function getDupes() {
-               $fname = 'UserDupes::listDupes';
                $user = $this->db->tableName( 'user' );
                $result = $this->db->query(
                         "SELECT user_name,COUNT(*) AS n
-                           FROM $user
+                               FROM $user
                        GROUP BY user_name
-                         HAVING n > 1", $fname );
+                         HAVING n > 1", __METHOD__ );
 
                $list = array();
-               while( $row = $this->db->fetchObject( $result ) ) {
+               foreach ( $result as $row ) {
                        $list[] = $row->user_name;
                }
-               $this->db->freeResult( $result );
-
                return $list;
        }
 
@@ -196,63 +212,61 @@ class UserDupes {
         * Examine user records for the given name. Try to see which record
         * will be the one that actually gets used, then check remaining records
         * for edits. If the dupes have no edits, we can safely remove them.
-        * @param string $name
-        * @param bool $doDelete
+        * @param $name string
+        * @param $doDelete bool
         * @access private
         */
        function examine( $name, $doDelete ) {
-               $fname = 'UserDupes::listDupes';
                $result = $this->db->select( 'user',
                        array( 'user_id' ),
                        array( 'user_name' => $name ),
-                       $fname );
+                       __METHOD__ );
 
                $firstRow = $this->db->fetchObject( $result );
                $firstId  = $firstRow->user_id;
-               echo "Record that will be used for '$name' is user_id=$firstId\n";
+               $this->out( "Record that will be used for '$name' is user_id=$firstId\n" );
 
-               while( $row = $this->db->fetchObject( $result ) ) {
+               foreach ( $result as $row ) {
                        $dupeId = $row->user_id;
-                       echo "... dupe id $dupeId: ";
+                       $this->out( "... dupe id $dupeId: " );
                        $edits = $this->editCount( $dupeId );
-                       if( $edits > 0 ) {
+                       if ( $edits > 0 ) {
                                $this->reassigned++;
-                               echo "has $edits edits! ";
-                               if( $doDelete ) {
+                               $this->out( "has $edits edits! " );
+                               if ( $doDelete ) {
                                        $this->reassignEdits( $dupeId, $firstId );
                                        $newEdits = $this->editCount( $dupeId );
-                                       if( $newEdits == 0 ) {
-                                               echo "confirmed cleaned. ";
+                                       if ( $newEdits == 0 ) {
+                                               $this->out( "confirmed cleaned. " );
                                        } else {
                                                $this->failed++;
-                                               echo "WARNING! $newEdits remaining edits for $dupeId; NOT deleting user.\n";
+                                               $this->out( "WARNING! $newEdits remaining edits for $dupeId; NOT deleting user.\n" );
                                                continue;
                                        }
                                } else {
-                                       echo "(will need to reassign edits on fix)";
+                                       $this->out( "(will need to reassign edits on fix)" );
                                }
                        } else {
-                               echo "ok, no edits. ";
+                               $this->out( "ok, no edits. " );
                        }
                        $this->trimmed++;
-                       if( $doDelete ) {
+                       if ( $doDelete ) {
                                $this->trimAccount( $dupeId );
                        }
-                       echo "\n";
+                       $this->out( "\n" );
                }
-               $this->db->freeResult( $result );
        }
 
        /**
         * Count the number of edits attributed to this user.
         * Does not currently check log table or other things
         * where it might show up...
-        * @param int $userid
+        * @param $userid int
         * @return int
         * @access private
         */
        function editCount( $userid ) {
-               if( $this->newSchema() ) {
+               if ( $this->newSchema() ) {
                        return $this->editCountOn( 'revision', 'rev_user', $userid );
                } else {
                        return $this->editCountOn( 'cur', 'cur_user', $userid ) +
@@ -262,65 +276,59 @@ class UserDupes {
 
        /**
         * Count the number of hits on a given table for this account.
-        * @param string $table
-        * @param string $field
-        * @param int $userid
+        * @param $table string
+        * @param $field string
+        * @param $userid int
         * @return int
         * @access private
         */
        function editCountOn( $table, $field, $userid ) {
-               $fname = 'UserDupes::editCountOn';
                return intval( $this->db->selectField(
                        $table,
                        'COUNT(*)',
                        array( $field => $userid ),
-                       $fname ) );
+                       __METHOD__ ) );
        }
 
        /**
-        * @param int $from
-        * @param int $to
+        * @param $from int
+        * @param $to int
         * @access private
         */
        function reassignEdits( $from, $to ) {
                $set = $this->newSchema()
                        ? array( 'revision' => 'rev_user' )
                        : array( 'cur' => 'cur_user', 'old' => 'old_user' );
-               foreach( $set as $table => $field ) {
+               foreach ( $set as $table => $field ) {
                        $this->reassignEditsOn( $table, $field, $from, $to );
                }
        }
 
        /**
-        * @param string $table
-        * @param string $field
-        * @param int $from
-        * @param int $to
+        * @param $table string
+        * @param $field string
+        * @param $from int
+        * @param $to int
         * @access private
         */
        function reassignEditsOn( $table, $field, $from, $to ) {
-               $fname = 'UserDupes::reassignEditsOn';
-               echo "reassigning on $table... ";
+               $this->out( "reassigning on $table... " );
                $this->db->update( $table,
                        array( $field => $to ),
                        array( $field => $from ),
-                       $fname );
-               echo "ok. ";
+                       __METHOD__ );
+               $this->out( "ok. " );
        }
 
        /**
         * Remove a user account line.
-        * @param int $userid
+        * @param $userid int
         * @access private
         */
        function trimAccount( $userid ) {
-               $fname = 'UserDupes::trimAccount';
-               echo "deleting...";
-               $this->db->delete( 'user', array( 'user_id' => $userid ), $fname );
-               echo " ok";
+               $this->out( "deleting..." );
+               $this->db->delete( 'user', array( 'user_id' => $userid ), __METHOD__ );
+               $this->out( " ok" );
        }
 
 }
-
-
-?>