UserEditCountUpdate.php

Go to the documentation of this file.

<?php
use Wikimedia\Assert\Assert;
use MediaWiki\MediaWikiServices;
 
class UserEditCountUpdate implements DeferrableUpdate, MergeableUpdate {
    private $infoByUser;
 
    public function __construct( User $user, $increment ) {
        if ( !$user->getId() ) {
            throw new RuntimeException( "Got user ID of zero" );
        }
        $this->infoByUser = [
            $user->getId() => [ 'increment' => $increment, 'instances' => [ $user ] ]
        ];
    }
 
    public function merge( MergeableUpdate $update ) {
        Assert::parameterType( __CLASS__, $update, '$update' );
        '@phan-var UserEditCountUpdate $update';
 
        foreach ( $update->infoByUser as $userId => $info ) {
            if ( !isset( $this->infoByUser[$userId] ) ) {
                $this->infoByUser[$userId] = [ 'increment' => 0, 'instances' => [] ];
            }
            // Merge the increment amount
            $this->infoByUser[$userId]['increment'] += $info['increment'];
            // Merge the list of User instances to update in doUpdate()
            foreach ( $info['instances'] as $user ) {
                if ( !in_array( $user, $this->infoByUser[$userId]['instances'], true ) ) {
                    $this->infoByUser[$userId]['instances'][] = $user;
                }
            }
        }
    }
 
    public function doUpdate() {
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
        $dbw = $lb->getConnectionRef( DB_MASTER );
        $fname = __METHOD__;
 
        ( new AutoCommitUpdate( $dbw, __METHOD__, function () use ( $lb, $dbw, $fname ) {
            foreach ( $this->infoByUser as $userId => $info ) {
                $dbw->update(
                    'user',
                    [ 'user_editcount=user_editcount+' . (int)$info['increment'] ],
                    [ 'user_id' => $userId, 'user_editcount IS NOT NULL' ],
                    $fname
                );
                $affectedInstances = $info['instances'];
                // Lazy initialization check...
                if ( $dbw->affectedRows() == 0 ) {
                    // The user_editcount is probably NULL (e.g. not initialized).
                    // Since this update runs after the new revisions were committed,
                    // wait for the replica DB to catch up so they will be counted.
                    $dbr = $lb->getConnectionRef( DB_REPLICA );
                    // If $dbr is actually the master DB, then clearing the snapshot
                    // is harmless and waitForMasterPos() will just no-op.
                    $dbr->flushSnapshot( $fname );
                    $lb->waitForMasterPos( $dbr );
                    $affectedInstances[0]->initEditCountInternal( $dbr );
                }
                $newCount = (int)$dbw->selectField(
                    'user',
                    'user_editcount',
                    [ 'user_id' => $userId ],
                    $fname
                );
 
                // Update the edit count in the instance caches. This is mostly useful
                // for maintenance scripts, where deferred updates might run immediately
                // and user instances might be reused for a long time.
                foreach ( $affectedInstances as $affectedInstance ) {
                    $affectedInstance->setEditCountInternal( $newCount );
                }
                // Clear the edit count in user cache too
                $affectedInstances[0]->invalidateCache();
            }
        } ) )->doUpdate();
    }
}