reassignEdits.php

Go to the documentation of this file.

<?php
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, $rc = false, $report = false ) {
        $dbw = $this->getDB( DB_MASTER );
        $this->beginTransaction( $dbw, __METHOD__ );

        # Count things
        $this->output( "Checking current edits..." );
        $res = $dbw->select(
            'revision',
            'COUNT(*) AS count',
            $this->userConditions( $from, 'rev_user', 'rev_user_text' ),
            __METHOD__
        );
        $row = $dbw->fetchObject( $res );
        $cur = $row->count;
        $this->output( "found {$cur}.\n" );

        $this->output( "Checking deleted edits..." );
        $res = $dbw->select(
            'archive',
            'COUNT(*) AS count',
            $this->userConditions( $from, 'ar_user', 'ar_user_text' ),
            __METHOD__
        );
        $row = $dbw->fetchObject( $res );
        $del = $row->count;
        $this->output( "found {$del}.\n" );

        # Don't count recent changes if we're not supposed to
        if ( $rc ) {
            $this->output( "Checking recent changes..." );
            $res = $dbw->select(
                'recentchanges',
                'COUNT(*) AS count',
                $this->userConditions( $from, 'rc_user', 'rc_user_text' ),
                __METHOD__
            );
            $row = $dbw->fetchObject( $res );
            $rec = $row->count;
            $this->output( "found {$rec}.\n" );
        } else {
            $rec = 0;
        }

        $total = $cur + $del + $rec;
        $this->output( "\nTotal entries to change: {$total}\n" );

        if ( !$report ) {
            if ( $total ) {
                # Reassign edits
                $this->output( "\nReassigning current edits..." );
                $dbw->update( 'revision', $this->userSpecification( $to, 'rev_user', 'rev_user_text' ),
                    $this->userConditions( $from, 'rev_user', 'rev_user_text' ), __METHOD__ );
                $this->output( "done.\nReassigning deleted edits..." );
                $dbw->update( 'archive', $this->userSpecification( $to, 'ar_user', 'ar_user_text' ),
                    $this->userConditions( $from, 'ar_user', 'ar_user_text' ), __METHOD__ );
                $this->output( "done.\n" );
                # Update recent changes if required
                if ( $rc ) {
                    $this->output( "Updating recent changes..." );
                    $dbw->update( 'recentchanges', $this->userSpecification( $to, 'rc_user', 'rc_user_text' ),
                        $this->userConditions( $from, 'rc_user', 'rc_user_text' ), __METHOD__ );
                    $this->output( "done.\n" );
                }
            }
        }

        $this->commitTransaction( $dbw, __METHOD__ );

        return (int)$total;
    }

    private function userConditions( &$user, $idfield, $utfield ) {
        return $user->getId()
            ? [ $idfield => $user->getId() ]
            : [ $utfield => $user->getName() ];
    }

    private function userSpecification( &$user, $idfield, $utfield ) {
        return [ $idfield => $user->getId(), $utfield => $user->getName() ];
    }

    private function initialiseUser( $username ) {
        if ( User::isIP( $username ) ) {
            $user = new User();
            $user->setId( 0 );
            $user->setName( $username );
        } else {
            $user = User::newFromName( $username );
            if ( !$user ) {
                $this->error( "Invalid username", true );
            }
        }
        $user->load();

        return $user;
    }
}

$maintClass = "ReassignEdits";
require_once RUN_MAINTENANCE_IF_MAIN;