maintenance/cleanupUsersWithNoId.php

   1 <?php
   2 /**
   3  * Cleanup tables that have valid usernames with no user ID
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 use Wikimedia\Rdbms\IDatabase;
  25
  26 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script that cleans up tables that have valid usernames with no
  30  * user ID.
  31  *
  32  * @ingroup Maintenance
  33  * @since 1.31
  34  */
  35 class CleanupUsersWithNoId extends LoggedUpdateMaintenance {
  36         private $prefix, $table, $assign;
  37         private $triedCreations = [];
  38
  39         public function __construct() {
  40                 parent::__construct();
  41                 $this->addDescription( 'Cleans up tables that have valid usernames with no user ID' );
  42                 $this->addOption( 'prefix', 'Interwiki prefix to apply to the usernames', true, true, 'p' );
  43                 $this->addOption( 'table', 'Only clean up this table', false, true );
  44                 $this->addOption( 'assign', 'Assign edits to existing local users if they exist', false, false );
  45                 $this->setBatchSize( 100 );
  46         }
  47
  48         protected function getUpdateKey() {
  49                 return __CLASS__;
  50         }
  51
  52         protected function doDBUpdates() {
  53                 $this->prefix = $this->getOption( 'prefix' );
  54                 $this->table = $this->getOption( 'table', null );
  55                 $this->assign = $this->getOption( 'assign' );
  56
  57                 $this->cleanup(
  58                         'revision', 'rev_id', 'rev_user', 'rev_user_text',
  59                         [ 'rev_user' => 0 ], [ 'rev_timestamp', 'rev_id' ]
  60                 );
  61                 $this->cleanup(
  62                         'archive', 'ar_id', 'ar_user', 'ar_user_text',
  63                         [], [ 'ar_id' ]
  64                 );
  65                 $this->cleanup(
  66                         'logging', 'log_id', 'log_user', 'log_user_text',
  67                         [ 'log_user' => 0 ], [ 'log_timestamp', 'log_id' ]
  68                 );
  69                 $this->cleanup(
  70                         'image', 'img_name', 'img_user', 'img_user_text',
  71                         [ 'img_user' => 0 ], [ 'img_timestamp', 'img_name' ]
  72                 );
  73                 $this->cleanup(
  74                         'oldimage', [ 'oi_name', 'oi_timestamp' ], 'oi_user', 'oi_user_text',
  75                         [], [ 'oi_name', 'oi_timestamp' ]
  76                 );
  77                 $this->cleanup(
  78                         'filearchive', 'fa_id', 'fa_user', 'fa_user_text',
  79                         [], [ 'fa_id' ]
  80                 );
  81                 $this->cleanup(
  82                         'ipblocks', 'ipb_id', 'ipb_by', 'ipb_by_text',
  83                         [], [ 'ipb_id' ]
  84                 );
  85                 $this->cleanup(
  86                         'recentchanges', 'rc_id', 'rc_user', 'rc_user_text',
  87                         [], [ 'rc_id' ]
  88                 );
  89
  90                 return true;
  91         }
  92
  93         /**
  94          * Calculate a "next" condition and progress display string
  95          * @param IDatabase $dbw
  96          * @param string[] $indexFields Fields in the index being ordered by
  97          * @param object $row Database row
  98          * @return string[] [ string $next, string $display ]
  99          */
 100         private function makeNextCond( $dbw, $indexFields, $row ) {
 101                 $next = '';
 102                 $display = [];
 103                 for ( $i = count( $indexFields ) - 1; $i >= 0; $i-- ) {
 104                         $field = $indexFields[$i];
 105                         $display[] = $field . '=' . $row->$field;
 106                         $value = $dbw->addQuotes( $row->$field );
 107                         if ( $next === '' ) {
 108                                 $next = "$field > $value";
 109                         } else {
 110                                 $next = "$field > $value OR $field = $value AND ($next)";
 111                         }
 112                 }
 113                 $display = implode( ' ', array_reverse( $display ) );
 114                 return [ $next, $display ];
 115         }
 116
 117         /**
 118          * Cleanup a table
 119          *
 120          * @param string $table Table to migrate
 121          * @param string|string[] $primaryKey Primary key of the table.
 122          * @param string $idField User ID field name
 123          * @param string $nameField User name field name
 124          * @param array $conds Query conditions
 125          * @param string[] $orderby Fields to order by
 126          */
 127         protected function cleanup(
 128                 $table, $primaryKey, $idField, $nameField, array $conds, array $orderby
 129         ) {
 130                 if ( $this->table !== null && $this->table !== $table ) {
 131                         return;
 132                 }
 133
 134                 $primaryKey = (array)$primaryKey;
 135                 $pkFilter = array_flip( $primaryKey );
 136                 $this->output(
 137                         "Beginning cleanup of $table\n"
 138                 );
 139
 140                 $dbw = $this->getDB( DB_MASTER );
 141                 $next = '1=1';
 142                 $countAssigned = 0;
 143                 $countPrefixed = 0;
 144                 while ( true ) {
 145                         // Fetch the rows needing update
 146                         $res = $dbw->select(
 147                                 $table,
 148                                 array_merge( $primaryKey, [ $idField, $nameField ], $orderby ),
 149                                 array_merge( $conds, [ $next ] ),
 150                                 __METHOD__,
 151                                 [
 152                                         'ORDER BY' => $orderby,
 153                                         'LIMIT' => $this->mBatchSize,
 154                                 ]
 155                         );
 156                         if ( !$res->numRows() ) {
 157                                 break;
 158                         }
 159
 160                         // Update the existing rows
 161                         foreach ( $res as $row ) {
 162                                 $name = $row->$nameField;
 163                                 if ( $row->$idField || !User::isUsableName( $name ) ) {
 164                                         continue;
 165                                 }
 166
 167                                 $id = 0;
 168                                 if ( $this->assign ) {
 169                                         $id = User::idFromName( $name );
 170                                         if ( !$id ) {
 171                                                 // See if any extension wants to create it.
 172                                                 if ( !isset( $this->triedCreations[$name] ) ) {
 173                                                         $this->triedCreations[$name] = true;
 174                                                         if ( !Hooks::run( 'ImportHandleUnknownUser', [ $name ] ) ) {
 175                                                                 $id = User::idFromName( $name, User::READ_LATEST );
 176                                                         }
 177                                                 }
 178                                         }
 179                                 }
 180                                 if ( $id ) {
 181                                         $set = [ $idField => $id ];
 182                                         $counter = &$countAssigned;
 183                                 } else {
 184                                         $set = [ $nameField => substr( $this->prefix . '>' . $name, 0, 255 ) ];
 185                                         $counter = &$countPrefixed;
 186                                 }
 187
 188                                 $dbw->update(
 189                                         $table,
 190                                         $set,
 191                                         array_intersect_key( (array)$row, $pkFilter ) + [
 192                                                 $idField => 0,
 193                                                 $nameField => $name,
 194                                         ],
 195                                         __METHOD__
 196                                 );
 197                                 $counter += $dbw->affectedRows();
 198                         }
 199
 200                         list( $next, $display ) = $this->makeNextCond( $dbw, $orderby, $row );
 201                         $this->output( "... $display\n" );
 202                         wfWaitForSlaves();
 203                 }
 204
 205                 $this->output(
 206                         "Completed cleanup, assigned $countAssigned and prefixed $countPrefixed row(s)\n"
 207                 );
 208         }
 209 }
 210
 211 $maintClass = CleanupUsersWithNoId::class;
 212 require_once RUN_MAINTENANCE_IF_MAIN;