resetUserTokens.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';
 
use MediaWiki\MediaWikiServices;
 
class ResetUserTokens extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription(
            "Reset the user_token of all users on the wiki. Note that this may log some of them out.\n"
            . "Deprecated, use \$wgAuthenticationTokenVersion instead."
        );
        $this->addOption( 'nowarn', "Hides the 5 seconds warning", false, false );
        $this->addOption(
            'nulls',
            'Only reset tokens that are currently null (string of \x00\'s)',
            false,
            false
        );
        $this->setBatchSize( 1000 );
    }
 
    public function execute() {
        $nullsOnly = $this->getOption( 'nulls' );
 
        if ( !$this->getOption( 'nowarn' ) ) {
            if ( $nullsOnly ) {
                $this->output( "The script is about to reset the user_token "
                    . "for USERS WITH NULL TOKENS in the database.\n" );
            } else {
                $this->output( "The script is about to reset the user_token for ALL USERS in the database.\n" );
                $this->output( "This may log some of them out and is not necessary unless you believe your\n" );
                $this->output( "user table has been compromised.\n" );
            }
            $this->output( "\n" );
            $this->output( "Abort with control-c in the next five seconds "
                . "(skip this countdown with --nowarn) ... " );
            $this->countDown( 5 );
        }
 
        // We list user by user_id from one of the replica DBs
        $dbr = $this->getDB( DB_REPLICA );
 
        $where = [];
        if ( $nullsOnly ) {
            // Have to build this by hand, because \ is escaped in helper functions
            $where = [ 'user_token = \'' . str_repeat( '\0', 32 ) . '\'' ];
        }
 
        $maxid = $dbr->selectField( 'user', 'MAX(user_id)', [], __METHOD__ );
 
        $min = 0;
        $max = $this->getBatchSize();
        $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 
        do {
            $result = $dbr->select( 'user',
                [ 'user_id' ],
                array_merge(
                    $where,
                    [ 'user_id > ' . $dbr->addQuotes( $min ),
                        'user_id <= ' . $dbr->addQuotes( $max )
                    ]
                ),
                __METHOD__
            );
 
            foreach ( $result as $user ) {
                $this->updateUser( $user->user_id );
            }
 
            $min = $max;
            $max = $min + $this->getBatchSize();
 
            $lbFactory->waitForReplication();
        } while ( $min <= $maxid );
    }
 
    private function updateUser( $userid ) {
        $user = User::newFromId( $userid );
        $username = $user->getName();
        $this->output( 'Resetting user_token for "' . $username . '": ' );
        // Change value
        $user->setToken();
        $user->saveSettings();
        $this->output( " OK\n" );
    }
}
 
$maintClass = ResetUserTokens::class;
require_once RUN_MAINTENANCE_IF_MAIN;