960a7925ae
Add a hook which runs at the end of UserEditCountUpdate. The idea is to allow CentralAuth to keep its own similar edit count. There's no other hook appropriate for this purpose since UserEditTracker::incrementUserEditCount() has multiple callers. Convert the private associative array in UserEditCountUpdate to a class. Instances of the class are passed to the new hook. A class is better suited to a public interface. Bug: T300075 Change-Id: I16a92e6a6e9faf1be4c7fbe25354a08559df163d
105 lines
3.5 KiB
PHP
105 lines
3.5 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\HookContainer\HookRunner;
|
|
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 UserEditCountInfo[] Map of (user ID => UserEditCountInfo)
|
|
*/
|
|
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() => new UserEditCountInfo( $user, $increment ),
|
|
];
|
|
}
|
|
|
|
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] ) ) {
|
|
$this->infoByUser[$userId] = $info;
|
|
} else {
|
|
$this->infoByUser[$userId]->merge( $info );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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->getIncrement() ],
|
|
[ 'user_id' => $userId, 'user_editcount IS NOT NULL' ],
|
|
$fname
|
|
);
|
|
// 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( $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 ) );
|
|
}
|
|
}
|