wiki.techinc.nl/includes/deferred/UserEditCountUpdate.php
James D. Forrester 8426aacd96 ILoadBalancer: Rename waitForMasterPos to waitForPrimaryPos
Hard-deprecating immediately as no known users in git outside of this repo.

Bug: T282894
Change-Id: I5fa312ae89660a9c6de3c24e13d48de92893e5b0
2021-09-03 20:11:05 +00:00

107 lines
3.7 KiB
PHP

<?php
/**
* User edit count incrementing.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserIdentity;
use Wikimedia\Assert\Assert;
/**
* Handles increment the edit count for a given set of users
*/
class UserEditCountUpdate implements DeferrableUpdate, MergeableUpdate {
/**
* We need to keep a single copy of the relevant UserIdentity to be able to pass to UserEditTracker
*
* @var array[] Map of (user ID => ('increment': int, 'object': UserIdentity))
*/
private $infoByUser;
/**
* @param UserIdentity $user
* @param int $increment
*/
public function __construct( UserIdentity $user, $increment ) {
if ( !$user->getId() ) {
throw new RuntimeException( "Got user ID of zero" );
}
$this->infoByUser = [
$user->getId() => [ 'increment' => $increment, 'object' => $user ]
];
}
public function merge( MergeableUpdate $update ) {
/** @var UserEditCountUpdate $update */
Assert::parameterType( __CLASS__, $update, '$update' );
'@phan-var UserEditCountUpdate $update';
foreach ( $update->infoByUser as $userId => $info ) {
if ( !isset( $this->infoByUser[$userId] ) ) {
// Object will be filled in below
$this->infoByUser[$userId] = [ 'increment' => 0 ];
}
// Merge the increment amount
$this->infoByUser[$userId]['increment'] += $info['increment'];
// Always use the UserIdentity from the other update in case we don't
// already have info for the user
$this->infoByUser[$userId]['object'] = $info['object'];
}
}
/**
* Commits the provided user edit count increments to the database
*/
public function doUpdate() {
$mwServices = MediaWikiServices::getInstance();
$lb = $mwServices->getDBLoadBalancer();
$dbw = $lb->getConnectionRef( DB_PRIMARY );
$editTracker = $mwServices->getUserEditTracker();
$fname = __METHOD__;
( new AutoCommitUpdate( $dbw, __METHOD__, function () use ( $lb, $dbw, $fname, $editTracker ) {
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
);
/** @var UserIdentity $targetUserIdentity */
$targetUserIdentity = $info['object'];
// 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 primary DB, then clearing the snapshot
// is harmless and waitForPrimaryPos() will just no-op.
$dbr->flushSnapshot( $fname );
$lb->waitForPrimaryPos( $dbr );
$editTracker->initializeUserEditCount( $targetUserIdentity );
}
// Clear the edit count in the UserEditTracker cache.
$editTracker->clearUserEditCache( $targetUserIdentity );
}
} ) )->doUpdate();
}
}