populateLogUsertext.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';
 
class PopulateLogUsertext extends LoggedUpdateMaintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Populates the log_user_text field' );
        $this->setBatchSize( 100 );
    }
 
    protected function getUpdateKey() {
        return 'populate log_usertext';
    }
 
    protected function updateSkippedMessage() {
        return 'log_user_text column of logging table already populated.';
    }
 
    protected function doDBUpdates() {
        $batchSize = $this->getBatchSize();
        $db = $this->getDB( DB_MASTER );
        $start = $db->selectField( 'logging', 'MIN(log_id)', '', __METHOD__ );
        if ( !$start ) {
            $this->output( "Nothing to do.\n" );
 
            return true;
        }
        $end = $db->selectField( 'logging', 'MAX(log_id)', '', __METHOD__ );
 
        // If this is being run during an upgrade from 1.16 or earlier, this
        // will be run before the actor table change and should continue. But
        // if it's being run on a new installation, the field won't exist to be populated.
        if ( !$db->fieldInfo( 'logging', 'log_user_text' ) ) {
            $this->output( "No log_user_text field, nothing to do.\n" );
            return true;
        }
 
        # Do remaining chunk
        $end += $batchSize - 1;
        $blockStart = $start;
        $blockEnd = $start + $batchSize - 1;
        while ( $blockEnd <= $end ) {
            $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
            $cond = "log_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd .
                " AND log_user = user_id";
            $res = $db->select( [ 'logging', 'user' ],
                [ 'log_id', 'user_name' ], $cond, __METHOD__ );
 
            $this->beginTransaction( $db, __METHOD__ );
            foreach ( $res as $row ) {
                $db->update( 'logging', [ 'log_user_text' => $row->user_name ],
                    [ 'log_id' => $row->log_id ], __METHOD__ );
            }
            $this->commitTransaction( $db, __METHOD__ );
            $blockStart += $batchSize;
            $blockEnd += $batchSize;
        }
        $this->output( "Done populating log_user_text field.\n" );
 
        return true;
    }
}
 
$maintClass = PopulateLogUsertext::class;
require_once RUN_MAINTENANCE_IF_MAIN;