]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - maintenance/populateLogSearch.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / maintenance / populateLogSearch.php
index b045104e5f6b1ef555ab0f354646309a8bdccd73..1b07407e4ac5d35cdcf4e09d94032eb6b1747cd2 100644 (file)
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
-require_once( dirname(__FILE__) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
-class PopulateLogSearch extends Maintenance {
-
-       const LOG_SEARCH_BATCH_SIZE = 100;
+/**
+ * Maintenance script that makes the required database updates for populating the
+ * log_search table retroactively
+ *
+ * @ingroup Maintenance
+ */
+class PopulateLogSearch extends LoggedUpdateMaintenance {
+       private static $tableMap = [
+               'rev' => 'revision',
+               'fa' => 'filearchive',
+               'oi' => 'oldimage',
+               'ar' => 'archive'
+       ];
 
-       static $tableMap = array('rev' => 'revision', 'fa' => 'filearchive', 'oi' => 'oldimage', 'ar' => 'archive');
-       
        public function __construct() {
                parent::__construct();
-               $this->mDescription = "Migrate log params to new table and index for searching";
+               $this->addDescription( 'Migrate log params to new table and index for searching' );
+               $this->setBatchSize( 100 );
        }
 
-       public function execute() {
-               $db = wfGetDB( DB_MASTER );
+       protected function getUpdateKey() {
+               return 'populate log_search';
+       }
+
+       protected function updateSkippedMessage() {
+               return 'log_search table already populated.';
+       }
+
+       protected function doDBUpdates() {
+               $db = $this->getDB( DB_MASTER );
                if ( !$db->tableExists( 'log_search' ) ) {
-                       $this->error( "log_search does not exist", true );
+                       $this->error( "log_search does not exist" );
+
+                       return false;
                }
                $start = $db->selectField( 'logging', 'MIN(log_id)', false, __FUNCTION__ );
-               if( !$start ) {
+               if ( !$start ) {
                        $this->output( "Nothing to do.\n" );
+
                        return true;
                }
                $end = $db->selectField( 'logging', 'MAX(log_id)', false, __FUNCTION__ );
-       
+
                # Do remaining chunk
-               $end += self::LOG_SEARCH_BATCH_SIZE - 1;
+               $end += $this->mBatchSize - 1;
                $blockStart = $start;
-               $blockEnd = $start + self::LOG_SEARCH_BATCH_SIZE - 1;
-               
-               $delTypes = array('delete','suppress'); // revisiondelete types
-               while( $blockEnd <= $end ) {
+               $blockEnd = $start + $this->mBatchSize - 1;
+
+               $delTypes = [ 'delete', 'suppress' ]; // revisiondelete types
+               while ( $blockEnd <= $end ) {
                        $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
                        $cond = "log_id BETWEEN $blockStart AND $blockEnd";
                        $res = $db->select( 'logging', '*', $cond, __FUNCTION__ );
-                       $batch = array();
-                       foreach( $res as $row ) {
+                       foreach ( $res as $row ) {
                                // RevisionDelete logs - revisions
-                               if( LogEventsList::typeAction( $row, $delTypes, 'revision' ) ) {
+                               if ( LogEventsList::typeAction( $row, $delTypes, 'revision' ) ) {
                                        $params = LogPage::extractParams( $row->log_params );
                                        // Param format: <urlparam> <item CSV> [<ofield> <nfield>]
-                                       if( count($params) < 2 ) continue; // bad row?
-                                       $field = RevisionDeleter::getRelationType($params[0]);
+                                       if ( count( $params ) < 2 ) {
+                                               continue; // bad row?
+                                       }
+                                       $field = RevisionDeleter::getRelationType( $params[0] );
                                        // B/C, the params may start with a title key (<title> <urlparam> <CSV>)
-                                       if( $field == null ) {
-                                               array_shift($params); // remove title param
-                                               $field = RevisionDeleter::getRelationType($params[0]);
-                                               if( $field == null ) {
+                                       if ( $field == null ) {
+                                               array_shift( $params ); // remove title param
+                                               $field = RevisionDeleter::getRelationType( $params[0] );
+                                               if ( $field == null ) {
                                                        $this->output( "Invalid param type for {$row->log_id}\n" );
                                                        continue; // skip this row
                                                } else {
                                                        // Clean up the row...
-                                                       $db->update( 'logging', 
-                                                               array('log_params' => implode(',',$params) ),
-                                                               array('log_id' => $row->log_id ) );
+                                                       $db->update( 'logging',
+                                                               [ 'log_params' => implode( ',', $params ) ],
+                                                               [ 'log_id' => $row->log_id ] );
                                                }
                                        }
-                                       $items = explode(',',$params[1]);
+                                       $items = explode( ',', $params[1] );
                                        $log = new LogPage( $row->log_type );
                                        // Add item relations...
                                        $log->addRelations( $field, $items, $row->log_id );
                                        // Determine what table to query...
-                                       $prefix = substr( $field, 0, strpos($field,'_') ); // db prefix
-                                       if( !isset(self::$tableMap[$prefix]) )
+                                       $prefix = substr( $field, 0, strpos( $field, '_' ) ); // db prefix
+                                       if ( !isset( self::$tableMap[$prefix] ) ) {
                                                continue; // bad row?
+                                       }
                                        $table = self::$tableMap[$prefix];
-                                       $userField = $prefix.'_user';
-                                       $userTextField = $prefix.'_user_text';
+                                       $userField = $prefix . '_user';
+                                       $userTextField = $prefix . '_user_text';
                                        // Add item author relations...
-                                       $userIds = $userIPs = array();
+                                       $userIds = $userIPs = [];
                                        $sres = $db->select( $table,
-                                               array($userField,$userTextField),
-                                               array($field => $items)
+                                               [ $userField, $userTextField ],
+                                               [ $field => $items ]
                                        );
-                                       foreach( $sres as $srow ) {
-                                               if( $srow->$userField > 0 )
-                                                       $userIds[] = intval($srow->$userField);
-                                               else if( $srow->$userTextField != '' )
+                                       foreach ( $sres as $srow ) {
+                                               if ( $srow->$userField > 0 ) {
+                                                       $userIds[] = intval( $srow->$userField );
+                                               } elseif ( $srow->$userTextField != '' ) {
                                                        $userIPs[] = $srow->$userTextField;
+                                               }
                                        }
                                        // Add item author relations...
                                        $log->addRelations( 'target_author_id', $userIds, $row->log_id );
                                        $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
-                               // RevisionDelete logs - log events
-                               } else if( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
+                               } elseif ( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
+                                       // RevisionDelete logs - log events
                                        $params = LogPage::extractParams( $row->log_params );
                                        // Param format: <item CSV> [<ofield> <nfield>]
-                                       if( count($params) < 1 ) continue; // bad row
+                                       if ( count( $params ) < 1 ) {
+                                               continue; // bad row
+                                       }
                                        $items = explode( ',', $params[0] );
                                        $log = new LogPage( $row->log_type );
                                        // Add item relations...
                                        $log->addRelations( 'log_id', $items, $row->log_id );
                                        // Add item author relations...
-                                       $userIds = $userIPs = array();
+                                       $userIds = $userIPs = [];
                                        $sres = $db->select( 'logging',
-                                               array('log_user','log_user_text'),
-                                               array('log_id' => $items)
+                                               [ 'log_user', 'log_user_text' ],
+                                               [ 'log_id' => $items ]
                                        );
-                                       foreach( $sres as $srow ) {
-                                               if( $srow->log_user > 0 )
-                                                       $userIds[] = intval($srow->log_user);
-                                               else if( IP::isIPAddress($srow->log_user_text) )
+                                       foreach ( $sres as $srow ) {
+                                               if ( $srow->log_user > 0 ) {
+                                                       $userIds[] = intval( $srow->log_user );
+                                               } elseif ( IP::isIPAddress( $srow->log_user_text ) ) {
                                                        $userIPs[] = $srow->log_user_text;
+                                               }
                                        }
                                        $log->addRelations( 'target_author_id', $userIds, $row->log_id );
                                        $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
                                }
                        }
-                       $blockStart += self::LOG_SEARCH_BATCH_SIZE;
-                       $blockEnd += self::LOG_SEARCH_BATCH_SIZE;
-                       wfWaitForSlaves( 5 );
-               }
-               if( $db->insert(
-                               'updatelog',
-                               array( 'ul_key' => 'populate log_search' ),
-                               __FUNCTION__,
-                               'IGNORE'
-                       )
-               ) {
-                       $this->output( "log_search population complete.\n" );
-                       return true;
-               } else {
-                       $this->output( "Could not insert log_search population row.\n" );
-                       return false;
+                       $blockStart += $this->mBatchSize;
+                       $blockEnd += $this->mBatchSize;
+                       wfWaitForSlaves();
                }
+               $this->output( "Done populating log_search table.\n" );
+
+               return true;
        }
 }
 
 $maintClass = "PopulateLogSearch";
-require_once( DO_MAINTENANCE );
+require_once RUN_MAINTENANCE_IF_MAIN;