UserEditCountUpdate.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Deferred;
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserIdentity;
use RuntimeException;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\RawSQLValue;
 
class UserEditCountUpdate implements DeferrableUpdate, MergeableUpdate {
    private $infoByUser;
 
    public function __construct( UserIdentity $user, $increment ) {
        if ( !$user->getId() ) {
            throw new RuntimeException( "Got anonymous user" );
        }
        $this->infoByUser = [
            $user->getId() => new UserEditCountInfo( $user, $increment ),
        ];
    }
 
    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] = $info;
            } else {
                $this->infoByUser[$userId]->merge( $info );
            }
        }
    }
 
    public function doUpdate() {
        $mwServices = MediaWikiServices::getInstance();
        $lb = $mwServices->getDBLoadBalancer();
        $dbw = $lb->getConnection( DB_PRIMARY );
        $editTracker = $mwServices->getUserEditTracker();
        $fname = __METHOD__;
 
        ( new AutoCommitUpdate( $dbw, __METHOD__, function () use ( $lb, $dbw, $fname, $editTracker ) {
            foreach ( $this->infoByUser as $userId => $info ) {
                $dbw->newUpdateQueryBuilder()
                    ->update( 'user' )
                    ->set( [
                        'user_editcount' => new RawSQLValue(
                            'user_editcount+' . (int)$info->getIncrement()
                        )
                    ] )
                    ->where( [ 'user_id' => $userId, $dbw->expr( 'user_editcount', '!=', null ) ] )
                    ->caller( $fname )->execute();
                // 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->getConnection( DB_REPLICA );
                    // If $dbr is actually the primary DB, then clearing the snapshot
                    // is harmless and waitForPrimaryPos() will just no-op.
                    $dbr->flushSnapshot( $fname );
                    $lb->waitForPrimaryPos( $dbr );
                    $editTracker->initializeUserEditCount( $info->getUser() );
                }
 
                // Clear the edit count in the UserEditTracker cache.
                $editTracker->clearUserEditCache( $info->getUser() );
            }
        } ) )->doUpdate();
 
        $hookRunner = new HookRunner( $mwServices->getHookContainer() );
        $hookRunner->onUserEditCountUpdate( array_values( $this->infoByUser ) );
    }
}
 
class_alias( UserEditCountUpdate::class, 'UserEditCountUpdate' );