maintenance/populateLogSearch.php

   1 <?php
   2 /**
   3  * Makes the required database updates for populating the
   4  * log_search table retroactively
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 require_once __DIR__ . '/Maintenance.php';
  26
  27 /**
  28  * Maintenance script that makes the required database updates for populating the
  29  * log_search table retroactively
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class PopulateLogSearch extends LoggedUpdateMaintenance {
  34         private static $tableMap = [
  35                 'rev' => 'revision',
  36                 'fa' => 'filearchive',
  37                 'oi' => 'oldimage',
  38                 'ar' => 'archive'
  39         ];
  40
  41         public function __construct() {
  42                 parent::__construct();
  43                 $this->addDescription( 'Migrate log params to new table and index for searching' );
  44                 $this->setBatchSize( 100 );
  45         }
  46
  47         protected function getUpdateKey() {
  48                 return 'populate log_search';
  49         }
  50
  51         protected function updateSkippedMessage() {
  52                 return 'log_search table already populated.';
  53         }
  54
  55         protected function doDBUpdates() {
  56                 global $wgActorTableSchemaMigrationStage;
  57
  58                 $batchSize = $this->getBatchSize();
  59                 $db = $this->getDB( DB_MASTER );
  60                 if ( !$db->tableExists( 'log_search' ) ) {
  61                         $this->error( "log_search does not exist" );
  62
  63                         return false;
  64                 }
  65                 $start = $db->selectField( 'logging', 'MIN(log_id)', '', __FUNCTION__ );
  66                 if ( !$start ) {
  67                         $this->output( "Nothing to do.\n" );
  68
  69                         return true;
  70                 }
  71                 $end = $db->selectField( 'logging', 'MAX(log_id)', '', __FUNCTION__ );
  72
  73                 # Do remaining chunk
  74                 $end += $batchSize - 1;
  75                 $blockStart = $start;
  76                 $blockEnd = $start + $batchSize - 1;
  77
  78                 $delTypes = [ 'delete', 'suppress' ]; // revisiondelete types
  79                 while ( $blockEnd <= $end ) {
  80                         $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
  81                         $cond = "log_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd;
  82                         $res = $db->select(
  83                                 'logging', [ 'log_id', 'log_type', 'log_action', 'log_params' ], $cond, __FUNCTION__
  84                         );
  85                         foreach ( $res as $row ) {
  86                                 if ( LogEventsList::typeAction( $row, $delTypes, 'revision' ) ) {
  87                                         // RevisionDelete logs - revisions
  88                                         $params = LogPage::extractParams( $row->log_params );
  89                                         // Param format: <urlparam> <item CSV> [<ofield> <nfield>]
  90                                         if ( count( $params ) < 2 ) {
  91                                                 continue; // bad row?
  92                                         }
  93                                         $field = RevisionDeleter::getRelationType( $params[0] );
  94                                         // B/C, the params may start with a title key (<title> <urlparam> <CSV>)
  95                                         if ( $field == null ) {
  96                                                 array_shift( $params ); // remove title param
  97                                                 $field = RevisionDeleter::getRelationType( $params[0] );
  98                                                 if ( $field == null ) {
  99                                                         $this->output( "Invalid param type for {$row->log_id}\n" );
 100                                                         continue; // skip this row
 101                                                 } else {
 102                                                         // Clean up the row...
 103                                                         $db->update( 'logging',
 104                                                                 [ 'log_params' => implode( ',', $params ) ],
 105                                                                 [ 'log_id' => $row->log_id ] );
 106                                                 }
 107                                         }
 108                                         $items = explode( ',', $params[1] );
 109                                         $log = new LogPage( $row->log_type );
 110                                         // Add item relations...
 111                                         $log->addRelations( $field, $items, $row->log_id );
 112                                         // Query item author relations...
 113                                         $prefix = substr( $field, 0, strpos( $field, '_' ) ); // db prefix
 114                                         if ( !isset( self::$tableMap[$prefix] ) ) {
 115                                                 continue; // bad row?
 116                                         }
 117                                         $tables = [ self::$tableMap[$prefix] ];
 118                                         $fields = [];
 119                                         $joins = [];
 120                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
 121                                                 // Read the old fields if we're still writing them regardless of read mode, to handle upgrades
 122                                                 $fields['userid'] = $prefix . '_user';
 123                                                 $fields['username'] = $prefix . '_user_text';
 124                                         }
 125                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
 126                                                 // Read the new fields if we're writing them regardless of read mode, to handle upgrades
 127                                                 if ( $prefix === 'rev' ) {
 128                                                         $tables[] = 'revision_actor_temp';
 129                                                         $joins['revision_actor_temp'] = [
 130                                                                 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) ? 'LEFT JOIN' : 'JOIN',
 131                                                                 'rev_id = revactor_rev',
 132                                                         ];
 133                                                         $fields['actorid'] = 'revactor_actor';
 134                                                 } else {
 135                                                         $fields['actorid'] = $prefix . '_actor';
 136                                                 }
 137                                         }
 138                                         $sres = $db->select( $tables, $fields, [ $field => $items ], __METHOD__, [], $joins );
 139                                 } elseif ( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
 140                                         // RevisionDelete logs - log events
 141                                         $params = LogPage::extractParams( $row->log_params );
 142                                         // Param format: <item CSV> [<ofield> <nfield>]
 143                                         if ( count( $params ) < 1 ) {
 144                                                 continue; // bad row
 145                                         }
 146                                         $items = explode( ',', $params[0] );
 147                                         $log = new LogPage( $row->log_type );
 148                                         // Add item relations...
 149                                         $log->addRelations( 'log_id', $items, $row->log_id );
 150                                         // Query item author relations...
 151                                         $fields = [];
 152                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
 153                                                 // Read the old fields if we're still writing them regardless of read mode, to handle upgrades
 154                                                 $fields['userid'] = 'log_user';
 155                                                 $fields['username'] = 'log_user_text';
 156                                         }
 157                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
 158                                                 // Read the new fields if we're writing them regardless of read mode, to handle upgrades
 159                                                 $fields['actorid'] = 'log_actor';
 160                                         }
 161
 162                                         $sres = $db->select( 'logging', $fields, [ 'log_id' => $items ], __METHOD__ );
 163                                 } else {
 164                                         continue;
 165                                 }
 166
 167                                 // Add item author relations...
 168                                 $userIds = $userIPs = $userActors = [];
 169                                 foreach ( $sres as $srow ) {
 170                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
 171                                                 if ( $srow->userid > 0 ) {
 172                                                         $userIds[] = intval( $srow->userid );
 173                                                 } elseif ( $srow->username != '' ) {
 174                                                         $userIPs[] = $srow->username;
 175                                                 }
 176                                         }
 177                                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
 178                                                 if ( $srow->actorid ) {
 179                                                         $userActors[] = intval( $srow->actorid );
 180                                                 } elseif ( $srow->userid > 0 ) {
 181                                                         $userActors[] = User::newFromId( $srow->userid )->getActorId( $db );
 182                                                 } else {
 183                                                         $userActors[] = User::newFromName( $srow->username, false )->getActorId( $db );
 184                                                 }
 185                                         }
 186                                 }
 187                                 // Add item author relations...
 188                                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
 189                                         $log->addRelations( 'target_author_id', $userIds, $row->log_id );
 190                                         $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
 191                                 }
 192                                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
 193                                         $log->addRelations( 'target_author_actor', $userActors, $row->log_id );
 194                                 }
 195                         }
 196                         $blockStart += $batchSize;
 197                         $blockEnd += $batchSize;
 198                         wfWaitForSlaves();
 199                 }
 200                 $this->output( "Done populating log_search table.\n" );
 201
 202                 return true;
 203         }
 204 }
 205
 206 $maintClass = PopulateLogSearch::class;
 207 require_once RUN_MAINTENANCE_IF_MAIN;