RevisionDeleteUser.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\IDatabase;
 
class RevisionDeleteUser {
 
    private static function setUsernameBitfields( $name, $userId, $op, $dbw ) {
        if ( !$userId || ( $op !== '|' && $op !== '&' ) ) {
            return false; // sanity check
        }
        if ( !$dbw instanceof IDatabase ) {
            $dbw = wfGetDB( DB_MASTER );
        }
 
        # To suppress, we OR the current bitfields with Revision::DELETED_USER
        # to put a 1 in the username *_deleted bit. To unsuppress we AND the
        # current bitfields with the inverse of Revision::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 = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
        $delAction = LogPage::DELETED_ACTION | Revision::DELETED_RESTRICTED;
        if ( $op == '&' ) {
            $delUser = $dbw->bitNot( $delUser );
            $delAction = $dbw->bitNot( $delAction );
        }
 
        # Normalize user name
        $userTitle = Title::makeTitleSafe( NS_USER, $name );
        $userDbKey = $userTitle->getDBkey();
 
        # Hide name from live edits
        $dbw->update(
            'revision',
            [ self::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
            [ 'rev_user' => $userId ],
            __METHOD__ );
 
        # Hide name from deleted edits
        $dbw->update(
            'archive',
            [ self::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
            [ 'ar_user_text' => $name ],
            __METHOD__
        );
 
        # Hide name from logs
        $dbw->update(
            'logging',
            [ self::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
            [ 'log_user' => $userId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
            __METHOD__
        );
        $dbw->update(
            'logging',
            [ self::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) ],
            [ 'log_namespace' => NS_USER, 'log_title' => $userDbKey,
                'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
            __METHOD__
        );
 
        # Hide name from RC
        $dbw->update(
            'recentchanges',
            [ self::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
            [ 'rc_user_text' => $name ],
            __METHOD__
        );
        $dbw->update(
            'recentchanges',
            [ self::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) ],
            [ 'rc_namespace' => NS_USER, 'rc_title' => $userDbKey, 'rc_logid > 0' ],
            __METHOD__
        );
 
        # Hide name from live images
        $dbw->update(
            'oldimage',
            [ self::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
            [ 'oi_user_text' => $name ],
            __METHOD__
        );
 
        # Hide name from deleted images
        $dbw->update(
            'filearchive',
            [ self::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
            [ 'fa_user_text' => $name ],
            __METHOD__
        );
        # Done!
        return true;
    }
 
    private static function buildSetBitDeletedField( $field, $op, $value, $dbw ) {
        return $field . ' = ' . ( $op === '&'
            ? $dbw->bitAnd( $field, $value )
            : $dbw->bitOr( $field, $value ) );
    }
 
    public static function suppressUserName( $name, $userId, $dbw = null ) {
        return self::setUsernameBitfields( $name, $userId, '|', $dbw );
    }
 
    public static function unsuppressUserName( $name, $userId, $dbw = null ) {
        return self::setUsernameBitfields( $name, $userId, '&', $dbw );
    }
}