reassignEdits.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use Wikimedia\IPUtils;
 
require_once __DIR__ . '/Maintenance.php';
 
class ReassignEdits extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Reassign edits from one user to another' );
        $this->addOption( "force", "Reassign even if the target user doesn't exist" );
        $this->addOption( "norc", "Don't update the recent changes table" );
        $this->addOption( "report", "Print out details of what would be changed, but don't update it" );
        $this->addArg( 'from', 'Old user to take edits from' );
        $this->addArg( 'to', 'New user to give edits to' );
    }
 
    public function execute() {
        if ( $this->hasArg( 0 ) && $this->hasArg( 1 ) ) {
            # Set up the users involved
            $from = $this->initialiseUser( $this->getArg( 0 ) );
            $to = $this->initialiseUser( $this->getArg( 1 ) );
 
            # If the target doesn't exist, and --force is not set, stop here
            if ( $to->getId() || $this->hasOption( 'force' ) ) {
                # Reassign the edits
                $report = $this->hasOption( 'report' );
                $this->doReassignEdits( $from, $to, !$this->hasOption( 'norc' ), $report );
                # If reporting, and there were items, advise the user to run without --report
                if ( $report ) {
                    $this->output( "Run the script again without --report to update.\n" );
                }
            } else {
                $ton = $to->getName();
                $this->error( "User '{$ton}' not found." );
            }
        }
    }
 
    private function doReassignEdits( &$from, &$to, $updateRC = false, $report = false ) {
        $dbw = $this->getDB( DB_PRIMARY );
        $this->beginTransaction( $dbw, __METHOD__ );
        $actorNormalization = MediaWikiServices::getInstance()->getActorNormalization();
        $fromActorId = $actorNormalization->findActorId( $from, $dbw );
 
        # Count things
        $this->output( "Checking current edits..." );
        $revQueryInfo = ActorMigration::newMigration()->getWhere( $dbw, 'rev_user', $from );
        $revisionRows = $dbw->selectRowCount(
            [ 'revision' ] + $revQueryInfo['tables'],
            '*',
            $revQueryInfo['conds'],
            __METHOD__,
            [],
            $revQueryInfo['joins']
        );
        $this->output( "found {$revisionRows}.\n" );
 
        $this->output( "Checking deleted edits..." );
        $archiveRows = $dbw->selectRowCount(
            [ 'archive' ],
            '*',
            [ 'ar_actor' => $fromActorId ],
            __METHOD__
        );
        $this->output( "found {$archiveRows}.\n" );
 
        # Don't count recent changes if we're not supposed to
        if ( $updateRC ) {
            $this->output( "Checking recent changes..." );
            $recentChangesRows = $dbw->selectRowCount(
                [ 'recentchanges' ],
                '*',
                [ 'rc_actor' => $fromActorId ],
                __METHOD__
            );
            $this->output( "found {$recentChangesRows}.\n" );
        } else {
            $recentChangesRows = 0;
        }
 
        $total = $revisionRows + $archiveRows + $recentChangesRows;
        $this->output( "\nTotal entries to change: {$total}\n" );
 
        $toActorId = $actorNormalization->acquireActorId( $to, $dbw );
        if ( !$report && $total ) {
            $this->output( "\n" );
            if ( $revisionRows ) {
                # Reassign edits
                $this->output( "Reassigning current edits..." );
                $dbw->update(
                    'revision',
                    [ 'rev_actor' => $toActorId ],
                    [ 'rev_actor' => $fromActorId ],
                    __METHOD__
                );
                $this->output( "done.\n" );
            }
 
            if ( $archiveRows ) {
                $this->output( "Reassigning deleted edits..." );
                $dbw->update( 'archive',
                    [ 'ar_actor' => $toActorId ],
                    [ 'ar_actor' => $fromActorId ],
                    __METHOD__
                );
                $this->output( "done.\n" );
            }
            # Update recent changes if required
            if ( $recentChangesRows ) {
                $this->output( "Updating recent changes..." );
                $dbw->update( 'recentchanges',
                    [ 'rc_actor' => $toActorId ],
                    [ 'rc_actor' => $fromActorId ],
                    __METHOD__
                );
                $this->output( "done.\n" );
            }
 
            # If $from is an IP, delete any relevant rows from the
            # ip_changes. No update needed, as $to cannot be an IP.
            if ( !$from->isRegistered() ) {
                $this->output( "Deleting ip_changes..." );
                $dbw->delete(
                    'ip_changes',
                    [
                        'ipc_hex' => IPUtils::toHex( $from->getName() )
                    ],
                    __METHOD__
                );
                $this->output( "done.\n" );
            }
        }
 
        $this->commitTransaction( $dbw, __METHOD__ );
 
        return $total;
    }
 
    private function initialiseUser( $username ) {
        $services = MediaWikiServices::getInstance();
        if ( $services->getUserNameUtils()->isIP( $username ) ) {
            $user = User::newFromName( $username, false );
            $user->getActorId();
        } else {
            $user = User::newFromName( $username );
            if ( !$user ) {
                $this->fatalError( "Invalid username" );
            }
        }
        $user->load();
 
        return $user;
    }
}
 
$maintClass = ReassignEdits::class;
require_once RUN_MAINTENANCE_IF_MAIN;