RenameUserJob.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Config\Config;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\Title\Title;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\ILBFactory;
 
class RenameUserJob extends Job {
    private $updateRowsPerQuery;
 
    private $lbFactory;
 
    private $logger;
 
    public function __construct(
        Title $title,
        $params,
        Config $config,
        ILBFactory $lbFactory
    ) {
        parent::__construct( 'renameUser', $title, $params );
 
        $this->updateRowsPerQuery = $config->get( MainConfigNames::UpdateRowsPerQuery );
        $this->lbFactory = $lbFactory;
        $this->logger = LoggerFactory::getInstance( 'Renameuser' );
    }
 
    public function run() {
        $dbw = $this->lbFactory->getMainLB()->getMaintenanceConnectionRef( DB_PRIMARY );
        $table = $this->params['table'];
        $column = $this->params['column'];
 
        // It's not worth a hook to let extensions add themselves to that list.
        // Just check whether the table and column still exist instead.
        if ( !$dbw->tableExists( $table, __METHOD__ ) ) {
            $this->logger->info(
                "Ignoring job {$this->toString()}, table $table does not exist" );
            return true;
        } elseif ( !$dbw->fieldExists( $table, $column, __METHOD__ ) ) {
            $this->logger->info(
                "Ignoring job {$this->toString()}, column $table.$column does not exist" );
            return true;
        }
 
        $oldname = $this->params['oldname'];
        $newname = $this->params['newname'];
        if ( isset( $this->params['userID'] ) ) {
            $userID = $this->params['userID'];
            $uidColumn = $this->params['uidColumn'];
        } else {
            $userID = null;
            $uidColumn = null;
        }
        if ( isset( $this->params['timestampColumn'] ) ) {
            $timestampColumn = $this->params['timestampColumn'];
            $minTimestamp = $this->params['minTimestamp'];
            $maxTimestamp = $this->params['maxTimestamp'];
        } else {
            $timestampColumn = null;
            $minTimestamp = null;
            $maxTimestamp = null;
        }
        $uniqueKey = $this->params['uniqueKey'] ?? null;
        $keyId = $this->params['keyId'] ?? null;
 
        # Conditions like "*_user_text = 'x'
        $conds = [ $column => $oldname ];
        # If user ID given, add that to condition to avoid rename collisions
        if ( $userID !== null ) {
            $conds[$uidColumn] = $userID;
        }
        # Bound by timestamp if given
        if ( $timestampColumn !== null ) {
            $conds[] = "$timestampColumn >= " . $dbw->addQuotes( $minTimestamp );
            $conds[] = "$timestampColumn <= " . $dbw->addQuotes( $maxTimestamp );
        # Bound by unique key if given (B/C)
        } elseif ( $uniqueKey !== null && $keyId !== null ) {
            $conds[$uniqueKey] = $keyId;
        } else {
            throw new InvalidArgumentException( 'Expected ID batch or time range' );
        }
 
        # Actually update the rows for this job...
        if ( $uniqueKey !== null ) {
            # Select the rows to update by PRIMARY KEY
            $ids = $dbw->selectFieldValues( $table, $uniqueKey, $conds, __METHOD__ );
            # Update these rows by PRIMARY KEY to avoid replica lag
            foreach ( array_chunk( $ids, $this->updateRowsPerQuery ) as $batch ) {
                $dbw->commit( __METHOD__, 'flush' );
                $this->lbFactory->waitForReplication();
 
                $dbw->newUpdateQueryBuilder()
                    ->update( $table )
                    ->set( [ $column => $newname ] )
                    ->where( [ $column => $oldname, $uniqueKey => $batch ] )
                    ->caller( __METHOD__ )->execute();
            }
        } else {
            # Update the chunk of rows directly
            $dbw->newUpdateQueryBuilder()
                ->update( $table )
                ->set( [ $column => $newname ] )
                ->where( $conds )
                ->caller( __METHOD__ )->execute();
        }
 
        return true;
    }
}