purgeExpiredUserrights.php

Go to the documentation of this file.

<?php
use MediaWiki\Maintenance\Maintenance;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
/*
 * Remove expired userrights from user_groups table and move them to former_user_groups.
 *
 * By default, this does not need to be run. The UserGroupManager service naturally
 * takes care of detecting expired rows when it is written to (e.g. from SpecialUserrights)
 * and queues UserGroupExpiryJob to purge expired rows.
 *
 * Large wiki farms may experience stale rows if their users manage local groups
 * via a central wiki. In that case, UserGroupExpiryJob may run rarely or never
 * from local wikis, in which case this script can help to periodically clean up
 * expired rows.
 *
 * @since 1.31
 * @ingroup Maintenance
 * @author Eddie Greiner-Petter <wikimedia.org at eddie-sh.de>
 */
class PurgeExpiredUserrights extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Move expired userrights from user_groups to former_user_groups table.' );
    }
 
    public function execute() {
        $this->output( "Purging expired user rights...\n" );
        $res = $this->getServiceContainer()->getUserGroupManager()->purgeExpired();
        if ( $res === false ) {
            $this->output( "Purging failed.\n" );
        } else {
            $this->output( "$res rows purged.\n" );
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = PurgeExpiredUserrights::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd