RevisionDeleteUser.php

Go to the documentation of this file.

<?php
use MediaWiki\Logging\LogPage;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\RawSQLValue;
 
class RevisionDeleteUser {
 
    private static function setUsernameBitfields( $name, $userId, $op, ?IDatabase $dbw = null ) {
        if ( !$userId || ( $op !== '|' && $op !== '&' ) ) {
            return false;
        }
        if ( !$dbw instanceof IDatabase ) {
            $dbw = MediaWikiServices::getInstance()->getConnectionProvider()->getPrimaryDatabase();
        }
 
        # To suppress, we OR the current bitfields with RevisionRecord::DELETED_USER
        # to put a 1 in the username *_deleted bit. To unsuppress we AND the
        # current bitfields with the inverse of RevisionRecord::DELETED_USER. The
        # username bit is made to 0 (x & 0 = 0), while others are unchanged (x & 1 = x).
        # The same goes for the sysop-restricted *_deleted bit.
        $delUser = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
        $delAction = LogPage::DELETED_ACTION | RevisionRecord::DELETED_RESTRICTED;
        if ( $op === '&' ) {
            $delUser = $dbw->bitNot( $delUser );
            $delAction = $dbw->bitNot( $delAction );
        }
 
        # Normalize user name
        $userTitle = Title::makeTitleSafe( NS_USER, $name );
        $userDbKey = $userTitle->getDBkey();
 
        $actorId = $dbw->newSelectQueryBuilder()
            ->select( 'actor_id' )
            ->from( 'actor' )
            ->where( [ 'actor_name' => $name ] )
            ->caller( __METHOD__ )->fetchField();
        if ( $actorId ) {
            # Hide name from live edits
            $dbw->newUpdateQueryBuilder()
                ->update( 'revision' )
                ->set( self::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'rev_actor' => $actorId ] )
                ->caller( __METHOD__ )->execute();
 
            # Hide name from deleted edits
            $dbw->newUpdateQueryBuilder()
                ->update( 'archive' )
                ->set( self::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'ar_actor' => $actorId ] )
                ->caller( __METHOD__ )->execute();
 
            # Hide name from logs
            $dbw->newUpdateQueryBuilder()
                ->update( 'logging' )
                ->set( self::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'log_actor' => $actorId, $dbw->expr( 'log_type', '!=', 'suppress' ) ] )
                ->caller( __METHOD__ )->execute();
 
            # Hide name from RC
            $dbw->newUpdateQueryBuilder()
                ->update( 'recentchanges' )
                ->set( self::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'rc_actor' => $actorId ] )
                ->caller( __METHOD__ )->execute();
 
            # Hide name from live images
            $dbw->newUpdateQueryBuilder()
                ->update( 'oldimage' )
                ->set( self::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'oi_actor' => $actorId ] )
                ->caller( __METHOD__ )->execute();
 
            # Hide name from deleted images
            $dbw->newUpdateQueryBuilder()
                ->update( 'filearchive' )
                ->set( self::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) )
                ->where( [ 'fa_actor' => $actorId ] )
                ->caller( __METHOD__ )->execute();
        }
 
        # Hide log entries pointing to the user page
        $dbw->newUpdateQueryBuilder()
            ->update( 'logging' )
            ->set( self::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) )
            ->where( [
                'log_namespace' => NS_USER,
                'log_title' => $userDbKey,
                $dbw->expr( 'log_type', '!=', 'suppress' )
            ] )
            ->caller( __METHOD__ )->execute();
 
        # Hide RC entries pointing to the user page
        $dbw->newUpdateQueryBuilder()
            ->update( 'recentchanges' )
            ->set( self::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) )
            ->where( [ 'rc_namespace' => NS_USER, 'rc_title' => $userDbKey, $dbw->expr( 'rc_logid', '>', 0 ) ] )
            ->caller( __METHOD__ )->execute();
 
        return true;
    }
 
    private static function buildSetBitDeletedField(
        string $field, string $op, $value, IDatabase $dbw
    ): array {
        return [ $field => new RawSQLValue( $op === '&'
            ? $dbw->bitAnd( $field, $value )
            : $dbw->bitOr( $field, $value )
        ) ];
    }
 
    public static function suppressUserName( $name, $userId, ?IDatabase $dbw = null ) {
        return self::setUsernameBitfields( $name, $userId, '|', $dbw );
    }
 
    public static function unsuppressUserName( $name, $userId, ?IDatabase $dbw = null ) {
        return self::setUsernameBitfields( $name, $userId, '&', $dbw );
    }
}